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

place a new item on the map More...

#include <action_item.hpp>

Inheritance diagram for editor::editor_action_item:
Inheritance graph

Public Member Functions

 editor_action_item (map_location loc, const overlay &item)
 
editor_action_itemclone () 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...
 

Protected Attributes

overlay item_
 
- 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

place a new item on the map

Definition at line 39 of file action_item.hpp.

Constructor & Destructor Documentation

◆ editor_action_item()

editor::editor_action_item::editor_action_item ( map_location  loc,
const overlay item 
)
inline

Definition at line 42 of file action_item.hpp.

References clone(), get_name(), perform(), and perform_without_undo().

Member Function Documentation

◆ clone()

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

◆ get_name()

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

◆ perform()

editor_action * editor::editor_action_item::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 31 of file action_item.cpp.

References loc_.

Referenced by editor_action_item(), editor::editor_action_item_delete::editor_action_item_delete(), editor::editor_action_item_facing::editor_action_item_facing(), and editor::editor_action_item_replace::editor_action_item_replace().

◆ perform_without_undo()

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

Member Data Documentation

◆ item_

overlay editor::editor_action_item::item_
protected

Definition at line 59 of file action_item.hpp.


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