issun 0.10.0

A mini game engine for logic-focused games - Build games in ISSUN (一寸) of time
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170

//! Time-related resources for game timer management

use serde::{Deserialize, Serialize};

/// Game timer resource for tracking in-game time progression
///
/// This resource provides pure time management without action point coupling.
/// It tracks days and ticks independently of game mechanics.
///
/// # Example
///
/// ```
/// use issun::plugin::GameTimer;
///
/// let mut timer = GameTimer::new();
/// assert_eq!(timer.day, 1);
/// assert_eq!(timer.tick, 0);
///
/// let new_day = timer.increment_day();
/// assert_eq!(new_day, 2);
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GameTimer {
    /// Current in-game day (starts at 1)
    pub day: u32,
    /// Frame/tick counter for sub-day timing
    pub tick: u64,
}

impl GameTimer {
    /// Create a new game timer starting at day 1
    ///
    /// # Example
    ///
    /// ```
    /// use issun::plugin::GameTimer;
    ///
    /// let timer = GameTimer::new();
    /// assert_eq!(timer.day, 1);
    /// assert_eq!(timer.tick, 0);
    /// ```
    pub fn new() -> Self {
        Self { day: 1, tick: 0 }
    }

    /// Increment day counter
    ///
    /// # Returns
    ///
    /// The new day number
    ///
    /// # Example
    ///
    /// ```
    /// use issun::plugin::GameTimer;
    ///
    /// let mut timer = GameTimer::new();
    /// let new_day = timer.increment_day();
    /// assert_eq!(new_day, 2);
    /// assert_eq!(timer.day, 2);
    /// ```
    pub fn increment_day(&mut self) -> u32 {
        self.day += 1;
        self.day
    }

    /// Increment tick counter (for realtime/sub-day timing)
    ///
    /// # Example
    ///
    /// ```
    /// use issun::plugin::GameTimer;
    ///
    /// let mut timer = GameTimer::new();
    /// timer.tick();
    /// assert_eq!(timer.tick, 1);
    /// ```
    pub fn tick(&mut self) {
        self.tick += 1;
    }

    /// Get current day
    ///
    /// # Example
    ///
    /// ```
    /// use issun::plugin::GameTimer;
    ///
    /// let timer = GameTimer::new();
    /// assert_eq!(timer.current_day(), 1);
    /// ```
    pub fn current_day(&self) -> u32 {
        self.day
    }
}

impl Default for GameTimer {
    fn default() -> Self {
        Self::new()
    }
}

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

    #[test]
    fn test_new_timer() {
        let timer = GameTimer::new();
        assert_eq!(timer.day, 1);
        assert_eq!(timer.tick, 0);
    }

    #[test]
    fn test_increment_day() {
        let mut timer = GameTimer::new();

        let new_day = timer.increment_day();
        assert_eq!(new_day, 2);
        assert_eq!(timer.day, 2);

        timer.increment_day();
        assert_eq!(timer.day, 3);
    }

    #[test]
    fn test_tick() {
        let mut timer = GameTimer::new();

        timer.tick();
        assert_eq!(timer.tick, 1);

        timer.tick();
        timer.tick();
        assert_eq!(timer.tick, 3);
    }

    #[test]
    fn test_current_day() {
        let timer = GameTimer::new();
        assert_eq!(timer.current_day(), 1);

        let mut timer = GameTimer::new();
        timer.increment_day();
        assert_eq!(timer.current_day(), 2);
    }

    #[test]
    fn test_default() {
        let timer = GameTimer::default();
        assert_eq!(timer.day, 1);
        assert_eq!(timer.tick, 0);
    }

    #[test]
    fn test_independent_day_and_tick() {
        let mut timer = GameTimer::new();

        // Tick doesn't affect day
        timer.tick();
        timer.tick();
        assert_eq!(timer.day, 1);
        assert_eq!(timer.tick, 2);

        // Day doesn't reset tick
        timer.increment_day();
        assert_eq!(timer.day, 2);
        assert_eq!(timer.tick, 2);
    }
}