Struct veloren_common::comp::agent::Timer

pub struct Timer {
    action_starts: Vec<Option<f64>>,
    last_action: Option<TimerAction>,
}

A time used for managing agent-related timeouts. The timer is designed to keep track of the start of any number of previous actions. However, starting/progressing an action will end previous actions. Therefore, the timer should be used for actions that are mutually-exclusive.

Fields

action_starts: Vec<Option<f64>>

last_action: Option<TimerAction>

Implementations

impl Timer

fn idx_for(action: TimerAction) -> usize

pub fn reset(&mut self, action: TimerAction) -> bool

Reset the timer for the given action, returning true if the timer was not already reset.

pub fn start(&mut self, time: f64, action: TimerAction)

Start the timer for the given action, even if it was already started.

pub fn progress(&mut self, time: f64, action: TimerAction)

Continue timing the given action, starting it if it was not already started.

pub fn time_of_last(&self, action: TimerAction) -> Option<f64>

Return the time that the given action was last performed at.

pub fn time_since_exceeds( &self, time: f64, action: TimerAction, timeout: f64, ) -> bool

Return true if the time since the action was last started exceeds the given timeout.

pub fn timeout_elapsed( &mut self, time: f64, action: TimerAction, timeout: f64, ) -> Option<bool>

Return true while the time since the action was last started is less than the given period. Once the time has elapsed, reset the timer.

Trait Implementations

impl Clone for Timer

fn clone(&self) -> Timer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Timer

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

Formats the value using the given formatter.

impl Default for Timer

fn default() -> Self

Returns the “default value” for a type.