Struct Timer 

pub struct Timer { /* private fields */ }

A countdown timer that fires after a fixed duration, optionally repeating.

Timers are updated with the frame delta time; Timer::update returns the number of times the timer fired during that update (0 or 1 for one-shot timers, possibly more for repeating timers after a long frame).

Implementations

impl Timer

Implements creation and countdown logic for Timer.

pub fn create(duration: f64) -> Timer

Creates a one-shot timer that fires once after duration seconds.

Arguments

• f64 - The countdown duration in seconds.

Returns

• Timer - The new one-shot timer.

pub fn create_repeating(duration: f64) -> Timer

Creates a repeating timer that fires every duration seconds.

Arguments

• f64 - The interval between firings in seconds.

Returns

• Timer - The new repeating timer.

pub fn update(&mut self, delta_time: f64) -> u32

Advances the timer by the given delta time.

Arguments

• f64 - The time elapsed since the last update, in seconds.

Returns

• u32 - The number of times the timer fired during this update.

pub fn reset(&mut self)

Resets the timer to its initial state so it can count down again.

pub fn pause(&mut self)

Pauses the timer, preserving the accumulated elapsed time.

pub fn resume(&mut self)

Resumes a paused timer.

pub fn is_paused(&self) -> bool

Returns whether the timer is currently paused.

Returns

• bool - True if paused.

pub fn is_finished(&self) -> bool

Returns whether a one-shot timer has fired and stopped.

Returns

• bool - True if finished.

pub fn progress(&self) -> f64

Returns the countdown progress in the range 0.0 to 1.0.

Returns

• f64 - The progress ratio.

pub fn remaining(&self) -> f64

Returns the time remaining until the next firing, in seconds.

Returns

• f64 - The remaining time.

impl Timer

pub fn get_duration(&self) -> f64

pub fn get_mut_duration(&mut self) -> &mut f64

pub fn get_repeating(&self) -> bool

pub fn get_mut_repeating(&mut self) -> &mut bool

pub fn get_paused(&self) -> bool

pub fn get_mut_paused(&mut self) -> &mut bool

pub fn set_paused(&mut self, val: bool) -> &mut Self

pub fn get_finished(&self) -> bool

pub fn get_mut_finished(&mut self) -> &mut bool

pub fn set_finished(&mut self, val: bool) -> &mut Self

impl Timer

pub fn new(duration: f64, repeating: bool) -> Self

Trait Implementations

impl Clone for Timer

fn clone(&self) -> Timer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Timer

impl Debug for Timer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Timer

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Timer

fn partial_cmp(&self, other: &Timer) -> 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

impl Updatable for Timer

Forwards Timer::update through the Updatable trait so timers can participate in the same generic update loop as entities, animators, scenes, and physics worlds.

fn update(&mut self, delta_time: f64)

Advance the object’s internal state by the given delta time.