The Battle for Wesnoth  1.19.0-dev
advancement.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2016 - 2024
3  Part of the Battle for Wesnoth Project https://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  * Various functions that implement advancements of units.
18  */
19 
20 #pragma once
21 
22 class unit;
23 class config;
24 
25 #include "map/location.hpp"
26 #include "units/ptr.hpp"
27 #include "utils/variant.hpp"
28 
29 #include <string>
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 */
39 {
40  advance_unit_params(const map_location& loc) : loc_(loc), force_dialog_(false), fire_events_(true), animate_(true) {}
41  advance_unit_params& force_dialog(bool value) {force_dialog_ = value; return *this;}
42  advance_unit_params& fire_events(bool value) {fire_events_ = value; return *this;}
43  advance_unit_params& animate(bool value) {animate_ = value; return *this;}
44  friend void advance_unit_at(const advance_unit_params&);
45 private:
49  bool animate_;
50 };
51 void advance_unit_at(const advance_unit_params& params);
52 /**
53  * Returns the advanced version of a unit (with traits and items retained).
54  */
55 unit_ptr get_advanced_unit(const unit &u, const std::string &advance_to);
56 
57 /**
58  * Returns the AMLA-advanced version of a unit (with traits and items retained).
59  */
60 unit_ptr get_amla_unit(const unit &u, const config &mod_option);
61 
62 using advancement_option = utils::variant<std::string /*change type*/, const config* /*apply amla*/>;
63 
64 /**
65  * Function which will advance the unit at @a loc to 'advance_to'.
66  * which is eigher a type to advance to or a config containing the
67  * [advancement] to perform an amla.
68  * Note that 'loc' is not a reference, because if it were a reference,
69  * we couldn't safely pass in a reference to the item in the map
70  * that we're going to delete, since deletion would invalidate the reference.
71  */
72 void advance_unit(map_location loc, const advancement_option &advance_to, bool fire_event = true);
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'.
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).
utils::variant< std::string, const config * > advancement_option
Definition: advancement.hpp:62
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).
void advance_unit_at(const advance_unit_params &params)
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:159
This class represents a single unit of a specific type.
Definition: unit.hpp:133
bool fire_event(const ui_event event, const std::vector< std::pair< widget *, ui_event >> &event_chain, widget *dispatcher, widget *w, F &&... params)
Helper function for fire_event.
std::shared_ptr< unit > unit_ptr
Definition: ptr.hpp:26
advances the unit at loc if it has enough experience, maximum 20 times.
Definition: advancement.hpp:39
advance_unit_params & animate(bool value)
Definition: advancement.hpp:43
advance_unit_params & fire_events(bool value)
Definition: advancement.hpp:42
map_location loc_
Definition: advancement.hpp:46
advance_unit_params & force_dialog(bool value)
Definition: advancement.hpp:41
friend void advance_unit_at(const advance_unit_params &)
advance_unit_params(const map_location &loc)
Definition: advancement.hpp:40
Encapsulates the map of the game.
Definition: location.hpp:38
MacOS doesn't support std::visit when targing MacOS < 10.14 (currently we target 10....