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
109
110
111
112
113
114
115
116
117
118
119
120
121

use crate::reaction::Reaction;
use crate::types::Element;

/// Errors returned by calculation functions.
///
/// Each variant includes the invalid value for debugging.
#[derive(Debug, Clone, PartialEq, thiserror::Error)]
pub enum CalcError {
    /// Character level is outside the valid range of 1..=90.
    #[error("character level must be 1..=90, got {0}")]
    InvalidCharacterLevel(u32),

    /// Enemy level is outside the valid range of 1..=200.
    #[error("enemy level must be 1..=200, got {0}")]
    InvalidEnemyLevel(u32),

    /// Crit rate is outside the valid range of 0.0..=1.0.
    #[error("crit_rate must be 0.0..=1.0, got {0}")]
    InvalidCritRate(f64),

    /// DEF reduction is outside the valid range of 0.0..=1.0.
    #[error("def_reduction must be 0.0..=1.0, got {0}")]
    InvalidDefReduction(f64),

    /// DEF ignore is outside the valid range of 0.0..=1.0.
    #[error("def_ignore must be 0.0..=1.0, got {0}")]
    InvalidDefIgnore(f64),

    /// Talent multiplier must be positive.
    #[error("talent_multiplier must be > 0.0, got {0}")]
    InvalidTalentMultiplier(f64),

    /// Amplifying reactions require an elemental attack (not physical).
    #[error("amplifying reaction requires an element, but element is None (physical)")]
    AmplifyingRequiresElement,

    /// Elemental mastery must be non-negative.
    #[error("elemental_mastery must be >= 0.0, got {0}")]
    InvalidElementalMastery(f64),

    /// Reaction bonus must be non-negative.
    #[error("reaction_bonus must be >= 0.0, got {0}")]
    InvalidReactionBonus(f64),

    /// Reaction is transformative; use `calculate_transformative` instead.
    #[error("reaction {0:?} is not amplifying or catalyze; use calculate_transformative")]
    UseTransformativeFunction(Reaction),

    /// Reaction is lunar; use `calculate_lunar` instead.
    #[error("reaction {0:?} is not amplifying or catalyze; use calculate_lunar")]
    UseLunarFunction(Reaction),

    /// Reaction is not a transformative reaction.
    #[error("reaction {0:?} is not a transformative reaction")]
    NotTransformative(Reaction),

    /// Reaction is not a lunar reaction.
    #[error("reaction {0:?} is not a lunar reaction")]
    NotLunar(Reaction),

    /// Swirl element must be Pyro, Hydro, Electro, or Cryo.
    #[error("swirl element must be Pyro, Hydro, Electro, or Cryo, got {0:?}")]
    InvalidSwirlElement(Element),

    /// Invalid amplifying reaction and trigger element combination.
    #[error("invalid amplifying combination: {0:?} with {1:?} trigger")]
    InvalidAmplifyingCombination(Reaction, Element),

    /// Character level for reaction calculations must be 1..=100.
    #[error("character level must be 1..=100 for reaction calculations, got {0}")]
    InvalidReactionLevel(u32),

    /// Base stat value must be non-negative.
    #[error("invalid base value: {0} (must be >= 0)")]
    InvalidBaseValue(f64),

    /// Percent bonus must be >= -1.0.
    #[error("invalid percent bonus: {0} (must be >= -1.0)")]
    InvalidPercentBonus(f64),

    /// Flat bonus must be non-negative.
    #[error("invalid flat bonus: {0} (must be >= 0)")]
    InvalidFlatBonus(f64),

    /// Crit DMG must be non-negative.
    #[error("crit_dmg must be >= 0.0, got {0}")]
    InvalidCritDmg(f64),

    /// Energy recharge must be non-negative.
    #[error("energy_recharge must be >= 0.0, got {0}")]
    InvalidEnergyRecharge(f64),

    /// DMG bonus must be >= -1.0.
    #[error("dmg_bonus must be >= -1.0, got {0}")]
    InvalidDmgBonus(f64),

    /// Team must have 1 to 4 members.
    #[error("team must have 1..=4 members, got {0}")]
    InvalidTeamSize(usize),

    /// Target index is out of bounds for the given team size.
    #[error("target index {index} out of bounds for team of size {team_size}")]
    InvalidTargetIndex {
        /// The requested target index.
        index: usize,
        /// The actual team size.
        team_size: usize,
    },

    /// Constellation must be 0..=6.
    #[error("constellation must be 0..=6, got {0}")]
    InvalidConstellation(u8),

    /// Talent level must be 1..=15.
    #[error("talent level must be 1..=15, got {0}")]
    InvalidTalentLevel(u8),

    /// Weapon refinement must be 1..=5.
    #[error("weapon refinement must be 1..=5, got {0}")]
    InvalidRefinement(u8),
}