The Battle for Wesnoth  1.15.7+dev
Public Member Functions | Protected Attributes | List of all members
editor::editor_action_starting_position Class Reference

Set starting position action, sets location ids (both for starting locations and for non-starting locations). More...

#include <action.hpp>

Inheritance diagram for editor::editor_action_starting_position:
Inheritance graph

Public Member Functions

 editor_action_starting_position (map_location loc, std::string loc_id)
 
std::unique_ptr< editor_actionclone () const override
 Action cloning. More...
 
std::unique_ptr< editor_actionperform (map_context &mc) const override
 Perform the action, returning an undo action that, when performed, shall reverse any effects of this action. More...
 
void perform_without_undo (map_context &mc) 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_location
 editor_action_location (map_location loc)
 
- Public Member Functions inherited from editor::editor_action
 editor_action ()
 
virtual ~editor_action ()
 
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

std::string loc_id_
 
- Protected Attributes inherited from editor::editor_action_location
map_location loc_
 

Additional Inherited Members

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

Detailed Description

Set starting position action, sets location ids (both for starting locations and for non-starting locations).

Definition at line 311 of file action.hpp.

Constructor & Destructor Documentation

◆ editor_action_starting_position()

editor::editor_action_starting_position::editor_action_starting_position ( map_location  loc,
std::string  loc_id 
)
inline

Member Function Documentation

◆ clone()

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

Action cloning.

Implements editor::editor_action.

◆ get_name()

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

Reimplemented from editor::editor_action_location.

◆ perform()

std::unique_ptr< editor_action > editor::editor_action_starting_position::perform ( map_context mc) const
overridevirtual

Perform the action, returning an undo action that, when performed, shall reverse any effects of this action.

The undo action object is owned by the caller. Default behavior is to create a whole-map undo, call the perform_without_undo function and return the undo object.

Reimplemented from editor::editor_action.

Definition at line 240 of file action.cpp.

References loc_, LOG_ED, and mariadb::value::string.

◆ perform_without_undo()

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

Member Data Documentation

◆ loc_id_

std::string editor::editor_action_starting_position::loc_id_
protected

Definition at line 326 of file action.hpp.


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