The Battle for Wesnoth  1.19.0-dev
Public Member Functions | Protected Attributes | List of all members
editor::editor_action_whole_map Class Reference

Replace contents of the entire map, Useful as a fallback undo method when something else would be impractical. More...

#include <action.hpp>

Inheritance diagram for editor::editor_action_whole_map:

Public Member Functions

 editor_action_whole_map (const editor_map &m)
 
std::unique_ptr< editor_actionclone () const override
 Action cloning. More...
 
void perform_without_undo (map_context &m) const override
 Perform the action without creating an undo action. More...
 
const std::string & get_name () const override
 
- Public Member Functions inherited from editor::editor_action
 editor_action ()
 
virtual ~editor_action ()
 
virtual std::unique_ptr< editor_actionperform (map_context &) const
 Perform the action, returning an undo action that, when performed, shall reverse any effects of this action. More...
 
virtual int action_count () const
 
virtual std::string get_description () const
 A textual description of the action. More...
 
int get_id () const
 Debugging aid. More...
 

Protected Attributes

editor_map m_
 

Additional Inherited Members

- Static Public Member Functions inherited from editor::editor_action
static int get_instance_count ()
 Debugging aid. More...
 

Detailed Description

Replace contents of the entire map, Useful as a fallback undo method when something else would be impractical.

Definition at line 38 of file action.hpp.

Constructor & Destructor Documentation

◆ editor_action_whole_map()

editor::editor_action_whole_map::editor_action_whole_map ( const editor_map m)
inline

Definition at line 41 of file action.hpp.

Member Function Documentation

◆ clone()

std::unique_ptr<editor_action> editor::editor_action_whole_map::clone ( ) const
overridevirtual

Action cloning.

Implements editor::editor_action.

◆ get_name()

const std::string& editor::editor_action_whole_map::get_name ( ) const
overridevirtual
Returns
a short name of this action type, defaults to unknown

Reimplemented from editor::editor_action.

◆ perform_without_undo()

void editor::editor_action_whole_map::perform_without_undo ( map_context ) const
overridevirtual

Perform the action without creating an undo action.

Implements editor::editor_action.

Definition at line 73 of file action.cpp.

Member Data Documentation

◆ m_

editor_map editor::editor_action_whole_map::m_
protected

Definition at line 51 of file action.hpp.


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