The Battle for Wesnoth  1.15.9+dev
attack_type.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 "map/location.hpp"
18 #include "tstring.hpp"
19 #include "config.hpp"
20 #include <string>
21 #include <vector>
22 #include <cassert>
23 
24 #include <boost/iterator/indirect_iterator.hpp>
25 #include <boost/range/iterator_range.hpp>
26 #include <boost/dynamic_bitset_fwd.hpp>
27 
28 #include "units/ptr.hpp" // for attack_ptr
29 
30 class unit_ability_list;
31 class unit_type;
32 namespace wfl {
33  class map_formula_callable;
34 }
35 //the 'attack type' is the type of attack, how many times it strikes,
36 //and how much damage it does.
37 class attack_type : public std::enable_shared_from_this<attack_type>
38 {
39 public:
40 
41  explicit attack_type(const config& cfg);
42  const t_string& name() const { return description_; }
43  const std::string& id() const { return id_; }
44  const std::string& type() const { return type_; }
45  const std::string& icon() const { return icon_; }
46  const std::string& range() const { return range_; }
47  int min_range() const { return min_range_; }
48  int max_range() const { return max_range_; }
49  std::string accuracy_parry_description() const;
50  int accuracy() const { return accuracy_; }
51  int parry() const { return parry_; }
52  int damage() const { return damage_; }
53  int num_attacks() const { return num_attacks_; }
54  double attack_weight() const { return attack_weight_; }
55  double defense_weight() const { return defense_weight_; }
56  const config &specials() const { return specials_; }
57 
58  void set_name(const t_string& value) { description_ = value; set_changed(true); }
59  void set_id(const std::string& value) { id_ = value; set_changed(true); }
60  void set_type(const std::string& value) { type_ = value; set_changed(true); }
61  void set_icon(const std::string& value) { icon_ = value; set_changed(true); }
62  void set_range(const std::string& value) { range_ = value; set_changed(true); }
63  void set_accuracy(int value) { accuracy_ = value; set_changed(true); }
64  void set_parry(int value) { parry_ = value; set_changed(true); }
65  void set_damage(int value) { damage_ = value; set_changed(true); }
66  void set_num_attacks(int value) { num_attacks_ = value; set_changed(true); }
67  void set_attack_weight(double value) { attack_weight_ = value; set_changed(true); }
68  void set_defense_weight(double value) { defense_weight_ = value; set_changed(true); }
69  void set_specials(config value) { specials_ = value; set_changed(true); }
70 
71 
72  // In unit_abilities.cpp:
73 
74  /**
75  * @return True iff the special @a special is active.
76  * @param special The special being checked.
77  * @param simple_check If true, check whether the unit has the special. Else, check whether the special is currently active.
78  * @param special_id If true, match @a special against the @c id of special tags.
79  * @param special_tags If true, match @a special against the tag name of special tags.
80  */
81  bool get_special_bool(const std::string& special, bool simple_check=false, bool special_id=true, bool special_tags=true) const;
82  unit_ability_list get_specials(const std::string& special) const;
83  std::vector<std::pair<t_string, t_string>> special_tooltips(boost::dynamic_bitset<>* active_list = nullptr) const;
84  std::string weapon_specials(bool only_active=false, bool is_backstab=false) const;
85 
86  /** Calculates the number of attacks this weapon has, considering specials. */
87  void modified_attacks(bool is_backstab, unsigned & min_attacks,
88  unsigned & max_attacks) const;
89  /** Returns the damage per attack of this weapon, considering specials. */
90  int modified_damage(bool is_backstab) const;
91  /** Returns list for weapon like abilitiesfor each ability type. */
92  unit_ability_list list_ability(const std::string& ability) const;
93  /** Returns list who contains list_ability and get_specials list for each ability type */
94  unit_ability_list get_special_ability(const std::string& ability) const;
95  /** return an boolean value for abilities like poison slow firstrike or petrifies */
96  bool bool_ability(const std::string& ability) const;
97 
98  // In unit_types.cpp:
99 
100  bool matches_filter(const config& filter) const;
101  bool apply_modification(const config& cfg);
102  bool describe_modification(const config& cfg,std::string* description);
103 
104  int movement_used() const { return movement_used_; }
105  void set_movement_used(int value) { movement_used_ = value; }
106 
107  void write(config& cfg) const;
108  inline config to_config() const { config c; write(c); return c; }
109 
110  void add_formula_context(wfl::map_formula_callable&) const;
111 private:
112  // In unit_abilities.cpp:
113 
114  // Configured as a bit field, in case that is useful.
115  enum AFFECTS { AFFECT_SELF=1, AFFECT_OTHER=2, AFFECT_EITHER=3 };
116  bool special_active(const config& special, AFFECTS whom, const std::string& tag_name,
117  bool include_backstab=true, const std::string& filter_self ="filter_self") const;
118 
119  static bool special_active_impl(
120  const_attack_ptr self_attack,
121  const_attack_ptr other_attack,
122  const config& special,
123  AFFECTS whom,
124  const std::string& tag_name,
125  bool include_backstab=true,
126  const std::string& filter_self ="filter_self"
127  );
128 
129  // Used via specials_context() to control which specials are
130  // considered active.
131  friend class specials_context_t;
132  mutable map_location self_loc_, other_loc_;
135  mutable bool is_attacker_;
137  mutable bool is_for_listing_ = false;
138 public:
140  std::shared_ptr<const attack_type> parent;
141  friend class attack_type;
142  /** Initialize weapon specials context for listing */
143  explicit specials_context_t(const attack_type& weapon, bool attacking);
144  /** Initialize weapon specials context for a unit type */
145  specials_context_t(const attack_type& weapon, const unit_type& self_type, const map_location& loc, bool attacking = true);
146  /** Initialize weapon specials context for a single unit */
147  specials_context_t(const attack_type& weapon, const_attack_ptr other_weapon,
148  unit_const_ptr self, unit_const_ptr other,
149  const map_location& self_loc, const map_location& other_loc,
150  bool attacking);
151  /** Initialize weapon specials context for a pair of units */
152  specials_context_t(const attack_type& weapon, unit_const_ptr self, const map_location& loc, bool attacking);
153  specials_context_t(const specials_context_t&) = delete;
154  bool was_moved = false;
155  public:
156  // Destructor at least needs to be public for all this to work.
159  };
160  // Set up a specials context.
161  // Usage: auto ctx = weapon.specials_context(...);
163  const map_location& unit_loc, const map_location& other_loc,
164  bool attacking, const_attack_ptr other_attack) const {
165  return specials_context_t(*this, other_attack, self, other, unit_loc, other_loc, attacking);
166  }
167  specials_context_t specials_context(unit_const_ptr self, const map_location& loc, bool attacking = true) const {
168  return specials_context_t(*this, self, loc, attacking);
169  }
170  specials_context_t specials_context(const unit_type& self_type, const map_location& loc, bool attacking = true) const {
171  return specials_context_t(*this, self_type, loc, attacking);
172  }
173  specials_context_t specials_context_for_listing(bool attacking = true) const {
174  return specials_context_t(*this, attacking);
175  }
176  void set_changed(bool value)
177  {
178  changed_ = value;
179  }
180  bool get_changed() const
181  {
182  return changed_;
183  }
184 private:
185 
187  std::string id_;
188  std::string type_;
189  std::string icon_;
190  std::string range_;
192  int damage_;
196 
199  int parry_;
201  bool changed_;
202 };
203 
204 using attack_list = std::vector<attack_ptr>;
205 using attack_itors = boost::iterator_range<boost::indirect_iterator<attack_list::iterator>>;
206 using const_attack_itors = boost::iterator_range<boost::indirect_iterator<attack_list::const_iterator>>;
207 
209  return boost::make_iterator_range(boost::make_indirect_iterator(atks.begin()), boost::make_indirect_iterator(atks.end()));
210 }
211 
213  return boost::make_iterator_range(boost::make_indirect_iterator(atks.begin()), boost::make_indirect_iterator(atks.end()));
214 }
std::vector< attack_ptr > attack_list
std::string icon_
const std::string & id() const
Definition: attack_type.hpp:43
std::string type_
boost::iterator_range< boost::indirect_iterator< attack_list::iterator > > attack_itors
int max_range() const
Definition: attack_type.hpp:48
void set_num_attacks(int value)
Definition: attack_type.hpp:66
int parry() const
Definition: attack_type.hpp:51
unit_const_ptr other_
const std::string & type() const
Definition: attack_type.hpp:44
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:53
A single unit type that the player may recruit.
Definition: types.hpp:44
double defense_weight_
void set_name(const t_string &value)
Definition: attack_type.hpp:58
std::shared_ptr< const unit > unit_const_ptr
Definition: ptr.hpp:26
int min_range() const
Definition: attack_type.hpp:47
void write(std::ostream &out, const configr_of &cfg, unsigned int level)
Definition: parser.cpp:763
int movement_used() const
double attack_weight_
const t_string & name() const
Definition: attack_type.hpp:42
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:46
const std::string & icon() const
Definition: attack_type.hpp:45
bool get_changed() const
config specials_
void set_defense_weight(double value)
Definition: attack_type.hpp:68
void set_specials(config value)
Definition: attack_type.hpp:69
t_string description_
Encapsulates the map of the game.
Definition: location.hpp:37
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:65
int damage() const
Definition: attack_type.hpp:52
int accuracy() const
Definition: attack_type.hpp:50
const config & specials() const
Definition: attack_type.hpp:56
double attack_weight() const
Definition: attack_type.hpp:54
unit_const_ptr self_
double defense_weight() const
Definition: attack_type.hpp:55
friend class specials_context_t
void set_range(const std::string &value)
Definition: attack_type.hpp:62
void set_parry(int value)
Definition: attack_type.hpp:64
std::string id_
Definition: contexts.hpp:43
const_attack_ptr other_attack_
void set_icon(const std::string &value)
Definition: attack_type.hpp:61
void set_id(const std::string &value)
Definition: attack_type.hpp:59
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:58
mock_char c
std::shared_ptr< const attack_type > const_attack_ptr
Definition: ptr.hpp:33
void set_accuracy(int value)
Definition: attack_type.hpp:63
map_location self_loc_
void set_attack_weight(double value)
Definition: attack_type.hpp:67
void set_type(const std::string &value)
Definition: attack_type.hpp:60