Enum leafwing_input_manager::user_input::UserInput

pub enum UserInput {
    Single(InputButton),
    Chord(PetitSet<InputButton, 8>),
}

Some combination of user input, which may cross Input boundaries

Suitable for use in an InputMap

Variants

Single(InputButton)

A single button

Chord(PetitSet<InputButton, 8>)

A combination of buttons, pressed simultaneously

Up to 8 (!!) buttons can be chorded together at once. Chords are considered to belong to all of the InputModes of their constituent buttons.

Implementations

impl UserInput

pub fn chord(buttons: impl IntoIterator<Item = impl Into<InputButton>>) -> Self

Creates a UserInput::Chord from an iterator of [Button]s

If buttons has a length of 1, a UserInput::Single variant will be returned instead.

pub fn input_modes(&self) -> PetitSet<InputMode, 3>

Which InputModes does this input contain?

pub fn matches_input_mode(&self, input_mode: InputMode) -> bool

Does this UserInput match the provided InputMode?

For UserInput::Chord, this will be true if any of the buttons in the combination match.

pub fn len(&self) -> usize

The number of buttons in the UserInput

pub fn is_empty(&self) -> bool

Is the number of buttons in the UserInput 0?

pub fn n_matching(&self, buttons: &HashSet<InputButton>) -> usize

How many of the provided buttons are found in the UserInput

Example

use bevy_input::keyboard::KeyCode::*;
use bevy_utils::HashSet;
use leafwing_input_manager::user_input::UserInput;

let buttons = HashSet::from_iter([LControl.into(), LAlt.into()]);
let a: UserInput  = A.into();
let ctrl_a = UserInput::chord([LControl, A]);
let ctrl_alt_a = UserInput::chord([LControl, LAlt, A]);

assert_eq!(a.n_matching(&buttons), 0);
assert_eq!(ctrl_a.n_matching(&buttons), 1);
assert_eq!(ctrl_alt_a.n_matching(&buttons), 2);

pub fn raw_inputs(
    &self
) -> (Vec<GamepadButtonType>, Vec<KeyCode>, Vec<MouseButton>)

Returns the raw inputs that make up this UserInput

Trait Implementations

impl Clone for UserInput

fn clone(&self) -> UserInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserInput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UserInput

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for UserInput

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

Formats the value using the given formatter.

impl From<GamepadButtonType> for UserInput

fn from(input: GamepadButtonType) -> Self

Converts to this type from the input type.

impl From<InputButton> for UserInput

fn from(input: InputButton) -> Self

Converts to this type from the input type.

impl From<KeyCode> for UserInput

fn from(input: KeyCode) -> Self

Converts to this type from the input type.

impl From<MouseButton> for UserInput

fn from(input: MouseButton) -> Self

Converts to this type from the input type.

impl Hash for UserInput

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<UserInput> for UserInput

fn eq(&self, other: &UserInput) -> bool

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

fn ne(&self, other: &UserInput) -> bool

This method tests for !=.

impl Serialize for UserInput

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for UserInput

impl StructuralEq for UserInput

impl StructuralPartialEq for UserInput