Struct leafwing_input_manager::action_state::Timing

pub struct Timing {
    pub instant_started: Option<Instant>,
    pub current_duration: Duration,
    pub previous_duration: Duration,
}

Stores information about when an action was pressed or released

This struct is principally used as a field on ActionData, which itself lives inside an ActionState.

Fields

instant_started: Option<Instant>

The [Instant] at which the button was pressed or released Recorded as the Time at the start of the tick after the state last changed. If this is none, Timing::tick has not been called yet.

current_duration: Duration

The Duration for which the button has been pressed or released.

This begins at Duration::ZERO when ActionState::update is called.

previous_duration: Duration

The Duration for which the button was pressed or released before the state last changed.

Implementations

impl Timing

pub fn tick(&mut self, current_instant: Instant, previous_instant: Instant)

Advances the current_duration of this timer

If the instant_started is None, it will be set to the current time. This design allows us to ensure that the timing is always synchronized with the start of each frame.

pub fn flip(&mut self)

Flips the metaphorical hourglass, storing current_duration in previous_duration and resetting instant_started

This method is called whenever actions are pressed or released

Trait Implementations

impl Clone for Timing

fn clone(&self) -> Timing

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Timing

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

Formats the value using the given formatter.

impl Default for Timing

fn default() -> Timing

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Timing

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<Timing> for Timing

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Timing> for Timing

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Timing

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Timing

impl StructuralEq for Timing

impl StructuralPartialEq for Timing