Trait InputContextAppExt 

pub trait InputContextAppExt {
    // Required method
    fn add_input_context_to<S: ScheduleLabel + Default, C: Component>(
        &mut self,
    ) -> &mut Self;

    // Provided method
    fn add_input_context<C: Component>(&mut self) -> &mut Self { ... }
}

An extension trait for App to assign input to components.

Required Methods

fn add_input_context_to<S: ScheduleLabel + Default, C: Component>( &mut self, ) -> &mut Self

Like Self::add_input_context, but allows specifying the schedule in which the context’s actions will be evaluated.

For example, if your game logic runs inside FixedMain, you can set the schedule to FixedPreUpdate. This way, if the schedule runs multiple times per frame, events like Start or Complete will be triggered only once per schedule run.

Provided Methods

fn add_input_context<C: Component>(&mut self) -> &mut Self

Registers type C as an input context, whose actions will be evaluated during PreUpdate.

Action evaluation follows these steps:

• If the action has an ActionMock component, use the mocked ActionValue and ActionState directly.
• Otherwise, evaluate the action from its bindings:
  1. Iterate over each binding from the Bindings component.
     1. Read the binding input as an ActionValue, or ActionValue::zero if the input was already consumed by another action. The enum variant depends on the input source.
     2. Apply all binding-level InputModifiers.
     3. Evaluate all input-level InputConditions, combining their results based on their InputCondition::kind.
  2. Select all ActionValues with the most significant ActionState and combine them using the ActionSettings::accumulation strategy.
  3. Convert the combined value to ActionOutput::DIM using ActionValue::convert.
  4. Apply all action-level InputModifiers.
  5. Evaluate all action-level InputConditions, combining their results based on their InputCondition::kind.
  6. Convert the final value to ActionOutput::DIM again using ActionValue::convert.
  7. Apply the resulting ActionState and ActionValue to the action entity.
  8. If the final state is not ActionState::None, consume the binding input value.

This logic may look complicated, but you don’t have to memorize it. It behaves surprisingly intuitively.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl InputContextAppExt for App

fn add_input_context_to<S: ScheduleLabel + Default, C: Component>( &mut self, ) -> &mut Self

Implementors