Struct GamepadControlDirection

pub struct GamepadControlDirection {
    pub axis: GamepadAxis,
    pub direction: AxisDirection,
    pub threshold: f32,
}

Provides button-like behavior for a specific direction on a GamepadAxis.

By default, it reads from any connected gamepad. Use the InputMap::set_gamepad for specific ones.

use bevy::prelude::*;
use bevy::input::InputPlugin;
use bevy::input::gamepad::GamepadEvent;
use leafwing_input_manager::prelude::*;

let mut app = App::new();
app.add_plugins(InputPlugin);

// Positive Y-axis movement on left stick
let input = GamepadControlDirection::LEFT_UP;

// Movement in the opposite direction doesn't activate the input
GamepadControlAxis::LEFT_Y.set_value(app.world_mut(), -1.0);
app.update();
assert!(!app.read_pressed(input));

// Movement in the chosen direction activates the input
GamepadControlAxis::LEFT_Y.set_value(app.world_mut(), 1.0);
app.update();
assert!(app.read_pressed(input));

Fields

axis: GamepadAxis

The axis that this input tracks.

direction: AxisDirection

The direction of the axis to monitor (positive or negative).

threshold: f32

The threshold value for the direction to be considered pressed. Must be non-negative.

Implementations

impl GamepadControlDirection

pub const LEFT_UP: Self

“Up” on the left analog stick (positive Y-axis movement).

pub const LEFT_DOWN: Self

“Down” on the left analog stick (negative Y-axis movement).

pub const LEFT_LEFT: Self

“Left” on the left analog stick (negative X-axis movement).

pub const LEFT_RIGHT: Self

“Right” on the left analog stick (positive X-axis movement).

pub const RIGHT_UP: Self

“Up” on the right analog stick (positive Y-axis movement).

pub const RIGHT_DOWN: Self

“Down” on the right analog stick (negative Y-axis movement).

pub const RIGHT_LEFT: Self

“Left” on the right analog stick (negative X-axis movement).

pub const RIGHT_RIGHT: Self

“Right” on the right analog stick (positive X-axis movement).

pub const fn negative(axis: GamepadAxis) -> Self

Creates a GamepadControlDirection triggered by a negative value on the specified axis.

pub const fn positive(axis: GamepadAxis) -> Self

Creates a GamepadControlDirection triggered by a positive value on the specified axis.

pub fn threshold(self, threshold: f32) -> Self

Sets the threshold value.

Requirements

• threshold >= 0.0.

Panics

Panics if the requirement isn’t met.

Trait Implementations

impl Buttonlike for GamepadControlDirection

fn pressed(&self, input_store: &CentralInputStore, gamepad: Entity) -> bool

Checks if there is any recent stick movement along the specified direction.

fn press_as_gamepad(&self, world: &mut World, gamepad: Option<Entity>)

Sends a RawGamepadEvent::Axis event with a magnitude of 1.0 for the specified direction on the provided gamepad Entity.

fn release_as_gamepad(&self, world: &mut World, gamepad: Option<Entity>)

Sends a RawGamepadEvent::Axis event with a magnitude of 0.0 for the specified direction.

fn set_value_as_gamepad( &self, world: &mut World, value: f32, gamepad: Option<Entity>, )

Simulate a value change of the buttonlike input, pretending to be the provided gamepad Entity.

fn released(&self, input_store: &CentralInputStore, gamepad: Entity) -> bool

Checks if the input is currently inactive.

fn value(&self, input_store: &CentralInputStore, gamepad: Entity) -> f32

Gets the current value of the button as an f32.

fn press(&self, world: &mut World)

Simulates a press of the buttonlike input by sending the appropriate event.

fn release(&self, world: &mut World)

Simulates a release of the buttonlike input by sending the appropriate event.

fn set_value(&self, world: &mut World, value: f32)

Simulate a value change of the buttonlike input by sending the appropriate event.

impl Clone for GamepadControlDirection

fn clone(&self) -> GamepadControlDirection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GamepadControlDirection

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GamepadControlDirection

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromReflect for GamepadControlDirection

where GamepadControlDirection: Any + Send + Sync, GamepadAxis: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AxisDirection: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

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

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

impl GetTypeRegistration for GamepadControlDirection

where GamepadControlDirection: Any + Send + Sync, GamepadAxis: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AxisDirection: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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 for GamepadControlDirection

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 GamepadControlDirection

fn eq(&self, other: &GamepadControlDirection) -> 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 PartialReflect for GamepadControlDirection

where GamepadControlDirection: Any + Send + Sync, GamepadAxis: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AxisDirection: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Returns the TypeInfo of the type represented by this value.

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

Tries to apply 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 try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

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

Returns a “partial equality” comparison result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

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

👎Deprecated since 0.16.0: to clone reflected values, prefer using reflect_clone. To convert reflected values to dynamic ones, use to_dynamic.

Clones Self into its dynamic representation.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

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

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

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

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for GamepadControlDirection

where GamepadControlDirection: Any + Send + Sync, GamepadAxis: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AxisDirection: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

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

Casts this type to a mutable, fully-reflected 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.

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

fn register_typetag(registry: &mut InfallibleMapRegistry<dyn Buttonlike>)

Registers the specified type tag into the InfallibleMapRegistry.

impl Serialize for GamepadControlDirection

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for GamepadControlDirection

where GamepadControlDirection: Any + Send + Sync, GamepadAxis: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AxisDirection: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

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

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

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

Returns an iterator over the values of the reflectable fields for this struct.

fn to_dynamic_struct(&self) -> DynamicStruct

fn clone_dynamic(&self) -> DynamicStruct

👎Deprecated since 0.16.0: use to_dynamic_struct instead

Clones the struct into a DynamicStruct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for GamepadControlDirection

where GamepadControlDirection: 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 GamepadControlDirection

where GamepadControlDirection: Any + Send + Sync, GamepadAxis: FromReflect + TypePath + MaybeTyped + RegisterForReflection, AxisDirection: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl UserInput for GamepadControlDirection

fn kind(&self) -> InputControlKind

GamepadControlDirection acts as a virtual button.

fn decompose(&self) -> BasicInputs

GamepadControlDirection represents a simple virtual button.

impl Copy for GamepadControlDirection

impl Eq for GamepadControlDirection

impl StructuralPartialEq for GamepadControlDirection