Enum leafwing_input_manager::user_input::UserInput

source · [−]

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

Expand description

Some combination of user input, which may cross [Input]-mode boundaries

Suitable for use in an InputMap

Variants

`Single(InputKind)`

A single button

`Chord(PetitSet<InputKind, 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 [InputMode]s of their constituent buttons.

`VirtualDPad(VirtualDPad)`

A virtual DPad that you can get an [AxisPair] from

Implementations

impl UserInput

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

Creates a UserInput::Chord from an iterator of 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([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) -> 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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for UserInput

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

Formats the value using the given formatter. Read more

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. Read more

impl Display for UserInput

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

Formats the value using the given formatter. Read more

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<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<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. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

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 ==. Read more

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. Read more

impl Eq for UserInput

impl StructuralEq for UserInput

impl StructuralPartialEq for UserInput

Auto Trait Implementations

impl RefUnwindSafe for UserInput

impl Send for UserInput

impl Sync for UserInput

impl Unpin for UserInput

impl UnwindSafe for UserInput

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T, U> AsBindGroupShaderType<U> for T where
U: ShaderType,
&'a T: for<'a> Into<U>,

fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U

Return the T [ShaderType] for self. When used in [AsBindGroup] derives, it is safe to assume that all images in self exist. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CallHasher for T where
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> Downcast for T where
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

impl<T> DynEq for T where
T: Any + Eq,

fn as_any(&self) -> &(dyn Any + 'static)

fn dyn_eq(&self, other: &(dyn DynEq + 'static)) -> bool

impl<T> DynHash for T where
T: DynEq + Hash,

fn as_dyn_eq(&self) -> &(dyn DynEq + 'static)

fn dyn_hash(&self, state: &mut dyn Hasher)

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Serialize for T where
T: Serialize + ?Sized,

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T where
T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,

fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,

impl<T> Event for T where
T: 'static + Send + Sync,

impl<T> Resource for T where
T: 'static + Send + Sync,

impl<T> StateData for T where
T: 'static + Send + Sync + Clone + Eq + Debug + Hash,