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
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
122
123
124
125
126
127
128

use alloc::string::String;

use hashbrown::HashSet;
use serde::{
    Deserialize,
    Serialize,
};

use crate::{
    HitEffect,
    ItemFlag,
    ItemInput,
    ItemTarget,
    Type,
};

/// Data for what happens when "Fling" is used with this item.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct FlingData {
    pub power: u32,
    #[serde(default)]
    pub use_item: bool,
    pub hit_effect: Option<HitEffect>,
}

/// Data for what happens when "Natural Gift" is used with this item.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct NaturalGiftData {
    pub power: u32,
    #[serde(rename = "type")]
    pub typ: Type,
}

/// Data for what happens when "Judgment" is used with this item.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct JudgmentData {
    #[serde(rename = "type")]
    pub typ: Type,
}

/// Data for what happens when "Techno Blast" is used with this item.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct TechnoBlastData {
    #[serde(rename = "type")]
    pub typ: Type,
}

/// Data for what happens when "Multi-Attack" is used with this item.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct MultiAttackData {
    #[serde(rename = "type")]
    pub typ: Type,
}

/// Data for Mega Evolution.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct MegaEvolutionData {
    pub from: String,
    pub into: String,
}

/// Source of a Z-Crystal's power.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum ZCrystalSource {
    #[serde(rename = "from")]
    Move(String),
    #[serde(rename = "type")]
    Type(Type),
}

/// Data for Ultra Burst.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct UltraBurstData {
    pub from: HashSet<String>,
    pub into: String,
}

/// Data for Z-Crystals.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ZCrystalData {
    #[serde(flatten)]
    pub source: Option<ZCrystalSource>,
    pub into: String,
    #[serde(default)]
    pub users: HashSet<String>,
}

/// Data for special item effects; namely, item data associated with moves and effects.
#[derive(Debug, Default, PartialEq, Eq, Clone, Serialize, Deserialize)]
pub struct SpecialItemData {
    pub mega_evolution: Option<MegaEvolutionData>,
    pub z_crystal: Option<ZCrystalData>,
    pub ultra_burst: Option<UltraBurstData>,

    pub fling: Option<FlingData>,
    pub natural_gift: Option<NaturalGiftData>,
    pub judgment: Option<JudgmentData>,
    pub techno_blast: Option<TechnoBlastData>,
    pub multi_attack: Option<MultiAttackData>,
}

/// Data about a particular item.
///
/// Items can be held by a Mon in battle to produce various side effects. Items can affect stat
/// calculations, move calculations, move choice restrictions, and much more.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ItemData {
    /// Name of the item.
    pub name: String,
    /// Target of the item if used by a player.
    pub target: Option<ItemTarget>,
    /// Type of input received alongside the item.
    pub input: Option<ItemInput>,
    /// Data for special item effects associated with moves and effects.
    #[serde(default)]
    pub special_data: SpecialItemData,
    /// The forme this item forces a Mon into.
    pub force_forme: Option<String>,
    /// Item flags.
    pub flags: HashSet<ItemFlag>,

    /// Dynamic battle effects.
    #[serde(default)]
    pub effect: serde_json::Value,
    /// Dynamic battle effects of the condition created by this item.
    #[serde(default)]
    pub condition: serde_json::Value,
}