The Battle for Wesnoth  1.19.1+dev
helper.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2003 - 2024
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 /**
17  * @file
18  * Support functions for dealing with units.
19  */
20 
21 #include "units/unit.hpp"
22 #include "units/helper.hpp"
23 #include "units/types.hpp"
24 #include "play_controller.hpp"
25 
26 namespace unit_helper {
27 
29 {
30  return u.advances_to().size() + u.get_modification_advances().size();
31 }
32 
34 {
35  if(!u.valid()) {
36  return false;
37  }
38  return u->advances() && number_of_possible_advances(*u) > 0;
39 }
40 
41 /**
42  * Maps resistance <= -60 (resistance value <= -60%) to intense red.
43  * Maps resistance >= 60 (resistance value >= 60%) to intense green.
44  * Intermediate values are affinely mapped to the red-to-green scale,
45  * with 0 (0%) being mapped to yellow.
46  * Compare attack_info_percent_color() in reports.cpp.
47  */
48 std::string resistance_color(const int resistance)
49 {
50  // Passing false to select the more saturated red-to-green scale.
51  return game_config::red_to_green(50.0 + resistance * 5.0 / 6.0, false).to_hex_string();
52 }
53 
54 static std::string unit_level_tooltip(const int level, const std::vector<std::string> &adv_to_types, const std::vector<config> &adv_to_mods)
55 {
56  std::ostringstream tooltip;
57  tooltip << _("Level: ") << "<b>" << level << "</b>\n";
58  const bool has_advancements = !adv_to_types.empty() || !adv_to_mods.empty();
59  if(has_advancements) {
60  tooltip << _("Advancements:") << "\n<b>\t";
61  if(!adv_to_types.empty())
62  tooltip << utils::join(adv_to_types, "\n\t");
63  if(!adv_to_mods.empty()) {
64  if(!adv_to_types.empty())
65  tooltip << "\n\t";
66  std::vector<std::string> descriptions;
67  for(const config& adv : adv_to_mods)
68  descriptions.push_back(adv["description"].str());
69  tooltip << utils::join(descriptions, "\n\t");
70  }
71  tooltip << "</b>";
72  } else {
73  tooltip << _("No advancement");
74  }
75  return tooltip.str();
76 }
77 
78 std::string unit_level_tooltip(const unit &u)
79 {
81 }
82 
83 std::string unit_level_tooltip(const unit_type &type)
84 {
85  const auto mod_adv_iters = type.modification_advancements();
86  const std::vector<config> mod_advancements(mod_adv_iters.begin(), mod_adv_iters.end());
87 
88  return unit_level_tooltip(type.level(), type.advances_to(), mod_advancements);
89 }
90 
91 }
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:159
A single unit type that the player may recruit.
Definition: types.hpp:43
This class represents a single unit of a specific type.
Definition: unit.hpp:133
static std::string _(const char *str)
Definition: gettext.hpp:93
int level() const
The current level of this unit.
Definition: unit.hpp:559
std::vector< config > get_modification_advances() const
Gets any non-typed advanced options set by modifications.
Definition: unit.cpp:1941
const advances_to_t & advances_to() const
Gets the possible types this unit can advance to on level-up.
Definition: unit.hpp:244
const std::vector< std::string > advances_to_translated() const
Gets the names of the possible types this unit can advance to on level-up.
Definition: unit.cpp:1196
std::string tooltip
Shown when hovering over an entry in the filter's drop-down list.
Definition: manager.cpp:209
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....
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:54
bool will_certainly_advance(const unit_map::iterator &u)
Encapsulates the logic for deciding whether an iterator u points to a unit that can advance.
Definition: helper.cpp:33
std::string resistance_color(const int resistance)
Maps resistance <= -60 (resistance value <= -60%) to intense red.
Definition: helper.cpp:48
int number_of_possible_advances(const unit &u)
Determines the total number of available advancements (of any kind) for a given unit.
Definition: helper.cpp:28
std::string join(const T &v, const std::string &s=",")
Generates a new string joining container items in a list.
std::string to_hex_string() const
Returns the stored color in rrggbb hex format.
Definition: color.cpp:84
bool valid() const
Definition: map.hpp:273