The Battle for Wesnoth  1.17.0-dev
attack_type.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2003 - 2021
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 only_active=false, bool is_backstab=false) const;
86 
87  /** Calculates the number of attacks this weapon has, considering specials. */
88  void modified_attacks(bool is_backstab, unsigned & min_attacks,
89  unsigned & max_attacks) const;
90  /** Returns the damage per attack of this weapon, considering specials. */
91  int modified_damage(bool is_backstab) const;
92  /** Returns list for weapon like abilities for each ability type. */
93  unit_ability_list get_weapon_ability(const std::string& ability) const;
94  /** Returns list who contains get_weapon_ability and get_specials list for each ability type */
95  unit_ability_list get_specials_and_abilities(const std::string& special) const;
96  /** used for abilities used like weapon
97  * @return True if the ability @a special is active.
98  * @param special The special being checked.
99  * @param special_id If true, match @a special against the @c id of special tags.
100  * @param special_tags If true, match @a special against the tag name of special tags.
101  */
102  bool has_weapon_ability(const std::string& special, bool special_id=true, bool special_tags=true) const;
103  /** used for abilities used like weapon and true specials
104  * @return True if the ability @a special is active.
105  * @param special The special being checked.
106  * @param special_id If true, match @a special against the @c id of special tags.
107  * @param special_tags If true, match @a special against the tag name of special tags.
108  */
109  bool has_special_or_ability(const std::string& special, bool special_id=true, bool special_tags=true) const;
110 
111  // In unit_types.cpp:
112 
113  bool matches_filter(const config& filter) const;
114  bool apply_modification(const config& cfg);
115  bool describe_modification(const config& cfg,std::string* description);
116 
117  int movement_used() const { return movement_used_; }
118  void set_movement_used(int value) { movement_used_ = value; }
119 
120  void write(config& cfg) const;
121  inline config to_config() const { config c; write(c); return c; }
122 
123  void add_formula_context(wfl::map_formula_callable&) const;
124 private:
125  // In unit_abilities.cpp:
126 
127  // Configured as a bit field, in case that is useful.
128  enum AFFECTS { AFFECT_SELF=1, AFFECT_OTHER=2, AFFECT_EITHER=3 };
129  /** overwrite_special_checking : return an unit_ability_list list after checking presence or not of overwrite_specials
130  * @param ability The special ability type who is being checked.
131  * @param temp_list the list checked and returned.
132  * @param abil_list list checked for verify presence of overwrite_specials .
133  * @param filter_self name of [filter_"self/student"] if is abilities or specials who are checked
134  */
135  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;
136  /** check_self_abilities : return an boolean value for checking of activities of abilities used like weapon
137  * @return True if the special @a special is active.
138  * @param cfg the config to one special ability checked.
139  * @param special The special ability type who is being checked.
140  */
141  bool check_self_abilities(const config& cfg, const std::string& special) const;
142  /** check_adj_abilities : return an boolean value for checking of activities of abilities used like weapon
143  * @return True if the special @a special is active.
144  * @param cfg the config to one special ability checked.
145  * @param special The special ability type who is being checked.
146  * @param dir direction to research a unit adjacent to self_.
147  * @param from unit adjacent to self_ is checked.
148  */
149  bool check_adj_abilities(const config& cfg, const std::string& special, int dir, const unit& from) const;
150  bool special_active(const config& special, AFFECTS whom, const std::string& tag_name,
151  bool include_backstab=true, const std::string& filter_self ="filter_self") const;
152 
153  /** check_self_abilities_impl : return an boolean value for checking of activities of abilities used like weapon
154  * @return True if the special @a tag_name is active.
155  * @param self_attack the attack used by unit checked in this function.
156  * @param other_attack the attack used by opponent to unit checked.
157  * @param special the config to one special ability checked.
158  * @param u the unit checked.
159  * @param loc location of the unit checked.
160  * @param whom determine if unit affected or not by special ability.
161  * @param tag_name The special ability type who is being checked.
162  * @param leader_bool If true, [leadership] abilities are checked.
163  */
164  static bool check_self_abilities_impl(
165  const_attack_ptr self_attack,
166  const_attack_ptr other_attack,
167  const config& special,
168  unit_const_ptr u,
169  const map_location& loc,
170  AFFECTS whom,
171  const std::string& tag_name,
172  bool leader_bool=false
173  );
174 
175 
176  /** check_adj_abilities_impl : return an boolean value for checking of activities of abilities used like weapon in unit adjacent to fighter
177  * @return True if the special @a tag_name is active.
178  * @param self_attack the attack used by unit who fight.
179  * @param other_attack the attack used by opponent.
180  * @param special the config to one special ability checked.
181  * @param u the unit who is or not affected by an abilities owned by @a from.
182  * @param from unit adjacent to @a u is checked.
183  * @param dir direction to research a unit adjacent to @a u.
184  * @param loc location of the unit checked.
185  * @param whom determine if unit affected or not by special ability.
186  * @param tag_name The special ability type who is being checked.
187  * @param leader_bool If true, [leadership] abilities are checked.
188  */
189  static bool check_adj_abilities_impl(
190  const_attack_ptr self_attack,
191  const_attack_ptr other_attack,
192  const config& special,
193  unit_const_ptr u,
194  const unit& from,
195  int dir,
196  const map_location& loc,
197  AFFECTS whom,
198  const std::string& tag_name,
199  bool leader_bool=false
200  );
201 
202  static bool special_active_impl(
203  const_attack_ptr self_attack,
204  const_attack_ptr other_attack,
205  const config& special,
206  AFFECTS whom,
207  const std::string& tag_name,
208  bool include_backstab=true,
209  const std::string& filter_self ="filter_self"
210  );
211 
212  // Used via specials_context() to control which specials are
213  // considered active.
214  friend class specials_context_t;
215  mutable map_location self_loc_, other_loc_;
218  mutable bool is_attacker_;
220  mutable bool is_for_listing_ = false;
221 public:
223  std::shared_ptr<const attack_type> parent;
224  friend class attack_type;
225  /** Initialize weapon specials context for listing */
226  explicit specials_context_t(const attack_type& weapon, bool attacking);
227  /** Initialize weapon specials context for a unit type */
228  specials_context_t(const attack_type& weapon, const unit_type& self_type, const map_location& loc, bool attacking = true);
229  /** Initialize weapon specials context for a single unit */
230  specials_context_t(const attack_type& weapon, const_attack_ptr other_weapon,
231  unit_const_ptr self, unit_const_ptr other,
232  const map_location& self_loc, const map_location& other_loc,
233  bool attacking);
234  /** Initialize weapon specials context for a pair of units */
235  specials_context_t(const attack_type& weapon, unit_const_ptr self, const map_location& loc, bool attacking);
236  specials_context_t(const specials_context_t&) = delete;
237  bool was_moved = false;
238  public:
239  // Destructor at least needs to be public for all this to work.
242  };
243  // Set up a specials context.
244  // Usage: auto ctx = weapon.specials_context(...);
246  const map_location& unit_loc, const map_location& other_loc,
247  bool attacking, const_attack_ptr other_attack) const {
248  return specials_context_t(*this, other_attack, self, other, unit_loc, other_loc, attacking);
249  }
250  specials_context_t specials_context(unit_const_ptr self, const map_location& loc, bool attacking = true) const {
251  return specials_context_t(*this, self, loc, attacking);
252  }
253  specials_context_t specials_context(const unit_type& self_type, const map_location& loc, bool attacking = true) const {
254  return specials_context_t(*this, self_type, loc, attacking);
255  }
256  specials_context_t specials_context_for_listing(bool attacking = true) const {
257  return specials_context_t(*this, attacking);
258  }
259  void set_changed(bool value)
260  {
261  changed_ = value;
262  }
263  bool get_changed() const
264  {
265  return changed_;
266  }
267 private:
268 
270  std::string id_;
271  std::string type_;
272  std::string icon_;
273  std::string range_;
275  int damage_;
279 
282  int parry_;
284  bool changed_;
285 };
286 
287 using attack_list = std::vector<attack_ptr>;
288 using attack_itors = boost::iterator_range<boost::indirect_iterator<attack_list::iterator>>;
289 using const_attack_itors = boost::iterator_range<boost::indirect_iterator<attack_list::const_iterator>>;
290 
292  return boost::make_iterator_range(boost::make_indirect_iterator(atks.begin()), boost::make_indirect_iterator(atks.end()));
293 }
294 
296  return boost::make_iterator_range(boost::make_indirect_iterator(atks.begin()), boost::make_indirect_iterator(atks.end()));
297 }
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:121
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:61
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