Trait leafwing_input_manager::user_input::UserInput

pub trait UserInput:
    Send
    + Sync
    + Debug
    + DynClone
    + DynEq
    + DynHash
    + Reflect
    + Serialize {
    // Required methods
    fn kind(&self) -> InputControlKind;
    fn decompose(&self) -> BasicInputs;
}

A trait for defining the behavior expected from different user input sources.

Implementers of this trait should provide methods for accessing and processing user input data.

Examples

use std::hash::{Hash, Hasher};
use bevy::prelude::*;
use bevy::math::{Vec2, FloatOrd};
use serde::{Deserialize, Serialize};
use leafwing_input_manager::prelude::*;
use leafwing_input_manager::axislike::{DualAxisType};
use leafwing_input_manager::clashing_inputs::BasicInputs;

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Reflect, Serialize, Deserialize)]
pub struct MouseScrollAlwaysFiveOnYAxis;

// Add this attribute for ensuring proper serialization and deserialization.
#[serde_typetag]
impl UserInput for MouseScrollAlwaysFiveOnYAxis {
    fn kind(&self) -> InputControlKind {
        // Returns the kind of input this represents.
        //
        // In this case, it represents an axial input.
        InputControlKind::Axis
    }

    fn decompose(&self) -> BasicInputs {
        // Gets the most basic form of this input for clashing input detection.
        //
        // This input is not buttonlike, so it uses `None`.
        BasicInputs::None
    }
}

// Remember to register your input - it will ensure everything works smoothly!
let mut app = App::new();
app.register_user_input::<MouseScrollAlwaysFiveOnYAxis>();

Required Methods

fn kind(&self) -> InputControlKind

Defines the kind of behavior that the input should be.

fn decompose(&self) -> BasicInputs

Returns the set of primitive inputs that make up this input.

These inputs are used to detect clashes between different user inputs, and are stored in a BasicInputs for easy comparison.

For inputs that represent a simple, atomic control, this method should always return a BasicInputs::Simple that only contains the input itself.

Trait Implementations

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

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromReflect for Box<dyn UserInput>

