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:

Public Member Functions
	editor_action_starting_position (map_location loc, std::string loc_id)
std::unique_ptr< editor_action >	clone () const override
	Action cloning. More...
std::unique_ptr< editor_action >	perform (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 312 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

Definition at line 315 of file action.hpp.

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 241 of file action.cpp.

References loc_, and LOG_ED.

perform_without_undo()

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

overridevirtual

Perform the action without creating an undo action.

Implements editor::editor_action.

Definition at line 273 of file action.cpp.

References gamemap_base::is_special_location(), editor::editor_action_location::loc_, loc_id_, editor::map_context::map(), editor::map_context::set_needs_labels_reset(), and gamemap_base::set_special_location().

Member Data Documentation

loc_id_

std::string editor::editor_action_starting_position::loc_id_

protected

Definition at line 327 of file action.hpp.

Referenced by perform_without_undo().

---

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

• editor/action/action.hpp
• editor/action/action.cpp