The Battle for Wesnoth  1.19.0+dev
unit_attack.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2010 - 2024
3  by Mark de Wever <koraq@xs4all.nl>
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 
18 
19 #include "font/text_formatting.hpp"
22 #include "gui/widgets/button.hpp"
23 #include "gui/widgets/listbox.hpp"
25 #include "gui/widgets/window.hpp"
26 #include "game_config.hpp"
27 #include "gettext.hpp"
28 #include "language.hpp"
29 #include "color.hpp"
30 #include "units/unit.hpp"
31 
32 #include <functional>
33 
34 namespace gui2::dialogs
35 {
36 
38 
39 unit_attack::unit_attack(const unit_map::iterator& attacker_itor,
40  const unit_map::iterator& defender_itor,
41  std::vector<battle_context>&& weapons,
42  const int best_weapon)
43  : modal_dialog(window_id())
44  , selected_weapon_(-1)
45  , attacker_itor_(attacker_itor)
46  , defender_itor_(defender_itor)
47  , weapons_(std::move(weapons))
48  , best_weapon_(best_weapon)
49 {
50 }
51 
53 {
54  const std::size_t index = find_widget<listbox>(get_window(), "weapon_list", false).get_selected_row();
55  attack_predictions::display(weapons_[index], attacker_itor_.get_shared_ptr(), defender_itor_.get_shared_ptr());
56 }
57 
59 {
61  find_widget<button>(&window, "damage_calculation", false),
62  std::bind(&unit_attack::damage_calc_callback, this));
63 
64  find_widget<unit_preview_pane>(&window, "attacker_pane", false)
65  .set_displayed_unit(*attacker_itor_);
66 
67  find_widget<unit_preview_pane>(&window, "defender_pane", false)
68  .set_displayed_unit(*defender_itor_);
69 
70  selected_weapon_ = -1;
71 
72  listbox& weapon_list = find_widget<listbox>(&window, "weapon_list", false);
73  window.keyboard_capture(&weapon_list);
74 
75  // Possible TODO: If a "blank weapon" is generally useful, add it as a static member in attack_type.
76  static const config empty;
77  static const_attack_ptr no_weapon(new attack_type(empty));
78 
79  for(const auto & weapon : weapons_) {
80  const battle_context_unit_stats& attacker = weapon.get_attacker_stats();
81  const battle_context_unit_stats& defender = weapon.get_defender_stats();
82 
83  const attack_type& attacker_weapon =
84  *attacker.weapon;
85  const attack_type& defender_weapon = defender.weapon ?
86  *defender.weapon : *no_weapon;
87 
88  const color_t a_cth_color = game_config::red_to_green(attacker.chance_to_hit);
89  const color_t d_cth_color = game_config::red_to_green(defender.chance_to_hit);
90 
91  const std::string attw_name = !attacker_weapon.name().empty() ? attacker_weapon.name() : " ";
92  const std::string defw_name = !defender_weapon.name().empty() ? defender_weapon.name() : " ";
93 
94  std::string range = attacker_weapon.range().empty() ? defender_weapon.range() : attacker_weapon.range();
95  if (!range.empty()) {
96  range = string_table["range_" + range];
97  }
98 
99  auto a_ctx = attacker_weapon.specials_context(
102  attacker_itor_->get_location(),
103  defender_itor_->get_location(), true, defender.weapon
104  );
105 
106  auto d_ctx = defender_weapon.specials_context(
109  defender_itor_->get_location(),
110  attacker_itor_->get_location(), false, attacker.weapon
111  );
112 
113  std::pair<std::string, std::string> types = attacker_weapon.damage_type();
114  std::string attw_type_second = types.second;
115  std::string attw_type = !(types.first).empty() ? types.first : attacker_weapon.type();
116  if (!attw_type.empty()) {
117  attw_type = string_table["type_" + attw_type];
118  }
119  if (!attw_type_second.empty()) {
120  attw_type_second = ", " + string_table["type_" + attw_type_second];
121  }
122  std::pair<std::string, std::string> def_types = defender_weapon.damage_type();
123  std::string defw_type_second = def_types.second;
124  std::string defw_type = !(def_types.first).empty() ? def_types.first : defender_weapon.type();
125  if (!defw_type.empty()) {
126  defw_type = string_table["type_" + defw_type];
127  }
128  if (!defw_type_second.empty()) {
129  defw_type_second = ", " + string_table["type_" + defw_type_second];
130  }
131 
132  const std::set<std::string> checking_tags_other = {"damage_type", "disable", "berserk", "drains", "heal_on_hit", "plague", "slow", "petrifies", "firststrike", "poison"};
133  std::string attw_specials = attacker_weapon.weapon_specials();
134  std::string attw_specials_dmg = attacker_weapon.weapon_specials_value({"leadership", "damage"});
135  std::string attw_specials_atk = attacker_weapon.weapon_specials_value({"attacks", "swarm"});
136  std::string attw_specials_cth = attacker_weapon.weapon_specials_value({"chance_to_hit"});
137  std::string attw_specials_others = attacker_weapon.weapon_specials_value(checking_tags_other);
138  bool defender_attack = !(defender_weapon.name().empty() && defender_weapon.damage() == 0 && defender_weapon.num_attacks() == 0 && defender.chance_to_hit == 0);
139  std::string defw_specials = defender_attack ? defender_weapon.weapon_specials() : "";
140  std::string defw_specials_dmg = defender_attack ? defender_weapon.weapon_specials_value({"leadership", "damage"}) : "";
141  std::string defw_specials_atk = defender_attack ? defender_weapon.weapon_specials_value({"attacks", "swarm"}) : "";
142  std::string defw_specials_cth = defender_attack ? defender_weapon.weapon_specials_value({"chance_to_hit"}) : "";
143  std::string defw_specials_others = defender_attack ? defender_weapon.weapon_specials_value(checking_tags_other) : "";
144 
145  if(!attw_specials.empty()) {
146  attw_specials = " " + attw_specials;
147  }
148  if(!attw_specials_dmg.empty()) {
149  attw_specials_dmg = " " + attw_specials_dmg;
150  }
151  if(!attw_specials_atk.empty()) {
152  attw_specials_atk = " " + attw_specials_atk;
153  }
154  if(!attw_specials_cth.empty()) {
155  attw_specials_cth = " " + attw_specials_cth;
156  }
157  if(!attw_specials_others.empty()) {
158  attw_specials_others = "\n" + ("<b>" + _("Other aspects: ") + "</b>") + "\n" + ("<i>"+attw_specials_others+"</i>");
159  }
160  if(!defw_specials.empty()) {
161  defw_specials = " " + defw_specials;
162  }
163  if(!defw_specials_dmg.empty()) {
164  defw_specials_dmg = " " + defw_specials_dmg;
165  }
166  if(!defw_specials_atk.empty()) {
167  defw_specials_atk = " " + defw_specials_atk;
168  }
169  if(!defw_specials_cth.empty()) {
170  defw_specials_cth = " " + defw_specials_cth;
171  }
172  if(!defw_specials_others.empty()) {
173  defw_specials_others = "\n" + ("<b>" + _("Other aspects: ") + "</b>") + "\n" + ("<i>"+defw_specials_others+"</i>");
174  }
175 
176  std::stringstream attacker_stats, defender_stats, attacker_tooltip, defender_tooltip;
177 
178  // Use attacker/defender.num_blows instead of attacker/defender_weapon.num_attacks() because the latter does not consider the swarm weapon special
179  attacker_stats << "<b>" << attw_name << "</b>" << "\n"
180  << attw_type << attw_type_second << "\n"
181  << attacker.damage << font::weapon_numbers_sep << attacker.num_blows
182  << attw_specials << "\n"
183  << font::span_color(a_cth_color) << attacker.chance_to_hit << "%</span>";
184 
185  attacker_tooltip << _("Weapon: ") << "<b>" << attw_name << "</b>" << "\n"
186  << _("Type: ") << attw_type << attw_type_second << "\n"
187  << _("Damage: ") << attacker.damage << "<i>" << attw_specials_dmg << "</i>" << "\n"
188  << _("Attacks: ") << attacker.num_blows << "<i>" << attw_specials_atk << "</i>" << "\n"
189  << _("Chance to hit: ") << font::span_color(a_cth_color) << attacker.chance_to_hit << "%</span>"<< "<i>" << attw_specials_cth << "</i>"
190  << attw_specials_others;
191 
192  defender_stats << "<b>" << defw_name << "</b>" << "\n"
193  << defw_type << defw_type_second << "\n"
194  << defender.damage << font::weapon_numbers_sep << defender.num_blows
195  << defw_specials << "\n"
196  << font::span_color(d_cth_color) << defender.chance_to_hit << "%</span>";
197 
198  defender_tooltip << _("Weapon: ") << "<b>" << defw_name << "</b>" << "\n"
199  << _("Type: ") << defw_type << defw_type_second << "\n"
200  << _("Damage: ") << defender.damage << "<i>" << defw_specials_dmg << "</i>" << "\n"
201  << _("Attacks: ") << defender.num_blows << "<i>" << defw_specials_atk << "</i>" << "\n"
202  << _("Chance to hit: ") << font::span_color(d_cth_color) << defender.chance_to_hit << "%</span>"<< "<i>" << defw_specials_cth << "</i>"
203  << defw_specials_others;
204 
207 
208  item["use_markup"] = "true";
209 
210  item["label"] = attacker_weapon.icon();
211  data.emplace("attacker_weapon_icon", item);
212 
213  item["tooltip"] = attacker_tooltip.str();
214  item["label"] = attacker_stats.str();
215  data.emplace("attacker_weapon", item);
216  item["tooltip"] = "";
217 
218  item["label"] = "<span color='#a69275'>" + font::unicode_em_dash + " " + range + " " + font::unicode_em_dash + "</span>";
219  data.emplace("range", item);
220 
221  item["tooltip"] = defender_attack ? defender_tooltip.str() : "";
222  item["label"] = defender_stats.str();
223  data.emplace("defender_weapon", item);
224 
225  item["tooltip"] = "";
226  item["label"] = defender_weapon.icon();
227  data.emplace("defender_weapon_icon", item);
228 
229  weapon_list.add_row(data);
230  }
231 
232  // If these two aren't the same size, we can't use list selection incides
233  // to access to weapons list!
234  assert(weapons_.size() == weapon_list.get_item_count());
235 
236  weapon_list.select_row(best_weapon_);
237 }
238 
240 {
241  if(get_retval() == retval::OK) {
242  selected_weapon_ = find_widget<listbox>(&window, "weapon_list", false).get_selected_row();
243  }
244 }
245 
246 } // namespace dialogs
std::string weapon_specials() const
Returns a comma-separated string of active names for the specials of *this.
Definition: abilities.cpp:911
const std::string & range() const
Definition: attack_type.hpp:45
const std::string & type() const
Definition: attack_type.hpp:43
std::string weapon_specials_value(const std::set< std::string > checking_tags) const
Definition: abilities.cpp:954
int num_attacks() const
Definition: attack_type.hpp:52
const t_string & name() const
Definition: attack_type.hpp:41
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
const std::string & icon() const
Definition: attack_type.hpp:44
int damage() const
Definition: attack_type.hpp:51
std::pair< std::string, std::string > damage_type() const
return a modified damage type and/or add a secondary_type for hybrid use if special is active.
Definition: abilities.cpp:1242
Computes the statistics of a battle between an attacker and a defender unit.
Definition: attack.hpp:167
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:159
Abstract base class for all modal dialogs.
int get_retval() const
Returns the cached window exit code.
window * get_window()
Returns a pointer to the dialog's window.
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
Definition: unit_attack.cpp:58
int selected_weapon_
The index of the selected weapon.
Definition: unit_attack.hpp:50
unit_map::iterator defender_itor_
Iterator pointing to the defender.
Definition: unit_attack.hpp:56
int best_weapon_
The best weapon, aka the one high-lighted.
Definition: unit_attack.hpp:62
unit_map::iterator attacker_itor_
Iterator pointing to the attacker.
Definition: unit_attack.hpp:53
virtual void post_show(window &window) override
Actions to be taken after the window has been shown.
std::vector< battle_context > weapons_
List of all battle contexts used for getting the weapons.
Definition: unit_attack.hpp:59
The listbox class.
Definition: listbox.hpp:43
grid & add_row(const widget_item &item, const int index=-1)
When an item in the list is selected by the user we need to update the state.
Definition: listbox.cpp:59
bool select_row(const unsigned row, const bool select=true)
Selects a row.
Definition: listbox.cpp:243
unsigned get_item_count() const
Returns the number of items in the listbox.
Definition: listbox.cpp:124
base class of top level items, the only item which needs to store the final canvases to draw on.
Definition: window.hpp:61
void keyboard_capture(widget *widget)
Definition: window.cpp:1221
bool empty() const
Definition: tstring.hpp:186
Container associating units to locations.
Definition: map.hpp:98
static std::string _(const char *str)
Definition: gettext.hpp:93
This file contains the window object, this object is a top level container which has the event manage...
symbol_table string_table
Definition: language.cpp:64
const std::string unicode_em_dash
Definition: constants.cpp:44
std::string span_color(const color_t &color)
Returns a Pango formatting string using the provided color_t object.
const std::string weapon_numbers_sep
Definition: constants.cpp:49
color_t red_to_green(double val, bool for_text)
Return a color corresponding to the value val red for val=0.0 to green for val=100....
REGISTER_DIALOG(editor_edit_unit)
void connect_signal_mouse_left_click(dispatcher &dispatcher, const signal &signal)
Connects a signal handler for a left mouse button click.
Definition: dispatcher.cpp:177
std::map< std::string, widget_item > widget_data
Definition: widget.hpp:34
std::map< std::string, t_string > widget_item
Definition: widget.hpp:31
@ OK
Dialog was closed with the OK button.
Definition: retval.hpp:35
std::pair< std::string, unsigned > item
Definition: help_impl.hpp:410
void unit_attack(display *disp, game_board &board, const map_location &a, const map_location &b, int damage, const attack_type &attack, const_attack_ptr secondary_attack, int swing, const std::string &hit_text, int drain_amount, const std::string &att_text, const std::vector< std::string > *extra_hit_sounds, bool attacking)
Make the unit on tile 'a' attack the unit on tile 'b'.
Definition: udisplay.cpp:596
std::size_t index(const std::string &str, const std::size_t index)
Codepoint index corresponding to the nth character in a UTF-8 string.
Definition: unicode.cpp:70
std::string::const_iterator iterator
Definition: tokenizer.hpp:25
std::string_view data
Definition: picture.cpp:194
std::shared_ptr< const attack_type > const_attack_ptr
Definition: ptr.hpp:34
Structure describing the statistics of a unit involved in the battle.
Definition: attack.hpp:51
unsigned int num_blows
Effective number of blows, takes swarm into account.
Definition: attack.hpp:76
const_attack_ptr weapon
The weapon used by the unit to attack the opponent, or nullptr if there is none.
Definition: attack.hpp:52
int damage
Effective damage of the weapon (all factors accounted for).
Definition: attack.hpp:72
unsigned int chance_to_hit
Effective chance to hit as a percentage (all factors accounted for).
Definition: attack.hpp:71
The basic class for representing 8-bit RGB or RGBA colour values.
Definition: color.hpp:59
pointer get_shared_ptr() const
This is exactly the same as operator-> but it's slightly more readable, and can replace &*iter syntax...
Definition: map.hpp:217