The Battle for Wesnoth  1.13.10+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
action_village.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2008 - 2017 by Fabian Mueller <fabianmueller5@gmx.de>
3  Part of the Battle for Wesnoth Project http://www.wesnoth.org/
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation; either version 2 of the License, or
8  (at your option) any later version.
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY.
11 
12  See the COPYING file for more details.
13 */
14 
15 /**
16  * @file
17  * Editor action classes. Some important points:
18  * - This is a polymorphic hierarchy of classes, so actions are usually passed around
19  * as editor_action pointers
20  * - The pointers can, in general, be null. Always check for null before doing anything.
21  * The helper functions perform_ that take a pointer do that.
22  * - The perform() functions can throw when an error occurs. Use smart pointers if you
23  * need to ensure the pointer is deleted.
24  */
25 
26 #pragma once
27 
28 #include "editor/action/action.hpp"
29 
30 namespace editor
31 {
32 /**
33  * Sets the ownership of a village to the current side.
34  */
36 {
37 public:
40  , side_number_(side_number)
41  {
42  }
43 
44  /** Inherited from editor_action, implemented by IMPLEMENT_ACTION. */
46 
47  editor_action* perform(map_context& mc) const;
48 
49  void perform_without_undo(map_context& mc) const;
50 
51  /** Inherited from editor_action, implemented by IMPLEMENT_ACTION. */
52  const std::string& get_name() const;
53 
54 private:
56 };
57 
58 /**
59  * Clears the ownership of a village.
60  */
62 {
63 public:
66  {
67  }
68 
69  /** Inherited from editor_action, implemented by IMPLEMENT_ACTION. */
71 
72  editor_action* perform(map_context& mc) const;
73 
74  void perform_without_undo(map_context& mc) const;
75 
76  /** Inherited from editor_action, implemented by IMPLEMENT_ACTION. */
77  const std::string& get_name() const;
78 };
79 
80 } // end namespace editor
editor_action_village_delete(map_location loc)
std::vector< char_t > string
Base class for actions which act on a specified location (and possibly on other locations that can be...
Definition: action.hpp:189
const std::string & get_name() const
Inherited from editor_action, implemented by IMPLEMENT_ACTION.
const std::string & get_name() const
Inherited from editor_action, implemented by IMPLEMENT_ACTION.
Sets the ownership of a village to the current side.
void perform_without_undo(map_context &mc) const
Perform the action without creating an undo action.
editor_action * perform(map_context &mc) const
Perform the action, returning an undo action that, when performed, shall reverse any effects of this ...
editor_action * perform(map_context &mc) const
Perform the action, returning an undo action that, when performed, shall reverse any effects of this ...
Editor action classes.
Manage the empty-palette in the editor.
Definition: action.cpp:29
editor_action_village_delete * clone() const
Inherited from editor_action, implemented by IMPLEMENT_ACTION.
Encapsulates the map of the game.
Definition: location.hpp:40
editor_action_village * clone() const
Inherited from editor_action, implemented by IMPLEMENT_ACTION.
Base class for all editor actions.
Definition: action_base.hpp:40
This class wraps around a map to provide a concise interface for the editor to work with...
Definition: map_context.hpp:55
void perform_without_undo(map_context &mc) const
Perform the action without creating an undo action.
editor_action_village(map_location loc, int side_number)
int side_number
Definition: game_info.hpp:42
Clears the ownership of a village.