weasel 0.11.0

A customizable battle system for turn-based games.
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

//! Generic implementations for different types of statistic.

use crate::util::Id;
#[cfg(feature = "serialization")]
use serde::{Deserialize, Serialize};
use std::cmp::PartialOrd;
use std::fmt::Debug;
use std::hash::Hash;
use std::ops::Add;

/// A simple generic statistic storing current value, minimum and maximum value.
#[derive(PartialEq, Clone, Debug)]
#[cfg_attr(feature = "serialization", derive(Serialize, Deserialize))]
pub struct SimpleStatistic<I, V> {
    id: I,
    min: V,
    max: V,
    value: V,
}

impl<I: Send, V: Copy + Default> SimpleStatistic<I, V> {
    /// Creates a new `SimpleStatistic` with `value` equal to `max`
    /// and `min` equal to `V::default()`.
    pub fn new(id: I, max: V) -> Self {
        Self::with_value(id, V::default(), max, max)
    }

    /// Creates a new `SimpleStatistic` with the given value.
    pub fn with_value(id: I, min: V, max: V, value: V) -> Self {
        Self {
            id,
            min,
            max,
            value,
        }
    }
}

impl<I: Send, V> SimpleStatistic<I, V>
where
    V: Copy + PartialOrd + Add<Output = V>,
{
    /// Returns the current value of this statistic.
    pub fn value(&self) -> V {
        self.value
    }

    /// Returns the minimum value of this statistic.
    pub fn min(&self) -> V {
        self.min
    }

    /// Returns the maximum value of this statistic.
    pub fn max(&self) -> V {
        self.max
    }

    /// Sets the current value to the new one, respecting the min/max bounds.
    pub fn set_value(&mut self, value: V) {
        self.value = value;
        if self.value < self.min {
            self.value = self.min;
        } else if self.value > self.max {
            self.value = self.max;
        }
    }

    /// Adds an increment `inc` to the value, respecting the min/max bounds.
    pub fn add(&mut self, inc: V) {
        self.set_value(self.value + inc);
    }
}

#[cfg(not(feature = "serialization"))]
impl<I, V> Id for SimpleStatistic<I, V>
where
    I: Debug + Hash + Eq + Clone + Send,
{
    type Id = I;
    fn id(&self) -> &Self::Id {
        &self.id
    }
}

#[cfg(feature = "serialization")]
impl<I, V> Id for SimpleStatistic<I, V>
where
    I: Debug + Hash + Eq + Clone + Send + Serialize + for<'a> Deserialize<'a>,
{
    type Id = I;
    fn id(&self) -> &Self::Id {
        &self.id
    }
}

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

    #[test]
    fn simple_statistic_bounds() {
        let mut stat = SimpleStatistic::with_value(1, 10, 20, 15);
        stat.add(100);
        assert_eq!(stat.value(), stat.max());
        stat.add(-100);
        assert_eq!(stat.value(), stat.min());
    }
}