The Battle for Wesnoth  1.17.5+dev
attack_type.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 "map/location.hpp"
19 #include "tstring.hpp"
20 #include "config.hpp"
21 #include <string>
22 #include <vector>
23 #include <cassert>
24 
25 #include <boost/iterator/indirect_iterator.hpp>
26 #include <boost/range/iterator_range.hpp>
27 #include <boost/dynamic_bitset_fwd.hpp>
28 
29 #include "units/ptr.hpp" // for attack_ptr
30 
31 class unit_ability_list;
32 class unit_type;
33 namespace wfl {
34  class map_formula_callable;
35 }
36 //the 'attack type' is the type of attack, how many times it strikes,
37 //and how much damage it does.
38 class attack_type : public std::enable_shared_from_this<attack_type>
39 {
40 public:
41 
42  explicit attack_type(const config& cfg);
43  const t_string& name() const { return description_; }
44  const std::string& id() const { return id_; }
45  const std::string& type() const { return type_; }
46  const std::string& icon() const { return icon_; }
47  const std::string& range() const { return range_; }
48  int min_range() const { return min_range_; }
49  int max_range() const { return max_range_; }
50  std::string accuracy_parry_description() const;
51  int accuracy() const { return accuracy_; }
52  int parry() const { return parry_; }
53  int damage() const { return damage_; }
54  int num_attacks() const { return num_attacks_; }
55  double attack_weight() const { return attack_weight_; }
56  double defense_weight() const { return defense_weight_; }
57  const config &specials() const { return specials_; }
58 
59  void set_name(const t_string& value) { description_ = value; set_changed(true); }
60  void set_id(const std::string& value) { id_ = value; set_changed(true); }
61  void set_type(const std::string& value) { type_ = value; set_changed(true); }
62  void set_icon(const std::string& value) { icon_ = value; set_changed(true); }
63  void set_range(const std::string& value) { range_ = value; set_changed(true); }
64  void set_accuracy(int value) { accuracy_ = value; set_changed(true); }
65  void set_parry(int value) { parry_ = value; set_changed(true); }
66  void set_damage(int value) { damage_ = value; set_changed(true); }
67  void set_num_attacks(int value) { num_attacks_ = value; set_changed(true); }
68  void set_attack_weight(double value) { attack_weight_ = value; set_changed(true); }
69  void set_defense_weight(double value) { defense_weight_ = value; set_changed(true); }
70  void set_specials(config value) { specials_ = value; set_changed(true); }
71 
72 
73  // In unit_abilities.cpp:
74 
75  /**
76  * @return True iff the special @a special is active.
77  * @param special The special being checked.
78  * @param simple_check If true, check whether the unit has the special. Else, check whether the special is currently active.
79  * @param special_id If true, match @a special against the @c id of special tags.
80  * @param special_tags If true, match @a special against the tag name of special tags.
81  */
82  bool has_special(const std::string& special, bool simple_check=false, bool special_id=true, bool special_tags=true) const;
83  unit_ability_list get_specials(const std::string& special) const;
84  std::vector<std::pair<t_string, t_string>> special_tooltips(boost::dynamic_bitset<>* active_list = nullptr) const;
85  std::string weapon_specials(bool is_backstab=false) const;
86  std::string weapon_specials_value(const std::set<std::string> checking_tags) const;
87 
88  /** Calculates the number of attacks this weapon has, considering specials. */
89  void modified_attacks(bool is_backstab, unsigned & min_attacks,
90  unsigned & max_attacks) const;
91  /** Returns the damage per attack of this weapon, considering specials. */
92  int modified_damage(bool is_backstab) const;
93  /** Returns list for weapon like abilities for each ability type. */
94  unit_ability_list get_weapon_ability(const std::string& ability) const;
95  /** Returns list who contains get_weapon_ability and get_specials list for each ability type */
96  unit_ability_list get_specials_and_abilities(const std::string& special) const;
97  /** used for abilities used like weapon
98  * @return True if the ability @a special is active.
99  * @param special The special being checked.
100  * @param special_id If true, match @a special against the @c id of special tags.
101  * @param special_tags If true, match @a special against the tag name of special tags.
102  */
103  bool has_weapon_ability(const std::string& special, bool special_id=true, bool special_tags=true) const;
104  /** used for abilities used like weapon and true specials
105  * @return True if the ability @a special is active.
106  * @param special The special being checked.
107  * @param special_id If true, match @a special against the @c id of special tags.
108  * @param special_tags If true, match @a special against the tag name of special tags.
109  */
110  bool has_special_or_ability(const std::string& special, bool special_id=true, bool special_tags=true) const;
111 
112  // In unit_types.cpp:
113 
114  bool matches_filter(const config& filter) const;
115  bool apply_modification(const config& cfg);
116  bool describe_modification(const config& cfg,std::string* description);
117 
118  int movement_used() const { return movement_used_; }
119  void set_movement_used(int value) { movement_used_ = value; }
120 
121  void write(config& cfg) const;
122  inline config to_config() const { config c; write(c); return c; }
123 
124  void add_formula_context(wfl::map_formula_callable&) const;
125 private:
126  // In unit_abilities.cpp:
127 
128  // Configured as a bit field, in case that is useful.
129  enum AFFECTS { AFFECT_SELF=1, AFFECT_OTHER=2, AFFECT_EITHER=3 };
130  /** overwrite_special_checking : return an unit_ability_list list after checking presence or not of overwrite_specials
131  * @param ability The special ability type who is being checked.
132  * @param temp_list the list checked and returned.
133  * @param abil_list list checked for verify presence of overwrite_specials .
134  * @param filter_self name of [filter_"self/student"] if is abilities or specials who are checked
135  */
136  unit_ability_list overwrite_special_checking(const std::string& ability, unit_ability_list temp_list, const unit_ability_list& abil_list, const std::string& filter_self = "filter_self") const;
137  /** check_self_abilities : return an boolean value for checking of activities of abilities used like weapon
138  * @return True if the special @a special is active.
139  * @param cfg the config to one special ability checked.
140  * @param special The special ability type who is being checked.
141  */
142  bool check_self_abilities(const config& cfg, const std::string& special) const;
143  /** check_adj_abilities : return an boolean value for checking of activities of abilities used like weapon
144  * @return True if the special @a special is active.
145  * @param cfg the config to one special ability checked.
146  * @param special The special ability type who is being checked.
147  * @param dir direction to research a unit adjacent to self_.
148  * @param from unit adjacent to self_ is checked.
149  */
150  bool check_adj_abilities(const config& cfg, const std::string& special, int dir, const unit& from) const;
151  bool special_active(const config& special, AFFECTS whom, const std::string& tag_name,
152  bool include_backstab=true, const std::string& filter_self ="filter_self") const;
153 
154 /** weapon_specials_impl_self and weapon_specials_impl_adj : check if special name can be added.
155  * @param[in,out] temp_string the string modified and returned
156  * @param[in] self the unit checked.
157  * @param[in] self_attack the attack used by unit checked in this function.
158  * @param[in] other_attack the attack used by opponent to unit checked.
159  * @param[in] self_loc location of the unit checked.
160  * @param[in] whom determine if unit affected or not by special ability.
161  * @param[in,out] checking_name the reference for checking if a name is already added
162  * @param[in] checking_tags the reference for checking if special ability type can be used
163  * @param[in] leader_bool If true, [leadership] abilities are checked.
164  */
165  static void weapon_specials_impl_self(
166  std::string& temp_string,
167  unit_const_ptr self,
168  const_attack_ptr self_attack,
169  const_attack_ptr other_attack,
170  const map_location& self_loc,
171  AFFECTS whom,
172  std::set<std::string>& checking_name,
173  const std::set<std::string>& checking_tags={},
174  bool leader_bool=false
175  );
176 
177  static void weapon_specials_impl_adj(
178  std::string& temp_string,
179  unit_const_ptr self,
180  const_attack_ptr self_attack,
181  const_attack_ptr other_attack,
182  const map_location& self_loc,
183  AFFECTS whom,
184  std::set<std::string>& checking_name,
185  const std::set<std::string>& checking_tags={},
186  const std::string& affect_adjacents="",
187  bool leader_bool=false
188  );
189  /** check_self_abilities_impl : return an boolean value for checking of activities of abilities used like weapon
190  * @return True if the special @a tag_name is active.
191  * @param self_attack the attack used by unit checked in this function.
192  * @param other_attack the attack used by opponent to unit checked.
193  * @param special the config to one special ability checked.
194  * @param u the unit checked.
195  * @param loc location of the unit checked.
196  * @param whom determine if unit affected or not by special ability.
197  * @param tag_name The special ability type who is being checked.
198  * @param leader_bool If true, [leadership] abilities are checked.
199  */
200  static bool check_self_abilities_impl(
201  const_attack_ptr self_attack,
202  const_attack_ptr other_attack,
203  const config& special,
204  unit_const_ptr u,
205  const map_location& loc,
206  AFFECTS whom,
207  const std::string& tag_name,
208  bool leader_bool=false
209  );
210 
211 
212  /** check_adj_abilities_impl : return an boolean value for checking of activities of abilities used like weapon in unit adjacent to fighter
213  * @return True if the special @a tag_name is active.
214  * @param self_attack the attack used by unit who fight.
215  * @param other_attack the attack used by opponent.
216  * @param special the config to one special ability checked.
217  * @param u the unit who is or not affected by an abilities owned by @a from.
218  * @param from unit adjacent to @a u is checked.
219  * @param dir direction to research a unit adjacent to @a u.
220  * @param loc location of the unit checked.
221  * @param whom determine if unit affected or not by special ability.
222  * @param tag_name The special ability type who is being checked.
223  * @param leader_bool If true, [leadership] abilities are checked.
224  */
225  static bool check_adj_abilities_impl(
226  const_attack_ptr self_attack,
227  const_attack_ptr other_attack,
228  const config& special,
229  unit_const_ptr u,
230  const unit& from,
231  int dir,
232  const map_location& loc,
233  AFFECTS whom,
234  const std::string& tag_name,
235  bool leader_bool=false
236  );
237 
238  static bool special_active_impl(
239  const_attack_ptr self_attack,
240  const_attack_ptr other_attack,
241  const config& special,
242  AFFECTS whom,
243  const std::string& tag_name,
244  bool include_backstab=true,
245  const std::string& filter_self ="filter_self"
246  );
247 
248  // Used via specials_context() to control which specials are
249  // considered active.
250  friend class specials_context_t;
251  mutable map_location self_loc_, other_loc_;
254  mutable bool is_attacker_;
256  mutable bool is_for_listing_ = false;
257 public:
259  std::shared_ptr<const attack_type> parent;
260  friend class attack_type;
261  /** Initialize weapon specials context for listing */
262  explicit specials_context_t(const attack_type& weapon, bool attacking);
263  /** Initialize weapon specials context for a unit type */
264  specials_context_t(const attack_type& weapon, const unit_type& self_type, const map_location& loc, bool attacking = true);
265  /** Initialize weapon specials context for a single unit */
266  specials_context_t(const attack_type& weapon, const_attack_ptr other_weapon,
267  unit_const_ptr self, unit_const_ptr other,
268  const map_location& self_loc, const map_location& other_loc,
269  bool attacking);
270  /** Initialize weapon specials context for a pair of units */
271  specials_context_t(const attack_type& weapon, unit_const_ptr self, const map_location& loc, bool attacking);
272  specials_context_t(const specials_context_t&) = delete;
273  bool was_moved = false;
274  public:
275  // Destructor at least needs to be public for all this to work.
278  };
279  // Set up a specials context.
280  // Usage: auto ctx = weapon.specials_context(...);
282  const map_location& unit_loc, const map_location& other_loc,
283  bool attacking, const_attack_ptr other_attack) const {
284  return specials_context_t(*this, other_attack, self, other, unit_loc, other_loc, attacking);
285  }
286  specials_context_t specials_context(unit_const_ptr self, const map_location& loc, bool attacking = true) const {
287  return specials_context_t(*this, self, loc, attacking);
288  }
289  specials_context_t specials_context(const unit_type& self_type, const map_location& loc, bool attacking = true) const {
290  return specials_context_t(*this, self_type, loc, attacking);
291  }
292  specials_context_t specials_context_for_listing(bool attacking = true) const {
293  return specials_context_t(*this, attacking);
294  }
295  void set_changed(bool value)
296  {
297  changed_ = value;
298  }
299  bool get_changed() const
300  {
301  return changed_;
302  }
303 private:
304 
306  std::string id_;
307  std::string type_;
308  std::string icon_;
309  std::string range_;
311  int damage_;
315 
318  int parry_;
320  bool changed_;
321 };
322 
323 using attack_list = std::vector<attack_ptr>;
324 using attack_itors = boost::iterator_range<boost::indirect_iterator<attack_list::iterator>>;
325 using const_attack_itors = boost::iterator_range<boost::indirect_iterator<attack_list::const_iterator>>;
326 
328  return boost::make_iterator_range(boost::make_indirect_iterator(atks.begin()), boost::make_indirect_iterator(atks.end()));
329 }
330 
332  return boost::make_iterator_range(boost::make_indirect_iterator(atks.begin()), boost::make_indirect_iterator(atks.end()));
333 }
std::vector< attack_ptr > attack_list
std::string icon_
const std::string & id() const
Definition: attack_type.hpp:44
std::string type_
This class represents a single unit of a specific type.
Definition: unit.hpp:120
boost::iterator_range< boost::indirect_iterator< attack_list::iterator > > attack_itors
int max_range() const
Definition: attack_type.hpp:49
void set_num_attacks(int value)
Definition: attack_type.hpp:67
int parry() const
Definition: attack_type.hpp:52
unit_const_ptr other_
const std::string & type() const
Definition: attack_type.hpp:45
attack_itors make_attack_itors(attack_list &atks)
Definitions for the interface to Wesnoth Markup Language (WML).
void set_changed(bool value)
int num_attacks() const
Definition: attack_type.hpp:54
A single unit type that the player may recruit.
Definition: types.hpp:45
double defense_weight_
void set_name(const t_string &value)
Definition: attack_type.hpp:59
std::shared_ptr< const unit > unit_const_ptr
Definition: ptr.hpp:27
int min_range() const
Definition: attack_type.hpp:48
void write(std::ostream &out, const configr_of &cfg, unsigned int level)
Definition: parser.cpp:764
int movement_used() const
double attack_weight_
const t_string & name() const
Definition: attack_type.hpp:43
std::string range_
specials_context_t specials_context(const unit_type &self_type, const map_location &loc, bool attacking=true) const
const std::string & range() const
Definition: attack_type.hpp:47
const std::string & icon() const
Definition: attack_type.hpp:46
bool get_changed() const
config specials_
void set_defense_weight(double value)
Definition: attack_type.hpp:69
void set_specials(config value)
Definition: attack_type.hpp:70
t_string description_
Encapsulates the map of the game.
Definition: location.hpp:38
specials_context_t specials_context(unit_const_ptr self, const map_location &loc, bool attacking=true) const
void set_damage(int value)
Definition: attack_type.hpp:66
int damage() const
Definition: attack_type.hpp:53
int accuracy() const
Definition: attack_type.hpp:51
const config & specials() const
Definition: attack_type.hpp:57
double attack_weight() const
Definition: attack_type.hpp:55
unit_const_ptr self_
double defense_weight() const
Definition: attack_type.hpp:56
friend class specials_context_t
void set_range(const std::string &value)
Definition: attack_type.hpp:63
void set_parry(int value)
Definition: attack_type.hpp:65
std::string id_
Definition: contexts.hpp:44
const_attack_ptr other_attack_
void set_icon(const std::string &value)
Definition: attack_type.hpp:62
void set_id(const std::string &value)
Definition: attack_type.hpp:60
specials_context_t specials_context_for_listing(bool attacking=true) const
config to_config() const
specials_context_t specials_context(unit_const_ptr self, unit_const_ptr other, const map_location &unit_loc, const map_location &other_loc, bool attacking, const_attack_ptr other_attack) const
boost::iterator_range< boost::indirect_iterator< attack_list::const_iterator > > const_attack_itors
void set_movement_used(int value)
std::shared_ptr< const attack_type > parent
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:60
mock_char c
std::shared_ptr< const attack_type > const_attack_ptr
Definition: ptr.hpp:34
void set_accuracy(int value)
Definition: attack_type.hpp:64
map_location self_loc_
void set_attack_weight(double value)
Definition: attack_type.hpp:68
void set_type(const std::string &value)
Definition: attack_type.hpp:61