actions::undo_action Struct Reference

Records information to be able to undo an action. More...

#include <undo_action.hpp>

Inheritance diagram for actions::undo_action:

Public Member Functions
	undo_action ()
virtual	~undo_action ()
virtual bool	undo (int side)=0
	Undoes this action. More...
virtual void	write (config &cfg) const
	Writes this into the provided config. More...
virtual const char *	get_type () const =0

Detailed Description

Records information to be able to undo an action.

Each type of step gets its own derived type.

Definition at line 79 of file undo_action.hpp.

Constructor & Destructor Documentation

undo_action()

actions::undo_action::undo_action ( )

inline

Definition at line 81 of file undo_action.hpp.

~undo_action()

virtual actions::undo_action::~undo_action ( )

inlinevirtual

Definition at line 83 of file undo_action.hpp.

Member Function Documentation

get_type()

virtual const char* actions::undo_action::get_type ( ) const

pure virtual

Implemented in actions::undo::auto_shroud_action, actions::undo::recruit_action, actions::undo::recall_action, actions::undo::move_action, actions::undo::dismiss_action, and actions::undo_event.

Referenced by write().

undo()

virtual bool actions::undo_action::undo ( int  side )

pure virtual

Undoes this action.

Returns

true on success; false on an error.

Implemented in actions::undo::auto_shroud_action, actions::undo::recruit_action, actions::undo::recall_action, actions::undo::move_action, actions::undo::dismiss_action, and actions::undo_event.

write()

virtual void actions::undo_action::write ( config &  cfg ) const

inlinevirtual

Writes this into the provided config.

Reimplemented in actions::undo::auto_shroud_action, actions::undo::recruit_action, actions::undo::recall_action, actions::undo::move_action, actions::undo::dismiss_action, and actions::undo_event.

Definition at line 91 of file undo_action.hpp.

References get_type().

Referenced by actions::undo_event::write(), actions::undo::dismiss_action::write(), actions::undo::move_action::write(), actions::undo::recall_action::write(), actions::undo::recruit_action::write(), and actions::undo::auto_shroud_action::write().

---

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

• actions/undo_action.hpp