Enum leafwing_input_manager::user_input::UserInput

pub enum UserInput {
    Single(InputKind),
    Chord(Box<PetitSet<InputKind, 8>>),
    VirtualDPad(VirtualDPad),
    VirtualAxis(VirtualAxis),
}

Some combination of user input, which may cross input-mode boundaries.

For example, this may store mouse, keyboard or gamepad input, including cross-device chords!

Suitable for use in an InputMap

Variants

Single(InputKind)

A single button

Chord(Box<PetitSet<InputKind, 8>>)

A combination of buttons, pressed simultaneously

Up to 8 (!!) buttons can be chorded together at once.

VirtualDPad(VirtualDPad)

A virtual DPad that you can get an DualAxis from

VirtualAxis(VirtualAxis)

A virtual axis that you can get a SingleAxis from

Implementations

impl UserInput

pub fn modified(modifier: Modifier, input: impl Into<InputKind>) -> UserInput

Creates a UserInput::Chord from a Modifier and an input that can be converted into an InputKind

When working with keyboard modifiers, should be preferred over manually specifying both the left and right variant.

pub fn chord(inputs: impl IntoIterator<Item = impl Into<InputKind>>) -> Self

Creates a UserInput::Chord from an iterator of inputs of the same type that can be converted into an InputKinds

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

pub fn len(&self) -> usize

The number of logical inputs that make up the UserInput.

• A Single input returns 1
• A Chord returns the number of buttons in the chord
• A VirtualDPad returns 1

pub fn is_empty(&self) -> bool

Is the number of buttons in the UserInput 0?

pub fn n_matching(&self, buttons: &HashSet<InputKind>) -> 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([ControlLeft.into(), AltLeft.into()]);
let a: UserInput  = A.into();
let ctrl_a = UserInput::chord([ControlLeft, A]);
let ctrl_alt_a = UserInput::chord([ControlLeft, AltLeft, 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) -> RawInputs

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<DualAxis> for UserInput

fn from(input: DualAxis) -> Self

Converts to this type from the input type.

impl From<GamepadButtonType> for UserInput

fn from(input: GamepadButtonType) -> Self

Converts to this type from the input type.

impl From<InputKind> for UserInput

fn from(input: InputKind) -> 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<Modifier> for UserInput

fn from(input: Modifier) -> 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 From<MouseMotionDirection> for UserInput

fn from(input: MouseMotionDirection) -> Self

Converts to this type from the input type.

impl From<MouseWheelDirection> for UserInput

fn from(input: MouseWheelDirection) -> Self

Converts to this type from the input type.

impl From<QwertyScanCode> for UserInput

fn from(input: QwertyScanCode) -> Self

Converts to this type from the input type.

impl From<ScanCode> for UserInput

fn from(input: ScanCode) -> Self

Converts to this type from the input type.

impl From<SingleAxis> for UserInput

fn from(input: SingleAxis) -> Self

Converts to this type from the input type.

impl From<VirtualAxis> for UserInput

fn from(input: VirtualAxis) -> Self

Converts to this type from the input type.

impl From<VirtualDPad> for UserInput

fn from(input: VirtualDPad) -> 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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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