battler-data 0.2.0

Data objects for battler.
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

use alloc::string::String;

use serde::{
    Deserialize,
    Serialize,
};
use serde_string_enum::{
    DeserializeLabeledStringEnum,
    SerializeLabeledStringEnum,
};

/// The type of a condition.
#[derive(Debug, Clone, PartialEq, Eq, SerializeLabeledStringEnum, DeserializeLabeledStringEnum)]
pub enum ConditionType {
    /// A condition that is built into the battle engine.
    #[string = "Built-in"]
    #[alias = "BuiltIn"]
    BuiltIn,
    /// An ordinary condition that can be applied to anything in a battle.
    #[string = "Condition"]
    Condition,
    /// Weather, which is applied to the entire battlefield.
    #[string = "Weather"]
    Weather,
    /// Status, which is applied to a single Mon for a finite amount of time.
    #[string = "Status"]
    Status,
    /// Type, which is applied to a single Mon for a finite amount of time while the user has the
    /// type.
    #[string = "Type"]
    Type,
    /// Volatile, which is applied to a single Mon for a finite amount of time.
    #[string = "Volatile"]
    Volatile,
    /// Z-Power, which is applied to the user of a Z-Move.
    #[string = "ZPower"]
    #[alias = "Z-Power"]
    ZPower,
}

/// Data about a particular condition.
///
/// Conditions can be applied to Mons as the result of moves or abilities.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ConditionData {
    /// Condition name.
    pub name: String,
    /// Condition type.
    pub condition_type: ConditionType,
    /// Can this condition be copied from one Mon to another?
    ///
    /// This relates to how "Baton Pass" affects this condition.
    #[serde(default)]
    pub no_copy: bool,

    /// Dynamic battle effects.
    #[serde(default)]
    pub condition: serde_json::Value,
}

#[cfg(test)]
mod condition_test {
    use crate::{
        conditions::ConditionType,
        test_util::{
            test_string_deserialization,
            test_string_serialization,
        },
    };

    #[test]
    fn serializes_to_string() {
        test_string_serialization(ConditionType::BuiltIn, "Built-in");
        test_string_serialization(ConditionType::Condition, "Condition");
        test_string_serialization(ConditionType::Weather, "Weather");
        test_string_serialization(ConditionType::Status, "Status");
    }

    #[test]
    fn deserializes_lowercase() {
        test_string_deserialization("built-in", ConditionType::BuiltIn);
        test_string_deserialization("builtin", ConditionType::BuiltIn);
        test_string_deserialization("condition", ConditionType::Condition);
        test_string_deserialization("weather", ConditionType::Weather);
        test_string_deserialization("status", ConditionType::Status);
    }
}