The Battle for Wesnoth  1.15.0+dev
Public Member Functions | List of all members
editor::editor_action_unit_delete Class Reference

Remove a unit from the map. More...

#include <action_unit.hpp>

Inheritance diagram for editor::editor_action_unit_delete:
Inheritance graph

Public Member Functions

 editor_action_unit_delete (map_location loc)
 
editor_action_unit_deleteclone () const
 Inherited from editor_action, implemented by IMPLEMENT_ACTION. More...
 
editor_actionperform (map_context &mc) const
 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
 Perform the action without creating an undo action. More...
 
const std::string & get_name () const
 Inherited from editor_action, implemented by IMPLEMENT_ACTION. More...
 
- 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from editor::editor_action
static int get_instance_count ()
 Debugging aid. More...
 
- Protected Attributes inherited from editor::editor_action_location
map_location loc_
 

Detailed Description

Remove a unit from the map.

Definition at line 63 of file action_unit.hpp.

Constructor & Destructor Documentation

◆ editor_action_unit_delete()

editor::editor_action_unit_delete::editor_action_unit_delete ( map_location  loc)
inline

Member Function Documentation

◆ clone()

editor_action_unit_delete* editor::editor_action_unit_delete::clone ( ) const
virtual

Inherited from editor_action, implemented by IMPLEMENT_ACTION.

Implements editor::editor_action.

◆ get_name()

const std::string& editor::editor_action_unit_delete::get_name ( ) const
virtual

Inherited from editor_action, implemented by IMPLEMENT_ACTION.

Reimplemented from editor::editor_action_location.

◆ perform()

editor_action * editor::editor_action_unit_delete::perform ( map_context mc) const
virtual

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 50 of file action_unit.cpp.

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

◆ perform_without_undo()

void editor::editor_action_unit_delete::perform_without_undo ( map_context ) const
virtual

Perform the action without creating an undo action.

Implements editor::editor_action.

Definition at line 65 of file action_unit.cpp.

References editor::map_context::add_changed_location(), unit_map::erase(), ERR_ED, IMPLEMENT_ACTION, editor::editor_action_location::loc_, and editor::map_context::units().


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