Enum leafwing_input_manager::user_input::UserInput

pub enum UserInput {
    Single(InputKind),
    Chord(Vec<InputKind>),
    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(Vec<InputKind>)

A combination of buttons, pressed simultaneously

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 which can be converted into an InputKind

When working with keyboard modifiers, should be preferred to 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 over inputs of the same type convertible 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
• A VirtualAxis 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  = KeyA.into();
let ctrl_a = UserInput::chord([ControlLeft, KeyA]);
let ctrl_alt_a = UserInput::chord([ControlLeft, AltLeft, KeyA]);

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

where Self: Any + Send + Sync, InputKind: FromReflect + TypePath, Vec<InputKind>: FromReflect + TypePath, VirtualDPad: FromReflect + TypePath, VirtualAxis: FromReflect + TypePath,

fn field(&self, __name_param: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field (in the current variant) with the given name.

fn field_at(&self, __index_param: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field (in the current variant) at the given index.

fn field_mut(&mut self, __name_param: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field (in the current variant) with the given name.

fn field_at_mut(&mut self, __index_param: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field (in the current variant) at the given index.

fn index_of(&self, __name_param: &str) -> Option<usize>

Returns the index of the field (in the current variant) with the given name.

fn name_at(&self, __index_param: usize) -> Option<&str>

Returns the name of the field (in the current variant) with the given index.

fn iter_fields(&self) -> VariantFieldIter<'_>

Returns an iterator over the values of the current variant’s fields.

fn field_len(&self) -> usize

Returns the number of fields in the current variant.

fn variant_name(&self) -> &str

The name of the current variant.

fn variant_index(&self) -> usize

The index of the current variant.

fn variant_type(&self) -> VariantType

The type of the current variant.

fn clone_dynamic(&self) -> DynamicEnum

fn is_variant(&self, variant_type: VariantType) -> bool

Returns true if the current variant’s type matches the given one.

fn variant_path(&self) -> String

Returns the full path to the current variant.

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

where Self: Any + Send + Sync, InputKind: FromReflect + TypePath, Vec<InputKind>: FromReflect + TypePath, VirtualDPad: FromReflect + TypePath, VirtualAxis: FromReflect + TypePath,

fn from_reflect(__param0: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for UserInput

where Self: Any + Send + Sync, InputKind: FromReflect + TypePath, Vec<InputKind>: FromReflect + TypePath, VirtualDPad: FromReflect + TypePath, VirtualAxis: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

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

where Self: Any + Send + Sync, InputKind: FromReflect + TypePath, Vec<InputKind>: FromReflect + TypePath, VirtualDPad: FromReflect + TypePath, VirtualAxis: FromReflect + TypePath,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the [TypeInfo] of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set( &mut self, __value_param: Box<dyn Reflect> ) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, __value_param: &dyn Reflect)

Applies a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

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

where Self: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for UserInput

where Self: Any + Send + Sync, InputKind: FromReflect + TypePath, Vec<InputKind>: FromReflect + TypePath, VirtualDPad: FromReflect + TypePath, VirtualAxis: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Eq for UserInput

impl StructuralPartialEq for UserInput