mirror of
https://github.com/bevyengine/bevy
synced 2024-09-20 14:32:06 +00:00
73605f43b6
As mentioned in #2926, it's better to have an explicit type that clearly communicates the intent of the timer mode rather than an opaque boolean, which can be only understood when knowing the signature or having to look up the documentation. This also opens up a way to merge different timers, such as `Stopwatch`, and possibly future ones, such as `DiscreteStopwatch` and `DiscreteTimer` from #2683, into one struct. Signed-off-by: Lena Milizé <me@lvmn.org> # Objective Fixes #2926. ## Solution Introduce `TimerMode` which replaces the `bool` argument of `Timer` constructors. A `Default` value for `TimerMode` is `Once`. --- ## Changelog ### Added - `TimerMode` enum, along with variants `TimerMode::Once` and `TimerMode::Repeating` ### Changed - Replace `bool` argument of `Timer::new` and `Timer::from_seconds` with `TimerMode` - Change `repeating: bool` field of `Timer` with `mode: TimerMode` ## Migration Guide - Replace `Timer::new(duration, false)` with `Timer::new(duration, TimerMode::Once)`. - Replace `Timer::new(duration, true)` with `Timer::new(duration, TimerMode::Repeating)`. - Replace `Timer::from_seconds(seconds, false)` with `Timer::from_seconds(seconds, TimerMode::Once)`. - Replace `Timer::from_seconds(seconds, true)` with `Timer::from_seconds(seconds, TimerMode::Repeating)`. - Change `timer.repeating()` to `timer.mode() == TimerMode::Repeating`.
78 lines
2.4 KiB
Rust
78 lines
2.4 KiB
Rust
//! Illustrates how `Timer`s can be used both as resources and components.
|
|
|
|
use bevy::{log::info, prelude::*};
|
|
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins(DefaultPlugins)
|
|
.init_resource::<Countdown>()
|
|
.add_startup_system(setup)
|
|
.add_system(countdown)
|
|
.add_system(print_when_completed)
|
|
.run();
|
|
}
|
|
|
|
#[derive(Component, Deref, DerefMut)]
|
|
pub struct PrintOnCompletionTimer(Timer);
|
|
|
|
#[derive(Resource)]
|
|
pub struct Countdown {
|
|
pub percent_trigger: Timer,
|
|
pub main_timer: Timer,
|
|
}
|
|
|
|
impl Countdown {
|
|
pub fn new() -> Self {
|
|
Self {
|
|
percent_trigger: Timer::from_seconds(4.0, TimerMode::Repeating),
|
|
main_timer: Timer::from_seconds(20.0, TimerMode::Once),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Default for Countdown {
|
|
fn default() -> Self {
|
|
Self::new()
|
|
}
|
|
}
|
|
|
|
fn setup(mut commands: Commands) {
|
|
// Add an entity to the world with a timer
|
|
commands.spawn(PrintOnCompletionTimer(Timer::from_seconds(
|
|
5.0,
|
|
TimerMode::Once,
|
|
)));
|
|
}
|
|
|
|
/// This system ticks all the `Timer` components on entities within the scene
|
|
/// using bevy's `Time` resource to get the delta between each update.
|
|
fn print_when_completed(time: Res<Time>, mut query: Query<&mut PrintOnCompletionTimer>) {
|
|
for mut timer in &mut query {
|
|
if timer.tick(time.delta()).just_finished() {
|
|
info!("Entity timer just finished");
|
|
}
|
|
}
|
|
}
|
|
|
|
/// This system controls ticking the timer within the countdown resource and
|
|
/// handling its state.
|
|
fn countdown(time: Res<Time>, mut countdown: ResMut<Countdown>) {
|
|
countdown.main_timer.tick(time.delta());
|
|
|
|
// The API encourages this kind of timer state checking (if you're only checking for one value)
|
|
// Additionally, `finished()` would accomplish the same thing as `just_finished` due to the
|
|
// timer being repeating, however this makes more sense visually.
|
|
if countdown.percent_trigger.tick(time.delta()).just_finished() {
|
|
if !countdown.main_timer.finished() {
|
|
// Print the percent complete the main timer is.
|
|
info!(
|
|
"Timer is {:0.0}% complete!",
|
|
countdown.main_timer.percent() * 100.0
|
|
);
|
|
} else {
|
|
// The timer has finished so we pause the percent output timer
|
|
countdown.percent_trigger.pause();
|
|
info!("Paused percent trigger timer");
|
|
}
|
|
}
|
|
}
|