Struct Cooldown 

pub struct Cooldown { /* private fields */ }

Limits how often something can happen, e.g. firing a weapon.

use audio_code::time::Cooldown;
let mut gun = Cooldown::new(0.5);
if gun.try_use() {
    // fire! The next try_use() returns false for half a second.
}

Implementations

impl Cooldown

pub fn new(seconds: f32) -> Self

Creates a cooldown of seconds that is ready immediately.

pub fn ready(&self) -> bool

Whether the cooldown has run out.

pub fn try_use(&mut self) -> bool

If ready, starts the cooldown and returns true. Otherwise returns false.

pub fn trigger(&mut self)

Starts the cooldown regardless of whether it was ready.

pub fn reset(&mut self)

Makes the cooldown ready immediately.

pub fn remaining(&self) -> f32

Seconds until ready (0.0 if ready).

pub fn set_length(&mut self, seconds: f32)

Changes the cooldown length.

Trait Implementations

impl Clone for Cooldown

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cooldown

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

Formats the value using the given formatter.