The Battle for Wesnoth  1.19.7+dev
undo_move_action.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2017 - 2024
3  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation; either version 2 of the License, or
8  (at your option) any later version.
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY.
11 
12  See the COPYING file for more details.
13 */
14 
15 #pragma once
16 
17 #include "undo_action.hpp"
19 #include "units/ptr.hpp"
20 
21 namespace actions::undo
22 {
24 {
28 
29 
30  move_action(const unit_const_ptr& moved,
31  const std::vector<map_location>::const_iterator & begin,
32  const std::vector<map_location>::const_iterator & end,
33  int sm, const map_location::direction dir);
34  move_action(const config & cfg)
35  : undo_action()
37  , starting_moves(cfg["starting_moves"].to_int())
38  , starting_dir(map_location::parse_direction(cfg["starting_direction"]))
39  , goto_hex(cfg.child_or_empty("unit")["goto_x"].to_int(-999),
40  cfg.child_or_empty("unit")["goto_y"].to_int(-999),
41  wml_loc())
42  {
43  }
44 
45  static const char* get_type_impl() { return "move"; }
46  virtual const char* get_type() const { return get_type_impl(); }
47 
48  virtual ~move_action() {}
49 
50  /** Writes this into the provided config. */
51  virtual void write(config & cfg) const;
52 
53  /** Undoes this action. */
54  virtual bool undo(int side);
55 };
56 
57 }
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:172
std::shared_ptr< const unit > unit_const_ptr
Definition: ptr.hpp:27
base class for classes that clear srhoud (move/recruit/recall)
move_action(const config &cfg)
static const char * get_type_impl()
virtual const char * get_type() const
map_location::direction starting_dir
virtual bool undo(int side)
Undoes this action.
move_action(const unit_const_ptr &moved, const std::vector< map_location >::const_iterator &begin, const std::vector< map_location >::const_iterator &end, int sm, const map_location::direction dir)
virtual void write(config &cfg) const
Writes this into the provided config.
Records information to be able to undo an action.
Definition: undo_action.hpp:80
Encapsulates the map of the game.
Definition: location.hpp:45
direction
Valid directions which can be moved in our hexagonal world.
Definition: location.hpp:47