battler 0.8.0

Pokémon battle engine for Rust.
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

use anyhow::Result;
use battler_data::SerializedRuleSet;
use serde::{
    Deserialize,
    Serialize,
};

use crate::{
    battle::BattleType,
    config::RuleSet,
    dex::Dex,
};

/// Data for the format of a battle, which describes how a battle is configured.
#[derive(Debug, Default, Clone, Serialize, Deserialize)]
pub struct FormatData {
    /// The type of battle that will take place.
    pub battle_type: BattleType,
    /// The rules in place that must be validated before and during the battle.
    pub rules: SerializedRuleSet,
}

/// The format of a battle, which describes how a battle is configured.
#[derive(Clone)]
pub struct Format {
    /// The type of battle that is taking place.
    pub battle_type: BattleType,
    /// The rules in place that must be validated before and during the battle.
    pub rules: RuleSet,
}

impl Format {
    /// Creates a new format.
    pub fn new(data: FormatData, dex: &Dex) -> Result<Self> {
        let rules = RuleSet::new(data.rules, &data.battle_type, dex)?;
        Ok(Self {
            battle_type: data.battle_type,
            rules,
        })
    }

    /// Constructs the [`FormatData`] for the [`Format`].
    pub fn data(&self) -> FormatData {
        FormatData {
            battle_type: self.battle_type.clone(),
            rules: self.rules.serialized(),
        }
    }
}