Struct Timer 

pub struct Timer(pub Rc<RefCell<TimerData>>);

Timer

A timer that counts down each frame. Can be paused and extended. Actions can be boundd to the timer that will run on completion.

Don’t put the timer in the loop

Timers won’t run by default, you must call add_timer() and pass in the timer to add them to the timer list. Or call spawn_timer(seconds) and it will run immediately.

let mut my_timer = add_timer(Timer::new(5.0));
// or
let mut my_timer = spawn_timer(5.0);

println!("Time left: {}", my_timer.time_left);
println!("Timer is paused: {}", my_timer.paused);

my_timer.extend(2.0); // extend by 2 seconds

if my_timer.completed() {
    // timer is completed
}

if my_timer.ongoing() {
    // timer is active
}

// Pause/Unpause a timer
my_timer.pause();
my_timer.unpause();
my_timer.set_paused(true);
my_timer.toggle_paused();

// Action will run if the timer is completed (must be called each frame)
my_timer.on_completion(|| {
    println!("Timer was completed!");
})

// Reset the time left to the original (does not include `extend()`)
my_timer.reset();

// Stop the timer (marks as completed())
my_timer.finish();

Once a timer is completed it will be removed from the timer list. The timer will stop ticking and on_completion() will stop firing.

// Re-add a timer to the timer list (REMEMBER TO RESET IT)
my_timer.reset();
add_timer(my_timer);

Tuple Fields

0: Rc<RefCell<TimerData>>

Implementations

impl Timer

pub fn new(seconds: f32) -> Self

Create a new timer using seconds

pub fn new_repeating(seconds: f32) -> Self

Create a new repeating timer using seconds. Restarts after completing

pub fn tick(&mut self, dt: f32)

Tick down the time left by dt (deltatime) only if it’s unpaused

pub fn reset(&self)

Reset the timer to original time (does not include extend())

pub fn finish(&self)

Sets time left to zero (completed) which may also remove the timer from the timer list

pub fn pause(&self)

Pause the timer

pub fn unpause(&self)

Unpause the timer

pub fn set_paused(&self, paused: bool)

Set whether timer is paused or not

pub fn toggle_paused(&self)

Toggle the timer paused/unpaused

pub fn extend(&self, seconds: f32)

Extend (or decrease) the timer’s time left

pub fn ongoing(&self) -> bool

Check if timer is ongoing (time left > 0)

pub fn is_active(&self) -> bool

Check if timer is active (in the timer list)

pub fn on_completion(&self, action: impl FnMut())

Runs an action if timer is completed (only runs if timer is in timer list)

pub fn completed(&self) -> bool

Returns true if the timer was just completed this frame

pub fn restart(&self) -> Timer

Restarts the timer and adds it to the timer list

pub fn completed_and_restart(&self) -> bool

Restarts the timer if it just got completed this frame, also returns whether its completed() or not

pub fn start(&self) -> Timer

Starts the timer (adds it to the timer list)

pub async fn wait(&self)

Trait Implementations

impl Clone for Timer

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Timer

fn default() -> Self

Returns the “default value” for a type.

impl Future for Timer

type Output = ()

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl PartialEq for Timer

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for Timer

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Timer