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

#include <action_item.hpp>

Inheritance diagram for editor::editor_action_item_move_all:

Public Member Functions

 editor_action_item_move_all (int x_offset, int y_offset)
 
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
 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

int x_offset_
 
int y_offset_
 

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 97 of file action_item.hpp.

Constructor & Destructor Documentation

◆ editor_action_item_move_all()

editor::editor_action_item_move_all::editor_action_item_move_all ( int  x_offset,
int  y_offset 
)
inline

Definition at line 100 of file action_item.hpp.

Member Function Documentation

◆ clone()

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

Action cloning.

Implements editor::editor_action.

◆ get_name()

const std::string& editor::editor_action_item_move_all::get_name ( ) const
overridevirtual
Returns
a short name of this action type, defaults to unknown

Reimplemented from editor::editor_action.

◆ perform()

std::unique_ptr< editor_action > editor::editor_action_item_move_all::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 108 of file action_item.cpp.

◆ perform_without_undo()

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

Perform the action without creating an undo action.

Implements editor::editor_action.

Definition at line 115 of file action_item.cpp.

References editor::map_context::get_overlays(), editor::map_context::set_overlays(), map_location::x, x_offset_, and y_offset_.

Member Data Documentation

◆ x_offset_

int editor::editor_action_item_move_all::x_offset_
protected

Definition at line 112 of file action_item.hpp.

Referenced by perform_without_undo().

◆ y_offset_

int editor::editor_action_item_move_all::y_offset_
protected

Definition at line 112 of file action_item.hpp.

Referenced by perform_without_undo().


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