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

Sets the ownership of a village to the current side. More...

#include <action_village.hpp>

Inheritance diagram for editor::editor_action_village:

Public Member Functions

 editor_action_village (map_location loc, int side_number)
 
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...
 

Private Attributes

int side_number_
 

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_location
map_location loc_
 

Detailed Description

Sets the ownership of a village to the current side.

Definition at line 36 of file action_village.hpp.

Constructor & Destructor Documentation

◆ editor_action_village()

editor::editor_action_village::editor_action_village ( map_location  loc,
int  side_number 
)
inline

Definition at line 39 of file action_village.hpp.

Member Function Documentation

◆ clone()

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

Action cloning.

Implements editor::editor_action.

◆ get_name()

const std::string& editor::editor_action_village::get_name ( ) const
overridevirtual
Returns
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_village::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 31 of file action_village.cpp.

References loc_, and t.

◆ perform_without_undo()

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

Perform the action without creating an undo action.

Implements editor::editor_action.

Definition at line 59 of file action_village.cpp.

References editor::editor_action_location::loc_, side_number_, t, and editor::map_context::teams().

Member Data Documentation

◆ side_number_

int editor::editor_action_village::side_number_
private

Definition at line 51 of file action_village.hpp.

Referenced by perform_without_undo().


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