Set label action. More...

#include <action_label.hpp>

Inheritance diagram for editor::editor_action_label:

Public Member Functions
	editor_action_label (map_location loc, const std::string &text, const std::string &team_name, color_t color, bool visible_fog, bool visible_shroud, bool immutable, std::string category)

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
const std::string	text_

const std::string	team_name_

const std::string	category_

color_t	color_

bool	visible_fog_

bool	visible_shroud_

bool	immutable_

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 label action.

Definition at line 37 of file action_label.hpp.

Constructor & Destructor Documentation

◆ editor_action_label()

editor::editor_action_label::editor_action_label	(	map_location	loc,
		const std::string &	text,
		const std::string &	team_name,
		color_t	color,
		bool	visible_fog,
		bool	visible_shroud,
		bool	immutable,
		std::string	category
	)

inline

Definition at line 40 of file action_label.hpp.

Member Function Documentation

◆ clone()

std::unique_ptr<editor_action> editor::editor_action_label::clone ( ) const

overridevirtual

Action cloning.

Implements editor::editor_action.

◆ get_name()

const std::string& editor::editor_action_label::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_label::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 30 of file action_label.cpp.

References terrain_label::category(), terrain_label::color(), terrain_label::immutable(), terrain_label::team_name(), terrain_label::text(), terrain_label::visible_in_fog(), and terrain_label::visible_in_shroud().