astrelis 0.2.4

A modular 2D/3D game engine framework
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

//! Time plugin for tracking frame timing and game time.
use crate::plugin::Plugin;
use crate::resource::Resources;
use crate::time::Time;

/// Plugin that provides time tracking for the game loop.
///
/// This plugin sets up the `Time` resource which tracks delta time,
/// elapsed time, frame count, time scaling, and fixed timestep support.
///
/// # Resources Provided
///
/// - `Time` - Frame timing and game time information
///
/// # Example
///
/// ```ignore
/// use astrelis::prelude::*;
///
/// let engine = Engine::builder()
///     .add_plugin(TimePlugin)
///     .build();
///
/// // In your app:
/// fn update(&mut self, ctx: &mut AppCtx, time: &Time) {
///     let dt = time.delta_seconds();
///     position += velocity * dt; // Frame-independent movement
/// }
/// ```
pub struct TimePlugin;

impl Plugin for TimePlugin {
    type Dependencies = ();
    fn name(&self) -> &'static str {
        "TimePlugin"
    }

    fn build(&self, resources: &mut Resources) {
        resources.insert(Time::new());
        tracing::debug!("TimePlugin: Registered Time resource");
    }
}

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

    #[test]
    fn test_time_plugin_registers_time() {
        let engine = EngineBuilder::new().add_plugin(TimePlugin).build();

        assert!(engine.get::<Time>().is_some());
    }

    #[test]
    fn test_time_starts_at_zero() {
        let engine = EngineBuilder::new().add_plugin(TimePlugin).build();

        let time = engine.get::<Time>().unwrap();
        assert_eq!(time.frame_count(), 0);
        assert_eq!(time.time_scale(), 1.0);
    }
}