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

Randomize terrain in an area. More...

#include <action.hpp>

Inheritance diagram for editor::editor_action_shuffle_area:

Public Member Functions

 editor_action_shuffle_area (const std::set< map_location > &area)
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_area
 editor_action_area (const std::set< map_location > &area)
void extend (const editor_map &map, const std::set< map_location > &locs) override
 The crux of the extendable contract. More...
- 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...

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_area
std::set< map_locationarea_

Detailed Description

Randomize terrain in an area.

Definition at line 398 of file action.hpp.

Constructor & Destructor Documentation

◆ editor_action_shuffle_area()

editor::editor_action_shuffle_area::editor_action_shuffle_area ( const std::set< map_location > &  area)

Definition at line 401 of file action.hpp.

Member Function Documentation

◆ clone()

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

Action cloning.

Implements editor::editor_action.

◆ get_name()

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

Reimplemented from editor::editor_action_area.

◆ perform()

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

◆ perform_without_undo()

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

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