diff --git a/CHANGELOG.md b/CHANGELOG.md index 39da8e5e61283..05e7dbaaebd89 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,7 +12,8 @@ current changes on git with [previous release tags][git_tag_comparison]. ### Added ### Changed - +- [Breaking changes to timer API][914] +- [Removed timer auto-ticking system][931] ### Fixed diff --git a/Cargo.toml b/Cargo.toml index 26ff837bfc3e1..ee26789e927da 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -198,6 +198,10 @@ path = "examples/ecs/startup_system.rs" name = "system_chaining" path = "examples/ecs/system_chaining.rs" +[[example]] +name = "timers" +path = "examples/ecs/timers.rs" + [[example]] name = "ecs_guide" path = "examples/ecs/ecs_guide.rs" diff --git a/crates/bevy_core/src/time/timer.rs b/crates/bevy_core/src/time/timer.rs index efa2c3e41aec9..b3f3fdd33edc6 100644 --- a/crates/bevy_core/src/time/timer.rs +++ b/crates/bevy_core/src/time/timer.rs @@ -41,12 +41,12 @@ impl Timer { } #[inline] - pub fn resume(&mut self) { + pub fn unpause(&mut self) { self.paused = false } #[inline] - pub fn is_paused(&self) -> bool { + pub fn paused(&self) -> bool { self.paused } @@ -76,7 +76,7 @@ impl Timer { /// Non repeating timers will stop tracking and stay in the finished state until reset. /// Repeating timers will only be in the finished state on each tick `duration` is reached or exceeded, and can still be reset at any given point. #[inline] - pub fn is_finished(&self) -> bool { + pub fn finished(&self) -> bool { self.finished } @@ -87,7 +87,7 @@ impl Timer { } #[inline] - pub fn is_repeating(&self) -> bool { + pub fn repeating(&self) -> bool { self.repeating } @@ -98,11 +98,15 @@ impl Timer { /// Advances the timer by `delta` seconds. pub fn tick(&mut self, delta: f32) -> &Self { + if self.paused { + return self; + } let prev_finished = self.finished; self.elapsed += delta; self.finished = self.elapsed >= self.duration; self.just_finished = !prev_finished && self.finished; + if self.finished { if self.repeating { // Repeating timers wrap around @@ -142,25 +146,36 @@ mod tests { let mut t = Timer::from_seconds(10.0, false); // Tick once, check all attributes t.tick(0.25); - assert_eq!(t.elapsed, 0.25); - assert_eq!(t.duration, 10.0); - assert_eq!(t.finished, false); - assert_eq!(t.just_finished, false); - assert_eq!(t.repeating, false); + assert_eq!(t.elapsed(), 0.25); + assert_eq!(t.duration(), 10.0); + assert_eq!(t.finished(), false); + assert_eq!(t.just_finished(), false); + assert_eq!(t.repeating(), false); + assert_eq!(t.percent(), 0.025); + assert_eq!(t.percent_left(), 0.975); + // Ticking while paused changes nothing + t.pause(); + t.tick(500.0); + assert_eq!(t.elapsed(), 0.25); + assert_eq!(t.duration(), 10.0); + assert_eq!(t.finished(), false); + assert_eq!(t.just_finished(), false); + assert_eq!(t.repeating(), false); assert_eq!(t.percent(), 0.025); assert_eq!(t.percent_left(), 0.975); // Tick past the end and make sure elapsed doesn't go past 0.0 and other things update + t.unpause(); t.tick(500.0); - assert_eq!(t.elapsed, 10.0); - assert_eq!(t.finished, true); - assert_eq!(t.just_finished, true); + assert_eq!(t.elapsed(), 10.0); + assert_eq!(t.finished(), true); + assert_eq!(t.just_finished(), true); assert_eq!(t.percent(), 1.0); assert_eq!(t.percent_left(), 0.0); // Continuing to tick when finished should only change just_finished t.tick(1.0); - assert_eq!(t.elapsed, 10.0); - assert_eq!(t.finished, true); - assert_eq!(t.just_finished, false); + assert_eq!(t.elapsed(), 10.0); + assert_eq!(t.finished(), true); + assert_eq!(t.just_finished(), false); assert_eq!(t.percent(), 1.0); assert_eq!(t.percent_left(), 0.0); } @@ -170,25 +185,25 @@ mod tests { let mut t = Timer::from_seconds(2.0, true); // Tick once, check all attributes t.tick(0.75); - assert_eq!(t.elapsed, 0.75); - assert_eq!(t.duration, 2.0); - assert_eq!(t.finished, false); - assert_eq!(t.just_finished, false); - assert_eq!(t.repeating, true); + assert_eq!(t.elapsed(), 0.75); + assert_eq!(t.duration(), 2.0); + assert_eq!(t.finished(), false); + assert_eq!(t.just_finished(), false); + assert_eq!(t.repeating(), true); assert_eq!(t.percent(), 0.375); assert_eq!(t.percent_left(), 0.625); // Tick past the end and make sure elapsed wraps t.tick(1.5); - assert_eq!(t.elapsed, 0.25); - assert_eq!(t.finished, true); - assert_eq!(t.just_finished, true); + assert_eq!(t.elapsed(), 0.25); + assert_eq!(t.finished(), true); + assert_eq!(t.just_finished(), true); assert_eq!(t.percent(), 0.125); assert_eq!(t.percent_left(), 0.875); // Continuing to tick should turn off both finished & just_finished for repeating timers t.tick(1.0); - assert_eq!(t.elapsed, 1.25); - assert_eq!(t.finished, false); - assert_eq!(t.just_finished, false); + assert_eq!(t.elapsed(), 1.25); + assert_eq!(t.finished(), false); + assert_eq!(t.just_finished(), false); assert_eq!(t.percent(), 0.625); assert_eq!(t.percent_left(), 0.375); } diff --git a/crates/bevy_diagnostic/src/print_diagnostics_plugin.rs b/crates/bevy_diagnostic/src/print_diagnostics_plugin.rs index 0354bf581a0a8..2d9d077a78405 100644 --- a/crates/bevy_diagnostic/src/print_diagnostics_plugin.rs +++ b/crates/bevy_diagnostic/src/print_diagnostics_plugin.rs @@ -66,7 +66,7 @@ impl PrintDiagnosticsPlugin { time: Res