Struct bevy_input::gamepad::ButtonSettings

pub struct ButtonSettings { /* private fields */ }

Manages settings for gamepad buttons.

It is used inside of GamepadSettings to define the threshold for a gamepad button to be considered pressed or released. A button is considered pressed if the press_threshold value is surpassed and released if the release_threshold value is undercut.

Allowed values: 0.0 <= ``release_threshold`` <= ``press_threshold`` <= 1.0

Implementations

impl ButtonSettings

pub fn new( press_threshold: f32, release_threshold: f32 ) -> Result<ButtonSettings, ButtonSettingsError>

Creates a new ButtonSettings instance.

Parameters

• press_threshold is the button input value above which the button is considered pressed.
• release_threshold is the button input value below which the button is considered released.

Restrictions:

• 0.0 <= ``release_threshold`` <= ``press_threshold`` <= 1.0

Errors

If the restrictions are not met, returns one of GamepadSettingsError::ButtonReleaseThresholdOutOfRange, GamepadSettingsError::ButtonPressThresholdOutOfRange, or GamepadSettingsError::ButtonReleaseThresholdGreaterThanPressThreshold.

pub fn is_pressed(&self, value: f32) -> bool

Returns true if the button is pressed.

A button is considered pressed if the value passed is greater than or equal to the press threshold.

pub fn is_released(&self, value: f32) -> bool

Returns true if the button is released.

A button is considered released if the value passed is lower than or equal to the release threshold.

pub fn press_threshold(&self) -> f32

Get the button input threshold above which the button is considered pressed.

pub fn try_set_press_threshold( &mut self, value: f32 ) -> Result<(), ButtonSettingsError>

Try to set the button input threshold above which the button is considered pressed.

Errors

If the value passed is outside the range [release threshold..=1.0], returns either GamepadSettingsError::ButtonPressThresholdOutOfRange or GamepadSettingsError::ButtonReleaseThresholdGreaterThanPressThreshold.

pub fn set_press_threshold(&mut self, value: f32) -> f32

Try to set the button input threshold above which the button is considered pressed. If the value passed is outside the range [release threshold..=1.0], the value will not be changed.

Returns the new value of the press threshold.

pub fn release_threshold(&self) -> f32

Get the button input threshold below which the button is considered released.

pub fn try_set_release_threshold( &mut self, value: f32 ) -> Result<(), ButtonSettingsError>

Try to set the button input threshold below which the button is considered released.

Errors

If the value passed is outside the range [0.0..=press threshold], returns ButtonSettingsError::ReleaseThresholdOutOfRange or ButtonSettingsError::ReleaseThresholdGreaterThanPressThreshold.

pub fn set_release_threshold(&mut self, value: f32) -> f32

Try to set the button input threshold below which the button is considered released. If the value passed is outside the range [0.0..=press threshold], the value will not be changed.

Returns the new value of the release threshold.

Trait Implementations

impl Clone for ButtonSettings

fn clone(&self) -> ButtonSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ButtonSettings

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

Formats the value using the given formatter.

impl Default for ButtonSettings

fn default() -> Self

Returns the “default value” for a type.

impl FromReflect for ButtonSettings

where Self: Any + Send + Sync, f32: FromReflect + TypePath,

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 ButtonSettings

where Self: Any + Send + Sync, f32: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Reflect for ButtonSettings

where Self: Any + Send + Sync, f32: 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: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

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

fn apply(&mut self, value: &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_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 reflect_hash(&self) -> Option<u64>

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

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 Struct for ButtonSettings

where Self: Any + Send + Sync, f32: FromReflect + TypePath,

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

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

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

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

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

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

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

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

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 clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for ButtonSettings

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 ButtonSettings

where Self: Any + Send + Sync, f32: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.