Struct leafwing_input_manager::action_driver::ActionStateDriver

pub struct ActionStateDriver<A: Actionlike> {
    pub action: A,
    pub targets: ActionStateDriverTarget,
}

A component that allows the attached entity to drive the ActionState of the associated entity

Examples

By default, update_action_state_from_interaction uses this component in order to connect bevy::ui buttons to the corresponding ActionState.

use bevy::prelude::*;
use leafwing_input_manager::prelude::*;

#[derive(Actionlike, PartialEq, Eq, Hash, Clone, Copy, Reflect)]
enum DanceDance {
    Left,
    Right,
    Up,
    Down,
}

// Spawn entity to track dance inputs
let mut world = World::new();
let dance_tracker = world
    .spawn(ActionState::<DanceDance>::default())
    .id();

// Spawn a button, which is wired up to the dance tracker
// When used with InputManagerPlugin<DanceDance>, this button will press the DanceDance::Left action when it is pressed.
world
    .spawn(ButtonBundle::default())
    // This component links the button to the entity with the `ActionState` component
    .insert(ActionStateDriver {
        action: DanceDance::Left,
        targets: dance_tracker.into(),
    });

Writing your own systems that use the ActionStateDriver component is easy, although this should be reserved for cases where the entity whose value you want to check is distinct from the entity whose ActionState you want to set. Check the source code of update_action_state_from_interaction for an example of how this is done.

Fields

action: A

The action triggered by this entity

targets: ActionStateDriverTarget

The entity whose action state should be updated

Trait Implementations

impl<A: Clone + Actionlike> Clone for ActionStateDriver<A>

fn clone(&self) -> ActionStateDriver<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Actionlike> Component for ActionStateDriver<A>

where Self: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either [TableStorage] or [SparseStorage].

impl<A: Debug + Actionlike> Debug for ActionStateDriver<A>

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

Formats the value using the given formatter.

impl<A: PartialEq + Actionlike> PartialEq for ActionStateDriver<A>

fn eq(&self, other: &ActionStateDriver<A>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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<A: Eq + Actionlike> Eq for ActionStateDriver<A>

impl<A: Actionlike> StructuralPartialEq for ActionStateDriver<A>