Struct leafwing_input_manager::action_state::ActionData

pub struct ActionData {
    pub state: ButtonState,
    pub value: f32,
    pub axis_pair: Option<DualAxisData>,
    pub timing: Timing,
    pub consumed: bool,
}

Metadata about an Actionlike action

If a button is released, its reasons_pressed should be empty.

Fields

state: ButtonState

Is the action pressed or released?

value: f32

The “value” of the binding that triggered the action.

See [ActionState::action_value()] for more details.

Warning: this value may not be bounded as you might expect. Consider clamping this to account for multiple triggering inputs.

axis_pair: Option<DualAxisData>

The [AxisPair] of the binding that triggered the action.

See [ActionState::action_axis_pair()] for more details.

timing: Timing

When was the button pressed / released, and how long has it been held for?

consumed: bool

Was this action consumed by ActionState::consume?

Actions that are consumed cannot be pressed again until they are explicitly released. This ensures that consumed actions are not immediately re-pressed by continued inputs.

Trait Implementations

impl Clone for ActionData

fn clone(&self) -> ActionData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ActionData

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

Formats the value using the given formatter.

impl Default for ActionData

fn default() -> ActionData

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ActionData

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<ActionData> for ActionData

fn eq(&self, other: &ActionData) -> 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 Serialize for ActionData

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ActionData