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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
use bevy_reflect::Reflect;
use bevy_utils::{Duration, Instant};

use crate::time::Time;

/// Real time clock representing elapsed wall clock time.
///
/// A specialization of the [`Time`] structure. **For method documentation, see
/// [`Time<Real>#impl-Time<Real>`].**
///
/// It is automatically inserted as a resource by
/// [`TimePlugin`](crate::TimePlugin) and updated with time instants according
/// to [`TimeUpdateStrategy`](crate::TimeUpdateStrategy).
///
/// The [`delta()`](Time::delta) and [`elapsed()`](Time::elapsed) values of this
/// clock should be used for anything which deals specifically with real time
/// (wall clock time). It will not be affected by relative game speed
/// adjustments, pausing or other adjustments.
///
/// The clock does not count time from [`startup()`](Time::startup) to
/// [`first_update()`](Time::first_update()) into elapsed, but instead will
/// start counting time from the first update call. [`delta()`](Time::delta) and
/// [`elapsed()`](Time::elapsed) will report zero on the first update as there
/// is no previous update instant. This means that a [`delta()`](Time::delta) of
/// zero must be handled without errors in application logic, as it may
/// theoretically also happen at other times.
///
/// [`Instant`]s for [`startup()`](Time::startup),
/// [`first_update()`](Time::first_update) and
/// [`last_update()`](Time::last_update) are recorded and accessible.
#[derive(Debug, Copy, Clone, Reflect)]
pub struct Real {
    startup: Instant,
    first_update: Option<Instant>,
    last_update: Option<Instant>,
}

impl Default for Real {
    fn default() -> Self {
        Self {
            startup: Instant::now(),
            first_update: None,
            last_update: None,
        }
    }
}

impl Time<Real> {
    /// Constructs a new `Time<Real>` instance with a specific startup
    /// [`Instant`].
    pub fn new(startup: Instant) -> Self {
        Self::new_with(Real {
            startup,
            ..Default::default()
        })
    }

    /// Updates the internal time measurements.
    ///
    /// Calling this method as part of your app will most likely result in
    /// inaccurate timekeeping, as the [`Time`] resource is ordinarily managed
    /// by the [`TimePlugin`](crate::TimePlugin).
    pub fn update(&mut self) {
        let instant = Instant::now();
        self.update_with_instant(instant);
    }

    /// Updates time with a specified [`Duration`].
    ///
    /// This method is provided for use in tests.
    ///
    /// Calling this method as part of your app will most likely result in
    /// inaccurate timekeeping, as the [`Time`] resource is ordinarily managed
    /// by the [`TimePlugin`](crate::TimePlugin).
    pub fn update_with_duration(&mut self, duration: Duration) {
        let last_update = self.context().last_update.unwrap_or(self.context().startup);
        self.update_with_instant(last_update + duration);
    }

    /// Updates time with a specified [`Instant`].
    ///
    /// This method is provided for use in tests.
    ///
    /// Calling this method as part of your app will most likely result in inaccurate timekeeping,
    /// as the [`Time`] resource is ordinarily managed by the [`TimePlugin`](crate::TimePlugin).
    pub fn update_with_instant(&mut self, instant: Instant) {
        let Some(last_update) = self.context().last_update else {
            let context = self.context_mut();
            context.first_update = Some(instant);
            context.last_update = Some(instant);
            return;
        };
        let delta = instant - last_update;
        self.advance_by(delta);
        self.context_mut().last_update = Some(instant);
    }

    /// Returns the [`Instant`] the clock was created.
    ///
    /// This usually represents when the app was started.
    #[inline]
    pub fn startup(&self) -> Instant {
        self.context().startup
    }

    /// Returns the [`Instant`] when [`Self::update`] was first called, if it
    /// exists.
    ///
    /// This usually represents when the first app update started.
    #[inline]
    pub fn first_update(&self) -> Option<Instant> {
        self.context().first_update
    }

    /// Returns the [`Instant`] when [`Self::update`] was last called, if it
    /// exists.
    ///
    /// This usually represents when the current app update started.
    #[inline]
    pub fn last_update(&self) -> Option<Instant> {
        self.context().last_update
    }
}

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

    #[test]
    fn test_update() {
        let startup = Instant::now();
        let mut time = Time::<Real>::new(startup);

        assert_eq!(time.startup(), startup);
        assert_eq!(time.first_update(), None);
        assert_eq!(time.last_update(), None);
        assert_eq!(time.delta(), Duration::ZERO);
        assert_eq!(time.elapsed(), Duration::ZERO);

        time.update();

        assert_ne!(time.first_update(), None);
        assert_ne!(time.last_update(), None);
        assert_eq!(time.delta(), Duration::ZERO);
        assert_eq!(time.elapsed(), Duration::ZERO);

        time.update();

        assert_ne!(time.first_update(), None);
        assert_ne!(time.last_update(), None);
        assert_ne!(time.last_update(), time.first_update());
        assert_ne!(time.delta(), Duration::ZERO);
        assert_eq!(time.elapsed(), time.delta());

        let prev_elapsed = time.elapsed();
        time.update();

        assert_ne!(time.delta(), Duration::ZERO);
        assert_eq!(time.elapsed(), prev_elapsed + time.delta());
    }

    #[test]
    fn test_update_with_instant() {
        let startup = Instant::now();
        let mut time = Time::<Real>::new(startup);

        let first_update = Instant::now();
        time.update_with_instant(first_update);

        assert_eq!(time.startup(), startup);
        assert_eq!(time.first_update(), Some(first_update));
        assert_eq!(time.last_update(), Some(first_update));
        assert_eq!(time.delta(), Duration::ZERO);
        assert_eq!(time.elapsed(), Duration::ZERO);

        let second_update = Instant::now();
        time.update_with_instant(second_update);

        assert_eq!(time.first_update(), Some(first_update));
        assert_eq!(time.last_update(), Some(second_update));
        assert_eq!(time.delta(), second_update - first_update);
        assert_eq!(time.elapsed(), second_update - first_update);

        let third_update = Instant::now();
        time.update_with_instant(third_update);

        assert_eq!(time.first_update(), Some(first_update));
        assert_eq!(time.last_update(), Some(third_update));
        assert_eq!(time.delta(), third_update - second_update);
        assert_eq!(time.elapsed(), third_update - first_update);
    }

    #[test]
    fn test_update_with_duration() {
        let startup = Instant::now();
        let mut time = Time::<Real>::new(startup);

        time.update_with_duration(Duration::from_secs(1));

        assert_eq!(time.startup(), startup);
        assert_eq!(time.first_update(), Some(startup + Duration::from_secs(1)));
        assert_eq!(time.last_update(), Some(startup + Duration::from_secs(1)));
        assert_eq!(time.delta(), Duration::ZERO);
        assert_eq!(time.elapsed(), Duration::ZERO);

        time.update_with_duration(Duration::from_secs(1));

        assert_eq!(time.first_update(), Some(startup + Duration::from_secs(1)));
        assert_eq!(time.last_update(), Some(startup + Duration::from_secs(2)));
        assert_eq!(time.delta(), Duration::from_secs(1));
        assert_eq!(time.elapsed(), Duration::from_secs(1));

        time.update_with_duration(Duration::from_secs(1));

        assert_eq!(time.first_update(), Some(startup + Duration::from_secs(1)));
        assert_eq!(time.last_update(), Some(startup + Duration::from_secs(3)));
        assert_eq!(time.delta(), Duration::from_secs(1));
        assert_eq!(time.elapsed(), Duration::from_secs(2));
    }
}