The Battle for Wesnoth  1.17.4+dev
unit_preview_pane.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2016 - 2022
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 #define GETTEXT_DOMAIN "wesnoth-lib"
16 
18 
20 
22 #include "gui/widgets/button.hpp"
23 #include "gui/widgets/drawing.hpp"
24 #include "gui/widgets/image.hpp"
25 #include "gui/widgets/label.hpp"
26 #include "gui/widgets/settings.hpp"
27 #include "gui/widgets/window.hpp"
30 
31 #include "font/text_formatting.hpp"
32 #include "formatter.hpp"
33 #include "formula/string_utils.hpp"
34 #include "language.hpp"
35 #include "preferences/game.hpp"
36 #include "gettext.hpp"
37 #include "help/help.hpp"
38 #include "help/help_impl.hpp"
39 #include "play_controller.hpp"
40 #include "resources.hpp"
41 #include "team.hpp"
42 #include "terrain/movement.hpp"
43 #include "terrain/type_data.hpp"
44 #include "units/attack_type.hpp"
45 #include "units/types.hpp"
46 #include "units/helper.hpp"
47 #include "units/unit.hpp"
48 
49 #include <functional>
50 
51 namespace gui2
52 {
53 
54 // ------------ WIDGET -----------{
55 
56 REGISTER_WIDGET(unit_preview_pane)
57 
58 unit_preview_pane::unit_preview_pane(const implementation::builder_unit_preview_pane& builder)
59  : container_base(builder, type())
60  , current_type_()
61  , icon_type_(nullptr)
62  , icon_race_(nullptr)
63  , icon_alignment_(nullptr)
64  , label_name_(nullptr)
65  , label_level_(nullptr)
66  , label_race_(nullptr)
67  , label_details_(nullptr)
68  , tree_details_(nullptr)
69  , button_profile_(nullptr)
70  , image_mods_()
71 {
72 }
73 
75 {
76  // Icons
77  icon_type_ = find_widget<drawing>(this, "type_image", false, false);
78  icon_race_ = find_widget<image>(this, "type_race", false, false);
79  icon_alignment_ = find_widget<image>(this, "type_alignment", false, false);
80 
81  // Labels
82  label_name_ = find_widget<label>(this, "type_name", false, false);
83  label_level_ = find_widget<label>(this, "type_level", false, false);
84  label_race_ = find_widget<label>(this, "type_race_label", false, false);
85  label_details_ = find_widget<styled_widget>(this, "type_details_minimal", false, false);
86 
87  tree_details_ = find_widget<tree_view>(this, "type_details", false, false);
88 
89  // Profile button
90  button_profile_ = find_widget<button>(this, "type_profile", false, false);
91 
92  if(button_profile_) {
93  connect_signal_mouse_left_click(*button_profile_,
95  }
96 }
97 
98 static inline tree_view_node& add_name_tree_node(tree_view_node& header_node, const std::string& type, const t_string& label, const t_string& tooltip = "")
99 {
100  /* Note: We have to pass data instead of just doing 'child_label.set_label(label)' below
101  * because the tree_view_node::add_child needs to have the correct size of the
102  * node child widgets for its internal size calculations.
103  * Same is true for 'use_markup'
104  */
105  auto& child_node = header_node.add_child(type, { { "name",{ { "label", label },{ "use_markup", "true" } } } });
106  auto& child_label = find_widget<styled_widget>(&child_node, "name", true);
107 
108  child_label.set_tooltip(tooltip);
109  return child_node;
110 }
111 
112 static inline std::string get_hp_tooltip(const utils::string_map& res, const std::function<int (const std::string&, bool)>& get)
113 {
114  std::ostringstream tooltip;
115 
116  std::set<std::string> resistances_table;
117 
118  bool att_def_diff = false;
119  for(const utils::string_map::value_type &resist : res) {
120  std::ostringstream line;
121  line << translation::dgettext("wesnoth", resist.first.c_str()) << ": ";
122 
123  // Some units have different resistances when attacking or defending.
124  const int res_att = 100 - get(resist.first, true);
125  const int res_def = 100 - get(resist.first, false);
126 
127  if(res_att == res_def) {
128  line << "<span color='" << unit_helper::resistance_color(res_def) << "'>\t" << utils::signed_percent(res_def) << "</span>";
129  } else {
130  line << "<span color='" << unit_helper::resistance_color(res_att) << "'>\t" << utils::signed_percent(res_att) << "</span>" << "/"
131  << "<span color='" << unit_helper::resistance_color(res_def) << "'>" << utils::signed_percent(res_def) << "</span>";
132  att_def_diff = true;
133  }
134 
135  resistances_table.insert(line.str());
136  }
137 
138  tooltip << "<big>" << _("Resistances: ") << "</big>";
139  if(att_def_diff) {
140  tooltip << _("(Att / Def)");
141  }
142 
143  for(const std::string &line : resistances_table) {
144  tooltip << '\n' << font::unicode_bullet << " " << line;
145  }
146 
147  return tooltip.str();
148 }
149 
150 static inline std::string get_mp_tooltip(int total_movement, std::function<int (t_translation::terrain_code)> get)
151 {
152  std::set<terrain_movement> terrain_moves;
153  std::ostringstream tooltip;
154  tooltip << "<big>" << _("Movement Costs:") << "</big>";
155 
156  std::shared_ptr<terrain_type_data> tdata = help::load_terrain_types_data();
157 
158  if(!tdata) {
159  return "";
160  }
161 
164  continue;
165  }
166 
167  const terrain_type& info = tdata->get_terrain_info(terrain);
168  if(info.is_indivisible() && info.is_nonnull()) {
169  terrain_moves.emplace(info.name(), get(terrain));
170  }
171  }
172 
173  for(const terrain_movement& tm: terrain_moves)
174  {
175  tooltip << '\n' << font::unicode_bullet << " " << tm.name << ": ";
176 
177  // movement - range: 1 .. 5, movetype::UNREACHABLE=impassable
178  const bool cannot_move = tm.moves > total_movement;
179 
180  std::string color;
181  if(cannot_move) {
182  // cannot move in this terrain
183  color = "red";
184  } else if(tm.moves > 1) {
185  color = "yellow";
186  } else {
187  color = "white";
188  }
189 
190  tooltip << "<span color='" << color << "'>";
191 
192  // A 5 MP margin; if the movement costs go above the unit's max moves + 5, we replace it with dashes.
193  if(cannot_move && (tm.moves > total_movement + 5)) {
194  tooltip << font::unicode_figure_dash;
195  } else {
196  tooltip << tm.moves;
197  }
198 
199  tooltip << "</span>";
200  }
201 
202  return tooltip.str();
203 }
204 
205 /*
206  * Both unit and unit_type use the same format (vector of attack_types) for their
207  * attack data, meaning we can keep this as a helper function.
208  */
209 template<typename T>
211 {
212  if(attacks.empty()) {
213  return;
214  }
215 
216  auto& header_node = add_name_tree_node(
217  parent_node,
218  "header",
219  "<b>" + _("Attacks") + "</b>"
220  );
221 
222  for(const auto& a : attacks) {
223  const std::string range_png = std::string("icons/profiles/") + a.range() + "_attack.png~SCALE_INTO_SHARP(16,16)";
224  const std::string type_png = std::string("icons/profiles/") + a.type() + ".png~SCALE_INTO_SHARP(16,16)";
225  const bool range_png_exists = ::image::locator(range_png).file_exists();
226  const bool type_png_exists = ::image::locator(type_png).file_exists();
227 
228  const t_string& range = string_table["range_" + a.range()];
229  const t_string& type = string_table["type_" + a.type()];
230 
231  const std::string label = (formatter()
233  << a.damage() << font::weapon_numbers_sep << a.num_attacks()
234  << " " << a.name() << "</span>").str();
235 
236  auto& subsection = header_node.add_child(
237  "item_image",
238  {
239  { "image_range", { { "label", range_png } } },
240  { "image_type", { { "label", type_png } } },
241  { "name", { { "label", label }, { "use_markup", "true" } } },
242  }
243  );
244 
245  find_widget<styled_widget>(&subsection, "image_range", true).set_tooltip(range);
246  find_widget<styled_widget>(&subsection, "image_type", true).set_tooltip(type);
247 
248  if(!range_png_exists || !type_png_exists) {
250  subsection,
251  "item",
252  (formatter()
254  << range << font::weapon_details_sep
255  << type << "</span>"
256  ).str()
257  );
258  }
259 
260  for(const auto& pair : a.special_tooltips()) {
262  subsection,
263  "item",
264  (formatter() << font::span_color(font::weapon_details_color) << pair.first << "</span>").str(),
265  (formatter() << "<span size='x-large'>" << pair.first << "</span>" << "\n" << pair.second).str()
266  );
267  }
268  }
269 }
270 
272 {
273  // Sets the current type id for the profile button callback to use
275 
276  if(icon_type_) {
277  std::string mods;
278 
280  mods = "~RC(" + type.flag_rgb() + ">" +
282  + ")";
283  }
284 
285  mods += image_mods_;
286 
287  icon_type_->set_label((type.icon().empty() ? type.image() : type.icon()) + mods);
288  }
289 
290  if(label_name_) {
291  label_name_->set_label("<big>" + type.type_name() + "</big>");
293  }
294 
295  if(label_level_) {
296  std::string l_str = VGETTEXT("Lvl $lvl", {{"lvl", std::to_string(type.level())}});
297 
298  label_level_->set_label("<b>" + l_str + "</b>");
301  }
302 
303  if(label_race_) {
304  label_race_ ->set_label(type.race()->name(type.genders().front()));
305  }
306 
307  if(icon_race_) {
308  icon_race_->set_label(type.race()->get_icon_path_stem() + "_30.png");
309  }
310 
311  if(icon_alignment_) {
312  const std::string& alignment_name = unit_alignments::get_string(type.alignment());
313 
314  icon_alignment_->set_label("icons/alignments/alignment_" + alignment_name + "_30.png");
316  type.alignment(),
317  type.genders().front()));
318  }
319 
320  if(label_details_) {
321  std::stringstream str;
322 
323  str << "<span size='large'> </span>" << "\n";
324 
325  str << font::span_color(font::unit_type_color) << type.type_name() << "</span>" << "\n";
326 
327  std::string l_str = VGETTEXT("Lvl $lvl", {{"lvl", std::to_string(type.level())}});
328  str << l_str << "\n";
329 
330  str << unit_alignments::get_string(type.alignment()) << "\n";
331 
332  str << "\n"; // Leave a blank line where traits would be
333 
334  str << _("HP: ") << type.hitpoints() << "\n";
335 
336  str << _("XP: ") << type.experience_needed(true);
337 
338  label_details_->set_label(str.str());
340  }
341 
342  if(tree_details_) {
343 
344  tree_details_->clear();
345  tree_details_->add_node("hp_xp_mp", {
346  { "hp",{
347  { "label", (formatter() << "<small>" << font::span_color(unit::hp_color_max()) << "<b>" << _("HP: ") << "</b>" << type.hitpoints() << "</span>" << " | </small>").str() },
348  { "use_markup", "true" },
349  { "tooltip", get_hp_tooltip(type.movement_type().get_resistances().damage_table(), [&type](const std::string& dt, bool is_attacker) { return type.resistance_against(dt, is_attacker); }) }
350  } },
351  { "xp",{
352  { "label", (formatter() << "<small>" << font::span_color(unit::xp_color(100, type.can_advance(), true)) << "<b>" << _("XP: ") << "</b>" << type.experience_needed() << "</span>" << " | </small>").str() },
353  { "use_markup", "true" },
354  { "tooltip", (formatter() << _("Experience Modifier: ") << unit_experience_accelerator::get_acceleration() << '%').str() }
355  } },
356  { "mp",{
357  { "label", (formatter() << "<small>" << "<b>" << _("MP: ") << "</b>" << type.movement() << "</small>").str() },
358  { "use_markup", "true" },
359  { "tooltip", get_mp_tooltip(type.movement(), [&type](t_translation::terrain_code terrain) { return type.movement_type().movement_cost(terrain); }) }
360  } },
361  });
362 
363  // Print trait details
364  {
365  tree_view_node* header_node = nullptr;
366 
367  for(const auto& tr : type.possible_traits()) {
368  t_string name = tr[type.genders().front() == unit_race::FEMALE ? "female_name" : "male_name"];
369  if(tr["availability"] != "musthave" || name.empty()) {
370  continue;
371  }
372 
373  if(header_node == nullptr) {
374  header_node = &add_name_tree_node(
376  "header",
377  "<b>" + _("Traits") + "</b>"
378  );
379  }
380 
382  *header_node,
383  "item",
384  name
385  );
386  }
387  }
388 
389  // Print ability details
390  if(!type.abilities_metadata().empty()) {
391 
392  auto& header_node = add_name_tree_node(
394  "header",
395  "<b>" + _("Abilities") + "</b>"
396  );
397 
398  for(const auto& ab : type.abilities_metadata()) {
399  if(!ab.name.empty()) {
401  header_node,
402  "item",
403  ab.name,
404  (formatter() << "<span size='x-large'>" << ab.name << "</span>\n" << ab.description).str()
405  );
406  }
407  }
408  }
409 
411  }
412 }
413 
415 {
416  // Sets the current type id for the profile button callback to use
417  current_type_ = u.type();
418 
419  if(icon_type_) {
420  std::string mods = u.image_mods();
421 
422  if(u.can_recruit()) {
423  mods += "~BLIT(" + unit::leader_crown() + ")";
424  }
425 
426  for(const std::string& overlay : u.overlays()) {
427  mods += "~BLIT(" + overlay + ")";
428  }
429 
430  mods += image_mods_;
431 
432  icon_type_->set_label(u.absolute_image() + mods);
433  }
434 
435  if(label_name_) {
436  std::string name;
437  if(!u.name().empty()) {
438  name = "<span size='large'>" + u.name() + "</span>" + "\n" + "<small>" + font::span_color(font::unit_type_color) + u.type_name() + "</span></small>";
439  } else {
440  name = "<span size='large'>" + u.type_name() + "</span>\n";
441  }
442 
443  label_name_->set_label(name);
445  }
446 
447  if(label_level_) {
448  std::string l_str = VGETTEXT("Lvl $lvl", {{"lvl", std::to_string(u.level())}});
449 
450  label_level_->set_label("<b>" + l_str + "</b>");
453  }
454 
455  if(label_race_) {
456  label_race_->set_label(u.race()->name(u.gender()));
457  }
458 
459  if(icon_race_) {
460  icon_race_->set_label(u.race()->get_icon_path_stem() + "_30.png");
461  }
462 
463  if(icon_alignment_) {
464  const std::string& alignment_name = unit_alignments::get_string(u.alignment());
465 
466  icon_alignment_->set_label("icons/alignments/alignment_" + alignment_name + "_30.png");
468  u.alignment(),
469  u.gender()));
470  }
471 
472  if(label_details_) {
473  std::stringstream str;
474 
475  const std::string name = "<span size='large'>" + (!u.name().empty() ? u.name() : " ") + "</span>";
476  str << name << "\n";
477 
478  str << font::span_color(font::unit_type_color) << u.type_name() << "</span>" << "\n";
479 
480  std::string l_str = VGETTEXT("Lvl $lvl", {{"lvl", std::to_string(u.level())}});
481  str << l_str << "\n";
482 
483  str << unit_type::alignment_description(u.alignment(), u.gender()) << "\n";
484 
485  str << utils::join(u.trait_names(), ", ") << "\n";
486 
487  str << font::span_color(u.hp_color())
488  << _("HP: ") << u.hitpoints() << "/" << u.max_hitpoints() << "</span>" << "\n";
489 
490  str << font::span_color(u.xp_color()) << _("XP: ");
491  if(u.can_advance()) {
492  str << u.experience() << "/" << u.max_experience();
493  } else {
494  str << font::unicode_en_dash;
495  }
496  str << "</span>";
497 
498  label_details_->set_label(str.str());
500  }
501 
502  if(tree_details_) {
503  tree_details_->clear();
504  const std::string unit_xp = u.can_advance() ? (formatter() << u.experience() << "/" << u.max_experience()).str() : font::unicode_en_dash;
505  tree_details_->add_node("hp_xp_mp", {
506  { "hp",{
507  { "label", (formatter() << "<small>" << font::span_color(u.hp_color()) << "<b>" << _("HP: ") << "</b>" << u.hitpoints() << "/" << u.max_hitpoints() << "</span>" << " | </small>").str() },
508  { "use_markup", "true" },
509  { "tooltip", get_hp_tooltip(u.get_base_resistances(), [&u](const std::string& dt, bool is_attacker) { return u.resistance_against(dt, is_attacker, u.get_location()); }) }
510  } },
511  { "xp",{
512  { "label", (formatter() << "<small>" << font::span_color(u.xp_color()) << "<b>" << _("XP: ") << "</b>" << unit_xp << "</span>" << " | </small>").str() },
513  { "use_markup", "true" },
514  { "tooltip", (formatter() << _("Experience Modifier: ") << unit_experience_accelerator::get_acceleration() << '%').str() }
515  } },
516  { "mp",{
517  { "label", (formatter() << "<small>" << "<b>" << _("MP: ") << "</b>" << u.movement_left() << "/" << u.total_movement() << "</small>").str() },
518  { "use_markup", "true" },
519  { "tooltip", get_mp_tooltip(u.total_movement(), [&u](t_translation::terrain_code terrain) { return u.movement_cost(terrain); }) }
520  } },
521  });
522 
523  if(!u.trait_names().empty()) {
524  auto& header_node = add_name_tree_node(
526  "header",
527  "<b>" + _("Traits") + "</b>"
528  );
529 
530  assert(u.trait_names().size() == u.trait_descriptions().size());
531  for (std::size_t i = 0; i < u.trait_names().size(); ++i) {
533  header_node,
534  "item",
535  u.trait_names()[i],
536  u.trait_descriptions()[i]
537  );
538  }
539  }
540 
541  if(!u.get_ability_list().empty()) {
542  auto& header_node = add_name_tree_node(
544  "header",
545  "<b>" + _("Abilities") + "</b>"
546  );
547 
548  for(const auto& ab : u.ability_tooltips()) {
550  header_node,
551  "item",
552  std::get<2>(ab),
553  std::get<3>(ab)
554  );
555  }
556  }
558  }
559 }
560 
562 {
563  if(get_window() && current_type_) {
565  }
566 }
567 
568 void unit_preview_pane::set_image_mods(const std::string& mods)
569 {
570  image_mods_ = mods;
571 }
572 
573 void unit_preview_pane::set_active(const bool /*active*/)
574 {
575  /* DO NOTHING */
576 }
577 
579 {
580  return true;
581 }
582 
584 {
585  return ENABLED;
586 }
587 
588 void unit_preview_pane::set_self_active(const bool /*active*/)
589 {
590  /* DO NOTHING */
591 }
592 
593 // }---------- DEFINITION ---------{
594 
597 {
598  DBG_GUI_P << "Parsing unit preview pane " << id << '\n';
599 
600  load_resolutions<resolution>(cfg);
601 }
602 
604  : resolution_definition(cfg), grid()
605 {
606  state.emplace_back(cfg.child("background"));
607  state.emplace_back(cfg.child("foreground"));
608 
609  const config& child = cfg.child("grid");
610  VALIDATE(child, _("No grid defined."));
611 
612  grid = std::make_shared<builder_grid>(child);
613 }
614 
615 // }---------- BUILDER -----------{
616 
617 namespace implementation
618 {
619 
620 builder_unit_preview_pane::builder_unit_preview_pane(const config& cfg)
621  : builder_styled_widget(cfg)
622  , image_mods_(cfg["image_mods"])
623 {
624 }
625 
626 std::unique_ptr<widget> builder_unit_preview_pane::build() const
627 {
628  auto widget = std::make_unique<unit_preview_pane>(*this);
629 
630  DBG_GUI_G << "Window builder: placed unit preview pane '" << id
631  << "' with definition '" << definition << "'.\n";
632 
633  const auto conf = widget->cast_config_to<unit_preview_pane_definition>();
634  assert(conf);
635 
636  widget->init_grid(*conf->grid);
637  widget->finalize_setup();
638  widget->set_image_mods(image_mods_);
639 
640  return widget;
641 }
642 
643 } // namespace implementation
644 
645 // }------------ END --------------
646 
647 } // namespace gui2
play_controller * controller
Definition: resources.cpp:22
Base class of a resolution, contains the common keys for a resolution.
#define DBG_GUI_P
Definition: log.hpp:66
static config unit_xp(const unit *u)
Definition: reports.cpp:517
config & child(config_key_type key, int n=0)
Returns the nth child with the given key, or a reference to an invalid config if there is none...
Definition: config.cpp:402
void set_displayed_type(const unit_type &type)
Displays the stats of a specified unit type.
std::vector< state_definition > state
static int get_acceleration()
Definition: types.cpp:573
resistances & get_resistances()
Definition: movetype.hpp:268
std::map< std::string, t_string > string_map
utils::optional_reference< const unit_type > current_type_
const std::string weapon_details_sep
Definition: constants.cpp:50
This class represents a single unit of a specific type.
Definition: unit.hpp:120
int movement_cost(const t_translation::terrain_code &terrain) const
Get the unit&#39;s movement cost on a particular terrain.
Definition: unit.hpp:1428
std::string join(const T &v, const std::string &s=",")
Generates a new string joining container items in a list.
void connect_signal_mouse_left_click(dispatcher &dispatcher, const signal &signal)
Connects a signal handler for a left mouse button click.
Definition: dispatcher.cpp:172
bool terrain_matches(const terrain_code &src, const terrain_code &dest)
Tests whether a specific terrain matches an expression, for matching rules see above.
unit_race::GENDER gender() const
The gender of this unit.
Definition: unit.hpp:455
logger & info()
Definition: log.cpp:89
#define a
int hitpoints() const
The current number of hitpoints this unit has.
Definition: unit.hpp:489
tree_view_node & get_root_node()
Definition: tree_view.hpp:75
const std::string & flag_rgb() const
Definition: types.cpp:721
This file contains the window object, this object is a top level container which has the event manage...
Base class for all widgets.
Definition: widget.hpp:49
std::string dgettext(const char *domain, const char *msgid)
Definition: gettext.cpp:415
virtual std::unique_ptr< widget > build() const override
A terrain string which is converted to a terrain is a string with 1 or 2 layers the layers are separa...
Definition: translation.hpp:49
int experience_needed(bool with_acceleration=true) const
Definition: types.cpp:578
static bool is_indivisible(t_translation::terrain_code id, const t_translation::ter_list &underlying)
Returns true if a terrain has no underlying types other than itself, in respect of either union...
Definition: terrain.hpp:100
int resistance_against(const std::string &damage_name, bool attacker) const
Gets resistance while considering custom WML abilities.
Definition: types.cpp:774
std::string absolute_image() const
The name of the file to game_display (used in menus).
Definition: unit.cpp:2416
styled_widget * label_details_
A label displays a text, the text can be wrapped but no scrollbars are provided.
Definition: label.hpp:57
void profile_button_callback()
Callback for the profile button.
static std::string _(const char *str)
Definition: gettext.hpp:93
utils::string_map get_base_resistances() const
Gets resistances without any abilities applied.
Definition: unit.hpp:1037
std::vector< std::tuple< std::string, t_string, t_string, t_string > > ability_tooltips() const
Gets the names and descriptions of this unit&#39;s abilities.
Definition: abilities.cpp:327
A single unit type that the player may recruit.
Definition: types.hpp:45
const color_t unit_type_color
bool is_nonnull() const
True if this object represents some sentinel values.
Definition: terrain.hpp:129
const t_string & name(GENDER gender=MALE) const
Definition: race.hpp:37
const terrain_code VOID_TERRAIN
VOID_TERRAIN is used for shrouded hexes.
Generic file dialog.
Definition: field-fwd.hpp:23
const unit_type & type() const
This unit&#39;s type, accounting for gender and variation.
Definition: unit.hpp:345
color_t hp_color() const
Color for this unit&#39;s current hitpoints.
Definition: unit.cpp:1085
virtual void set_label(const t_string &label)
void set_displayed_unit(const unit &u)
Displays the stats of a specific unit.
std::string span_color(const color_t &color)
Returns a Pango formatting string using the provided color_t object.
Base container class.
Definition: grid.hpp:31
std::string definition
Parameters for the styled_widget.
static const std::string & leader_crown()
The path to the leader crown overlay.
Definition: unit.cpp:1037
const std::vector< unit_race::GENDER > & genders() const
The returned vector will not be empty, provided this has been built to the HELP_INDEXED status...
Definition: types.hpp:251
void set_tooltip(const t_string &tooltip)
#define VALIDATE(cond, message)
The macro to use for the validation of WML.
const movetype & movement_type() const
Definition: types.hpp:191
unit_alignments::type alignment() const
Definition: types.hpp:195
This file contains the settings handling of the widget library.
std::shared_ptr< terrain_type_data > load_terrain_types_data()
Load the appropriate terrain types data to use.
Definition: help_impl.cpp:1621
const terrain_code FOGGED
std::ostringstream wrapper.
Definition: formatter.hpp:39
const t_string & type_name() const
The name of the unit in the current language setting.
Definition: types.hpp:141
color_t xp_color() const
Color for this unit&#39;s XP.
Definition: unit.cpp:1139
const t_string & name() const
Gets this unit&#39;s translatable display name.
Definition: unit.hpp:393
virtual void set_self_active(const bool active) override
See container_base::set_self_active.
virtual unsigned get_state() const override
See styled_widget::get_state.
virtual void set_active(const bool active) override
See styled_widget::set_active.
static tree_view_node & add_name_tree_node(tree_view_node &header_node, const std::string &type, const t_string &label, const t_string &tooltip="")
int max_experience() const
The max number of experience points this unit can have.
Definition: unit.hpp:519
std::set< t_translation::terrain_code > & encountered_terrains()
Definition: game.cpp:921
const std::vector< ability_metadata > & abilities_metadata() const
Definition: types.hpp:219
int level() const
The current level of this unit.
Definition: unit.hpp:549
virtual void set_use_markup(bool use_markup)
const std::vector< t_string > & trait_names() const
Gets the names of the currently registered traits.
Definition: unit.hpp:1071
const std::vector< std::string > & overlays() const
Get the unit&#39;s overlay images.
Definition: unit.hpp:1587
const t_string & type_name() const
Gets the translatable name of this unit&#39;s type.
Definition: unit.hpp:359
static color_t hp_color_max()
Definition: unit.cpp:1095
const std::string unicode_figure_dash
Definition: constants.cpp:45
void show_unit_description(const unit &u)
Definition: help.cpp:75
unit_alignments::type alignment() const
The alignment of this unit.
Definition: unit.hpp:465
#define REGISTER_WIDGET(id)
Wrapper for REGISTER_WIDGET3.
Generic locator abstracting the location of an image.
Definition: picture.hpp:60
static std::string get_side_color_id(unsigned side)
Definition: team.cpp:972
const color_t weapon_details_color
std::size_t i
Definition: function.cpp:967
const std::string unicode_en_dash
Definition: constants.cpp:43
int max_hitpoints() const
The max number of hitpoints this unit can have.
Definition: unit.hpp:495
std::string resistance_color(const int resistance)
Definition: helper.cpp:43
window * get_window()
Get the parent window.
Definition: widget.cpp:118
static std::string get_string(typename T::type key)
Uses the int value of the provided enum to get the associated index of the values array in the implem...
Definition: enum_base.hpp:41
bool can_recruit() const
Whether this unit can recruit other units - ie, are they a leader unit.
Definition: unit.hpp:602
std::string signed_percent(int val)
Convert into a percentage (using the Unicode "−" and +0% convention.
attack_itors attacks()
Gets an iterator over this unit&#39;s attacks.
Definition: unit.hpp:915
const std::string & icon() const
Definition: types.hpp:180
int level() const
Definition: types.hpp:167
static std::string unit_level_tooltip(const int level, const std::vector< std::string > &adv_to_types, const std::vector< config > &adv_to_mods)
Definition: helper.cpp:57
const unit_race * race() const
Gets this unit&#39;s race.
Definition: unit.hpp:483
const std::string unicode_bullet
Definition: constants.cpp:47
#define VGETTEXT(msgid,...)
Handy wrappers around interpolate_variables_into_string and gettext.
void finalize_setup()
Initializes the internal sub-widget pointers.
int hitpoints() const
Definition: types.hpp:164
A generic container base class.
int movement() const
Definition: types.hpp:169
int movement_cost(const t_translation::terrain_code &terrain, bool slowed=false) const
Returns the cost to move through the indicated terrain.
Definition: movetype.hpp:282
const t_string & name() const
Definition: terrain.hpp:48
static std::string alignment_description(unit_alignments::type align, unit_race::GENDER gender=unit_race::MALE)
Implementation detail of unit_type::alignment_description.
Definition: types.cpp:840
config::const_child_itors possible_traits() const
Definition: types.hpp:233
const std::string & image() const
Definition: types.hpp:179
bool empty() const
Definition: tstring.hpp:187
const ter_match ALL_OFF_MAP
const std::string weapon_numbers_sep
Definition: constants.cpp:49
const t_string & tooltip() const
int experience() const
The current number of experience points this unit has.
Definition: unit.hpp:513
utils::string_map damage_table() const
Returns a map from attack types to resistances.
Definition: movetype.cpp:729
const map_location & get_location() const
The current map location this unit is at.
Definition: unit.hpp:1345
symbol_table string_table
Definition: language.cpp:65
const unit_race * race() const
Never returns nullptr, but may point to the null race.
Definition: types.hpp:279
bool can_advance() const
Checks whether this unit has any options to advance to.
Definition: unit.hpp:262
void set_image_mods(const std::string &mods)
Sets the facing of the unit image.
Class to show the tips.
Definition: tooltip.cpp:57
static std::string get_hp_tooltip(const utils::string_map &res, const std::function< int(const std::string &, bool)> &get)
static const std::string & type()
Static type getter that does not rely on the widget being constructed.
int total_movement() const
The maximum moves this unit has.
Definition: unit.hpp:1254
void print_attack_details(T attacks, tree_view_node &parent_node)
std::string get_icon_path_stem() const
Gets this race&#39;s icon path without state/size suffix and extension.
Definition: race.cpp:161
std::vector< std::string > get_ability_list() const
Get a list of all abilities by ID.
Definition: abilities.cpp:243
const_attack_itors attacks() const
Definition: types.cpp:544
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
The unit&#39;s resistance against a given damage type.
Definition: unit.cpp:1651
bool can_advance() const
Definition: types.hpp:224
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:60
tree_view_node & add_child(const std::string &id, const std::map< std::string, string_map > &data, const int index=-1)
Constructs a new child node.
#define DBG_GUI_G
Definition: log.hpp:41
bool file_exists() const
Tests whether the file the locator points at exists.
Definition: picture.cpp:673
int movement_left() const
Gets how far a unit can move, considering the incapacitated flag.
Definition: unit.hpp:1270
std::string image_mods() const
Gets an IPF string containing all IPF image mods.
Definition: unit.cpp:2595
static std::string get_mp_tooltip(int total_movement, std::function< int(t_translation::terrain_code)> get)
Contains the implementation details for lexical_cast and shouldn&#39;t be used directly.
tree_view_node & add_node(const std::string &id, const std::map< std::string, string_map > &data, const int index=-1)
Definition: tree_view.cpp:57
virtual bool get_active() const override
See styled_widget::get_active.
const std::vector< t_string > & trait_descriptions() const
Gets the descriptions of the currently registered traits.
Definition: unit.hpp:1081