veloren_voxygen/hud/
util.rs

1use super::img_ids;
2use common::{
3    comp::{
4        BuffData, BuffKind,
5        inventory::trade_pricing::TradePricing,
6        item::{
7            Effects, Item, ItemDefinitionId, ItemDesc, ItemI18n, ItemKind, MaterialKind,
8            MaterialStatManifest,
9            armor::{Armor, ArmorKind, Protection},
10            tool::{Hands, Tool, ToolKind},
11        },
12    },
13    effect::Effect,
14    trade::{Good, SitePrices},
15};
16use conrod_core::image;
17use i18n::{FluentValue, Localization, fluent_args};
18use std::{borrow::Cow, fmt::Write};
19
20pub fn price_desc<'a>(
21    prices: &Option<SitePrices>,
22    item_definition_id: ItemDefinitionId<'_>,
23    i18n: &'a Localization,
24) -> Option<(Cow<'a, str>, Cow<'a, str>, f32)> {
25    let prices = prices.as_ref()?;
26    let materials = TradePricing::get_materials(&item_definition_id)?;
27    let coinprice = prices.values.get(&Good::Coin).cloned().unwrap_or(1.0);
28    let buyprice: f32 = materials
29        .iter()
30        .map(|e| prices.values.get(&e.1).cloned().unwrap_or_default() * e.0)
31        .sum();
32    let sellprice: f32 = materials
33        .iter()
34        .map(|e| prices.values.get(&e.1).cloned().unwrap_or_default() * e.0 * e.1.trade_margin())
35        .sum();
36
37    let deal_goodness: f32 = materials
38        .iter()
39        .map(|e| prices.values.get(&e.1).cloned().unwrap_or(0.0))
40        .sum::<f32>()
41        / prices.values.get(&Good::Coin).cloned().unwrap_or(1.0)
42        / (materials.len() as f32);
43    let deal_goodness = deal_goodness.log(2.0);
44
45    let buy_string = i18n.get_msg_ctx("hud-trade-buy", &fluent_args! {
46        "coin_num" => buyprice / coinprice,
47        "coin_formatted" => format!("{:0.1}", buyprice / coinprice),
48    });
49    let sell_string = i18n.get_msg_ctx("hud-trade-sell", &fluent_args! {
50        "coin_num" => sellprice / coinprice,
51        "coin_formatted" => format!("{:0.1}", sellprice / coinprice),
52    });
53
54    let deal_goodness = match deal_goodness {
55        x if x < -2.5 => 0.0,
56        x if x < -1.05 => 0.25,
57        x if x < -0.95 => 0.5,
58        x if x < 0.0 => 0.75,
59        _ => 1.0,
60    };
61    Some((buy_string, sell_string, deal_goodness))
62}
63
64pub fn item_text<'a, I: ItemDesc + ?Sized>(
65    item: &I,
66    i18n: &'a Localization,
67    i18n_spec: &'a ItemI18n,
68) -> (String, String) {
69    let (title, desc) = item.i18n(i18n_spec);
70
71    (i18n.get_content(&title), i18n.get_content(&desc))
72}
73
74pub fn describe<'a, I: ItemDesc + ?Sized>(
75    item: &I,
76    i18n: &'a Localization,
77    i18n_spec: &'a ItemI18n,
78) -> String {
79    let (title, _) = item_text(item, i18n, i18n_spec);
80    let amount = item.amount();
81
82    if amount.get() > 1 {
83        format!("{amount} x {title}")
84    } else {
85        title
86    }
87}
88
89pub fn kind_text<'a>(kind: &ItemKind, i18n: &'a Localization) -> Cow<'a, str> {
90    match kind {
91        ItemKind::Armor(armor) => armor_kind(armor, i18n),
92        ItemKind::Tool(tool) => Cow::Owned(format!(
93            "{} ({})",
94            tool_kind(tool, i18n),
95            tool_hands(tool, i18n)
96        )),
97        ItemKind::ModularComponent(mc) => {
98            if let Some(toolkind) = mc.toolkind() {
99                Cow::Owned(format!(
100                    "{} {}",
101                    i18n.get_msg(&format!("common-weapons-{}", toolkind.identifier_name())),
102                    i18n.get_msg("common-kind-modular_component_partial")
103                ))
104            } else {
105                i18n.get_msg("common-kind-modular_component")
106            }
107        },
108        ItemKind::Glider => i18n.get_msg("common-kind-glider"),
109        ItemKind::Consumable { .. } => i18n.get_msg("common-kind-consumable"),
110        ItemKind::Utility { .. } => i18n.get_msg("common-kind-utility"),
111        ItemKind::Ingredient { .. } => i18n.get_msg("common-kind-ingredient"),
112        ItemKind::Lantern { .. } => i18n.get_msg("common-kind-lantern"),
113        ItemKind::TagExamples { .. } => Cow::Borrowed(""),
114        ItemKind::RecipeGroup { .. } => i18n.get_msg("common-kind-recipegroup"),
115    }
116}
117
118pub fn material_kind_text<'a>(kind: &MaterialKind, i18n: &'a Localization) -> Cow<'a, str> {
119    match kind {
120        MaterialKind::Metal => i18n.get_msg("common-material-metal"),
121        MaterialKind::Gem => i18n.get_msg("common-material-gem"),
122        MaterialKind::Wood => i18n.get_msg("common-material-wood"),
123        MaterialKind::Stone => i18n.get_msg("common-material-stone"),
124        MaterialKind::Cloth => i18n.get_msg("common-material-cloth"),
125        MaterialKind::Hide => i18n.get_msg("common-material-hide"),
126    }
127}
128
129pub fn stats_count(item: &dyn ItemDesc, msm: &MaterialStatManifest) -> usize {
130    let mut count = match &*item.kind() {
131        ItemKind::Armor(armor) => {
132            let armor_stats = armor.stats(msm, item.stats_durability_multiplier());
133            armor_stats.energy_reward.is_some() as usize
134                + armor_stats.energy_max.is_some() as usize
135                + armor_stats.stealth.is_some() as usize
136                + armor_stats.precision_power.is_some() as usize
137                + armor_stats.poise_resilience.is_some() as usize
138                + armor_stats.protection.is_some() as usize
139                + (item.num_slots() > 0) as usize
140        },
141        ItemKind::Tool(_) => 6,
142        ItemKind::Consumable { effects, .. } => match effects {
143            Effects::Any(_) | Effects::One(_) => 1,
144            Effects::All(effects) => effects.len(),
145        },
146        ItemKind::RecipeGroup { recipes } => {
147            /* Add one for recipe known/not known message */
148            recipes.len() + 1
149        },
150        ItemKind::ModularComponent { .. } => 6,
151        _ => 0,
152    };
153    if item.has_durability() {
154        count += 1;
155    }
156    count
157}
158
159pub fn line_count(item: &dyn ItemDesc, msm: &MaterialStatManifest, i18n: &Localization) -> usize {
160    match &*item.kind() {
161        ItemKind::Consumable { effects, .. } => {
162            let descs = consumable_desc(effects, i18n);
163            let mut lines = 0;
164            for desc in descs {
165                lines += desc.matches('\n').count() + 1;
166            }
167
168            lines
169        },
170        _ => stats_count(item, msm),
171    }
172}
173
174/// Returns i18n key for a buff with title, .desc and optionally .stat
175///
176/// NOTE: not to be confused with buff key for buff's kill message
177fn buff_key(buff: BuffKind) -> &'static str {
178    match buff {
179        // Buffs
180        BuffKind::Regeneration => "buff-heal",
181        BuffKind::Saturation => "buff-saturation",
182        BuffKind::Potion => "buff-potion",
183        BuffKind::Agility => "buff-agility",
184        BuffKind::RestingHeal => "buff-resting_heal",
185        BuffKind::EnergyRegen => "buff-energy_regen",
186        BuffKind::ComboGeneration => "buff-combo_generation",
187        BuffKind::IncreaseMaxHealth => "buff-increase_max_health",
188        BuffKind::IncreaseMaxEnergy => "buff-increase_max_energy",
189        BuffKind::Invulnerability => "buff-invulnerability",
190        BuffKind::ProtectingWard => "buff-protectingward",
191        BuffKind::Frenzied => "buff-frenzied",
192        BuffKind::Hastened => "buff-hastened",
193        BuffKind::Fortitude => "buff-fortitude",
194        BuffKind::Reckless => "buff-reckless",
195        // BuffKind::SalamanderAspect => "buff-salamanderaspect",
196        BuffKind::Flame => "buff-burn",
197        BuffKind::Frigid => "buff-frigid",
198        BuffKind::Lifesteal => "buff-lifesteal",
199        BuffKind::ImminentCritical => "buff-imminentcritical",
200        BuffKind::Fury => "buff-fury",
201        BuffKind::Sunderer => "buff-sunderer",
202        BuffKind::Defiance => "buff-defiance",
203        BuffKind::Bloodfeast => "buff-bloodfeast",
204        BuffKind::Berserk => "buff-berserk",
205        BuffKind::ScornfulTaunt => "buff-scornfultaunt",
206        BuffKind::Tenacity => "buff-tenacity",
207        BuffKind::Resilience => "buff-resilience",
208        BuffKind::OwlTalon => "buff-owltalon",
209        BuffKind::HeavyNock => "buff-heavynock",
210        BuffKind::Heartseeker => "buff-heartseeker",
211        BuffKind::EagleEye => "buff-eagleeye",
212        BuffKind::ArdentHunter => "buff-ardenthunter",
213        BuffKind::SepticShot => "buff-septicshot",
214        // Debuffs
215        BuffKind::Bleeding => "buff-bleed",
216        BuffKind::Cursed => "buff-cursed",
217        BuffKind::Burning => "buff-burn",
218        BuffKind::Crippled => "buff-crippled",
219        BuffKind::Frozen => "buff-frozen",
220        BuffKind::Wet => "buff-wet",
221        BuffKind::Ensnared => "buff-ensnared",
222        BuffKind::Poisoned => "buff-poisoned",
223        BuffKind::Parried => "buff-parried",
224        BuffKind::PotionSickness => "buff-potionsickness",
225        BuffKind::Heatstroke => "buff-heatstroke",
226        BuffKind::Rooted => "buff-rooted",
227        BuffKind::Winded => "buff-winded",
228        BuffKind::Amnesia => "buff-amnesia",
229        BuffKind::OffBalance => "buff-offbalance",
230        BuffKind::Chilled => "buff-chilled",
231        BuffKind::ArdentHunted => "buff-ardenthunted",
232        // Neutral
233        BuffKind::Polymorphed => "buff-polymorphed",
234    }
235}
236
237/// Returns localized buff title
238pub fn get_buff_title(buff: BuffKind, i18n: &Localization) -> Cow<'_, str> {
239    let key = buff_key(buff);
240
241    i18n.get_msg(key)
242}
243
244/// Returns localized buff description
245pub fn get_buff_desc(buff: BuffKind, data: BuffData, i18n: &Localization) -> Cow<'_, str> {
246    let key = buff_key(buff);
247    if let BuffKind::RestingHeal = buff {
248        i18n.get_attr_ctx(key, "desc", &i18n::fluent_args! {
249            "rate" => data.strength * 100.0
250        })
251    } else {
252        i18n.get_attr(key, "desc")
253    }
254}
255
256fn almost_integer(number: &f32) -> FluentValue<'_> {
257    let epsilon = 0.001;
258    if number.fract() < epsilon {
259        FluentValue::from(number.round() as usize)
260    } else {
261        FluentValue::from(format!("{:.<3}", number))
262    }
263}
264/// Takes N `effects` and returns N effect descriptions
265/// If effect isn't intended to have description, returns empty string
266///
267/// FIXME: handle which effects should have description in `stats_count`
268/// to not waste space in item box
269pub fn consumable_desc(effects: &Effects, i18n: &Localization) -> Vec<String> {
270    let mut descriptions = Vec::new();
271    match effects {
272        Effects::Any(_) => {
273            descriptions.push(i18n.get_msg("buff-mysterious").into_owned());
274        },
275        Effects::All(_) | Effects::One(_) => {
276            for effect in effects.effects() {
277                let mut description = String::new();
278                if let Effect::Buff(buff) = effect {
279                    let strength = buff.data.strength;
280                    let duration = buff.data.duration.map(|d| d.0 as f32);
281                    let str_total = duration.map_or(strength, |secs| strength * secs);
282                    let str_duration = duration.unwrap_or(0.0);
283                    let fluent_duration = almost_integer(&str_duration);
284
285                    let format_float =
286                        |input: f32| format!("{:.1}", input).trim_end_matches(".0").to_string();
287
288                    let buff_desc = match buff.kind {
289                        // These share common buff-key and show full possible regen
290                        BuffKind::Saturation | BuffKind::Regeneration | BuffKind::Potion => {
291                            let key = "buff-heal";
292                            i18n.get_attr_ctx(key, "stat", &i18n::fluent_args! {
293                                "str_total" => format_float(str_total),
294                                "duration" => fluent_duration,
295                            })
296                        },
297                        // Shows its full possible regen
298                        BuffKind::EnergyRegen => {
299                            let key = buff_key(buff.kind);
300                            i18n.get_attr_ctx(key, "stat", &i18n::fluent_args! {
301                                "str_total" => format_float(str_total),
302                                "duration" => fluent_duration,
303                            })
304                        },
305                        BuffKind::ComboGeneration => {
306                            let key = buff_key(buff.kind);
307                            i18n.get_attr_ctx(key, "stat", &i18n::fluent_args! {
308                                "str_total" => format_float(str_total),
309                                "duration" => fluent_duration,
310                            })
311                        },
312                        // Show buff strength
313                        BuffKind::IncreaseMaxEnergy
314                        | BuffKind::IncreaseMaxHealth => {
315                            let key = buff_key(buff.kind);
316                            i18n.get_attr_ctx(key, "stat", &i18n::fluent_args! {
317                                "strength" => format_float(strength),
318                                "duration" => fluent_duration,
319                            })
320                        },
321                        // Show percentage
322                        BuffKind::PotionSickness
323                        | BuffKind::Agility => {
324                            let key = buff_key(buff.kind);
325                            i18n.get_attr_ctx(key, "stat", &i18n::fluent_args! {
326                                "strength" => format_float(strength * 100.0),
327                                "duration" => fluent_duration,
328                            })
329                        },
330                        // Independent of strength, still has duration
331                        BuffKind::Invulnerability => {
332                            let key = buff_key(buff.kind);
333                            i18n.get_attr_ctx(key, "stat", &i18n::fluent_args! {
334                                "duration" => fluent_duration,
335                            })
336                        },
337                        // Have no stat description
338                        BuffKind::Bleeding
339                        | BuffKind::Burning
340                        | BuffKind::RestingHeal
341                        | BuffKind::Cursed
342                        | BuffKind::ProtectingWard
343                        | BuffKind::Crippled
344                        | BuffKind::Frenzied
345                        | BuffKind::Frozen
346                        | BuffKind::Wet
347                        | BuffKind::Ensnared
348                        | BuffKind::Poisoned
349                        | BuffKind::Hastened
350                        | BuffKind::Fortitude
351                        | BuffKind::Parried
352                        | BuffKind::Reckless
353                        | BuffKind::Polymorphed
354                        | BuffKind::Flame
355                        | BuffKind::Frigid
356                        | BuffKind::Lifesteal
357                        // | BuffKind::SalamanderAspect
358                        | BuffKind::ImminentCritical
359                        | BuffKind::Fury
360                        | BuffKind::Sunderer
361                        | BuffKind::Defiance
362                        | BuffKind::Bloodfeast
363                        | BuffKind::Berserk
364                        | BuffKind::Heatstroke
365                        | BuffKind::ScornfulTaunt
366                        | BuffKind::Rooted
367                        | BuffKind::Winded
368                        | BuffKind::Amnesia
369                        | BuffKind::OffBalance
370                        | BuffKind::Tenacity
371                        | BuffKind::Resilience
372                        | BuffKind::OwlTalon
373                        | BuffKind::HeavyNock
374                        | BuffKind::Heartseeker
375                        | BuffKind::EagleEye
376                        | BuffKind::Chilled
377                        | BuffKind::ArdentHunter
378                        | BuffKind::ArdentHunted
379                        | BuffKind::SepticShot => Cow::Borrowed(""),
380                    };
381
382                    write!(&mut description, "{}", buff_desc).unwrap();
383                }
384                descriptions.push(description);
385            }
386        },
387    }
388    descriptions
389}
390
391// Armor
392fn armor_kind<'a>(armor: &Armor, i18n: &'a Localization) -> Cow<'a, str> {
393    match armor.kind {
394        ArmorKind::Shoulder => i18n.get_msg("hud-bag-shoulders"),
395        ArmorKind::Chest => i18n.get_msg("hud-bag-chest"),
396        ArmorKind::Belt => i18n.get_msg("hud-bag-belt"),
397        ArmorKind::Hand => i18n.get_msg("hud-bag-hands"),
398        ArmorKind::Pants => i18n.get_msg("hud-bag-legs"),
399        ArmorKind::Foot => i18n.get_msg("hud-bag-feet"),
400        ArmorKind::Back => i18n.get_msg("hud-bag-back"),
401        ArmorKind::Backpack => i18n.get_msg("hud-bag-backpack"),
402        ArmorKind::Ring => i18n.get_msg("hud-bag-ring"),
403        ArmorKind::Neck => i18n.get_msg("hud-bag-neck"),
404        ArmorKind::Head => i18n.get_msg("hud-bag-head"),
405        ArmorKind::Tabard => i18n.get_msg("hud-bag-tabard"),
406        ArmorKind::Bag => i18n.get_msg("hud-bag-bag"),
407    }
408}
409
410// Tool
411fn tool_kind<'a>(tool: &Tool, i18n: &'a Localization) -> Cow<'a, str> {
412    match tool.kind {
413        ToolKind::Sword => i18n.get_msg("common-weapons-sword"),
414        ToolKind::Axe => i18n.get_msg("common-weapons-axe"),
415        ToolKind::Hammer => i18n.get_msg("common-weapons-hammer"),
416        ToolKind::Bow => i18n.get_msg("common-weapons-bow"),
417        ToolKind::Dagger => i18n.get_msg("common-weapons-dagger"),
418        ToolKind::Staff => i18n.get_msg("common-weapons-staff"),
419        ToolKind::Sceptre => i18n.get_msg("common-weapons-sceptre"),
420        ToolKind::Shield => i18n.get_msg("common-weapons-shield"),
421        ToolKind::Spear => i18n.get_msg("common-weapons-spear"),
422        ToolKind::Blowgun => i18n.get_msg("common-weapons-blowgun"),
423        ToolKind::Natural => i18n.get_msg("common-weapons-natural"),
424        ToolKind::Debug => i18n.get_msg("common-tool-debug"),
425        ToolKind::Farming => i18n.get_msg("common-tool-farming"),
426        ToolKind::Instrument => i18n.get_msg("common-tool-instrument"),
427        ToolKind::Throwable => i18n.get_msg("common-tool-throwable"),
428        ToolKind::Pick => i18n.get_msg("common-tool-pick"),
429        ToolKind::Shovel => i18n.get_msg("common-tool-shovel"),
430        ToolKind::Empty => i18n.get_msg("common-empty"),
431    }
432}
433
434/// Output the number of hands needed to hold a tool
435pub fn tool_hands<'a>(tool: &Tool, i18n: &'a Localization) -> Cow<'a, str> {
436    match tool.hands {
437        Hands::One => i18n.get_msg("common-hands-one"),
438        Hands::Two => i18n.get_msg("common-hands-two"),
439    }
440}
441
442/// Compare two type, output a colored character to show comparison
443pub fn comparison<T: PartialOrd>(first: T, other: T) -> (&'static str, conrod_core::Color) {
444    if first == other {
445        ("•", conrod_core::color::GREY)
446    } else if other < first {
447        ("▲", conrod_core::color::GREEN)
448    } else {
449        ("▼", conrod_core::color::RED)
450    }
451}
452
453/// Compare two Option type, output a colored character to show comparison
454pub fn option_comparison<T: PartialOrd>(
455    first: &Option<T>,
456    other: &Option<T>,
457) -> (&'static str, conrod_core::Color) {
458    if let Some(first) = first {
459        if let Some(other) = other {
460            if first == other {
461                ("•", conrod_core::color::GREY)
462            } else if other < first {
463                ("▲", conrod_core::color::GREEN)
464            } else {
465                ("▼", conrod_core::color::RED)
466            }
467        } else {
468            ("▲", conrod_core::color::GREEN)
469        }
470    } else if other.is_some() {
471        ("▼", conrod_core::color::RED)
472    } else {
473        ("•", conrod_core::color::GREY)
474    }
475}
476
477/// Output protection as a string
478pub fn protec2string(stat: Protection) -> String {
479    match stat {
480        Protection::Normal(a) => format!("{:.1}", a),
481        Protection::Invincible => "Inf".to_string(),
482    }
483}
484
485/// Gets the durability of an item in a format more intuitive for UI
486pub fn item_durability(item: &dyn ItemDesc) -> Option<u32> {
487    let durability = item
488        .durability_lost()
489        .or_else(|| item.has_durability().then_some(0));
490    durability.map(|d| Item::MAX_DURABILITY - d)
491}
492
493pub fn ability_image(imgs: &img_ids::Imgs, ability_id: &str) -> image::Id {
494    match ability_id {
495        // Debug stick
496        "common.abilities.debug.forwardboost" => imgs.flyingrod_m1,
497        "common.abilities.debug.upboost" => imgs.flyingrod_m2,
498        "common.abilities.debug.possess" => imgs.snake_arrow_0,
499        // Sword
500        "veloren.core.pseudo_abilities.sword.heavy_stance" => imgs.sword_heavy_stance,
501        "veloren.core.pseudo_abilities.sword.agile_stance" => imgs.sword_agile_stance,
502        "veloren.core.pseudo_abilities.sword.defensive_stance" => imgs.sword_defensive_stance,
503        "veloren.core.pseudo_abilities.sword.crippling_stance" => imgs.sword_crippling_stance,
504        "veloren.core.pseudo_abilities.sword.cleaving_stance" => imgs.sword_cleaving_stance,
505        "veloren.core.pseudo_abilities.sword.double_slash" => imgs.sword_double_slash,
506        "common.abilities.sword.basic_double_slash" => imgs.sword_basic_double_slash,
507        "common.abilities.sword.heavy_double_slash" => imgs.sword_heavy_double_slash,
508        "common.abilities.sword.agile_double_slash" => imgs.sword_agile_double_slash,
509        "common.abilities.sword.defensive_double_slash" => imgs.sword_defensive_double_slash,
510        "common.abilities.sword.crippling_double_slash" => imgs.sword_crippling_double_slash,
511        "common.abilities.sword.cleaving_double_slash" => imgs.sword_cleaving_double_slash,
512        "veloren.core.pseudo_abilities.sword.secondary_ability" => imgs.sword_secondary_ability,
513        "common.abilities.sword.basic_thrust" => imgs.sword_basic_thrust,
514        "common.abilities.sword.heavy_slam" => imgs.sword_heavy_slam,
515        "common.abilities.sword.agile_perforate" => imgs.sword_agile_perforate,
516        "common.abilities.sword.agile_dual_perforate" => imgs.sword_agile_perforate,
517        "common.abilities.sword.defensive_vital_jab" => imgs.sword_defensive_vital_jab,
518        "common.abilities.sword.crippling_deep_rend" => imgs.sword_crippling_deep_rend,
519        "common.abilities.sword.cleaving_spiral_slash" => imgs.sword_cleaving_spiral_slash,
520        "common.abilities.sword.cleaving_dual_spiral_slash" => imgs.sword_cleaving_spiral_slash,
521        "veloren.core.pseudo_abilities.sword.crescent_slash" => imgs.sword_crescent_slash,
522        "common.abilities.sword.basic_crescent_slash" => imgs.sword_basic_crescent_slash,
523        "common.abilities.sword.heavy_crescent_slash" => imgs.sword_heavy_crescent_slash,
524        "common.abilities.sword.agile_crescent_slash" => imgs.sword_agile_crescent_slash,
525        "common.abilities.sword.defensive_crescent_slash" => imgs.sword_defensive_crescent_slash,
526        "common.abilities.sword.crippling_crescent_slash" => imgs.sword_crippling_crescent_slash,
527        "common.abilities.sword.cleaving_crescent_slash" => imgs.sword_cleaving_crescent_slash,
528        "veloren.core.pseudo_abilities.sword.fell_strike" => imgs.sword_fell_strike,
529        "common.abilities.sword.basic_fell_strike" => imgs.sword_basic_fell_strike,
530        "common.abilities.sword.heavy_fell_strike" => imgs.sword_heavy_fell_strike,
531        "common.abilities.sword.agile_fell_strike" => imgs.sword_agile_fell_strike,
532        "common.abilities.sword.defensive_fell_strike" => imgs.sword_defensive_fell_strike,
533        "common.abilities.sword.crippling_fell_strike" => imgs.sword_crippling_fell_strike,
534        "common.abilities.sword.cleaving_fell_strike" => imgs.sword_cleaving_fell_strike,
535        "veloren.core.pseudo_abilities.sword.skewer" => imgs.sword_skewer,
536        "common.abilities.sword.basic_skewer" => imgs.sword_basic_skewer,
537        "common.abilities.sword.heavy_skewer" => imgs.sword_heavy_skewer,
538        "common.abilities.sword.agile_skewer" => imgs.sword_agile_skewer,
539        "common.abilities.sword.defensive_skewer" => imgs.sword_defensive_skewer,
540        "common.abilities.sword.crippling_skewer" => imgs.sword_crippling_skewer,
541        "common.abilities.sword.cleaving_skewer" => imgs.sword_cleaving_skewer,
542        "veloren.core.pseudo_abilities.sword.cascade" => imgs.sword_cascade,
543        "common.abilities.sword.basic_cascade" => imgs.sword_basic_cascade,
544        "common.abilities.sword.heavy_cascade" => imgs.sword_heavy_cascade,
545        "common.abilities.sword.agile_cascade" => imgs.sword_agile_cascade,
546        "common.abilities.sword.defensive_cascade" => imgs.sword_defensive_cascade,
547        "common.abilities.sword.crippling_cascade" => imgs.sword_crippling_cascade,
548        "common.abilities.sword.cleaving_cascade" => imgs.sword_cleaving_cascade,
549        "veloren.core.pseudo_abilities.sword.cross_cut" => imgs.sword_cross_cut,
550        "common.abilities.sword.basic_cross_cut" => imgs.sword_basic_cross_cut,
551        "common.abilities.sword.heavy_cross_cut" => imgs.sword_heavy_cross_cut,
552        "common.abilities.sword.agile_cross_cut" => imgs.sword_agile_cross_cut,
553        "common.abilities.sword.defensive_cross_cut" => imgs.sword_defensive_cross_cut,
554        "common.abilities.sword.crippling_cross_cut" => imgs.sword_crippling_cross_cut,
555        "common.abilities.sword.cleaving_cross_cut" => imgs.sword_cleaving_cross_cut,
556        "common.abilities.sword.basic_dual_cross_cut" => imgs.sword_basic_cross_cut,
557        "common.abilities.sword.heavy_dual_cross_cut" => imgs.sword_heavy_cross_cut,
558        "common.abilities.sword.agile_dual_cross_cut" => imgs.sword_agile_cross_cut,
559        "common.abilities.sword.defensive_dual_cross_cut" => imgs.sword_defensive_cross_cut,
560        "common.abilities.sword.crippling_dual_cross_cut" => imgs.sword_crippling_cross_cut,
561        "common.abilities.sword.cleaving_dual_cross_cut" => imgs.sword_cleaving_cross_cut,
562        "veloren.core.pseudo_abilities.sword.finisher" => imgs.sword_finisher,
563        "common.abilities.sword.basic_mighty_strike" => imgs.sword_basic_mighty_strike,
564        "common.abilities.sword.heavy_guillotine" => imgs.sword_heavy_guillotine,
565        "common.abilities.sword.agile_hundred_cuts" => imgs.sword_agile_hundred_cuts,
566        "common.abilities.sword.defensive_counter" => imgs.sword_defensive_counter,
567        "common.abilities.sword.crippling_mutilate" => imgs.sword_crippling_mutilate,
568        "common.abilities.sword.cleaving_bladestorm" => imgs.sword_cleaving_bladestorm,
569        "common.abilities.sword.cleaving_dual_bladestorm" => imgs.sword_cleaving_bladestorm,
570        "common.abilities.sword.heavy_sweep" => imgs.sword_heavy_sweep,
571        "common.abilities.sword.heavy_pommel_strike" => imgs.sword_heavy_pommel_strike,
572        "common.abilities.sword.agile_quick_draw" => imgs.sword_agile_quick_draw,
573        "common.abilities.sword.agile_feint" => imgs.sword_agile_feint,
574        "common.abilities.sword.defensive_riposte" => imgs.sword_defensive_riposte,
575        "common.abilities.sword.defensive_disengage" => imgs.sword_defensive_disengage,
576        "common.abilities.sword.crippling_gouge" => imgs.sword_crippling_gouge,
577        "common.abilities.sword.crippling_hamstring" => imgs.sword_crippling_hamstring,
578        "common.abilities.sword.cleaving_whirlwind_slice" => imgs.sword_cleaving_whirlwind_slice,
579        "common.abilities.sword.cleaving_dual_whirlwind_slice" => {
580            imgs.sword_cleaving_whirlwind_slice
581        },
582        "common.abilities.sword.cleaving_earth_splitter" => imgs.sword_cleaving_earth_splitter,
583        "common.abilities.sword.heavy_fortitude" => imgs.sword_heavy_fortitude,
584        "common.abilities.sword.heavy_pillar_thrust" => imgs.sword_heavy_pillar_thrust,
585        "common.abilities.sword.agile_dancing_edge" => imgs.sword_agile_dancing_edge,
586        "common.abilities.sword.agile_flurry" => imgs.sword_agile_flurry,
587        "common.abilities.sword.agile_dual_flurry" => imgs.sword_agile_flurry,
588        "common.abilities.sword.defensive_stalwart_sword" => imgs.sword_defensive_stalwart_sword,
589        "common.abilities.sword.defensive_deflect" => imgs.sword_defensive_deflect,
590        "common.abilities.sword.crippling_eviscerate" => imgs.sword_crippling_eviscerate,
591        "common.abilities.sword.crippling_bloody_gash" => imgs.sword_crippling_bloody_gash,
592        "common.abilities.sword.cleaving_blade_fever" => imgs.sword_cleaving_blade_fever,
593        "common.abilities.sword.cleaving_sky_splitter" => imgs.sword_cleaving_sky_splitter,
594        // Axe
595        "common.abilities.axe.triple_chop" => imgs.axe_triple_chop,
596        "common.abilities.axe.cleave" => imgs.axe_cleave,
597        "common.abilities.axe.brutal_swing" => imgs.axe_brutal_swing,
598        "common.abilities.axe.berserk" => imgs.axe_berserk,
599        "common.abilities.axe.rising_tide" => imgs.axe_rising_tide,
600        "common.abilities.axe.savage_sense" => imgs.axe_savage_sense,
601        "common.abilities.axe.adrenaline_rush" => imgs.axe_adrenaline_rush,
602        "common.abilities.axe.execute" => imgs.axe_execute,
603        "common.abilities.axe.maelstrom" => imgs.axe_maelstrom,
604        "common.abilities.axe.rake" => imgs.axe_rake,
605        "common.abilities.axe.bloodfeast" => imgs.axe_bloodfeast,
606        "common.abilities.axe.fierce_raze" => imgs.axe_fierce_raze,
607        "common.abilities.axe.dual_fierce_raze" => imgs.axe_fierce_raze,
608        "common.abilities.axe.furor" => imgs.axe_furor,
609        "common.abilities.axe.fracture" => imgs.axe_fracture,
610        "common.abilities.axe.lacerate" => imgs.axe_lacerate,
611        "common.abilities.axe.riptide" => imgs.axe_riptide,
612        "common.abilities.axe.skull_bash" => imgs.axe_skull_bash,
613        "common.abilities.axe.sunder" => imgs.axe_sunder,
614        "common.abilities.axe.plunder" => imgs.axe_plunder,
615        "common.abilities.axe.defiance" => imgs.axe_defiance,
616        "common.abilities.axe.keelhaul" => imgs.axe_keelhaul,
617        "common.abilities.axe.bulkhead" => imgs.axe_bulkhead,
618        "common.abilities.axe.capsize" => imgs.axe_capsize,
619        // Hammer
620        "common.abilities.hammer.solid_smash" => imgs.hammer_solid_smash,
621        "common.abilities.hammer.wide_wallop" => imgs.hammer_wide_wallop,
622        "common.abilities.hammer.scornful_swipe" => imgs.hammer_scornful_swipe,
623        "common.abilities.hammer.tremor" => imgs.hammer_tremor,
624        "common.abilities.hammer.vigorous_bash" => imgs.hammer_vigorous_bash,
625        "common.abilities.hammer.heavy_whorl" => imgs.hammer_heavy_whorl,
626        "common.abilities.hammer.dual_heavy_whorl" => imgs.hammer_heavy_whorl,
627        "common.abilities.hammer.intercept" => imgs.hammer_intercept,
628        "common.abilities.hammer.dual_intercept" => imgs.hammer_intercept,
629        "common.abilities.hammer.retaliate" => imgs.hammer_retaliate,
630        "common.abilities.hammer.spine_cracker" => imgs.hammer_spine_cracker,
631        "common.abilities.hammer.breach" => imgs.hammer_breach,
632        "common.abilities.hammer.pile_driver" => imgs.hammer_pile_driver,
633        "common.abilities.hammer.lung_pummel" => imgs.hammer_lung_pummel,
634        "common.abilities.hammer.helm_crusher" => imgs.hammer_helm_crusher,
635        "common.abilities.hammer.iron_tempest" => imgs.hammer_iron_tempest,
636        "common.abilities.hammer.dual_iron_tempest" => imgs.hammer_iron_tempest,
637        "common.abilities.hammer.upheaval" => imgs.hammer_upheaval,
638        "common.abilities.hammer.dual_upheaval" => imgs.hammer_upheaval,
639        "common.abilities.hammer.rampart" => imgs.hammer_rampart,
640        "common.abilities.hammer.tenacity" => imgs.hammer_tenacity,
641        "common.abilities.hammer.thunderclap" => imgs.hammer_thunderclap,
642        "common.abilities.hammer.seismic_shock" => imgs.hammer_seismic_shock,
643        "common.abilities.hammer.earthshaker" => imgs.hammer_earthshaker,
644        "common.abilities.hammer.judgement" => imgs.hammer_judgement,
645        // Bow
646        "common.abilities.bow.arrow_shot" => imgs.bow_arrow_shot,
647        "common.abilities.bow.broadhead" => imgs.bow_broadhead,
648        "common.abilities.bow.foothold" => imgs.bow_foothold,
649        "common.abilities.bow.heavy_nock" => imgs.bow_heavy_nock,
650        "common.abilities.bow.ardent_hunt" => imgs.bow_ardent_hunt,
651        "common.abilities.bow.owl_talon" => imgs.bow_owl_talon,
652        "common.abilities.bow.eagle_eye" => imgs.bow_eagle_eye,
653        "common.abilities.bow.heartseeker" => imgs.bow_heartseeker,
654        "common.abilities.bow.hawkstrike" => imgs.bow_hawkstrike,
655        "common.abilities.bow.hawkstrike_shot" => imgs.bow_hawkstrike,
656        "common.abilities.bow.septic_shot" => imgs.bow_septic_shot,
657        "common.abilities.bow.ignite_arrow" => imgs.bow_ignite_arrow,
658        "common.abilities.bow.burning_arrow" => imgs.bow_burning_arrow,
659        "common.abilities.bow.burning_broadhead" => imgs.bow_burning_broadhead,
660        "common.abilities.bow.drench_arrow" => imgs.bow_drench_arrow,
661        "common.abilities.bow.poison_arrow" => imgs.bow_poison_arrow,
662        "common.abilities.bow.poison_broadhead" => imgs.bow_poison_broadhead,
663        "common.abilities.bow.freeze_arrow" => imgs.bow_freeze_arrow,
664        "common.abilities.bow.freezing_arrow" => imgs.bow_freezing_arrow,
665        "common.abilities.bow.freezing_broadhead" => imgs.bow_freezing_broadhead,
666        "common.abilities.bow.jolt_arrow" => imgs.bow_jolt_arrow,
667        "common.abilities.bow.lightning_arrow" => imgs.bow_lightning_arrow,
668        "common.abilities.bow.lightning_broadhead" => imgs.bow_lightning_broadhead,
669        "common.abilities.bow.barrage" => imgs.bow_barrage,
670        "common.abilities.bow.barrage_shot" => imgs.bow_barrage,
671        "common.abilities.bow.piercing_gale" => imgs.bow_piercing_gale,
672        "common.abilities.bow.piercing_gale_shot" => imgs.bow_piercing_gale,
673        "common.abilities.bow.scatterburst" => imgs.bow_scatterburst,
674        "common.abilities.bow.lesser_scatterburst" => imgs.bow_lesser_scatterburst,
675        "common.abilities.bow.greater_scatterburst" => imgs.bow_greater_scatterburst,
676        "common.abilities.bow.fusillade" => imgs.bow_fusillade,
677        "common.abilities.bow.fusillade_shot" => imgs.bow_fusillade,
678        "common.abilities.bow.death_volley" => imgs.bow_death_volley,
679        "common.abilities.bow.death_volley_shot" => imgs.bow_death_volley,
680        "common.abilities.bow.death_volley_heavy_shot" => imgs.bow_death_volley,
681        // Staff
682        "common.abilities.staff.firebomb" => imgs.fireball,
683        "common.abilities.staff.flamethrower" => imgs.flamethrower,
684        "common.abilities.staff.fireshockwave" => imgs.fire_aoe,
685        // Sceptre
686        "common.abilities.sceptre.lifestealbeam" => imgs.skill_sceptre_lifesteal,
687        "common.abilities.sceptre.healingaura" => imgs.skill_sceptre_heal,
688        "common.abilities.sceptre.wardingaura" => imgs.skill_sceptre_aura,
689        // Shield
690        "common.abilities.shield.singlestrike" => imgs.onehshield_m1,
691        "common.abilities.shield.power_guard" => imgs.onehshield_m1,
692        // Dagger
693        "common.abilities.dagger.tempbasic" => imgs.onehdagger_m1,
694        // Pickaxe
695        "common.abilities.pick.swing" => imgs.mining,
696        // Shovel
697        "common.abilities.shovel.dig" => imgs.dig,
698        // Instruments
699        "common.abilities.music.bass" => imgs.instrument,
700        "common.abilities.music.flute" => imgs.instrument,
701        "common.abilities.music.harp" => imgs.instrument,
702        "common.abilities.music.perc" => imgs.instrument,
703        "common.abilities.music.kalimba" => imgs.instrument,
704        "common.abilities.music.melodica" => imgs.instrument,
705        "common.abilities.music.lute" => imgs.instrument,
706        "common.abilities.music.oud" => imgs.instrument,
707        "common.abilities.music.guitar" => imgs.instrument,
708        "common.abilities.music.dark_guitar" => imgs.instrument,
709        "common.abilities.music.sitar" => imgs.instrument,
710        "common.abilities.music.double_bass" => imgs.instrument,
711        "common.abilities.music.glass_flute" => imgs.instrument,
712        "common.abilities.music.lyre" => imgs.instrument,
713        "common.abilities.music.wildskin_drum" => imgs.instrument,
714        "common.abilities.music.icy_talharpa" => imgs.instrument,
715        "common.abilities.music.washboard" => imgs.instrument,
716        "common.abilities.music.steeltonguedrum" => imgs.instrument,
717        "common.abilities.music.shamisen" => imgs.instrument,
718        "common.abilities.music.kora" => imgs.instrument,
719        "common.abilities.music.banjo" => imgs.instrument,
720        "common.abilities.music.viola_pizzicato" => imgs.instrument,
721        "common.abilities.music.starlight_conch" => imgs.instrument,
722        "common.abilities.music.timbrel_of_chaos" => imgs.instrument,
723        "common.abilities.music.rhythmo" => imgs.instrument,
724        // Glider
725        "common.abilities.debug.glide_boost" => imgs.flyingrod_m2,
726        "common.abilities.debug.glide_speeder" => imgs.flyingrod_m1,
727        _ => imgs.not_found,
728    }
729}
730
731pub fn ability_description<'a>(
732    ability_id: &str,
733    loc: &'a Localization,
734) -> (Cow<'a, str>, Cow<'a, str>) {
735    let ability_i18n_key = ability_id.replace('.', "-");
736    match ability_i18n_key.as_str() {
737        "common-abilities-axe-execute"
738        | "common-abilities-axe-maelstrom"
739        | "common-abilities-axe-lacerate"
740        | "common-abilities-axe-riptide"
741        | "common-abilities-axe-bulkhead"
742        | "common-abilities-axe-capsize" => (
743            loc.get_msg(&ability_i18n_key),
744            loc.get_attr_ctx(&ability_i18n_key, "desc", &i18n::fluent_args! {
745                "min_combo" => 25,
746                "min_combo_upg" => 40,
747            }),
748        ),
749        "common-abilities-hammer-earthshaker"
750        | "common-abilities-hammer-judgement"
751        | "common-abilities-hammer-seismic_shock"
752        | "common-abilities-hammer-thunderclap" => (
753            loc.get_msg(&ability_i18n_key),
754            loc.get_attr_ctx(&ability_i18n_key, "desc", &i18n::fluent_args! {
755                "min_combo" => 20,
756            }),
757        ),
758        "common-abilities-hammer-lung_pummel" | "common-abilities-hammer-spine_cracker" => (
759            loc.get_msg(&ability_i18n_key),
760            loc.get_attr_ctx(&ability_i18n_key, "desc", &i18n::fluent_args! {
761                "min_combo" => 5,
762            }),
763        ),
764        "common-abilities-hammer-helm_crusher" => (
765            loc.get_msg(&ability_i18n_key),
766            loc.get_attr_ctx(&ability_i18n_key, "desc", &i18n::fluent_args! {
767                "min_combo" => 10,
768            }),
769        ),
770        // Default case, no input values
771        ability_i18n_key => (
772            loc.get_msg(ability_i18n_key),
773            loc.get_attr(ability_i18n_key, "desc"),
774        ),
775    }
776}