genshin-calc-core 0.5.12

Genshin Impact damage calculation engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

use serde::{Deserialize, Serialize};

use crate::types::Element;

/// Final character stats used for damage calculation.
///
/// All percentage fields use decimal form (e.g. 75% crit rate = `0.75`).
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct Stats {
    /// Max HP.
    pub hp: f64,
    /// Total ATK (base + bonus).
    pub atk: f64,
    /// Total DEF (base + bonus).
    pub def: f64,
    /// Elemental mastery.
    pub elemental_mastery: f64,
    /// Crit rate in decimal form (0.0 to 1.0).
    pub crit_rate: f64,
    /// Crit DMG in decimal form (base 0.50 = 50%).
    pub crit_dmg: f64,
    /// Energy recharge in decimal form (base 1.0 = 100%).
    pub energy_recharge: f64,
    /// DMG bonus in decimal form (e.g. 0.466 for Pyro DMG goblet).
    pub dmg_bonus: f64,
    /// Pyro DMG bonus in decimal form.
    #[serde(default)]
    pub pyro_dmg_bonus: f64,
    /// Hydro DMG bonus in decimal form.
    #[serde(default)]
    pub hydro_dmg_bonus: f64,
    /// Electro DMG bonus in decimal form.
    #[serde(default)]
    pub electro_dmg_bonus: f64,
    /// Cryo DMG bonus in decimal form.
    #[serde(default)]
    pub cryo_dmg_bonus: f64,
    /// Dendro DMG bonus in decimal form.
    #[serde(default)]
    pub dendro_dmg_bonus: f64,
    /// Anemo DMG bonus in decimal form.
    #[serde(default)]
    pub anemo_dmg_bonus: f64,
    /// Geo DMG bonus in decimal form.
    #[serde(default)]
    pub geo_dmg_bonus: f64,
    /// Physical DMG bonus in decimal form.
    #[serde(default)]
    pub physical_dmg_bonus: f64,
}

impl Stats {
    /// Returns the total DMG bonus for the given element.
    /// `None` means physical damage.
    pub fn total_dmg_bonus(&self, element: Option<Element>) -> f64 {
        self.dmg_bonus
            + match element {
                Some(Element::Pyro) => self.pyro_dmg_bonus,
                Some(Element::Hydro) => self.hydro_dmg_bonus,
                Some(Element::Electro) => self.electro_dmg_bonus,
                Some(Element::Cryo) => self.cryo_dmg_bonus,
                Some(Element::Dendro) => self.dendro_dmg_bonus,
                Some(Element::Anemo) => self.anemo_dmg_bonus,
                Some(Element::Geo) => self.geo_dmg_bonus,
                None => self.physical_dmg_bonus,
            }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::types::Element;

    #[test]
    fn total_dmg_bonus_pyro() {
        let stats = Stats {
            dmg_bonus: 0.10,
            pyro_dmg_bonus: 0.466,
            ..Default::default()
        };
        let result = stats.total_dmg_bonus(Some(Element::Pyro));
        assert!((result - 0.566).abs() < 1e-10);
    }

    #[test]
    fn total_dmg_bonus_physical() {
        let stats = Stats {
            dmg_bonus: 0.10,
            physical_dmg_bonus: 0.583,
            ..Default::default()
        };
        let result = stats.total_dmg_bonus(None);
        assert!((result - 0.683).abs() < 1e-10);
    }

    #[test]
    fn total_dmg_bonus_no_element_bonus() {
        let stats = Stats {
            dmg_bonus: 0.15,
            pyro_dmg_bonus: 0.466,
            ..Default::default()
        };
        // Hydro damage should NOT include Pyro bonus
        let result = stats.total_dmg_bonus(Some(Element::Hydro));
        assert!((result - 0.15).abs() < 1e-10);
    }
}