The Battle for Wesnoth  1.19.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:

Public Member Functions

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

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

remove commented-out code (no separate ticket, but editor cleanup is on the roadmap for 1.15.11) action_item.cpp is full of commented-out code, it seems to be deadweight with the real implementation to be found in mouse_action_item.cpp.

Definition at line 44 of file action_item.hpp.

Constructor & Destructor Documentation

◆ editor_action_item()

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

Definition at line 47 of file action_item.hpp.

Member Function Documentation

◆ clone()

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

Action cloning.

Implements editor::editor_action.

◆ get_name()

const std::string& editor::editor_action_item::get_name ( ) const
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_item::perform ( map_context mc) const

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_.

◆ perform_without_undo()

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

Perform the action without creating an undo action.

Implements editor::editor_action.

Definition at line 38 of file action_item.cpp.

Member Data Documentation

◆ item_

overlay editor::editor_action_item::item_

Definition at line 59 of file action_item.hpp.

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