The Battle for Wesnoth  1.19.7+dev
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
actions::undo::auto_shroud_action Struct Reference

#include <undo_update_shroud_action.hpp>

Inheritance diagram for actions::undo::auto_shroud_action:

Public Member Functions

 auto_shroud_action (bool turned_on)
 
 auto_shroud_action (const config &cfg)
 
virtual const char * get_type () const
 
virtual bool undo (int)
 Undoes this action. More...
 
virtual ~auto_shroud_action ()
 
virtual void write (config &cfg) const
 Writes this into the provided config. More...
 
- Public Member Functions inherited from actions::undo_action
 undo_action ()
 
virtual ~undo_action ()
 

Static Public Member Functions

static const char * get_type_impl ()
 

Public Attributes

bool active
 

Detailed Description

Definition at line 21 of file undo_update_shroud_action.hpp.

Constructor & Destructor Documentation

◆ auto_shroud_action() [1/2]

actions::undo::auto_shroud_action::auto_shroud_action ( bool  turned_on)
inlineexplicit

Definition at line 24 of file undo_update_shroud_action.hpp.

◆ auto_shroud_action() [2/2]

actions::undo::auto_shroud_action::auto_shroud_action ( const config cfg)
inlineexplicit

Definition at line 29 of file undo_update_shroud_action.hpp.

◆ ~auto_shroud_action()

virtual actions::undo::auto_shroud_action::~auto_shroud_action ( )
inlinevirtual

Definition at line 40 of file undo_update_shroud_action.hpp.

Member Function Documentation

◆ get_type()

virtual const char* actions::undo::auto_shroud_action::get_type ( ) const
inlinevirtual

Implements actions::undo_action.

Definition at line 36 of file undo_update_shroud_action.hpp.

References get_type_impl().

◆ get_type_impl()

static const char* actions::undo::auto_shroud_action::get_type_impl ( )
inlinestatic

Definition at line 35 of file undo_update_shroud_action.hpp.

Referenced by get_type().

◆ undo()

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

Undoes this action.

Returns
true on success; false on an error.

Implements actions::undo_action.

Definition at line 33 of file undo_update_shroud_action.cpp.

References active, resources::controller, play_controller::current_team(), and team::set_auto_shroud_updates().

◆ write()

void actions::undo::auto_shroud_action::write ( config cfg) const
virtual

Writes this into the provided config.

Reimplemented from actions::undo_action.

Definition at line 27 of file undo_update_shroud_action.cpp.

References active, and actions::undo_action::write().

Member Data Documentation

◆ active

bool actions::undo::auto_shroud_action::active

Definition at line 22 of file undo_update_shroud_action.hpp.

Referenced by undo(), and write().


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