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

#include <action_unit.hpp>

Inheritance diagram for editor::editor_action_unit_facing:

Public Member Functions

 editor_action_unit_facing (map_location loc, map_location::DIRECTION new_direction, map_location::DIRECTION old_direction)
 
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

map_location::DIRECTION new_direction_
 
map_location::DIRECTION old_direction_
 
- 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

Definition at line 90 of file action_unit.hpp.

Constructor & Destructor Documentation

◆ editor_action_unit_facing()

editor::editor_action_unit_facing::editor_action_unit_facing ( map_location  loc,
map_location::DIRECTION  new_direction,
map_location::DIRECTION  old_direction 
)
inline

Member Function Documentation

◆ clone()

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

Action cloning.

Implements editor::editor_action.

◆ get_name()

const std::string& editor::editor_action_unit_facing::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_unit_facing::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 110 of file action_unit.cpp.

References editor::editor_action_location::loc_, and editor::editor_action_unit::perform_without_undo().

◆ perform_without_undo()

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

Perform the action without creating an undo action.

Implements editor::editor_action.

Definition at line 117 of file action_unit.cpp.

References unit_map::end(), unit_map::find(), editor::editor_action_location::loc_, and editor::map_context::units().

Member Data Documentation

◆ new_direction_

map_location::DIRECTION editor::editor_action_unit_facing::new_direction_
protected

Definition at line 107 of file action_unit.hpp.

◆ old_direction_

map_location::DIRECTION editor::editor_action_unit_facing::old_direction_
protected

Definition at line 108 of file action_unit.hpp.


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