The Battle for Wesnoth  1.19.0-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
22 {
23 namespace undo
24 {
25 
27 {
31 
32 
33  move_action(const unit_const_ptr moved,
34  const std::vector<map_location>::const_iterator & begin,
35  const std::vector<map_location>::const_iterator & end,
36  int sm, int timebonus, int orig, const map_location::DIRECTION dir);
37  move_action(const config & cfg, const config & unit_cfg,
38  int sm, const map_location::DIRECTION dir)
39  : undo_action(cfg)
41  , starting_moves(sm)
42  , starting_dir(dir)
43  , goto_hex(unit_cfg["goto_x"].to_int(-999),
44  unit_cfg["goto_y"].to_int(-999), wml_loc())
45  {
46  }
47  virtual const char* get_type() const { return "move"; }
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 }
58 }
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:159
std::shared_ptr< const unit > unit_const_ptr
Definition: ptr.hpp:27
base class for classes that clear srhoud (move/recruit/recall)
virtual const char * get_type() const
move_action(const config &cfg, const config &unit_cfg, int sm, const map_location::DIRECTION dir)
virtual bool undo(int side)
Undoes this action.
map_location::DIRECTION starting_dir
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, int timebonus, int orig, const map_location::DIRECTION dir)
virtual void write(config &cfg) const
Writes this into the provided config.
actions that are undoable (this does not include update_shroud and auto_shroud)
Definition: undo_action.hpp:66
Encapsulates the map of the game.
Definition: location.hpp:38
DIRECTION
Valid directions which can be moved in our hexagonal world.
Definition: location.hpp:40