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

Paste a map fragment into the map. More...

#include <action.hpp>

Inheritance diagram for editor::editor_action_paste:

Public Member Functions

 editor_action_paste (const map_fragment &paste, const map_location &offset=map_location::ZERO())
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...
void extend (const editor_map &map, const std::set< map_location > &locs) override
 The crux of the extendable contract. More...
const std::string & get_name () const override
- Public Member Functions inherited from editor::editor_action_extendable
 editor_action_extendable ()
- 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 offset_
map_fragment paste_

Additional Inherited Members

- Static Public Member Functions inherited from editor::editor_action
static int get_instance_count ()
 Debugging aid. More...

Detailed Description

Paste a map fragment into the map.

No offset is used.

Definition at line 242 of file action.hpp.

Constructor & Destructor Documentation

◆ editor_action_paste()

editor::editor_action_paste::editor_action_paste ( const map_fragment paste,
const map_location offset = map_location::ZERO() 

Member Function Documentation

◆ clone()

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

Action cloning.

Implements editor::editor_action.

◆ extend()

void editor::editor_action_paste::extend ( const editor_map map,
const std::set< map_location > &  locs 

The crux of the extendable contract.

This member function must be implemented so that the undo behavior is consistent, exactly the same as would be with separate undo actions for every part of the drag.

Implements editor::editor_action_extendable.

Definition at line 181 of file action.cpp.

◆ get_name()

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

Reimplemented from editor::editor_action_extendable.

◆ perform()

std::unique_ptr< editor_action > editor::editor_action_paste::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 186 of file action.cpp.

References editor::map_context::map(), and editor::editor_action_chain::perform_without_undo().

◆ perform_without_undo()

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

Perform the action without creating an undo action.

Implements editor::editor_action.

Definition at line 195 of file action.cpp.

References editor::map_context::add_changed_location(), IMPLEMENT_ACTION, editor::map_context::map(), and editor::map_context::set_needs_terrain_rebuild().

Member Data Documentation

◆ offset_

map_location editor::editor_action_paste::offset_

Definition at line 258 of file action.hpp.

◆ paste_

map_fragment editor::editor_action_paste::paste_

Definition at line 259 of file action.hpp.

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