Struct ActionBinding

pub struct ActionBinding { /* private fields */ }

Bindings associated with an InputAction marker.

Stored inside Actions.

Bindings are stored separately from ActionMap to allow reading other actions’ data during evaluation.

Action bindings evaluation follows these steps:

1. Iterate over each ActionValue from the associated Inputs: 1.1. Apply input-level InputModifiers. 1.2. Evaluate input-level InputConditions, combining their results based on their InputCondition::kind.
2. Select all ActionValues with the most significant ActionState and combine based on InputAction::ACCUMULATION. Combined value will be converted into InputAction::Output using ActionValue::convert.
3. Apply action level InputModifiers.
4. Evaluate action level InputConditions, combining their results according to InputCondition::kind.
5. Set the final ActionState based on the results. Final value will be converted into InputAction::Output using ActionValue::convert.

Implementations

impl ActionBinding

pub fn inputs(&self) -> &[InputBinding]

Returns associated input bindings.

See also Self::to.

pub fn with_modifiers(&mut self, modifiers: impl IntoModifiers) -> &mut Self

Adds action-level modifiers.

For input-level modifiers see BindingBuilder::with_modifiers.

Examples

Single modifier:

actions.bind::<Jump>()
    .to(KeyCode::Space)
    .with_modifiers(Scale::splat(2.0));

Multiple modifiers:

actions.bind::<Jump>()
    .to(KeyCode::Space)
    .with_modifiers((Scale::splat(2.0), Negate::all()));

pub fn with_conditions(&mut self, conditions: impl IntoConditions) -> &mut Self

Adds action-level conditions.

For input-level conditions see BindingBuilder::with_conditions.

Examples

Single condition:

actions.bind::<Jump>()
    .to(KeyCode::Space)
    .with_conditions(Release::default());

Multiple conditions:

actions.bind::<Jump>()
    .to(KeyCode::Space)
    .with_conditions((Release::default(), JustPress::default()));

pub fn to(&mut self, bindings: impl IntoBindings) -> &mut Self

Adds input mapping.

Thanks to traits, this function can be called with multiple types:

1. Raw input types.
2. Input enum which wraps any supported raw input and can store keyboard modifiers.
3. InputBinding which wraps Input and can store input modifiers or conditions.
4. IntoBindings which wraps InputBinding and can store multiple InputBindings. Also implemented on tuples, so you can pass multiple inputs to a single call.

All assigned inputs will be evaluated separately (equivalent to “any of”). If you’re looking for a chord, see the Chord condition.

Examples

Raw input:

actions.bind::<Jump>()
    .to((KeyCode::Space, GamepadButton::South));

Raw input with keyboard modifiers:

actions.bind::<Jump>().to(KeyCode::Space.with_mod_keys(ModKeys::CONTROL));

Raw input with input conditions or modifiers:

actions.bind::<Jump>().to(KeyCode::Space.with_conditions(Release::default()));
actions.bind::<Attack>().to(MouseButton::Left.with_modifiers(Scale::splat(10.0)));

Input type directly:

actions.bind::<Zoom>().to(Input::mouse_wheel());
actions.bind::<Move>().to(Input::mouse_motion());

Convenience preset which consists of multiple inputs with predefined conditions and modifiers:

actions.bind::<Move>().to(Cardinal::wasd_keys());

Multiple buttons from settings:

actions.bind::<Inspect>().to(&settings.inspect);

struct KeyboardSettings {
    inspect: Vec<KeyCode>,
}