Struct leafwing_input_manager::plugin::InputManagerPlugin

pub struct InputManagerPlugin<A: Actionlike> { /* private fields */ }

A [Plugin] that collects Input from disparate sources, producing an ActionState that can be conveniently checked

This plugin needs to be passed in an Actionlike enum type that you’ve created for your game. Each variant represents a “virtual button” whose state is stored in an ActionState struct.

Each InputManagerBundle contains:

• an InputMap component, which stores an entity-specific mapping between the assorted input streams and an internal representation of “actions”
• an ActionState component, which stores the current input state for that entity in an source-agnostic fashion

If you have more than one distinct type of action (e.g. menu actions, camera actions and player actions), consider creating multiple Actionlike enums and adding a copy of this plugin for each Actionlike type.

Systems

All systems added by this plugin can be dynamically enabled and disabled by setting the value of the ToggleActions<A> resource is set. This can be useful when working with states to pause the game, navigate menus or so on.

WARNING: These systems run during [PreUpdate]. If you have systems that care about inputs and actions that also run during this stage, you must define an ordering between your systems or behavior will be very erratic. The stable system sets for these systems are available under InputManagerSystem enum.

Complete list:

• tick_action_state, which resets the pressed and just_pressed fields of the ActionState each frame
• update_action_state, which collects Input resources to update the ActionState
• update_action_state_from_interaction, for triggering actions from buttons
  • powers the ActionStateDriver component based on an Interaction component
• release_on_disable, which resets action states when ToggleActions is flipped, to avoid persistent presses.

Implementations

impl<A: Actionlike> InputManagerPlugin<A>

pub fn server() -> Self

Creates a version of the plugin intended to run on the server

Inputs will not be processed; instead, ActionState should be copied directly from the state provided by the client, or constructed from ActionDiff event streams.

Trait Implementations

impl<A: Actionlike> Default for InputManagerPlugin<A>

fn default() -> Self

Returns the “default value” for a type.

impl<A: Actionlike> Plugin for InputManagerPlugin<A>

fn build(&self, app: &mut App)

Configures the [App] to which this plugin is added.

fn ready(&self, _app: &App) -> bool

Has the plugin finished it’s setup? This can be useful for plugins that needs something asynchronous to happen before they can finish their setup, like renderer initialization. Once the plugin is ready, finish should be called.

fn finish(&self, _app: &mut App)

Finish adding this plugin to the [App], once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the [Plugin] which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.