The Battle for Wesnoth  1.17.10+dev
types.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2003 - 2022
3  by David White <dave@whitevine.net>
4  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
5 
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY.
12 
13  See the COPYING file for more details.
14 */
15 
16 #pragma once
17 
18 #include "gettext.hpp"
19 #include "map/location.hpp"
20 #include "movetype.hpp"
22 #include "units/race.hpp"
23 #include "units/attack_type.hpp"
24 #include "units/type_error.hpp"
25 #include "game_config_view.hpp"
26 
27 #include <memory>
28 #include <array>
29 #include <map>
30 #include <set>
31 #include <string>
32 #include <vector>
33 
34 class unit_ability_list;
35 class unit_animation;
37 
38 typedef std::map<std::string, movetype> movement_type_map;
39 
40 
41 /**
42  * A single unit type that the player may recruit.
43  * Individual units are defined by the unit class.
44  */
45 class unit_type
46 {
47 private:
48  struct defaut_ctor_t {};
49  unit_type(defaut_ctor_t, const config& cfg, const std::string & parent_id);
50 
51 public:
53  /**
54  * Creates a unit type for the given config, but delays its build
55  * till later.
56  * @note @a cfg is not copied, so it has to point to some permanent
57  * storage, that is, a child of unit_type_data::unit_cfg.
58  */
59  explicit unit_type(const config &cfg, const std::string & parent_id="");
60  /**
61  * Creates a unit type for the given config, but delays its build
62  * till later.
63  * @note @a cfg is copied
64  */
65  explicit unit_type(config && cfg, const std::string & parent_id="");
66  unit_type();
67  unit_type(const unit_type& o);
68  unit_type(unit_type&& o) = default;
69 
70  ~unit_type();
71 
72  /**
73  * Records the status of the lazy building of unit types.
74  * These are in order of increasing levels of being built.
75  * HELP_INDEX is already defined in a windows header under some conditions
76  */
78 
79  /**
80  * Validate the id argument.
81  * Replaces invalid characters in the reference with underscores.
82  * @param id The proposed id for a unit_type.
83  * @throw error if id starts with a space.
84  */
85  static void check_id(std::string& id);
86 
87 private: // These will be called by build().
88  /** Load data into an empty unit_type (build to FULL). */
89  void build_full(const movement_type_map &movement_types,
90  const race_map &races, const config_array_view &traits);
91  /** Partially load data into an empty unit_type (build to HELP_INDEXED). */
92  void build_help_index(const movement_type_map &movement_types,
93  const race_map &races, const config_array_view &traits);
94  /** Load the most needed data into an empty unit_type (build to CREATE). */
95  void build_created();
96 
97  typedef std::map<std::string,unit_type> variations_map;
98 public:
99  /** Performs a build of this to the indicated stage. */
100  void build(BUILD_STATUS status, const movement_type_map &movement_types,
101  const race_map &races, const config_array_view &traits);
102  /**
103  * Performs a build of this to the indicated stage.
104  * (This does not logically change the unit type, so allow const access.)
105  */
106  void build(BUILD_STATUS status, const movement_type_map &movement_types,
107  const race_map &races, const config_array_view &traits) const
108  { const_cast<unit_type *>(this)->build(status, movement_types, races, traits); }
109 
110 
111  /** Get the advancement tree
112  * @return A set of ids of all unit_type objects that this unit_type can
113  * directly or indirectly advance to.
114  */
115  std::set<std::string> advancement_tree() const;
116 
117  /** A vector of unit_type ids that this unit_type can advance to. */
118  const std::vector<std::string>& advances_to() const { return advances_to_; }
119  /** A vector of unit_type ids that can advance to this unit_type. */
120  const std::vector<std::string> advances_from() const;
121 
122  /** Returns two iterators pointing to a range of AMLA configs. */
124  { return get_cfg().child_range("advancement"); }
125 
126  /**
127  * Returns a gendered variant of this unit_type.
128  * @param gender "male" or "female".
129  */
130  const unit_type& get_gender_unit_type(std::string gender) const;
131  /** Returns a gendered variant of this unit_type based on the given parameter. */
132  const unit_type& get_gender_unit_type(unit_race::GENDER gender) const;
133 
134  const unit_type& get_variation(const std::string& id) const;
135  /** Info on the type of unit that the unit reanimates as. */
136  const std::string& undead_variation() const { return undead_variation_; }
137 
138  unsigned int num_traits() const { return num_traits_; }
139 
140  /** The name of the unit in the current language setting. */
141  const t_string& type_name() const { return type_name_; }
142 
143  /** The id for this unit_type. */
144  const std::string& id() const { return id_; }
145  /** A variant on id() that is more descriptive, for use with message logging. */
146  const std::string log_id() const { return id_ + debug_id_; }
147  /** The id of the original type from which this (variation) descended. */
148  const std::string& parent_id() const { return parent_id_; }
149  /** The id of this variation; empty if it's a gender variation or a base unit. */
150  const std::string& variation_id() const { return variation_id_; }
151  // NOTE: this used to be a const object reference, but it messed up with the
152  // translation engine upon changing the language in the same session.
153  t_string unit_description() const;
154  /**
155  * Returns only the notes defined by [unit_type][special_note] tags, excluding
156  * any that would be found from abilities, attacks, etc.
157  */
158  std::vector<t_string> direct_special_notes() const { return special_notes_; }
159  /**
160  * Returns all notes that should be displayed in the help page for this type,
161  * including those found in abilities and attacks.
162  */
163  std::vector<t_string> special_notes() const;
164  int hitpoints() const { return hitpoints_; }
165  double hp_bar_scaling() const { return hp_bar_scaling_; }
166  double xp_bar_scaling() const { return xp_bar_scaling_; }
167  int level() const { return level_; }
168  int recall_cost() const { return recall_cost_;}
169  int movement() const { return movement_; }
170  int vision() const { return vision_ < 0 ? movement() : vision_; }
171  /** If @a base_value is set to true, do not fall back to movement(). */
172  int vision(bool base_value) const { return base_value ? vision_ : vision(); }
173  int jamming() const {return jamming_; }
174  int max_attacks() const { return max_attacks_; }
175  int cost() const { return cost_; }
176  const std::string& default_variation() const { return default_variation_; }
177  const t_string& variation_name() const { return variation_name_; }
178  const std::string& usage() const { return usage_; }
179  const std::string& image() const { return image_; }
180  const std::string& icon() const { return icon_; }
181  const std::string &small_profile() const { return small_profile_; }
182  const std::string &big_profile() const { return profile_; }
183  std::string halo() const { return get_cfg()["halo"]; }
184  std::string ellipse() const { return get_cfg()["ellipse"]; }
185  bool generate_name() const { return get_cfg()["generate_name"].to_bool(true); }
186  const std::vector<unit_animation>& animations() const;
187 
188  const std::string& flag_rgb() const;
189 
190  const_attack_itors attacks() const;
191  const movetype & movement_type() const { return movement_type_; }
192 
193  int experience_needed(bool with_acceleration=true) const;
194 
197 
199  {
200  explicit ability_metadata(const config& cfg);
201 
202  std::string id;
203 
206 
209 
212 
217  };
218 
219  const std::vector<ability_metadata>& abilities_metadata() const { return abilities_; }
220 
221  /** Some extra abilities that may be gained through AMLA advancements. */
222  const std::vector<ability_metadata>& adv_abilities_metadata() const { return adv_abilities_; }
223 
224  bool can_advance() const { return !advances_to_.empty(); }
225 
226  bool musthave_status(const std::string& status) const;
227 
228  bool has_zoc() const { return zoc_; }
229 
230  bool has_ability_by_id(const std::string& ability) const;
231  std::vector<std::string> get_ability_list() const;
232 
234  { return possible_traits_.child_range("trait"); }
235 
236  const config& abilities_cfg() const
237  { return get_cfg().child_or_empty("abilities"); }
238 
240  { return get_cfg().child_range("advancement"); }
241 
243  { return get_cfg().child_range("event"); }
244 
245  bool has_random_traits() const;
246 
247  /**
248  * The returned vector will not be empty, provided this has been built
249  * to the HELP_INDEXED status.
250  */
251  const std::vector<unit_race::GENDER>& genders() const { return genders_; }
252  bool has_gender_variation(const unit_race::GENDER gender) const
253  {
254  return std::find(genders_.begin(), genders_.end(), gender) != genders_.end();
255  }
256 
257  std::vector<std::string> variations() const;
258  const variations_map& variation_types() const {return variations_; }
259 
260  /**
261  * @param variation_id The id of the variation we search for.
262  * @return Whether one of the type's variations' (or the
263  * siblings' if the unit_type is a variation
264  * itself) id matches @a variation_id.
265  */
266  bool has_variation(const std::string& variation_id) const;
267 
268  /**
269  * Whether the unit type has at least one help-visible variation.
270  */
271  bool show_variations_in_help() const;
272 
273  /** Returns the ID of this type's race without the need to build the type. */
274  std::string race_id() const { return get_cfg()["race"]; } //race_->id(); }
275  /**
276  * Never returns nullptr, but may point to the null race.
277  * Requires building to the HELP_INDEXED status to get the correct race.
278  */
279  const unit_race* race() const { return race_; }
280  bool hide_help() const;
281  bool do_not_list() const { return do_not_list_; }
282 
283  const config &get_cfg() const
284  {
285  if(built_cfg_) {
286  return *built_cfg_;
287  }
288  assert(cfg_);
289  return *cfg_;
290  }
291 
292  /**
293  * Gets resistance while considering custom WML abilities.
294  * Attention: Filters in resistance-abilities will be ignored.
295  */
296  int resistance_against(const std::string& damage_name, bool attacker) const;
297 
298  void apply_scenario_fix(const config& cfg);
299  void remove_scenario_fixes();
300 private:
301 
302  /** Identical to unit::resistance_filter_matches. */
303  bool resistance_filter_matches(const config& cfg,bool attacker,const std::string& damage_name, int res) const;
304 
305 private:
307  if(!built_cfg_) {
308  built_cfg_ = std::make_unique<config>(*cfg_);
309  }
310  return *built_cfg_;
311  }
312  void fill_variations();
314  std::unique_ptr<unit_type> create_sub_type(const config& var_cfg, bool default_inherit);
315 
316  unit_type& operator=(const unit_type& o) = delete;
317 
318  const config* cfg_;
319  friend class unit_type_data;
320  mutable std::unique_ptr<config> built_cfg_;
321  mutable bool has_cfg_build_;
323 
324  std::string id_;
325  /** A suffix for id_, used when logging messages. */
326  std::string debug_id_;
327  /** The id of the top ancestor of this unit_type. */
328  std::string parent_id_;
329  /** from [base_unit] */
330  std::string base_unit_id_;
333  std::vector<t_string> special_notes_;
336  int level_;
339  int vision_;
340  int jamming_;
342  int cost_;
343  std::string usage_;
344  std::string undead_variation_;
345 
346  std::string image_;
347  std::string icon_;
348  std::string small_profile_;
349  std::string profile_;
350  std::string flag_rgb_;
351 
352  unsigned int num_traits_;
353 
354  std::array<std::unique_ptr<unit_type>, 2> gender_types_;
355 
356  variations_map variations_;
357  std::string default_variation_;
358  std::string variation_id_;
360 
361  /** Never nullptr, but may point to the null race. */
362  const unit_race* race_;
363 
364  std::vector<ability_metadata> abilities_, adv_abilities_;
365 
367 
368  std::vector<std::string> advances_to_;
370 
371 
373 
375 
377 
378  std::vector<unit_race::GENDER> genders_;
379 
380  // animations are loaded only after the first animations() call
381  mutable std::vector<unit_animation> animations_;
382 
384 };
385 
387 {
388 public:
389  unit_type_data(const unit_type_data&) = delete;
390  unit_type_data& operator=(const unit_type_data&) = delete;
391 
392  unit_type_data();
393 
394  typedef std::map<std::string,unit_type> unit_type_map;
395 
396  const unit_type_map &types() const { return types_; }
397  const race_map &races() const { return races_; }
398  config_array_view traits() const { return units_cfg().child_range("trait"); }
399  void set_config(const game_config_view &cfg);
400 
401  /** Finds a unit_type by its id() and makes sure it is built to the specified level. */
402  const unit_type *find(const std::string &key, unit_type::BUILD_STATUS status = unit_type::FULL) const;
403  void check_types(const std::vector<std::string>& types) const;
404  const unit_race *find_race(const std::string &) const;
405 
406  /** Makes sure the all unit_types are built to the specified level. */
407  void build_all(unit_type::BUILD_STATUS status);
408  /** Makes sure the provided unit_type is built to the specified level. */
409  void build_unit_type(const unit_type & ut, unit_type::BUILD_STATUS status) const;
410 
411  /** Checks if the [hide_help] tag contains these IDs. */
412  bool hide_help(const std::string &type_id, const std::string &race_id) const;
413 
414  void apply_scenario_fix(const config& cfg);
415  void remove_scenario_fixes();
416 private:
417  /** Parses the [hide_help] tag. */
418  void read_hide_help(const config &cfg);
419 
420  void clear();
421 
422  void apply_base_unit(unit_type& type, std::vector<std::string>& base_tree);
423 
424  mutable unit_type_map types_;
427 
428  /** True if [hide_help] contains a 'all=yes' at its root. */
430  // vectors containing the [hide_help] and its sub-tags [not]
431  std::vector< std::set<std::string>> hide_help_type_;
432  std::vector< std::set<std::string>> hide_help_race_;
433 
434  const game_config_view& units_cfg() const { return units_cfg_; }
437 };
438 
440 
441 void adjust_profile(std::string& profile);
442 
444  unit_experience_accelerator(int modifier);
446  static int get_acceleration();
447 private:
449 };
450 
451 /**
452  * Common logic for unit_type::special_notes() and unit::special_notes(). Adds
453  * any notes from the sources given as arguments, and filters out duplicates.
454  *
455  * @return the special notes for a unit or unit_type.
456  */
457 std::vector<t_string> combine_special_notes(const std::vector<t_string> direct, const config& abilities, const_attack_itors attacks, const movetype& mt);
int jamming_
Definition: types.hpp:340
std::vector< attack_ptr > attack_list
std::string parent_id_
The id of the top ancestor of this unit_type.
Definition: types.hpp:328
int experience_needed_
Definition: types.hpp:369
const std::string & parent_id() const
The id of the original type from which this (variation) descended.
Definition: types.hpp:148
bool has_cfg_build_
Definition: types.hpp:321
bool do_not_list_
Definition: types.hpp:366
unit_type::BUILD_STATUS build_status_
Definition: types.hpp:436
std::map< std::string, unit_type > unit_type_map
Definition: types.hpp:394
int vision(bool base_value) const
If base_value is set to true, do not fall back to movement().
Definition: types.hpp:172
std::string default_variation_
Definition: types.hpp:357
std::string flag_rgb_
Definition: types.hpp:350
bool generate_name() const
Definition: types.hpp:185
t_string variation_name_
Definition: types.hpp:359
std::string profile_
Definition: types.hpp:349
config_array_view traits() const
Definition: types.hpp:398
void build(BUILD_STATUS status, const movement_type_map &movement_types, const race_map &races, const config_array_view &traits)
Performs a build of this to the indicated stage.
Definition: types.cpp:418
config::const_child_itors events() const
Definition: types.hpp:242
const std::string & big_profile() const
Definition: types.hpp:182
std::string debug_id_
A suffix for id_, used when logging messages.
Definition: types.hpp:326
int hitpoints_
Definition: types.hpp:334
const std::vector< std::string > & advances_to() const
A vector of unit_type ids that this unit_type can advance to.
Definition: types.hpp:118
int recall_cost_
Definition: types.hpp:337
std::string variation_id_
Definition: types.hpp:358
const std::string & flag_rgb() const
Definition: types.cpp:720
~unit_type()
Definition: types.cpp:170
child_itors child_range(config_key_type key)
Definition: config.cpp:344
void adjust_profile(std::string &profile)
Definition: types.cpp:1467
const config * cfg_
Definition: types.hpp:318
void clear(const std::string &key)
Definition: general.cpp:190
t_string description_
Definition: types.hpp:332
void fill_variations()
Processes [variation] tags of ut_cfg, handling inheritance and child clearing.
Definition: types.cpp:1028
int experience_needed(bool with_acceleration=true) const
Definition: types.cpp:577
config possible_traits_
Definition: types.hpp:376
std::array< std::unique_ptr< unit_type >, 2 > gender_types_
Definition: types.hpp:354
void build_help_index(const movement_type_map &movement_types, const race_map &races, const config_array_view &traits)
Partially load data into an empty unit_type (build to HELP_INDEXED).
Definition: types.cpp:235
int resistance_against(const std::string &damage_name, bool attacker) const
Gets resistance while considering custom WML abilities.
Definition: types.cpp:773
const config & get_cfg() const
Definition: types.hpp:283
BUILD_STATUS
Records the status of the lazy building of unit types.
Definition: types.hpp:77
std::set< std::string > advancement_tree() const
Get the advancement tree.
Definition: types.cpp:645
const std::string & variation_id() const
The id of this variation; empty if it&#39;s a gender variation or a base unit.
Definition: types.hpp:150
t_string type_name_
Definition: types.hpp:331
variations_map variations_
Definition: types.hpp:356
const race_map & races() const
Definition: types.hpp:397
The basic "size" of the unit - flying, small land, large land, etc.
Definition: movetype.hpp:44
void build(BUILD_STATUS status, const movement_type_map &movement_types, const race_map &races, const config_array_view &traits) const
Performs a build of this to the indicated stage.
Definition: types.hpp:106
const unit_type_map & types() const
Definition: types.hpp:396
bool do_not_list() const
Definition: types.hpp:281
const std::vector< std::string > advances_from() const
A vector of unit_type ids that can advance to this unit_type.
Definition: types.cpp:652
int level_
Definition: types.hpp:336
A single unit type that the player may recruit.
Definition: types.hpp:45
const unit_race * race_
Never nullptr, but may point to the null race.
Definition: types.hpp:362
config & writable_cfg()
Definition: types.hpp:306
std::vector< t_string > combine_special_notes(const std::vector< t_string > direct, const config &abilities, const_attack_itors attacks, const movetype &mt)
Common logic for unit_type::special_notes() and unit::special_notes().
Definition: types.cpp:507
void build_full(const movement_type_map &movement_types, const race_map &races, const config_array_view &traits)
Load data into an empty unit_type (build to FULL).
Definition: types.cpp:192
std::string icon_
Definition: types.hpp:347
bool musthave_status(const std::string &status) const
Definition: types.cpp:672
const std::vector< unit_race::GENDER > & genders() const
The returned vector will not be empty, provided this has been built to the HELP_INDEXED status...
Definition: types.hpp:251
unit_alignments::type alignment_
Definition: types.hpp:372
int cost() const
Definition: types.hpp:175
void fill_variations_and_gender()
Definition: types.cpp:1057
movement_type_map movement_types_
Definition: types.hpp:425
int vision() const
Definition: types.hpp:170
bool zoc_
Definition: types.hpp:366
bool hide_help() const
Definition: types.cpp:624
const movetype & movement_type() const
Definition: types.hpp:191
unit_alignments::type alignment() const
Definition: types.hpp:195
const std::vector< unit_animation > & animations() const
Definition: types.cpp:534
const t_string & type_name() const
The name of the unit in the current language setting.
Definition: types.hpp:141
std::vector< std::set< std::string > > hide_help_type_
Definition: types.hpp:431
std::vector< std::set< std::string > > hide_help_race_
Definition: types.hpp:432
const std::string & usage() const
Definition: types.hpp:178
std::vector< unit_animation > animations_
Definition: types.hpp:381
std::string small_profile_
Definition: types.hpp:348
std::string ellipse() const
Definition: types.hpp:184
std::unique_ptr< config > built_cfg_
Definition: types.hpp:320
std::string undead_variation_
Definition: types.hpp:344
void remove_scenario_fixes()
Definition: types.cpp:1410
int movement_
Definition: types.hpp:338
movetype movement_type_
Definition: types.hpp:374
const std::vector< ability_metadata > & abilities_metadata() const
Definition: types.hpp:219
std::string race_id() const
Returns the ID of this type&#39;s race without the need to build the type.
Definition: types.hpp:274
const std::string & id() const
The id for this unit_type.
Definition: types.hpp:144
std::map< std::string, movetype > movement_type_map
Definition: types.hpp:36
double xp_bar_scaling_
Definition: types.hpp:335
double xp_bar_scaling() const
Definition: types.hpp:166
boost::iterator_range< const_child_iterator > const_child_itors
Definition: config.hpp:205
int cost_
Definition: types.hpp:342
const std::string & undead_variation() const
Info on the type of unit that the unit reanimates as.
Definition: types.hpp:136
const std::string log_id() const
A variant on id() that is more descriptive, for use with message logging.
Definition: types.hpp:146
const game_config_view & units_cfg() const
Definition: types.hpp:434
config::const_child_itors modification_advancements() const
Returns two iterators pointing to a range of AMLA configs.
Definition: types.hpp:123
std::vector< t_string > special_notes_
Definition: types.hpp:333
bool has_zoc() const
Definition: types.hpp:228
unsigned int num_traits_
Definition: types.hpp:352
int recall_cost() const
Definition: types.hpp:168
game_config_view units_cfg_
Definition: types.hpp:435
std::vector< std::string > variations() const
Definition: types.cpp:745
unit_type_map types_
Definition: types.hpp:424
std::vector< std::string > get_ability_list() const
Definition: types.cpp:604
friend class unit_type_data
Definition: types.hpp:319
void apply_scenario_fix(const config &cfg)
Definition: types.cpp:1358
bool show_variations_in_help() const
Whether the unit type has at least one help-visible variation.
Definition: types.cpp:762
const config & abilities_cfg() const
Definition: types.hpp:236
std::vector< std::string > advances_to_
Definition: types.hpp:368
std::string usage_
Definition: types.hpp:343
std::string halo() const
Definition: types.hpp:183
bool has_ability_by_id(const std::string &ability) const
Definition: types.cpp:591
double hp_bar_scaling_
Definition: types.hpp:335
const std::string & icon() const
Definition: types.hpp:180
bool hide_help_all_
True if [hide_help] contains a &#39;all=yes&#39; at its root.
Definition: types.hpp:429
int level() const
Definition: types.hpp:167
std::string base_unit_id_
from [base_unit]
Definition: types.hpp:330
bool has_gender_variation(const unit_race::GENDER gender) const
Definition: types.hpp:252
const std::string & small_profile() const
Definition: types.hpp:181
int hitpoints() const
Definition: types.hpp:164
int jamming() const
Definition: types.hpp:173
const std::vector< ability_metadata > & adv_abilities_metadata() const
Some extra abilities that may be gained through AMLA advancements.
Definition: types.hpp:222
std::vector< t_string > special_notes() const
Returns all notes that should be displayed in the help page for this type, including those found in a...
Definition: types.cpp:493
int movement() const
Definition: types.hpp:169
std::string id_
Definition: types.hpp:324
static std::string alignment_description(unit_alignments::type align, unit_race::GENDER gender=unit_race::MALE)
Implementation detail of unit_type::alignment_description.
Definition: types.cpp:839
config::const_child_itors possible_traits() const
Definition: types.hpp:233
const std::string & image() const
Definition: types.hpp:179
std::vector< ability_metadata > abilities_
Definition: types.hpp:364
bool resistance_filter_matches(const config &cfg, bool attacker, const std::string &damage_name, int res) const
Identical to unit::resistance_filter_matches.
Definition: types.cpp:804
int vision_
Definition: types.hpp:339
unsigned int num_traits() const
Definition: types.hpp:138
BUILD_STATUS build_status_
Definition: types.hpp:383
const unit_type & get_variation(const std::string &id) const
Definition: types.cpp:474
std::vector< std::reference_wrapper< const config > > config_array_view
int max_attacks_
Definition: types.hpp:341
int max_attacks() const
Definition: types.hpp:174
bool hide_help_
Definition: types.hpp:366
std::vector< ability_metadata > adv_abilities_
Definition: types.hpp:364
const t_string & variation_name() const
Definition: types.hpp:177
const variations_map & variation_types() const
Definition: types.hpp:258
const unit_race * race() const
Never returns nullptr, but may point to the null race.
Definition: types.hpp:279
const unit_type & get_gender_unit_type(std::string gender) const
Returns a gendered variant of this unit_type.
Definition: types.cpp:453
static void check_id(std::string &id)
Validate the id argument.
Definition: types.cpp:1439
double hp_bar_scaling() const
Definition: types.hpp:165
std::vector< t_string > direct_special_notes() const
Returns only the notes defined by [unit_type][special_note] tags, excluding any that would be found f...
Definition: types.hpp:158
unit_type & operator=(const unit_type &o)=delete
unit_type_data unit_types
Definition: types.cpp:1465
std::unique_ptr< unit_type > create_sub_type(const config &var_cfg, bool default_inherit)
Handles inheritance for configs of [male], [female], and [variation].
Definition: types.cpp:1011
const config & child_or_empty(config_key_type key) const
Returns the first child with the given key, or an empty config if there is none.
Definition: config.cpp:465
const_attack_itors attacks() const
Definition: types.cpp:543
std::map< std::string, unit_race > race_map
Definition: race.hpp:95
bool can_advance() const
Definition: types.hpp:224
boost::iterator_range< boost::indirect_iterator< attack_list::const_iterator > > const_attack_itors
t_string unit_description() const
Definition: types.cpp:484
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:60
attack_list attacks_cache_
Definition: types.hpp:322
bool has_random_traits() const
Definition: types.cpp:725
bool has_variation(const std::string &variation_id) const
Definition: types.cpp:757
std::string image_
Definition: types.hpp:346
race_map races_
Definition: types.hpp:426
config::const_child_itors advancements() const
Definition: types.hpp:239
std::vector< unit_race::GENDER > genders_
Definition: types.hpp:378
const std::string & default_variation() const
Definition: types.hpp:176
std::map< std::string, unit_type > variations_map
Definition: types.hpp:97
void build_created()
Load the most needed data into an empty unit_type (build to CREATE).
Definition: types.cpp:375