The Battle for Wesnoth  1.19.0-dev
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:

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...
 
- 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 ()
 
- Public Member Functions inherited from actions::undo_action_base
 undo_action_base (const undo_action_base &)=delete
 
undo_action_baseoperator= (const undo_action_base &)=delete
 
 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
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
 

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 100 of file undo_action.hpp.

Constructor & Destructor Documentation

◆ undo_dummy_action() [1/2]

actions::undo_dummy_action::undo_dummy_action ( )
inline

Definition at line 102 of file undo_action.hpp.

◆ undo_dummy_action() [2/2]

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

Definition at line 106 of file undo_action.hpp.

◆ ~undo_dummy_action()

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

Definition at line 111 of file undo_action.hpp.

Member Function Documentation

◆ get_type()

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

Implements actions::undo_action_base.

Definition at line 110 of file undo_action.hpp.

◆ undo()

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

Undoes this action.

Implements actions::undo_action.

Definition at line 113 of file undo_action.hpp.

References actions::undo_action::execute_undo_umc_wml().


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