The Battle for Wesnoth  1.15.1+dev
unit.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2003 - 2018 by David White <dave@whitevine.net>
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 #pragma once
16 
17 #include "units/id.hpp"
18 #include "units/ptr.hpp"
19 #include "units/types.hpp"
20 
21 #include <bitset>
22 #include <boost/dynamic_bitset_fwd.hpp>
23 #include <boost/ptr_container/ptr_vector.hpp>
24 #include <boost/variant.hpp>
25 
26 class display;
27 class team;
30 class vconfig;
31 struct color_t;
32 
33 namespace unit_detail
34 {
35  template<typename T>
36  const T& get_or_default(const std::unique_ptr<T>& v)
37  {
38  if(v) {
39  return *v;
40  } else {
41  static const T def;
42  return def;
43  }
44  }
45 }
46 
47 // Data typedef for unit_ability_list.
48 using unit_ability = std::pair<const config*, map_location>;
49 
51 {
52 public:
53  unit_ability_list(const map_location& loc = map_location()) : cfgs_() , loc_(loc) {}
54 
55  // Implemented in unit_abilities.cpp
56  std::pair<int, map_location> highest(const std::string& key, int def=0) const
57  {
58  return get_extremum(key, def, std::less<int>());
59  }
60  std::pair<int, map_location> lowest(const std::string& key, int def=0) const
61  {
62  return get_extremum(key, def, std::greater<int>());
63  }
64 
65  template<typename TComp>
66  std::pair<int, map_location> get_extremum(const std::string& key, int def, const TComp& comp) const;
67 
68  // The following make this class usable with standard library algorithms and such
70  typedef std::vector<unit_ability>::const_iterator const_iterator;
71 
72  iterator begin() { return cfgs_.begin(); }
73  const_iterator begin() const { return cfgs_.begin(); }
74  iterator end() { return cfgs_.end(); }
75  const_iterator end() const { return cfgs_.end(); }
76 
77  // Vector access
78  bool empty() const { return cfgs_.empty(); }
79  unit_ability& front() { return cfgs_.front(); }
80  const unit_ability& front() const { return cfgs_.front(); }
81  unit_ability& back() { return cfgs_.back(); }
82  const unit_ability& back() const { return cfgs_.back(); }
83 
84  iterator erase(const iterator& erase_it) { return cfgs_.erase(erase_it); }
85 
86  template<typename... T>
87  void emplace_back(T&&... args) { cfgs_.emplace_back(args...); }
88 
89  const map_location& loc() const { return loc_; }
90 private:
91  // Data
92  std::vector<unit_ability> cfgs_;
94 };
95 
96 /**
97  * This class represents a *single* unit of a specific type.
98  */
99 class unit
100 {
101 public:
102  /**
103  * Clear this unit status cache for all units. Currently only the hidden
104  * status of units is cached this way.
105  */
106  static void clear_status_caches();
107 
108  /** The path to the leader crown overlay. */
109  static const std::string& leader_crown();
110 private:
111  void init(const config& cfg, bool use_traits = false, const vconfig* vcfg = nullptr);
112 
113  void init(const unit_type& t, int side, bool real_unit, unit_race::GENDER gender = unit_race::NUM_GENDERS);
114 
115  // Copy constructor
116  unit(const unit& u);
117 
118  unit();
120  {
134  //note that UA_ATTACKS only tracks added/deleted attacks, not modified attacks.
141  UA_COUNT
142  };
144  {
145  changed_attributes_[int(attr)] = true;
146  }
147  bool get_attacks_changed() const;
149  {
150  return changed_attributes_[int(attr)];
151  }
152  void clear_changed_attributes();
153 public:
154  /** Initializes a unit from a config */
155  static unit_ptr create(const config& cfg, bool use_traits = false, const vconfig* vcfg = nullptr)
156  {
157  unit_ptr res(new unit());
158  res->init(cfg, use_traits, vcfg);
159  return res;
160  }
161 
162  /**
163  * Initializes a unit from a unit type.
164  *
165  * Only real_unit-s should have random traits, name and gender (to prevent OOS caused by RNG calls)
166  */
167  static unit_ptr create(const unit_type& t, int side, bool real_unit, unit_race::GENDER gender = unit_race::NUM_GENDERS)
168  {
169  unit_ptr res(new unit());
170  res->init(t, side, real_unit, gender);
171  return res;
172  }
173 
174  unit_ptr clone() const
175  {
176  return unit_ptr(new unit(*this));
177  }
178 
180  {
181  return unit_ptr(this);
182  }
183 
184  virtual ~unit();
185 
186  void swap(unit&);
187 
188  unit& operator=(const unit&) = delete;
189 
190  /**
191  * @defgroup unit_advance Advancement functions
192  * @{
193  */
194 
195  /** Advances this unit to another type */
196  void advance_to(const unit_type& t, bool use_traits = false);
197 
198  using advances_to_t = std::vector<std::string>;
199  /**
200  * Gets the possible types this unit can advance to on level-up.
201  *
202  * @returns A list of type IDs this unit may advance to.
203  */
204  const advances_to_t& advances_to() const
205  {
206  return advances_to_;
207  }
208 
209  /**
210  * Gets the names of the possible types this unit can advance to on level-up.
211  *
212  * @returns A list of the names of the types this unit may advance to.
213  */
214  const std::vector<std::string> advances_to_translated() const;
215 
216  /**
217  * Sets this unit's advancement options.
218  *
219  * @param advances_to A list of new type IDs this unit may advance to.
220  */
221  void set_advances_to(const std::vector<std::string>& advances_to);
222 
223  /**
224  * Checks whether this unit has any options to advance to.
225  *
226  * This considers both whether it has types to advance to OR whether any modifications
227  * specify non-type advancement options.
228  *
229  * Note this does not consider unit experience at all, it only checks option availability.
230  * See @ref advances if an experience check is necessary.
231  */
232  bool can_advance() const
233  {
234  return !advances_to_.empty() || !get_modification_advances().empty();
235  }
236 
237  /**
238  * Checks whether this unit is eligible for level-up.
239  *
240  * @retval true This unit has sufficient experience to level up and has advancement
241  * options available.
242  */
243  bool advances() const
244  {
245  return experience_ >= max_experience() && can_advance();
246  }
247 
248  /**
249  * Gets and image path and and associated description for each advancement option.
250  *
251  * Covers both type and modification-based advancements.
252  *
253  * @returns A data map, in image/description format. If the option is a unit type,
254  * advancement, the key is the type's image and the value the type ID.
255  *
256  * If the option is a modification, the key and value are set from config data
257  * (see @ref get_modification_advances).
258  */
259  std::map<std::string, std::string> advancement_icons() const;
260 
261  /**
262  * Gets any non-typed advanced options set by modifications.
263  *
264  * These are usually used to give a unit special advancement options that don't invole transforming to a
265  * new type.
266  *
267  * Note this is not the raw option data. Parsing is performed to ensure each option appears only once.
268  * Use @ref modification_advancements is the raw data is needed.
269  *
270  * @returns A config list of options data. Each option is unique.
271  */
272  std::vector<config> get_modification_advances() const;
273 
274  /**
275  * Gets the image and description data for modification advancements.
276  *
277  * @returns A list of pairs of the image paths(first) and descriptions (second) for
278  * each advancement option.
279  */
280  std::vector<std::pair<std::string, std::string>> amla_icons() const;
281 
282  using advancements_list= boost::ptr_vector<config>;
283  /** The raw, unparsed data for modification advancements. */
285  {
286  return advancements_;
287  }
288 
289  /** Sets the raw modification advancement option data */
290  void set_advancements(std::vector<config> advancements);
291 
292  /**
293  * @}
294  * @defgroup unit_access Basic data setters and getters
295  * @{
296  **/
297 
298 public:
299  /**
300  * The side this unit belongs to.
301  *
302  * Note that side numbers starts from 1, not 0, so be sure to subtract 1 if using as a container index.
303  */
304  int side() const
305  {
306  return side_;
307  }
308 
309  /** Sets the side this unit belongs to. */
310  void set_side(unsigned int new_side)
311  {
312  side_ = new_side;
313  }
314 
315  /** This unit's type, accounting for gender and variation. */
316  const unit_type& type() const
317  {
318  return *type_;
319  }
320 
321  /**
322  * The id of this unit's type.
323  *
324  * If you are dealing with creating units (e.g. recruitment), this is not what you want, as a
325  * variation can change this; use type().base_id() instead.
326  */
327  const std::string& type_id() const
328  {
329  return type_->id();
330  }
331 
332  /** Gets the translatable name of this unit's type. */
333  const t_string& type_name() const
334  {
335  return type_name_;
336  }
337 
338  /**
339  * Gets this unit's id.
340  *
341  * This is a unique string usually set by WML. It should *not* be used for internal tracking in
342  * the unit_map. Use @ref underlying_id for that.
343  */
344  const std::string& id() const
345  {
346  return id_;
347  }
348 
349  /** Sets this unit's string ID. */
350  void set_id(const std::string& id)
351  {
352  id_ = id;
353  }
354 
355  /** This unit's unique internal ID. This should *not* be used for user-facing operations. */
356  std::size_t underlying_id() const
357  {
358  return underlying_id_.value;
359  }
360 
361 private:
362  /** Sets the internal ID. */
363  void set_underlying_id(n_unit::id_manager& id_manager);
364 
365 public:
366  /** Gets this unit's translatable display name. */
367  const t_string& name() const
368  {
369  return name_;
370  }
371 
372  /**
373  * Sets this unit's translatable display name.
374  *
375  * This should only be used internally since it ignores the 'unrenamable' flag.
376  */
377  void set_name(const t_string& name)
378  {
379  name_ = name;
380  }
381 
382  /**
383  * Attempts to rename this unit's translatable display name, taking the 'unrenamable' flag into account.
384  *
385  * If a direct rename is desired, use @ref set_name.
386  * @todo should this also take a t_string?
387  */
388  void rename(const std::string& name)
389  {
390  if(!unrenamable_) {
391  name_ = name;
392  }
393  }
394 
395  /**
396  * Whether this unit can be renamed.
397  *
398  * This flag is considered by @ref rename, but not @ref set_name.
399  */
400  bool unrenamable() const
401  {
402  return unrenamable_;
403  }
404 
405  /**
406  * Sets the 'unrenamable' flag. Usually used for scenario-specific units which should not be renamed.
407  */
408  void set_unrenamable(bool unrenamable)
409  {
410  unrenamable_ = unrenamable;
411  }
412 
413  /** A detailed description of this unit. */
415  {
416  return description_;
417  }
418 
419  /** The unit's special notes. */
420  const std::vector<t_string>& unit_special_notes() const
421  {
422  return special_notes_;
423  }
424 
425  /** The gender of this unit. */
427  {
428  return gender_;
429  }
430 
431  /**
432  * The alignment of this unit.
433  *
434  * This affects the time of day during which this unit's attacks do the most damage.
435  */
436  unit_type::ALIGNMENT alignment() const
437  {
438  return alignment_;
439  }
440 
441  /** Sets the alignment of this unit. */
442  void set_alignment(unit_type::ALIGNMENT alignment)
443  {
444  set_attr_changed(UA_ALIGNMENT);
445  alignment_ = alignment;
446  }
447 
448  /**
449  * Gets this unit's race.
450  *
451  * @returns A pointer to a unit_race object - never nullptr, but it may point
452  * to the null race.
453  */
454  const unit_race* race() const
455  {
456  return race_;
457  }
458 
459  /** The current number of hitpoints this unit has. */
460  int hitpoints() const
461  {
462  return hit_points_;
463  }
464 
465  /** The max number of hitpoints this unit can have. */
466  int max_hitpoints() const
467  {
468  return max_hit_points_;
469  }
470 
471  void set_max_hitpoints(int value)
472  {
473  set_attr_changed(UA_MAX_HP);
474  max_hit_points_ = value;
475  }
476 
477  /** Sets the current hitpoint amount. */
478  void set_hitpoints(int hp)
479  {
480  hit_points_ = hp;
481  }
482 
483  /** The current number of experience points this unit has. */
484  int experience() const
485  {
486  return experience_;
487  }
488 
489  /** The max number of experience points this unit can have. */
490  int max_experience() const
491  {
492  return max_experience_;
493  }
494 
495  void set_max_experience(int value)
496  {
497  set_attr_changed(UA_MAX_XP);
498  max_experience_ = value;
499  }
500 
501  /** The number of experience points this unit needs to level up, or 0 if current XP > max XP. */
502  unsigned int experience_to_advance() const
503  {
504  return std::max(0, max_experience_ - experience_);
505  }
506 
507  /** The number of experience points over max this unit has, or 0 if current XP < max XP. */
508  unsigned int experience_overflow() const
509  {
510  return std::max(0, experience_ - max_experience_);
511  }
512 
513  /** Sets the current experience point amount. */
514  void set_experience(int xp)
515  {
516  experience_ = xp;
517  }
518 
519  /** The current level of this unit. */
520  int level() const
521  {
522  return level_;
523  }
524 
525  /** Sets the current level of this unit. */
526  void set_level(int level)
527  {
528  set_attr_changed(UA_LEVEL);
529  level_ = level;
530  }
531 
532  /** The ID of the variation of this unit's type. */
533  const std::string& variation() const
534  {
535  return variation_;
536  }
537 
538  /** The ID of the undead variation (ie, dwarf, swimmer) of this unit. */
539  void set_undead_variation(const std::string& value)
540  {
541  set_attr_changed(UA_UNDEAD_VARIATION);
542  undead_variation_ = value;
543  }
544  const std::string& undead_variation() const
545  {
546  return undead_variation_;
547  }
548 
549  /**
550  * An optional profile image to display in Help.
551  *
552  * @returns The specified image, this unit's type's sprite image if empty
553  * or 'unit_image' was set.
554  */
555  std::string small_profile() const;
556 
557  void set_small_profile(const std::string& value)
558  {
559  set_attr_changed(UA_SMALL_PROFILE);
560  small_profile_ = value;
561  }
562  /**
563  * An optional profile image displays when this unit is 'speaking' via [message].
564  *
565  * @returns The specified image, this unit's type's sprite image if empty
566  * or 'unit_image' was set.
567  */
568  std::string big_profile() const;
569 
570  void set_big_profile(const std::string& value)
571  {
572  set_attr_changed(UA_PROFILE);
573  profile_ = value;
574  adjust_profile(profile_);
575  }
576  /** Whether this unit can recruit other units - ie, are they a leader unit. */
577  bool can_recruit() const
578  {
579  return canrecruit_;
580  }
581 
582  /** Sets whether this unit can recruit other units. */
583  void set_can_recruit(bool canrecruit)
584  {
585  canrecruit_ = canrecruit;
586  }
587 
588  /** The type IDs of the other units this unit may recruit, if possible. */
589  const std::vector<std::string>& recruits() const
590  {
591  return recruit_list_;
592  }
593 
594  /** Sets the recruit list. */
595  void set_recruits(const std::vector<std::string>& recruits);
596 
597  /** How much gold is required to recruit this unit. */
598  int cost() const
599  {
600  return unit_value_;
601  }
602 
603  /** How much gold it costs to recall this unit, or -1 if the side's default
604  * recall cost is used. */
605  int recall_cost() const
606  {
607  return recall_cost_;
608  }
609 
610  /** Sets the cost of recalling this unit. */
612  {
613  recall_cost_ = recall_cost;
614  }
615 
616  /** Gets the filter constraints upon which units this unit may recall, if able. */
617  const config& recall_filter() const
618  {
619  return filter_recall_;
620  }
621 
622  /**
623  * Gets this unit's role.
624  *
625  * A role is a special string flag usually used to represent a unit's purpose in a scenario.
626  * It can be filtered on.
627  */
628  const std::string& get_role() const
629  {
630  return role_;
631  }
632 
633  /** Sets a unit's role */
634  void set_role(const std::string& role)
635  {
636  role_ = role;
637  }
638 
639  /**
640  * Gets this unit's usage. This is relevant to the AI.
641  *
642  * Usage refers to how the AI may consider utilizing this unit in combat.
643  * @todo document further
644  */
645  std::string usage() const
646  {
647  return unit_detail::get_or_default(usage_);
648  }
649 
650  /** Sets this unit's usage. */
651  void set_usage(const std::string& usage)
652  {
653  usage_.reset(new std::string(usage));
654  }
655 
656  /**
657  * Gets any user-defined variables this unit 'owns'.
658  *
659  * These are accessible via WML if the unit's data is serialized to a variable. They're strictly
660  * user-facing; internal engine calculations shouldn't use this.
661  */
663  {
664  return variables_;
665  }
666 
667  /** Const overload of @ref variables. */
668  const config& variables() const
669  {
670  return variables_;
671  }
672 
673  /**
674  * Gets whether this unit is currently hidden on the map.
675  *
676  * Hidden units are not drawn on the main map or the minimap. They are
677  * an implementation detail. For the [hides] ability, see invisible().
678  */
679  bool get_hidden() const
680  {
681  return hidden_;
682  }
683 
684  /** Sets whether the unit is hidden on the map. */
685  void set_hidden(bool state) const;
686 
687  /**
688  * The factor by which the HP bar should be scaled.
689  * @todo: document further
690  */
691  double hp_bar_scaling() const
692  {
693  return hp_bar_scaling_;
694  }
695 
696  /**
697  * The factor by which the XP bar should be scaled.
698  * @todo: document further
699  */
700  double xp_bar_scaling() const
701  {
702  return xp_bar_scaling_;
703  }
704 
705  /**
706  * Whether the unit has been instructed to hold its position.
707  * This excludes it from the unit cycling function.
708  * @return true if it is holding position
709  */
710  bool hold_position() const
711  {
712  return hold_position_;
713  }
714 
715  /**
716  * Toggle the unit's hold position status.
717  */
719  {
720  hold_position_ = !hold_position_;
721  if(hold_position_) {
722  end_turn_ = true;
723  }
724  }
725 
726  /**
727  * Set whether the user ended their turn
728  * @todo Verify meaning and explain better
729  */
730  void set_user_end_turn(bool value = true)
731  {
732  end_turn_ = value;
733  }
734 
735  /**
736  * Toggle whether the user ended their turn
737  * @todo Verify meaning and explain better
738  */
740  {
741  end_turn_ = !end_turn_;
742  if(!end_turn_) {
743  hold_position_ = false;
744  }
745  }
746 
747  /**
748  * Check whether the user ended their turn
749  * @todo Verify meaning and explain better
750  */
751  bool user_end_turn() const
752  {
753  return end_turn_;
754  }
755 
756  /**
757  * Refresh unit for the beginning of a turn
758  */
759  void new_turn();
760 
761  /**
762  * Refresh unit for the end of a turn
763  */
764  void end_turn();
765 
766  /**
767  * Refresh unit for the beginning of a new scenario
768  */
769  void new_scenario();
770 
771  /**
772  * Damage the unit.
773  * @returns true if the unit dies as a result
774  */
775  bool take_hit(int damage)
776  {
777  hit_points_ -= damage;
778  return hit_points_ <= 0;
779  }
780 
781  /**
782  * Heal the unit
783  * @amount The number of hitpoints to gain
784  */
785  void heal(int amount);
786 
787  /**
788  * Fully heal the unit, restoring it to max hitpoints
789  */
790  void heal_fully()
791  {
792  hit_points_ = max_hitpoints();
793  }
794 
795  /**
796  * Get the status effects currently affecting the unit.
797  * @return A set of status keys
798  */
799  const std::set<std::string> get_states() const;
800 
801  /**
802  * Check if the unit is affected by a status effect
803  * @param state The status effect to check
804  * @returns true if the unit is affected by the status effect
805  */
806  bool get_state(const std::string& state) const;
807 
808  /**
809  * Set whether the unit is affected by a status effect
810  * @param state The status effect to change
811  * @param value Whether the unit should be affected by the status
812  */
813  void set_state(const std::string& state, bool value);
814 
815  /**
816  * Built-in status effects known to the engine
817  */
818  enum state_t {
819  STATE_SLOWED = 0, ///< The unit is slowed - it moves slower and does less damage
820  STATE_POISONED, ///< The unit is poisoned - it loses health each turn
821  STATE_PETRIFIED, ///< The unit is petrified - it cannot move or be attacked
822  STATE_UNCOVERED, ///< The unit is uncovered - it was hiding but has been spotted
823  STATE_NOT_MOVED, ///< The unit has not moved @todo Explain better
824  STATE_UNHEALABLE, ///< The unit cannot be healed
825  STATE_GUARDIAN, ///< The unit is a guardian - it won't move unless a target is sighted
826  STATE_UNKNOWN = -1///< A status effect not known to the engine
827  };
828 
829  /**
830  * Set whether the unit is affected by a status effect
831  * @param state The status effect to change
832  * @param value Whether the unit should be affected by the status
833  */
834  void set_state(state_t state, bool value);
835 
836  /**
837  * Check if the unit is affected by a status effect
838  * @param state The status effect to check
839  * @returns true if the unit is affected by the status effect
840  */
841  bool get_state(state_t state) const;
842 
843  /**
844  * Convert a string status effect ID to a built-in status effect ID
845  * @returns the state_t representing the status, or STATE_UNKNOWN if it's not built-in
846  */
847  static state_t get_known_boolean_state_id(const std::string& state);
848 
849  /**
850  * Check if the unit has been poisoned
851  * @returns true if it's poisoned
852  */
853  bool poisoned() const
854  {
855  return get_state(STATE_POISONED);
856  }
857 
858  /**
859  * Check if the unit has been petrified
860  * @returns true if it's petrified
861  */
862  bool incapacitated() const
863  {
864  return get_state(STATE_PETRIFIED);
865  }
866 
867  /**
868  * Check if the unit has been slowed
869  * @returns true if it's slowed
870  */
871  bool slowed() const
872  {
873  return get_state(STATE_SLOWED);
874  }
875 
876  /**
877  * @}
878  * @defgroup unit_atk Attack and resistance functions
879  * @{
880  */
881 
882 public:
883  /** Gets an iterator over this unit's attacks. */
885  {
886  return make_attack_itors(attacks_);
887  }
888 
889  /** Const overload of @ref attacks. */
891  {
892  return make_attack_itors(attacks_);
893  }
894 
895  /**
896  * Adds a new attack to the unit.
897  * @param position An iterator pointing to the attack before which to insert the new one.
898  * @param args The arguments for constructing the attack
899  */
900  template<typename... Args>
901  attack_ptr add_attack(attack_itors::iterator position, Args&&... args)
902  {
903  set_attr_changed(UA_ATTACKS);
904  return *attacks_.emplace(position.base(), new attack_type(std::forward<Args>(args)...));
905  }
906 
907  /**
908  * Remove an attack from the unit
909  * @param atk A pointer to the attack to remove
910  * @return true if the attack was removed, false if it didn't exist on the unit
911  */
912  bool remove_attack(attack_ptr atk);
913 
914  /**
915  * Set the unit to have no attacks left for this turn.
916  */
917  void remove_attacks_ai();
918 
919  /**
920  * Calculates the damage this unit would take from a certain attack.
921  *
922  * @param attack The attack to consider.
923  * @param attacker Whether this unit should be considered the attacker.
924  * @param loc TODO: what does this do?
925  *
926  * @returns The expected damage.
927  */
928  int damage_from(const attack_type& attack, bool attacker, const map_location& loc, const_attack_ptr weapon = nullptr) const
929  {
930  return resistance_against(attack, attacker, loc, weapon);
931  }
932 
933  /** The maximum number of attacks this unit may perform per turn, usually 1. */
934  int max_attacks() const
935  {
936  return max_attacks_;
937  }
938 
939  void set_max_attacks(int value)
940  {
941  set_attr_changed(UA_MAX_AP);
942  max_attacks_ = value;
943  }
944 
945  /**
946  * Gets the remaining number of attacks this unit can perform this turn.
947  *
948  * If the 'incapacitated' status is set, this will always be 0.
949  */
950  int attacks_left() const
951  {
952  return (attacks_left_ == 0 || incapacitated()) ? 0 : attacks_left_;
953  }
954 
955  /**
956  * Gets the remaining number of attacks this unit can perform this turn.
957  *
958  * @param base_value If false, consider the `incapacitated` flag.
959  *
960  * @returns If @a base_value is true, the raw value is returned.
961  */
962  int attacks_left(bool base_value) const
963  {
964  return base_value ? attacks_left_ : attacks_left();
965  }
966 
967  /**
968  * Sets the number of attacks this unit has left this turn.
969  * @param left The number of attacks left
970  */
971  void set_attacks(int left)
972  {
973  attacks_left_ = std::max<int>(0, left);
974  }
975 
976  /**
977  * The unit's defense on a given terrain
978  * @param terrain The terrain to check
979  */
980  int defense_modifier(const t_translation::terrain_code& terrain) const;
981 
982  /**
983  * The unit's resistance against a given damage type
984  * @param damage_name The damage type
985  * @param attacker True if this unit is on the offensive (to resolve [resistance] abilities)
986  * @param loc The unit's location (to resolve [resistance] abilities)
987  */
988  int resistance_against(const std::string& damage_name, bool attacker, const map_location& loc, const_attack_ptr weapon = nullptr, const_attack_ptr opp_weapon = nullptr) const;
989 
990  /**
991  * The unit's resistance against a given attack
992  * @param atk The attack
993  * @param attacker True if this unit is on the offensive (to resolve [resistance] abilities)
994  * @param loc The unit's location (to resolve [resistance] abilities)
995  */
996  int resistance_against(const attack_type& atk, bool attacker, const map_location& loc, const_attack_ptr weapon = nullptr) const
997  {
998  return resistance_against(atk.type(), attacker, loc , weapon, atk.shared_from_this());
999  }
1000 
1001  /** Gets resistances without any abilities applied. */
1003  {
1004  return movement_type_.damage_table();
1005  }
1006 
1007 private:
1008  bool resistance_filter_matches(const config& cfg, bool attacker, const std::string& damage_name, int res) const;
1009 
1010  /**
1011  * @}
1012  * @defgroup unit_trait Trait and upkeep functions
1013  * @{
1014  */
1015 public:
1016  /**
1017  * Applies mandatory traits (e.g. undead, mechanical) to a unit and then fills in the remaining traits
1018  * traits until no more are available (leaders have a restricted set of available traits) or the unit has
1019  * its maximum number of traits.
1020  *
1021  * This routine does not apply the effects of added traits to a unit; that must be done by the caller.
1022  *
1023  * Note that random numbers used in config files don't work in multiplayer, so leaders should be barred
1024  * from all random traits until that is fixed. Later the restrictions will be based on play balance.
1025  *
1026  * @param must_have_only Whether random or optional traits should be included or not. If false only
1027  * mandatory traits will be used.
1028  */
1029  void generate_traits(bool must_have_only = false);
1030 
1031  /**
1032  * Gets the names of the currently registered traits.
1033  *
1034  * @returns A list of translatable trait names.
1035  */
1036  const std::vector<t_string>& trait_names() const
1037  {
1038  return trait_names_;
1039  }
1040 
1041  /**
1042  * Gets the descriptions of the currently registered traits.
1043  *
1044  * @returns A list of translatable trait descriptions.
1045  */
1046  const std::vector<t_string>& trait_descriptions() const
1047  {
1048  return trait_descriptions_;
1049  }
1050 
1051  /**
1052  * Gets a list of the traits this unit currently has.
1053  *
1054  * @returns A list of trait IDs.
1055  */
1056  std::vector<std::string> get_traits_list() const;
1057 
1058  /**
1059  * Register a trait's name and its description for the UI's use.
1060  *
1061  * The resulting data can be fetched with @ref trait_names and @ref trait_descriptions.
1062  *
1063  * @param trait A config containing the trait's attributes.
1064  * @param description The translatable description of the trait.
1065  */
1066  void add_trait_description(const config& trait, const t_string& description);
1067 
1068  /**
1069  * Gets the amount of gold this unit costs a side per turn.
1070  *
1071  * This fetches an actual numeric gold value:
1072  * - If @rec can_recruit is true, no upkeep is paid (0 is returned).
1073  * - If a special upkeep flag is set, the associated gold amount is returned (see @ref upkeep_value_visitor).
1074  * - If a numeric value is already set, it is returned directly.
1075  *
1076  * @returns A gold value, evaluated based on the state of @ref upkeep_raw.
1077  */
1078  int upkeep() const;
1079 
1081  {
1082  static std::string type() { static std::string v = "full"; return v; }
1083  };
1084 
1086  {
1087  static std::string type() { static std::string v = "loyal"; return v; }
1088  };
1089 
1090  /** Visitor helper class to fetch the appropriate upkeep value. */
1091  class upkeep_value_visitor : public boost::static_visitor<int>
1092  {
1093  public:
1094  explicit upkeep_value_visitor(const unit& unit) : u_(unit) {}
1095 
1096  /** Full upkeep equals the unit's level. */
1097  int operator()(const upkeep_full&) const
1098  {
1099  return u_.level();
1100  }
1101 
1102  /** Loyal units cost no upkeep. */
1103  int operator()(const upkeep_loyal&) const
1104  {
1105  return 0;
1106  }
1107 
1108  int operator()(int v) const
1109  {
1110  return v;
1111  }
1112 
1113  private:
1114  const unit& u_;
1115  };
1116 
1117  /** Visitor helper struct to fetch the upkeep type flag if applicable, or the the value otherwise. */
1118  struct upkeep_type_visitor : public boost::static_visitor<std::string>
1119  {
1120  template<typename T>
1121  std::enable_if_t<!std::is_same<int, T>::value, std::string>
1122  operator()(T&) const
1123  {
1124  // Any special upkeep type should have an associated @ref type getter in its helper struct.
1125  return T::type();
1126  }
1127 
1128  std::string operator()(int v) const
1129  {
1130  return std::to_string(v);
1131  }
1132  };
1133 
1134  using upkeep_t = boost::variant<upkeep_full, upkeep_loyal, int>;
1135 
1136  /**
1137  * Gets the raw variant controlling the upkeep value.
1138  *
1139  * This should not usually be called directly. To get an actual numeric value of upkeep use @ref upkeep.
1140  */
1142  {
1143  return upkeep_;
1144  }
1145 
1146  /** Sets the upkeep value to a specific value value. Does not necessarily need to be numeric */
1148  {
1149  upkeep_ = v;
1150  }
1151 
1152  /** Gets whether this unit is loyal - ie, it costs no upkeep. */
1153  bool loyal() const;
1154 
1155  /** Gets whether this unit is fearless - ie, unaffected by time of day. */
1156  bool is_fearless() const
1157  {
1158  return is_fearless_;
1159  }
1160 
1161  /** Gets whether this unit is healthy - ie, always rest heals. */
1162  bool is_healthy() const
1163  {
1164  return is_healthy_;
1165  }
1166 
1167  /**
1168  * @}
1169  * @defgroup unit_mvmt Movement and location functions
1170  * @{
1171  */
1172 
1173 public:
1174  /** The maximum moves this unit has. */
1175  int total_movement() const
1176  {
1177  return max_movement_;
1178  }
1179 
1180  void set_total_movement(int value)
1181  {
1182  set_attr_changed(UA_MAX_MP);
1183  max_movement_ = value;
1184  }
1185 
1186  /**
1187  * Gets how far a unit can move, considering the `incapacitated` flag.
1188  *
1189  * @returns The remaining movement, or zero if incapacitated.
1190  */
1191  int movement_left() const
1192  {
1193  return (movement_ == 0 || incapacitated()) ? 0 : movement_;
1194  }
1195 
1196  /**
1197  * Gets how far a unit can move.
1198  *
1199  * @param base_value If false, consider the `incapacitated` flag.
1200  *
1201  * @returns If @a base_value is true, the raw value is returned.
1202  */
1203  int movement_left(bool base_value) const
1204  {
1205  return base_value ? movement_ : movement_left();
1206  }
1207 
1208  /**
1209  * Set this unit's remaining movement to @a moves.
1210  *
1211  * This does not affect maximum movement.
1212  *
1213  * @param moves The new number of moves
1214  * @param unit_action If to true, the "end turn" and "hold position" flags will be cleared
1215  * (as they should be if a unit acts, as opposed to the movement being set
1216  * by the engine for other reasons).
1217  */
1218  void set_movement(int moves, bool unit_action = false);
1219 
1220  /** Checks if this unit has moved. */
1221  bool has_moved() const
1222  {
1223  return movement_left() != total_movement();
1224  }
1225 
1226  /** Sets the unit to have no moves left for this turn. */
1227  void remove_movement_ai();
1228 
1229  /**
1230  * Checks whether this unit is 'resting'.
1231  *
1232  * Resting refers to whether this unit has not moved yet this turn. Note that this can be true even
1233  * if @ref movement_left is not equal to @ref total_movement.
1234  */
1235  bool resting() const
1236  {
1237  return resting_;
1238  }
1239 
1240  /** Sets this unit's resting status. */
1241  void set_resting(bool rest)
1242  {
1243  resting_ = rest;
1244  }
1245 
1246  /** Tests whether the unit has a zone-of-control, considering @ref incapacitated. */
1247  bool emits_zoc() const
1248  {
1249  return emit_zoc_ && !incapacitated();
1250  }
1251 
1252  /** Gets the raw zone-of-control flag, disregarding @ref incapacitated. */
1253  bool get_emit_zoc() const
1254  {
1255  return emit_zoc_;
1256  }
1257 
1258  /** Sets the raw zone-of-control flag. */
1259  void set_emit_zoc(bool val)
1260  {
1261  set_attr_changed(UA_ZOC);
1262  emit_zoc_ = val;
1263  }
1264 
1265  /** The current map location this unit is at. */
1267  {
1268  return loc_;
1269  }
1270 
1271  /**
1272  * Sets this unit's map location.
1273  *
1274  * Note this should only be called by unit_map or for temporary units.
1275  */
1276  void set_location(const map_location& loc)
1277  {
1278  loc_ = loc;
1279  }
1280 
1281  /** The current directin this unit is facing within its hex. */
1283  {
1284  return facing_;
1285  }
1286 
1287  /** The this unit's facing. */
1288  void set_facing(map_location::DIRECTION dir) const;
1289 
1290  /** Gets whether this unit has a multi-turn destination set. */
1291  bool has_goto() const
1292  {
1293  return get_goto().valid();
1294  }
1295 
1296  /** The map location to which this unit is moving over multiple turns, if any. */
1297  const map_location& get_goto() const
1298  {
1299  return goto_;
1300  }
1301 
1302  /** Sets this unit's long term destination. */
1303  void set_goto(const map_location& new_goto)
1304  {
1305  goto_ = new_goto;
1306  }
1307 
1308  /** Gets the unit's vision points. */
1309  int vision() const
1310  {
1311  return vision_ < 0 ? max_movement_ : vision_;
1312  }
1313 
1314  /** Gets the unit's jamming points. */
1315  int jamming() const
1316  {
1317  return jamming_;
1318  }
1319 
1320  /** Check whether the unit's move has been interrupted. */
1321  bool move_interrupted() const
1322  {
1323  return movement_left() > 0 && interrupted_move_.x >= 0 && interrupted_move_.y >= 0;
1324  }
1325 
1326  /** Get the target location of the unit's interrupted move. */
1328  {
1329  return interrupted_move_;
1330  }
1331 
1332  /** Set the target location of the unit's interrupted move. */
1333  void set_interrupted_move(const map_location& interrupted_move)
1334  {
1335  interrupted_move_ = interrupted_move;
1336  }
1337 
1338  /** Get the unit's movement type. */
1339  const movetype& movement_type() const
1340  {
1341  return movement_type_;
1342  }
1343 
1344  /**
1345  * Get the unit's movement cost on a particular terrain
1346  * @param terrain The terrain to check
1347  * @returns the number of movement points to enter that terrain
1348  */
1349  int movement_cost(const t_translation::terrain_code& terrain) const
1350  {
1351  return movement_type_.movement_cost(terrain, get_state(STATE_SLOWED));
1352  }
1353 
1354  /**
1355  * Get the unit's vision cost on a particular terrain
1356  * @param terrain The terrain to check
1357  * @returns the number of vision points to see into that terrain
1358  */
1359  int vision_cost(const t_translation::terrain_code& terrain) const
1360  {
1361  return movement_type_.vision_cost(terrain, get_state(STATE_SLOWED));
1362  }
1363 
1364  /**
1365  * Get the unit's jamming cost on a particular terrain
1366  * @param terrain The terrain to check
1367  * @returns the number of jamming points to jam that terrain
1368  */
1369  int jamming_cost(const t_translation::terrain_code& terrain) const
1370  {
1371  return movement_type_.jamming_cost(terrain, get_state(STATE_SLOWED));
1372  }
1373 
1374  /** Check if the unit is a flying unit. */
1375  bool is_flying() const
1376  {
1377  return movement_type_.is_flying();
1378  }
1379 
1380  /**
1381  * @}
1382  * @defgroup unit_mod Modification functions
1383  * @{
1384  */
1385 
1386 public:
1387  /** Get the raw modifications. */
1389  {
1390  return modifications_;
1391  }
1392 
1393  /** Set the raw modifications. */
1394  const config& get_modifications() const
1395  {
1396  return modifications_;
1397  }
1398 
1399  /**
1400  * Count modifications of a particular type.
1401  * @param type The type of modification to count.
1402  * Valid values are "advancement", "trait", "object"
1403  * @param id The ID of the modification to count
1404  * @return The total number of modifications of that type and ID.
1405  */
1406  std::size_t modification_count(const std::string& type, const std::string& id) const;
1407 
1408  /**
1409  * Add a new modification to the unit.
1410  * @param type The type of modification to add.
1411  * Valid values are "advancement", "trait", "object"
1412  * @param modification The details of the modification
1413  * @param no_add If true, apply the modification but don't save it for unit rebuild time.
1414  * Defaults to false.
1415  */
1416  void add_modification(const std::string& type, const config& modification, bool no_add = false);
1417 
1418  /**
1419  * Clears those modifications whose duration has expired.
1420  *
1421  * @param duration If empty, all temporary modifications (those not lasting forever) expire.
1422  * Otherwise, modifications whose duration equals @a duration expire.
1423  */
1424  void expire_modifications(const std::string& duration);
1425 
1426  static const std::set<std::string> builtin_effects;
1427 
1428  /**
1429  * Apply a builtin effect to the unit.
1430  * @param type The effect to apply. Must be one of the effects in @ref builtin_effects.
1431  * @param effect The details of the effect
1432  */
1433  void apply_builtin_effect(std::string type, const config& effect);
1434 
1435  /**
1436  * Construct a string describing a built-in effect.
1437  * @param type The effect to describe. Must be one of the effects in @ref builtin_effects.
1438  * @param effect The details of the effect
1439  */
1440  std::string describe_builtin_effect(std::string type, const config& effect);
1441 
1442  /** Re-apply all saved modifications. */
1443  void apply_modifications();
1444 
1445  /**
1446  * @}
1447  * @defgroup unit_img Image and animations functions
1448  * @{
1449  */
1450 
1451 public:
1452  /** @todo Document this */
1454  {
1455  return *anim_comp_;
1456  }
1457 
1458  /** The name of the file to game_display (used in menus). */
1459  std::string absolute_image() const;
1460 
1461  /** The default image to use for animation frames with no defined image. */
1462  std::string default_anim_image() const;
1463 
1464  /** Get the unit's halo image. */
1465  std::string image_halo() const
1466  {
1467  return unit_detail::get_or_default(halo_);
1468  }
1469 
1470  /** Set the unit's halo image. */
1471  void set_image_halo(const std::string& halo);
1472 
1473  /** Get the unit's ellipse image. */
1474  std::string image_ellipse() const
1475  {
1476  return unit_detail::get_or_default(ellipse_);
1477  }
1478 
1479  /** Set the unit's ellipse image. */
1480  void set_image_ellipse(const std::string& ellipse)
1481  {
1482  appearance_changed_ = true;
1483  ellipse_.reset(new std::string(ellipse));
1484  }
1485 
1486  /**
1487  * Get the source color palette to use when recoloring the unit's image.
1488  */
1489  const std::string& flag_rgb() const;
1490 
1491  /** Constructs a recolor (RC) IPF string for this unit's team color. */
1492  std::string TC_image_mods() const;
1493 
1494  /** Gets any IPF image mods applied by effects. */
1495  const std::string& effect_image_mods() const
1496  {
1497  return image_mods_;
1498  }
1499 
1500  /**
1501  * Gets an IPF string containing all IPF image mods.
1502  *
1503  * @returns An amalgamation of @ref effect_image_mods followed by @ref TC_image_mods.
1504  */
1505  std::string image_mods() const;
1506 
1507  /** Get the unit's overlay images. */
1508  const std::vector<std::string>& overlays() const
1509  {
1510  return overlays_;
1511  }
1512 
1513  /**
1514  * Color for this unit's *current* hitpoints.
1515  *
1516  * @returns A color between green and red representing how wounded this unit is.
1517  * The maximum_hitpoints are considered as base.
1518  */
1519  color_t hp_color() const;
1520 
1521  /**
1522  * Color for this unit's hitpoints.
1523  *
1524  * @param hitpoints The number of hitpoints the color represents.
1525  * @returns The color considering the current hitpoints as base.
1526  */
1527  color_t hp_color(int hitpoints) const;
1528 
1529  /**
1530  * Color for this unit's XP. See also @ref hp_color
1531  */
1532  color_t xp_color() const;
1533 
1534  /**
1535  * @}
1536  * @defgroup unit_abil Ability functions
1537  * @{
1538  */
1539 
1540 public:
1541  /**
1542  * Checks whether this unit currently possesses or is affected by a given ability.
1543  *
1544  * This means that the ability could be owned by this unit itself or by an adjacent unit, should
1545  * the ability affect an AoE in which this unit happens to be.
1546  *
1547  * @param tag_name The name of the ability to check for.
1548  * @param loc The location around which to check for affected units. This may or
1549  * may not be the location of this unit.
1550  */
1551  bool get_ability_bool(const std::string& tag_name, const map_location& loc) const;
1552 
1553  /**
1554  * Checks whether this unit currently possesses or is affected by a given ability.
1555  *
1556  * This means that the ability could be owned by this unit itself or by an adjacent unit, should
1557  * the ability affect an AoE in which this unit happens to be.
1558  *
1559  * This overload uses the location of this unit for calculations.
1560  *
1561  * @param tag_name The name of the ability to check for.
1562  */
1563  bool get_ability_bool(const std::string& tag_name) const
1564  {
1565  return get_ability_bool(tag_name, loc_);
1566  }
1567 
1568  /**
1569  * Gets the unit's active abilities of a particular type if it were on a specified location.
1570  * @param tag_name The type of ability to check for
1571  * @param loc The location to use for resolving abilities
1572  * @return A list of active abilities, paired with the location they are active on
1573  */
1574  unit_ability_list get_abilities(const std::string& tag_name, const map_location& loc, const_attack_ptr weapon = nullptr, const_attack_ptr opp_weapon = nullptr) const;
1575 
1576  /**
1577  * Gets the unit's active abilities of a particular type.
1578  * @param tag_name The type of ability to check for
1579  * @return A list of active abilities, paired with the location they are active on
1580  */
1581  unit_ability_list get_abilities(const std::string& tag_name, const_attack_ptr weapon = nullptr, const_attack_ptr opp_weapon = nullptr) const
1582  {
1583  return get_abilities(tag_name, loc_, weapon, opp_weapon);
1584  }
1585 
1586  /**
1587  * Gets the names and descriptions of this unit's abilities. Location-independent variant
1588  * with all abilities shown as active.
1589  *
1590  * @returns A list of quadruples consisting of (in order) id, base name,
1591  * male or female name as appropriate for the unit, and description.
1592  */
1593  std::vector<std::tuple<std::string, t_string, t_string, t_string>>
1594  ability_tooltips() const;
1595 
1596  /**
1597  * Gets the names and descriptions of this unit's abilities.
1598  *
1599  * @param active_list This vector will be the same length as the returned one and will
1600  * indicate whether or not the corresponding ability is active.
1601  *
1602  * @param loc The location on which to resolve the ability.
1603  *
1604  * @returns A list of quadruples consisting of (in order) id, base name,
1605  * male or female name as appropriate for the unit, and description.
1606  */
1607  std::vector<std::tuple<std::string, t_string, t_string, t_string>>
1608  ability_tooltips(boost::dynamic_bitset<>& active_list, const map_location& loc) const;
1609 
1610  /** Get a list of all abilities by ID. */
1611  std::vector<std::string> get_ability_list() const;
1612 
1613  /**
1614  * Check if the unit has an ability of a specific type.
1615  * @param ability The type of ability (tag name) to check for.
1616  * @returns true if the ability is present
1617  */
1618  bool has_ability_type(const std::string& ability) const;
1619 
1620  /**
1621  * Check if the unit has an ability of a specific ID.
1622  * @param ability The ID of ability to check for.
1623  * @returns true if the ability is present
1624  */
1625  bool has_ability_by_id(const std::string& ability) const;
1626 
1627  /**
1628  * Removes a unit's abilities with a specific ID.
1629  * @param ability The type of ability (tag name) to remove.
1630  */
1631  void remove_ability_by_id(const std::string& ability);
1632 
1633  bool abilities_filter_matches(const config& cfg, bool attacker, int res) const;
1634  bool ability_filter_fighter(const std::string& ability, const std::string& filter_attacker , const config& cfg, const map_location& loc, const unit& u2) const;
1635 
1636 private:
1637  /**
1638  * Check if an ability is active.
1639  * @param ability The type (tag name) of the ability
1640  * @param cfg an ability WML structure
1641  * @param loc The location on which to resolve the ability
1642  * @returns true if it is active
1643  */
1644  bool ability_active(const std::string& ability, const config& cfg, const map_location& loc) const;
1645 
1646  /**
1647  * Check if an ability affects adjacent units.
1648  * @param ability The type (tag name) of the ability
1649  * @param cfg an ability WML structure
1650  * @param loc The location on which to resolve the ability
1651  * @param from The "other unit" for filter matching
1652  */
1653  bool ability_affects_adjacent(const std::string& ability, const config& cfg, int dir, const map_location& loc, const unit& from) const;
1654 
1655  /**
1656  * Check if an ability affects the owning unit.
1657  * @param ability The type (tag name) of the ability
1658  * @param cfg an ability WML structure
1659  * @param loc The location on which to resolve the ability
1660  */
1661  bool ability_affects_self(const std::string& ability, const config& cfg, const map_location& loc) const;
1662 
1663  bool ability_affects_weapon(const config& cfg, const_attack_ptr weapon, bool is_opp) const;
1664 
1665 public:
1666  /** Get the unit formula manager. */
1668  {
1669  return *formula_man_;
1670  }
1671 
1672  /** Generates a random race-appropriate name if one has not already been provided. */
1673  void generate_name();
1674 
1675  // Only see_all = true use caching
1676  bool invisible(const map_location& loc, bool see_all = true) const;
1677 
1678  bool is_visible_to_team(const team& team, bool const see_all = true) const;
1679  /// Return true if the unit would be visible to team if its location were loc.
1680  bool is_visible_to_team(const map_location& loc, const team& team, bool const see_all = true) const;
1681 
1682  /**
1683  * Serializes the current unit metadata values.
1684  *
1685  * @param cfg The config to write to.
1686  * @param write_all set this to false to not write unchanged attributes.
1687  */
1688  void write(config& cfg, bool write_all = true) const;
1689 
1690  /**
1691  * Mark this unit as clone so it can be inserted to unit_map.
1692  *
1693  * @returns self (for convenience)
1694  */
1695  unit& mark_clone(bool is_temporary);
1696 
1697  /** @} */
1698 
1699  long ref_count() const
1700  {
1701  return ref_count_;
1702  }
1703 
1704  friend void intrusive_ptr_add_ref(const unit*);
1705  friend void intrusive_ptr_release(const unit*);
1706 
1707  void set_appearance_changed(bool value) { appearance_changed_ = value; }
1708  bool appearance_changed() const { return appearance_changed_; }
1709 
1710 protected:
1711  mutable long ref_count_; // used by intrusive_ptr
1712 
1713 private:
1715 
1716  std::vector<std::string> advances_to_;
1717 
1718  /** Never nullptr. Adjusted for gender and variation. */
1720 
1721  /** The displayed name of this unit type. */
1723 
1724  /** Never nullptr, but may point to the null race. */
1726 
1727  std::string id_;
1730 
1731  std::string undead_variation_;
1732  std::string variation_;
1733 
1738 
1739  int level_;
1740 
1743  std::vector<std::string> recruit_list_;
1744  unit_type::ALIGNMENT alignment_;
1745 
1746  std::string flag_rgb_;
1747  std::string image_mods_;
1748 
1750 
1751  int side_;
1752 
1754 
1755  std::unique_ptr<unit_formula_manager> formula_man_;
1756 
1759  int vision_;
1761 
1763 
1766  bool resting_;
1767 
1770 
1771  std::set<std::string> states_;
1772 
1773  static const std::size_t num_bool_states = 7;
1774 
1775  std::bitset<num_bool_states> known_boolean_states_;
1776  static std::map<std::string, state_t> known_boolean_state_names_;
1777 
1781 
1783 
1784  std::vector<std::string> overlays_;
1785 
1786  std::string role_;
1788 
1789 protected:
1790  // TODO: I think we actually consider this to be part of the gamestate, so it might be better if it's not mutable,
1791  // but it's not easy to separate this guy from the animation code right now.
1793 
1794 private:
1795  std::vector<t_string> trait_names_;
1796  std::vector<t_string> trait_descriptions_;
1797 
1800 
1801  bool is_fearless_, is_healthy_;
1802 
1804 
1805  // Animations:
1807 
1808  std::unique_ptr<unit_animation_component> anim_comp_;
1809 
1810  mutable bool hidden_;
1811  double hp_bar_scaling_, xp_bar_scaling_;
1812 
1815 
1817 
1819  std::vector<t_string> special_notes_;
1820 
1821  std::unique_ptr<std::string> usage_;
1822  std::unique_ptr<std::string> halo_;
1823  std::unique_ptr<std::string> ellipse_;
1824 
1827 
1829 
1830  std::string profile_;
1831  std::string small_profile_;
1832 
1833  //Used to check whether the moving units during a move needs to be updated
1834  mutable bool appearance_changed_ = true;
1835  std::bitset<UA_COUNT> changed_attributes_;
1836 
1837  void parse_upkeep(const config::attribute_value& upkeep);
1838  void write_upkeep(config::attribute_value& upkeep) const;
1839 
1840  /**
1841  * Hold the visibility status cache for a unit, when not uncovered.
1842  * This is mutable since it is a cache.
1843  */
1844  mutable std::map<map_location, bool> invisibility_cache_;
1845 
1846  /**
1847  * Clears the cache.
1848  *
1849  * Since we don't change the state of the object we're marked const (also
1850  * required since the objects in the cache need to be marked const).
1851  */
1853  {
1854  invisibility_cache_.clear();
1855  }
1856 };
1857 
1858 /** Implement non-member swap function for std::swap (calls @ref unit::swap). */
1859 void swap(unit& lhs, unit& rhs);
1860 
1861 /**
1862  * Object which temporarily resets a unit's movement.
1863  *
1864  * @warning A unit whose movement is reset may not be deleted while held in a
1865  * @ref unit_movement_resetter object, so it's best to use thus only in a small scope.
1866  */
1868 {
1870  unit_movement_resetter& operator=(const unit_movement_resetter&) = delete;
1871 
1872  unit_movement_resetter(const unit& u, bool operate = true);
1874 
1875 private:
1877  int moves_;
1878 };
1879 
1880 /**
1881  * Gets a checksum for a unit.
1882  *
1883  * In MP games the descriptions are locally generated and might differ, so it
1884  * should be possible to discard them. Not sure whether replays suffer the
1885  * same problem.
1886  *
1887  * @param u this unit
1888  *
1889  * @returns the checksum for a unit
1890  */
1891 std::string get_checksum(const unit& u);
void set_experience(int xp)
Sets the current experience point amount.
Definition: unit.hpp:514
std::vector< attack_ptr > attack_list
bool move_interrupted() const
Check whether the unit&#39;s move has been interrupted.
Definition: unit.hpp:1321
int operator()(int v) const
Definition: unit.hpp:1108
int attacks_left() const
Gets the remaining number of attacks this unit can perform this turn.
Definition: unit.hpp:950
const unit_type * type_
Never nullptr.
Definition: unit.hpp:1719
attack_list attacks_
Definition: unit.hpp:1787
t_string type_name_
The displayed name of this unit type.
Definition: unit.hpp:1722
const map_location & loc() const
Definition: unit.hpp:89
bool empty() const
Definition: unit.hpp:78
void set_can_recruit(bool canrecruit)
Sets whether this unit can recruit other units.
Definition: unit.hpp:583
std::vector< std::string > recruit_list_
Definition: unit.hpp:1743
const unit_ability & back() const
Definition: unit.hpp:82
void set_big_profile(const std::string &value)
Definition: unit.hpp:570
config modifications_
Definition: unit.hpp:1813
int recall_cost_
Definition: unit.hpp:1741
utils::string_map modification_descriptions_
Definition: unit.hpp:1803
std::map< std::string, t_string > string_map
int jamming() const
Gets the unit&#39;s jamming points.
Definition: unit.hpp:1315
int vision() const
Gets the unit&#39;s vision points.
Definition: unit.hpp:1309
The unit is a guardian - it won&#39;t move unless a target is sighted.
Definition: unit.hpp:825
This class represents a single unit of a specific type.
Definition: unit.hpp:99
void intrusive_ptr_release(const unit *)
Definition: unit.cpp:230
boost::iterator_range< boost::indirect_iterator< attack_list::iterator > > attack_itors
int movement_cost(const t_translation::terrain_code &terrain) const
Get the unit&#39;s movement cost on a particular terrain.
Definition: unit.hpp:1349
The unit is uncovered - it was hiding but has been spotted.
Definition: unit.hpp:822
std::string image_mods_
Definition: unit.hpp:1747
void set_usage(const std::string &usage)
Sets this unit&#39;s usage.
Definition: unit.hpp:651
bool is_flying() const
Check if the unit is a flying unit.
Definition: unit.hpp:1375
const std::string & effect_image_mods() const
Gets any IPF image mods applied by effects.
Definition: unit.hpp:1495
std::vector< std::string > advances_to_
Definition: unit.hpp:1716
t_string name_
Definition: unit.hpp:1728
void emplace_back(T &&... args)
Definition: unit.hpp:87
iterator erase(const iterator &erase_it)
Definition: unit.hpp:84
Variant for storing WML attributes.
std::vector< t_string > trait_names_
Definition: unit.hpp:1795
int vision_
Definition: unit.hpp:1759
void set_appearance_changed(bool value)
Definition: unit.hpp:1707
unit_race::GENDER gender() const
The gender of this unit.
Definition: unit.hpp:426
void rename(const std::string &name)
Attempts to rename this unit&#39;s translatable display name, taking the &#39;unrenamable&#39; flag into account...
Definition: unit.hpp:388
const movetype & movement_type() const
Get the unit&#39;s movement type.
Definition: unit.hpp:1339
int hitpoints() const
The current number of hitpoints this unit has.
Definition: unit.hpp:460
config events_
Definition: unit.hpp:1779
std::string operator()(int v) const
Definition: unit.hpp:1128
unit_type::ALIGNMENT alignment_
Definition: unit.hpp:1744
const T & get_or_default(const std::unique_ptr< T > &v)
Definition: unit.hpp:36
map_location::DIRECTION facing_
Definition: unit.hpp:1792
std::string flag_rgb_
Definition: unit.hpp:1746
void set_user_end_turn(bool value=true)
Set whether the user ended their turn.
Definition: unit.hpp:730
config & variables()
Gets any user-defined variables this unit &#39;owns&#39;.
Definition: unit.hpp:662
void set_image_ellipse(const std::string &ellipse)
Set the unit&#39;s ellipse image.
Definition: unit.hpp:1480
void set_small_profile(const std::string &value)
Definition: unit.hpp:557
int jamming_
Definition: unit.hpp:1760
int unit_value_
Definition: unit.hpp:1798
bool generate_name_
Definition: unit.hpp:1826
bool hold_position_
Definition: unit.hpp:1764
std::vector< t_string > special_notes_
Definition: unit.hpp:1819
const std::string & variation() const
The ID of the variation of this unit&#39;s type.
Definition: unit.hpp:533
const config & variables() const
Const overload of variables.
Definition: unit.hpp:668
unit_ptr clone() const
Definition: unit.hpp:174
The unit is poisoned - it loses health each turn.
Definition: unit.hpp:820
A terrain string which is converted to a terrain is a string with 1 or 2 layers the layers are separa...
Definition: translation.hpp:50
void set_location(const map_location &loc)
Sets this unit&#39;s map location.
Definition: unit.hpp:1276
map_location::DIRECTION facing() const
The current directin this unit is facing within its hex.
Definition: unit.hpp:1282
The unit is petrified - it cannot move or be attacked.
Definition: unit.hpp:821
config variables_
Definition: unit.hpp:1778
bool take_hit(int damage)
Damage the unit.
Definition: unit.hpp:775
const std::string & type() const
Definition: attack_type.hpp:42
int resistance_against(const attack_type &atk, bool attacker, const map_location &loc, const_attack_ptr weapon=nullptr) const
The unit&#39;s resistance against a given attack.
Definition: unit.hpp:996
const std::string & type_id() const
The id of this unit&#39;s type.
Definition: unit.hpp:327
bool resting() const
Checks whether this unit is &#39;resting&#39;.
Definition: unit.hpp:1235
attack_itors make_attack_itors(attack_list &atks)
The basic "size" of the unit - flying, small land, large land, etc.
Definition: movetype.hpp:41
std::string image_ellipse() const
Get the unit&#39;s ellipse image.
Definition: unit.hpp:1474
bool is_healthy_
Definition: unit.hpp:1801
bool get_emit_zoc() const
Gets the raw zone-of-control flag, disregarding incapacitated.
Definition: unit.hpp:1253
boost::ptr_vector< config > advancements_list
Definition: unit.hpp:282
unit_ability & front()
Definition: unit.hpp:79
void set_interrupted_move(const map_location &interrupted_move)
Set the target location of the unit&#39;s interrupted move.
Definition: unit.hpp:1333
utils::string_map get_base_resistances() const
Gets resistances without any abilities applied.
Definition: unit.hpp:1002
bool get_hidden() const
Gets whether this unit is currently hidden on the map.
Definition: unit.hpp:679
int max_hit_points_
Definition: unit.hpp:1735
std::vector< unit_ability > cfgs_
Definition: unit.hpp:92
bool is_healthy() const
Gets whether this unit is healthy - ie, always rest heals.
Definition: unit.hpp:1162
attack_ptr add_attack(attack_itors::iterator position, Args &&... args)
Adds a new attack to the unit.
Definition: unit.hpp:901
unit_type::ALIGNMENT alignment() const
The alignment of this unit.
Definition: unit.hpp:436
static std::string type()
Definition: unit.hpp:1082
int cost() const
How much gold is required to recruit this unit.
Definition: unit.hpp:598
void set_total_movement(int value)
Definition: unit.hpp:1180
static unit_ptr create(const config &cfg, bool use_traits=false, const vconfig *vcfg=nullptr)
Initializes a unit from a config.
Definition: unit.hpp:155
double hp_bar_scaling() const
The factor by which the HP bar should be scaled.
Definition: unit.hpp:691
std::string small_profile_
Definition: unit.hpp:1831
bool get_ability_bool(const std::string &tag_name) const
Checks whether this unit currently possesses or is affected by a given ability.
Definition: unit.hpp:1563
void set_id(const std::string &id)
Sets this unit&#39;s string ID.
Definition: unit.hpp:350
A single unit type that the player may recruit.
Definition: types.hpp:42
static std::map< std::string, state_t > known_boolean_state_names_
Definition: unit.hpp:1776
std::vector< unit_ability >::iterator iterator
Definition: unit.hpp:69
state_t
Built-in status effects known to the engine.
Definition: unit.hpp:818
map_location loc_
void set_name(const t_string &name)
Sets this unit&#39;s translatable display name.
Definition: unit.hpp:377
std::unique_ptr< unit_formula_manager > formula_man_
Definition: unit.hpp:1755
bool hold_position() const
Whether the unit has been instructed to hold its position.
Definition: unit.hpp:710
void intrusive_ptr_add_ref(const unit *)
Intrusive Pointer interface.
Definition: unit.cpp:215
void set_level(int level)
Sets the current level of this unit.
Definition: unit.hpp:526
const unit_type & type() const
This unit&#39;s type, accounting for gender and variation.
Definition: unit.hpp:316
int vision_cost(const t_translation::terrain_code &terrain) const
Get the unit&#39;s vision cost on a particular terrain.
Definition: unit.hpp:1359
unsigned int experience_to_advance() const
The number of experience points this unit needs to level up, or 0 if current XP > max XP...
Definition: unit.hpp:502
bool poisoned() const
Check if the unit has been poisoned.
Definition: unit.hpp:853
std::string role_
Definition: unit.hpp:1786
void write(std::ostream &out, const configr_of &cfg, unsigned int level)
Definition: parser.cpp:762
This class stores all the data for a single &#39;side&#39; (in game nomenclature).
Definition: team.hpp:44
void set_max_attacks(int value)
Definition: unit.hpp:939
UNIT_ATTRIBUTE
Definition: unit.hpp:119
int damage_from(const attack_type &attack, bool attacker, const map_location &loc, const_attack_ptr weapon=nullptr) const
Calculates the damage this unit would take from a certain attack.
Definition: unit.hpp:928
struct utils::detail::formula_initer init
const std::string & id() const
Gets this unit&#39;s id.
Definition: unit.hpp:344
void swap(unit &lhs, unit &rhs)
Implement non-member swap function for std::swap (calls unit::swap).
Definition: unit.cpp:2762
std::pair< const config *, map_location > unit_ability
Definition: unit.hpp:48
unit_ability_list(const map_location &loc=map_location())
Definition: unit.hpp:53
const unit_ability & front() const
Definition: unit.hpp:80
bool get_attr_changed(UNIT_ATTRIBUTE attr) const
Definition: unit.hpp:148
std::string profile_
Definition: unit.hpp:1830
int max_movement_
Definition: unit.hpp:1758
std::vector< unit_ability >::const_iterator const_iterator
Definition: unit.hpp:70
const config & recall_filter() const
Gets the filter constraints upon which units this unit may recall, if able.
Definition: unit.hpp:617
void set_max_experience(int value)
Definition: unit.hpp:495
void set_recall_cost(int recall_cost)
Sets the cost of recalling this unit.
Definition: unit.hpp:611
const_iterator end() const
Definition: unit.hpp:75
upkeep_t upkeep_raw() const
Gets the raw variant controlling the upkeep value.
Definition: unit.hpp:1141
const t_string & name() const
Gets this unit&#39;s translatable display name.
Definition: unit.hpp:367
static unit_ptr create(const unit_type &t, int side, bool real_unit, unit_race::GENDER gender=unit_race::NUM_GENDERS)
Initializes a unit from a unit type.
Definition: unit.hpp:167
unit_ptr shared_from_this()
Definition: unit.hpp:179
std::vector< std::string > advances_to_t
Definition: unit.hpp:198
int max_experience() const
The max number of experience points this unit can have.
Definition: unit.hpp:490
const map_location & get_goto() const
The map location to which this unit is moving over multiple turns, if any.
Definition: unit.hpp:1297
Object which temporarily resets a unit&#39;s movement.
Definition: unit.hpp:1867
int level() const
The current level of this unit.
Definition: unit.hpp:520
int max_experience_
Definition: unit.hpp:1737
void set_alignment(unit_type::ALIGNMENT alignment)
Sets the alignment of this unit.
Definition: unit.hpp:442
const std::vector< t_string > & trait_names() const
Gets the names of the currently registered traits.
Definition: unit.hpp:1036
const std::vector< std::string > & overlays() const
Get the unit&#39;s overlay images.
Definition: unit.hpp:1508
const t_string & type_name() const
Gets the translatable name of this unit&#39;s type.
Definition: unit.hpp:333
The unit has not moved.
Definition: unit.hpp:823
std::bitset< UA_COUNT > changed_attributes_
Definition: unit.hpp:1835
unit_race::GENDER gender_
Definition: unit.hpp:1753
const config & get_modifications() const
Set the raw modifications.
Definition: unit.hpp:1394
int attacks_left(bool base_value) const
Gets the remaining number of attacks this unit can perform this turn.
Definition: unit.hpp:962
int hit_points_
Definition: unit.hpp:1734
void set_hitpoints(int hp)
Sets the current hitpoint amount.
Definition: unit.hpp:478
static const ::config * terrain
The terrain used to create the cache.
Definition: minimap.cpp:130
std::unique_ptr< std::string > ellipse_
Definition: unit.hpp:1823
bool random_traits_
Definition: unit.hpp:1825
void set_attr_changed(UNIT_ATTRIBUTE attr)
Definition: unit.hpp:143
std::string get_checksum(const unit &u)
Gets a checksum for a unit.
Definition: unit.cpp:2667
std::string flag_rgb
config abilities_
Definition: unit.hpp:1814
std::vector< std::string > overlays_
Definition: unit.hpp:1784
Encapsulates the map of the game.
Definition: location.hpp:42
void set_unrenamable(bool unrenamable)
Sets the &#39;unrenamable&#39; flag.
Definition: unit.hpp:408
std::pair< int, map_location > lowest(const std::string &key, int def=0) const
Definition: unit.hpp:60
bool hidden_
Definition: unit.hpp:1810
bool user_end_turn() const
Check whether the user ended their turn.
Definition: unit.hpp:751
const advancements_list & modification_advancements() const
The raw, unparsed data for modification advancements.
Definition: unit.hpp:284
bool has_moved() const
Checks if this unit has moved.
Definition: unit.hpp:1221
movetype movement_type_
Definition: unit.hpp:1762
int jamming_cost(const t_translation::terrain_code &terrain) const
Get the unit&#39;s jamming cost on a particular terrain.
Definition: unit.hpp:1369
config filter_recall_
Definition: unit.hpp:1780
int max_attacks_
Definition: unit.hpp:1769
unit_animation_component & anim_comp() const
Definition: unit.hpp:1453
void set_undead_variation(const std::string &value)
The ID of the undead variation (ie, dwarf, swimmer) of this unit.
Definition: unit.hpp:539
void set_attacks(int left)
Sets the number of attacks this unit has left this turn.
Definition: unit.hpp:971
int max_hitpoints() const
The max number of hitpoints this unit can have.
Definition: unit.hpp:466
Visitor helper class to fetch the appropriate upkeep value.
Definition: unit.hpp:1091
const std::string & get_role() const
Gets this unit&#39;s role.
Definition: unit.hpp:628
map_location interrupted_move_
Definition: unit.hpp:1799
bool advances() const
Checks whether this unit is eligible for level-up.
Definition: unit.hpp:243
void set_emit_zoc(bool val)
Sets the raw zone-of-control flag.
Definition: unit.hpp:1259
bool can_recruit() const
Whether this unit can recruit other units - ie, are they a leader unit.
Definition: unit.hpp:577
iterator begin()
Definition: unit.hpp:72
std::string usage() const
Gets this unit&#39;s usage.
Definition: unit.hpp:645
bool canrecruit_
Definition: unit.hpp:1742
attack_itors attacks()
Gets an iterator over this unit&#39;s attacks.
Definition: unit.hpp:884
int experience_
Definition: unit.hpp:1736
std::unique_ptr< std::string > usage_
Definition: unit.hpp:1821
int operator()(const upkeep_full &) const
Full upkeep equals the unit&#39;s level.
Definition: unit.hpp:1097
n_unit::unit_id underlying_id_
Definition: unit.hpp:1729
double xp_bar_scaling_
Definition: unit.hpp:1811
bool has_goto() const
Gets whether this unit has a multi-turn destination set.
Definition: unit.hpp:1291
DIRECTION
Valid directions which can be moved in our hexagonal world.
Definition: location.hpp:44
t_string description_
Definition: unit.hpp:1818
const unit_race * race() const
Gets this unit&#39;s race.
Definition: unit.hpp:454
int attacks_left_
Definition: unit.hpp:1768
void heal_fully()
Fully heal the unit, restoring it to max hitpoints.
Definition: unit.hpp:790
boost::variant< upkeep_full, upkeep_loyal, int > upkeep_t
Definition: unit.hpp:1134
void set_max_hitpoints(int value)
Definition: unit.hpp:471
void set_goto(const map_location &new_goto)
Sets this unit&#39;s long term destination.
Definition: unit.hpp:1303
The unit cannot be healed.
Definition: unit.hpp:824
std::unique_ptr< std::string > halo_
Definition: unit.hpp:1822
std::enable_if_t<!std::is_same< int, T >::value, std::string > operator()(T &) const
Definition: unit.hpp:1122
std::shared_ptr< attack_type > attack_ptr
Definition: ptr.hpp:36
const_iterator begin() const
Definition: unit.hpp:73
advancements_list advancements_
Definition: unit.hpp:1816
const std::vector< std::string > & recruits() const
The type IDs of the other units this unit may recruit, if possible.
Definition: unit.hpp:589
double xp_bar_scaling() const
The factor by which the XP bar should be scaled.
Definition: unit.hpp:700
void set_role(const std::string &role)
Sets a unit&#39;s role.
Definition: unit.hpp:634
long ref_count_
Definition: unit.hpp:1711
std::unique_ptr< unit_animation_component > anim_comp_
Definition: unit.hpp:1808
const std::string & undead_variation() const
Definition: unit.hpp:544
static std::string type()
Definition: unit.hpp:1087
std::string image_halo() const
Get the unit&#39;s halo image.
Definition: unit.hpp:1465
unit_formula_manager & formula_manager() const
Get the unit formula manager.
Definition: unit.hpp:1667
const_attack_itors attacks() const
Const overload of attacks.
Definition: unit.hpp:890
Definition: display.hpp:44
boost::intrusive_ptr< unit > unit_ptr
Definition: ptr.hpp:29
int movement_
Definition: unit.hpp:1757
static const std::set< std::string > builtin_effects
Definition: unit.hpp:1426
bool is_fearless() const
Gets whether this unit is fearless - ie, unaffected by time of day.
Definition: unit.hpp:1156
void toggle_hold_position()
Toggle the unit&#39;s hold position status.
Definition: unit.hpp:718
double t
Definition: astarsearch.cpp:64
unsigned int experience_overflow() const
The number of experience points over max this unit has, or 0 if current XP < max XP.
Definition: unit.hpp:508
int experience() const
The current number of experience points this unit has.
Definition: unit.hpp:484
upkeep_t upkeep_
Definition: unit.hpp:1828
bool unrenamable_
Definition: unit.hpp:1749
int level_
Definition: unit.hpp:1739
lu_byte left
Definition: lparser.cpp:1026
const map_location & get_location() const
The current map location this unit is at.
Definition: unit.hpp:1266
std::bitset< num_bool_states > known_boolean_states_
Definition: unit.hpp:1775
int movement_left(bool base_value) const
Gets how far a unit can move.
Definition: unit.hpp:1203
void set_upkeep(upkeep_t v)
Sets the upkeep value to a specific value value.
Definition: unit.hpp:1147
bool appearance_changed() const
Definition: unit.hpp:1708
A variable-expanding proxy for the config class.
Definition: variable.hpp:42
void adjust_profile(std::string &profile)
Definition: types.cpp:1530
bool can_advance() const
Checks whether this unit has any options to advance to.
Definition: unit.hpp:232
const unit_race * race_
Never nullptr, but may point to the null race.
Definition: unit.hpp:1725
std::string variation_
Definition: unit.hpp:1732
t_string unit_description() const
A detailed description of this unit.
Definition: unit.hpp:414
void set_side(unsigned int new_side)
Sets the side this unit belongs to.
Definition: unit.hpp:310
bool emit_zoc_
Definition: unit.hpp:1782
bool incapacitated() const
Check if the unit has been petrified.
Definition: unit.hpp:862
std::map< map_location, bool > invisibility_cache_
Hold the visibility status cache for a unit, when not uncovered.
Definition: unit.hpp:1844
int operator()(const upkeep_loyal &) const
Loyal units cost no upkeep.
Definition: unit.hpp:1103
int total_movement() const
The maximum moves this unit has.
Definition: unit.hpp:1175
const map_location goto_
Definition: move.cpp:309
void set_resting(bool rest)
Sets this unit&#39;s resting status.
Definition: unit.hpp:1241
std::string id_
Definition: unit.hpp:1727
void clear_visibility_cache() const
Clears the cache.
Definition: unit.hpp:1852
bool emits_zoc() const
Tests whether the unit has a zone-of-control, considering incapacitated.
Definition: unit.hpp:1247
int side() const
The side this unit belongs to.
Definition: unit.hpp:304
std::vector< t_string > trait_descriptions_
Definition: unit.hpp:1796
map_location loc_
Definition: unit.hpp:93
bool resting_
Definition: unit.hpp:1766
long ref_count() const
Definition: unit.hpp:1699
boost::iterator_range< boost::indirect_iterator< attack_list::const_iterator > > const_attack_itors
config & get_modifications()
Get the raw modifications.
Definition: unit.hpp:1388
Visitor helper struct to fetch the upkeep type flag if applicable, or the the value otherwise...
Definition: unit.hpp:1118
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:68
bool slowed() const
Check if the unit has been slowed.
Definition: unit.hpp:871
map_location loc_
Definition: unit.hpp:1714
std::shared_ptr< const attack_type > const_attack_ptr
Definition: ptr.hpp:37
void toggle_user_end_turn()
Toggle whether the user ended their turn.
Definition: unit.hpp:739
upkeep_value_visitor(const unit &unit)
Definition: unit.hpp:1094
const advances_to_t & advances_to() const
Gets the possible types this unit can advance to on level-up.
Definition: unit.hpp:204
bool unrenamable() const
Whether this unit can be renamed.
Definition: unit.hpp:400
int recall_cost() const
How much gold it costs to recall this unit, or -1 if the side&#39;s default recall cost is used...
Definition: unit.hpp:605
int side_
Definition: unit.hpp:1751
const std::vector< t_string > & unit_special_notes() const
The unit&#39;s special notes.
Definition: unit.hpp:420
std::string::const_iterator iterator
Definition: tokenizer.hpp:24
int movement_left() const
Gets how far a unit can move, considering the incapacitated flag.
Definition: unit.hpp:1191
std::size_t underlying_id() const
This unit&#39;s unique internal ID.
Definition: unit.hpp:356
iterator end()
Definition: unit.hpp:74
int max_attacks() const
The maximum number of attacks this unit may perform per turn, usually 1.
Definition: unit.hpp:934
bool end_turn_
Definition: unit.hpp:1765
std::pair< int, map_location > highest(const std::string &key, int def=0) const
Definition: unit.hpp:56
unit_ability_list get_abilities(const std::string &tag_name, const_attack_ptr weapon=nullptr, const_attack_ptr opp_weapon=nullptr) const
Gets the unit&#39;s active abilities of a particular type.
Definition: unit.hpp:1581
std::set< std::string > states_
Definition: unit.hpp:1771
std::string undead_variation_
Definition: unit.hpp:1731
const map_location & get_interrupted_move() const
Get the target location of the unit&#39;s interrupted move.
Definition: unit.hpp:1327
const std::vector< t_string > & trait_descriptions() const
Gets the descriptions of the currently registered traits.
Definition: unit.hpp:1046
unit_ability & back()
Definition: unit.hpp:81