fn from_reflect(reflect: &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 Box<dyn UserInput>

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl<'hash> Hash for dyn UserInput + 'hash

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

Feeds this value into the given Hasher.

impl<'hash> Hash for dyn UserInput + Send + 'hash

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

Feeds this value into the given Hasher.

impl<'hash> Hash for dyn UserInput + Send + Sync + 'hash

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

Feeds this value into the given Hasher.

impl<'hash> Hash for dyn UserInput + Sync + 'hash

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

Feeds this value into the given Hasher.

impl<'eq> PartialEq<&Box<dyn UserInput + 'eq>> for Box<dyn UserInput + 'eq>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'eq> PartialEq<&Box<dyn UserInput + Send + 'eq>> for Box<dyn UserInput + Send + 'eq>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'eq> PartialEq<&Box<dyn UserInput + Send + Sync + 'eq>> for Box<dyn UserInput + Send + Sync + 'eq>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'eq> PartialEq<&Box<dyn UserInput + Sync + 'eq>> for Box<dyn UserInput + Sync + 'eq>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'eq> PartialEq for dyn UserInput + 'eq

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'eq> PartialEq for dyn UserInput + Send + 'eq

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'eq> PartialEq for dyn UserInput + Send + Sync + 'eq

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'eq> PartialEq for dyn UserInput + Sync + 'eq

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Reflect for Box<dyn UserInput>

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 try_apply(&mut self, value: &dyn Reflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

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

Applies a reflected value to this value.

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

Performs a type-checked assignment of 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 clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

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

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<'de> RegisterTypeTag<'de, dyn UserInput> for AxislikeChord

fn register_typetag(registry: &mut MapRegistry<dyn UserInput>)

Registers the specified type tag into the MapRegistry.

impl<'de> RegisterTypeTag<'de, dyn UserInput> for ButtonlikeChord

fn register_typetag(registry: &mut MapRegistry<dyn UserInput>)

Registers the specified type tag into the MapRegistry.

impl<'de> RegisterTypeTag<'de, dyn UserInput> for DualAxislikeChord

fn register_typetag(registry: &mut MapRegistry<dyn UserInput>)

Registers the specified type tag into the MapRegistry.

impl<'de> RegisterTypeTag<'de, dyn UserInput> for GamepadButtonType

fn register_typetag(registry: &mut MapRegistry<dyn UserInput>)

Registers the specified type tag into the MapRegistry.

impl<'de> RegisterTypeTag<'de, dyn UserInput> for GamepadControlAxis

fn register_typetag(registry: &mut MapRegistry<dyn UserInput>)

Registers the specified type tag into the MapRegistry.

impl<'de> RegisterTypeTag<'de, dyn UserInput> for GamepadControlDirection

fn register_typetag(registry: &mut MapRegistry<dyn UserInput>)

Registers the specified type tag into the MapRegistry.

impl<'de> RegisterTypeTag<'de, dyn UserInput> for GamepadStick

fn register_typetag(registry: &mut MapRegistry<dyn UserInput>)

Registers the specified type tag into the MapRegistry.

impl<'de> RegisterTypeTag<'de, dyn UserInput> for GamepadVirtualAxis

fn register_typetag(registry: &mut MapRegistry<dyn UserInput>)

Registers the specified type tag into the MapRegistry.

impl<'de> RegisterTypeTag<'de, dyn UserInput> for GamepadVirtualDPad

fn register_typetag(registry: &mut MapRegistry<dyn UserInput>)

Registers the specified type tag into the MapRegistry.

impl<'de> RegisterTypeTag<'de, dyn UserInput> for KeyCode

fn register_typetag(registry: &mut MapRegistry<dyn UserInput>)

Registers the specified type tag into the MapRegistry.

impl<'de> RegisterTypeTag<'de, dyn UserInput> for KeyboardVirtualAxis

fn register_typetag(registry: &mut MapRegistry<dyn UserInput>)

Registers the specified type tag into the MapRegistry.

impl<'de> RegisterTypeTag<'de, dyn UserInput> for KeyboardVirtualDPad

fn register_typetag(registry: &mut MapRegistry<dyn UserInput>)

Registers the specified type tag into the MapRegistry.

impl<'de> RegisterTypeTag<'de, dyn UserInput> for ModifierKey

fn register_typetag(registry: &mut MapRegistry<dyn UserInput>)

Registers the specified type tag into the MapRegistry.

impl<'de> RegisterTypeTag<'de, dyn UserInput> for MouseButton

fn register_typetag(registry: &mut MapRegistry<dyn UserInput>)

Registers the specified type tag into the MapRegistry.

impl<'de> RegisterTypeTag<'de, dyn UserInput> for MouseMove

fn register_typetag(registry: &mut MapRegistry<dyn UserInput>)

Registers the specified type tag into the MapRegistry.

impl<'de> RegisterTypeTag<'de, dyn UserInput> for MouseMoveAxis

fn register_typetag(registry: &mut MapRegistry<dyn UserInput>)

Registers the specified type tag into the MapRegistry.

impl<'de> RegisterTypeTag<'de, dyn UserInput> for MouseMoveDirection

fn register_typetag(registry: &mut MapRegistry<dyn UserInput>)

Registers the specified type tag into the MapRegistry.

impl<'de> RegisterTypeTag<'de, dyn UserInput> for MouseScroll

fn register_typetag(registry: &mut MapRegistry<dyn UserInput>)

Registers the specified type tag into the MapRegistry.

impl<'de> RegisterTypeTag<'de, dyn UserInput> for MouseScrollAxis

fn register_typetag(registry: &mut MapRegistry<dyn UserInput>)

Registers the specified type tag into the MapRegistry.

impl<'de> RegisterTypeTag<'de, dyn UserInput> for MouseScrollDirection

fn register_typetag(registry: &mut MapRegistry<dyn UserInput>)

Registers the specified type tag into the MapRegistry.

impl<'a> Serialize for dyn UserInput + 'a

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 Box<dyn UserInput>

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 Box<dyn UserInput>

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl<'eq> Eq for dyn UserInput + 'eq

impl<'eq> Eq for dyn UserInput + Send + 'eq

impl<'eq> Eq for dyn UserInput + Send + Sync + 'eq

impl<'eq> Eq for dyn UserInput + Sync + 'eq

Implementations on Foreign Types

impl UserInput for GamepadButtonType

fn kind(&self) -> InputControlKind

GamepadButtonType acts as a button.

fn decompose(&self) -> BasicInputs

Creates a BasicInputs that only contains the GamepadButtonType itself, as it represents a simple physical button.

impl UserInput for KeyCode

fn kind(&self) -> InputControlKind

KeyCode acts as a button.

fn decompose(&self) -> BasicInputs

Returns a BasicInputs that only contains the KeyCode itself, as it represents a simple physical button.

impl UserInput for MouseButton

fn kind(&self) -> InputControlKind

MouseButton acts as a button.

fn decompose(&self) -> BasicInputs

Returns a BasicInputs that only contains the MouseButton itself, as it represents a simple physical button.

impl UserInput for GamepadAxis

Unlike GamepadButtonType, this struct represents a specific axis on a specific gamepad.

In the majority of cases, GamepadControlAxis or GamepadStick should be used instead.

fn kind(&self) -> InputControlKind

fn decompose(&self) -> BasicInputs

impl UserInput for GamepadButton

Unlike GamepadButtonType, this struct represents a specific button on a specific gamepad.

In the majority of cases, GamepadButtonType should be used instead.

fn kind(&self) -> InputControlKind

fn decompose(&self) -> BasicInputs

Implementors

impl UserInput for UserInputWrapper

impl UserInput for ModifierKey

impl UserInput for AxislikeChord

impl UserInput for ButtonlikeChord

impl UserInput for DualAxislikeChord

impl UserInput for GamepadControlAxis

impl UserInput for GamepadControlDirection

impl UserInput for GamepadStick

impl UserInput for GamepadVirtualAxis

impl UserInput for GamepadVirtualDPad

impl UserInput for KeyboardVirtualAxis

impl UserInput for KeyboardVirtualDPad

impl UserInput for MouseMove

impl UserInput for MouseMoveAxis

impl UserInput for MouseMoveDirection

impl UserInput for MouseScroll

impl UserInput for MouseScrollAxis

impl UserInput for MouseScrollDirection