The Battle for Wesnoth  1.13.10+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
advancement.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2016 - 2017 by the Battle for Wesnoth Project http://www.wesnoth.org/
3 
4  This program is free software; you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation; either version 2 of the License, or
7  (at your option) any later version.
8  This program is distributed in the hope that it will be useful,
9  but WITHOUT ANY WARRANTY.
10 
11  See the COPYING file for more details.
12 */
13 
14 /**
15  * @file
16  * Various functions that implement advancements of units.
17  */
18 
19 #pragma once
20 
21 struct map_location;
22 class team;
23 class unit;
24 class config;
25 #include "units/types.hpp"
27 
28 #include <string>
29 #include <vector>
30 
31 /**
32  advances the unit at loc if it has enough experience, maximum 20 times.
33  if the unit is on the currently active side, and that side is controlled by a human, a dialog pops up.
34  if we are in a non mp game, and the side is controlled by a human then a dialog is shown too.
35  if the side is controlled by an ai, and if ai_advancement is passed, then ai_advancement will be used.
36  otherwise a random decision will be taken.
37 
38  this method is currently not used by unstore_unit, if we want to do that we'd need to allow more arguments (animate, fire_events).
39 */
41 {
42  advance_unit_params(const map_location& loc) : loc_(loc), ai_advancements_(nullptr), force_dialog_(false), fire_events_(true), animate_(true) {}
44  advance_unit_params& force_dialog(bool value) {force_dialog_ = value; return *this;}
45  advance_unit_params& fire_events(bool value) {fire_events_ = value; return *this;}
46  advance_unit_params& animate(bool value) {animate_ = value; return *this;}
47  friend void advance_unit_at(const advance_unit_params&);
48 private:
53  bool animate_;
54 };
55 void advance_unit_at(const advance_unit_params& params);
56 /**
57  * Returns the advanced version of a unit (with traits and items retained).
58  */
59 unit_ptr get_advanced_unit(const unit &u, const std::string &advance_to);
60 
61 /**
62  * Returns the AMLA-advanced version of a unit (with traits and items retained).
63  */
64 unit_ptr get_amla_unit(const unit &u, const config &mod_option);
65 
66 using advancement_option = boost::variant<std::string /*change type*/, const config* /*apply amla*/>;
67 
68 /**
69  * Function which will advance the unit at @a loc to 'advance_to'.
70  * which is eigher a type to advance to or a config containing the
71  * [advancement] to perform an amla.
72  * Note that 'loc' is not a reference, because if it were a reference,
73  * we couldn't safely pass in a reference to the item in the map
74  * that we're going to delete, since deletion would invalidate the reference.
75  */
76 void advance_unit(map_location loc, const advancement_option &advance_to, bool fire_event = true);
bool fire_event(const ui_event event, std::vector< std::pair< widget *, ui_event >> &event_chain, widget *dispatcher, widget *w, F &&...params)
Helper function for fire_event.
std::vector< char_t > string
const ai::unit_advancements_aspect * ai_advancements_
Definition: advancement.hpp:50
This class represents a single unit of a specific type.
Definition: unit.hpp:101
void advance_unit(map_location loc, const advancement_option &advance_to, bool fire_event=true)
Function which will advance the unit at loc to 'advance_to'.
friend void advance_unit_at(const advance_unit_params &)
advance_unit_params & force_dialog(bool value)
Definition: advancement.hpp:44
void advance_unit_at(const advance_unit_params &params)
advance_unit_params & fire_events(bool value)
Definition: advancement.hpp:45
map_location loc_
Definition: advancement.hpp:49
advance_unit_params & animate(bool value)
Definition: advancement.hpp:46
boost::variant< std::string, const config * > advancement_option
Definition: advancement.hpp:66
This class stores all the data for a single 'side' (in game nomenclature).
Definition: team.hpp:44
advance_unit_params & ai_advancements(const ai::unit_advancements_aspect &value)
Definition: advancement.hpp:43
unit_ptr get_advanced_unit(const unit &u, const std::string &advance_to)
Returns the advanced version of a unit (with traits and items retained).
advances the unit at loc if it has enough experience, maximum 20 times.
Definition: advancement.hpp:40
Encapsulates the map of the game.
Definition: location.hpp:40
advance_unit_params(const map_location &loc)
Definition: advancement.hpp:42
boost::intrusive_ptr< unit > unit_ptr
Definition: ptr.hpp:29
unit_ptr get_amla_unit(const unit &u, const config &mod_option)
Returns the AMLA-advanced version of a unit (with traits and items retained).
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:93