The Battle for Wesnoth  1.13.4+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
actions::undo_dummy_action Struct Reference

entry for player actions that do not need any special code to be performed when undoing such as right-click menu items. More...

#include <undo_action.hpp>

Inheritance diagram for actions::undo_dummy_action:
Inheritance graph

Public Member Functions

 undo_dummy_action ()
 
 undo_dummy_action (const config &cfg)
 
virtual const char * get_type () const
 
virtual ~undo_dummy_action ()
 
virtual bool undo (int)
 Undoes this action. More...
 
virtual bool redo (int)
 Redoes this action. More...
 
- Public Member Functions inherited from actions::undo_action
 undo_action ()
 Default constructor. More...
 
 undo_action (const config &cfg)
 
virtual ~undo_action ()
 
virtual void write (config &cfg) const
 Writes this into the provided config. More...
 
void execute_undo_umc_wml ()
 
void execute_redo_umc_wml ()
 
- Public Member Functions inherited from actions::undo_action_base
 undo_action_base ()
 Default constructor. More...
 
virtual ~undo_action_base ()
 

Additional Inherited Members

- Public Types inherited from actions::undo_action
typedef std::vector< undo_eventevent_vector
 actions wml (specified by wml) that should be executed when undoing this command. More...
 
- Static Public Member Functions inherited from actions::undo_action
static void read_event_vector (event_vector &vec, const config &cfg, const std::string &tag)
 
static void write_event_vector (const event_vector &vec, config &cfg, const std::string &tag)
 
- Public Attributes inherited from actions::undo_action
config replay_data
 the replay data to do this action, this is only !empty() when this action is on the redo stack we need this because we don't recalculate the redos like they would be in real game, but even undoable commands can have "dependent" (= user_input) commands, which we save here. More...
 
int unit_id_diff
 the difference in the unit ids TODO: does it really make sense to allow undoing if the unit id counter has changed? More...
 
event_vector umc_commands_undo
 
event_vector umc_commands_redo
 

Detailed Description

entry for player actions that do not need any special code to be performed when undoing such as right-click menu items.

Definition at line 85 of file undo_action.hpp.

Constructor & Destructor Documentation

actions::undo_dummy_action::undo_dummy_action ( )
inline

Definition at line 87 of file undo_action.hpp.

actions::undo_dummy_action::undo_dummy_action ( const config cfg)
inlineexplicit

Definition at line 91 of file undo_action.hpp.

virtual actions::undo_dummy_action::~undo_dummy_action ( )
inlinevirtual

Definition at line 96 of file undo_action.hpp.

Member Function Documentation

virtual const char* actions::undo_dummy_action::get_type ( ) const
inlinevirtual

Implements actions::undo_action_base.

Definition at line 95 of file undo_action.hpp.

virtual bool actions::undo_dummy_action::redo ( int  )
inlinevirtual

Redoes this action.

Implements actions::undo_action.

Definition at line 103 of file undo_action.hpp.

virtual bool actions::undo_dummy_action::undo ( int  )
inlinevirtual

Undoes this action.

Implements actions::undo_action.

Definition at line 98 of file undo_action.hpp.


The documentation for this struct was generated from the following file: