Struct bevy::input::gamepad::GamepadSettings

pub struct GamepadSettings {
    pub default_button_settings: ButtonSettings,
    pub default_axis_settings: AxisSettings,
    pub default_button_axis_settings: ButtonAxisSettings,
    pub button_settings: HashMap<GamepadButton, ButtonSettings>,
    pub axis_settings: HashMap<GamepadAxis, AxisSettings>,
    pub button_axis_settings: HashMap<GamepadButton, ButtonAxisSettings>,
}

Settings for all Gamepads.

Usage

It is used to create a bevy resource that stores the settings of every GamepadButton and GamepadAxis. If no user defined ButtonSettings, AxisSettings, or ButtonAxisSettings are defined, the default settings of each are used as a fallback accordingly.

Note

The GamepadSettings are used inside of bevy_gilrs to determine when raw gamepad events from gilrs, should register as a GamepadEvent. Events that don’t meet the change thresholds defined in GamepadSettings will not register. To modify these settings, mutate the corresponding resource.

Fields

default_button_settings: ButtonSettings

The default button settings.

default_axis_settings: AxisSettings

The default axis settings.

default_button_axis_settings: ButtonAxisSettings

The default button axis settings.

button_settings: HashMap<GamepadButton, ButtonSettings>

The user defined button settings.

axis_settings: HashMap<GamepadAxis, AxisSettings>

The user defined axis settings.

button_axis_settings: HashMap<GamepadButton, ButtonAxisSettings>

The user defined button axis settings.

Implementations

impl GamepadSettings

pub fn get_button_settings(&self, button: GamepadButton) -> &ButtonSettings

Returns the ButtonSettings of the button.

If no user defined ButtonSettings are specified the default ButtonSettings get returned.

Examples

let button = GamepadButton::new(Gamepad::new(1), GamepadButtonType::South);
let button_settings = settings.get_button_settings(button);

pub fn get_axis_settings(&self, axis: GamepadAxis) -> &AxisSettings

Returns the AxisSettings of the axis.

If no user defined AxisSettings are specified the default AxisSettings get returned.

Examples

let axis = GamepadAxis::new(Gamepad::new(1), GamepadAxisType::LeftStickX);
let axis_settings = settings.get_axis_settings(axis);

pub fn get_button_axis_settings( &self, button: GamepadButton ) -> &ButtonAxisSettings

Returns the ButtonAxisSettings of the button.

If no user defined ButtonAxisSettings are specified the default ButtonAxisSettings get returned.

Examples

let button = GamepadButton::new(Gamepad::new(1), GamepadButtonType::South);
let button_axis_settings = settings.get_button_axis_settings(button);

Trait Implementations

impl Debug for GamepadSettings

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

Formats the value using the given formatter.

impl Default for GamepadSettings

fn default() -> GamepadSettings

Returns the “default value” for a type.

impl FromReflect for GamepadSettings

where GamepadSettings: Any + Send + Sync, ButtonSettings: FromReflect + TypePath + RegisterForReflection, AxisSettings: FromReflect + TypePath + RegisterForReflection, ButtonAxisSettings: FromReflect + TypePath + RegisterForReflection, HashMap<GamepadButton, ButtonSettings>: FromReflect + TypePath + RegisterForReflection, HashMap<GamepadAxis, AxisSettings>: FromReflect + TypePath + RegisterForReflection, HashMap<GamepadButton, ButtonAxisSettings>: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<GamepadSettings>

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 GamepadSettings

where GamepadSettings: Any + Send + Sync, ButtonSettings: FromReflect + TypePath + RegisterForReflection, AxisSettings: FromReflect + TypePath + RegisterForReflection, ButtonAxisSettings: FromReflect + TypePath + RegisterForReflection, HashMap<GamepadButton, ButtonSettings>: FromReflect + TypePath + RegisterForReflection, HashMap<GamepadAxis, AxisSettings>: FromReflect + TypePath + RegisterForReflection, HashMap<GamepadButton, ButtonAxisSettings>: FromReflect + TypePath + 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 Reflect for GamepadSettings

where GamepadSettings: Any + Send + Sync, ButtonSettings: FromReflect + TypePath + RegisterForReflection, AxisSettings: FromReflect + TypePath + RegisterForReflection, ButtonAxisSettings: FromReflect + TypePath + RegisterForReflection, HashMap<GamepadButton, ButtonSettings>: FromReflect + TypePath + RegisterForReflection, HashMap<GamepadAxis, AxisSettings>: FromReflect + TypePath + RegisterForReflection, HashMap<GamepadButton, ButtonAxisSettings>: FromReflect + TypePath + RegisterForReflection,

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

Returns the TypeInfo of the type represented by this value.

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

Returns the value as a Box<dyn Any>.

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

Returns the value as a &dyn Any.

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

Returns the value as a &mut dyn Any.

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

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

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 try_apply( &mut self, value: &(dyn Reflect + 'static) ) -> 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<GamepadSettings>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

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

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

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

Applies a reflected value to this 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 GamepadSettings

where GamepadSettings: Any + Send + Sync, ButtonSettings: FromReflect + TypePath + RegisterForReflection, AxisSettings: FromReflect + TypePath + RegisterForReflection, ButtonAxisSettings: FromReflect + TypePath + RegisterForReflection, HashMap<GamepadButton, ButtonSettings>: FromReflect + TypePath + RegisterForReflection, HashMap<GamepadAxis, AxisSettings>: FromReflect + TypePath + RegisterForReflection, HashMap<GamepadButton, ButtonAxisSettings>: FromReflect + TypePath + RegisterForReflection,

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

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 + 'static)>

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 + 'static)>

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 + 'static)>

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 GamepadSettings

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

where GamepadSettings: Any + Send + Sync, ButtonSettings: FromReflect + TypePath + RegisterForReflection, AxisSettings: FromReflect + TypePath + RegisterForReflection, ButtonAxisSettings: FromReflect + TypePath + RegisterForReflection, HashMap<GamepadButton, ButtonSettings>: FromReflect + TypePath + RegisterForReflection, HashMap<GamepadAxis, AxisSettings>: FromReflect + TypePath + RegisterForReflection, HashMap<GamepadButton, ButtonAxisSettings>: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Resource for GamepadSettings

where GamepadSettings: Send + Sync + 'static,