Skip to main content

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