Struct leafwing_input_manager::InputManagerPlugin

pub struct InputManagerPlugin<A: Actionlike, UserState: Resource + PartialEq + Clone = ()> { /* private fields */ }

A [Plugin] that collects [Input] from disparate sources, producing an ActionState to consume in game logic

This plugin needs to be passed in an Actionlike enum type that you’ve created for your game, which acts as a “virtual button” that can be comfortably consumed

Each InputManagerBundle contains:

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

Systems

• tick_action_state, which resets the pressed and just_pressed fields of the ActionState each frame
  • labeled InputManagerSystem::Reset
• update_action_state which collects [Input] resources to update the ActionState
  • labeled InputManagerSystem::Update
• update_action_state_from_interaction, for triggering actions from buttons
  • powers the ActionStateDriver component baseod on an [Interaction] component
  • labeled InputManagerSystem::Update

Implementations

impl<A: Actionlike, UserState: Resource + PartialEq + Clone> InputManagerPlugin<A, UserState>

pub fn run_in_state(state_variant: UserState) -> Self

Creates a version of this plugin that will only run in the specified state_variant

Example

use bevy::prelude::*;
use leafwing_input_manager::*;
#[derive(Actionlike, PartialEq, Eq, Clone, Copy, Hash, Debug, EnumIter)]
enum PlayerAction {
   // Movement
   Up,
   Down,
   Left,
   Right,
}

#[derive(Debug, Clone, Eq, PartialEq, Hash)]
enum GameState {
    Playing,
    Paused,
    Menu,
}

App::new().add_plugin(InputManagerPlugin::<PlayerAction, GameState>::run_in_state(GameState::Playing));

Trait Implementations

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

fn default() -> Self

Returns the “default value” for a type.

impl<A: Actionlike, UserState: Resource + PartialEq + Clone> Plugin for InputManagerPlugin<A, UserState>

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

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

fn name(&self) -> &str

Configures a name for the [Plugin]. Primarily for debugging.