Struct bevy_ui_navigation::systems::InputMapping

pub struct InputMapping {

    pub keyboard_navigation: bool,
    pub gamepads: Vec<Gamepad>,
    pub joystick_ui_deadzone: f32,
    pub move_x: GamepadAxisType,
    pub move_y: GamepadAxisType,
    pub left_button: GamepadButtonType,
    pub right_button: GamepadButtonType,
    pub up_button: GamepadButtonType,
    pub down_button: GamepadButtonType,
    pub action_button: GamepadButtonType,
    pub cancel_button: GamepadButtonType,
    pub previous_button: GamepadButtonType,
    pub next_button: GamepadButtonType,
    pub free_button: GamepadButtonType,
    pub key_left: KeyCode,
    pub key_right: KeyCode,
    pub key_up: KeyCode,
    pub key_down: KeyCode,
    pub key_left_alt: KeyCode,
    pub key_right_alt: KeyCode,
    pub key_up_alt: KeyCode,
    pub key_down_alt: KeyCode,
    pub key_action: KeyCode,
    pub key_cancel: KeyCode,
    pub key_next: KeyCode,
    pub key_next_alt: KeyCode,
    pub key_previous: KeyCode,
    pub key_free: KeyCode,
    pub focus_follows_mouse: bool,
}

Control default ui navigation input buttons

Fields

keyboard_navigation: bool

Whether to use keybaord keys for navigation (instead of just actions).

gamepads: Vec<Gamepad>

The gamepads to use for the UI. If empty, default to gamepad 0

joystick_ui_deadzone: f32

Deadzone on the gamepad left stick for ui navigation

move_x: GamepadAxisType

X axis of gamepad stick

move_y: GamepadAxisType

Y axis of gamepad stick

left_button: GamepadButtonType

Gamepad button for Direction::West NavRequest::Move

right_button: GamepadButtonType

Gamepad button for Direction::East NavRequest::Move

up_button: GamepadButtonType

Gamepad button for Direction::North NavRequest::Move

down_button: GamepadButtonType

Gamepad button for Direction::South NavRequest::Move

action_button: GamepadButtonType

Gamepad button for NavRequest::Action

cancel_button: GamepadButtonType

Gamepad button for NavRequest::Cancel

previous_button: GamepadButtonType

Gamepad button for ScopeDirection::Previous NavRequest::ScopeMove

next_button: GamepadButtonType

Gamepad button for ScopeDirection::Next NavRequest::ScopeMove

free_button: GamepadButtonType

Gamepad button for NavRequest::Unlock

key_left: KeyCode

Keyboard key for Direction::West NavRequest::Move

key_right: KeyCode

Keyboard key for Direction::East NavRequest::Move

key_up: KeyCode

Keyboard key for Direction::North NavRequest::Move

key_down: KeyCode

Keyboard key for Direction::South NavRequest::Move

key_left_alt: KeyCode

Alternative keyboard key for Direction::West NavRequest::Move

key_right_alt: KeyCode

Alternative keyboard key for Direction::East NavRequest::Move

key_up_alt: KeyCode

Alternative keyboard key for Direction::North NavRequest::Move

key_down_alt: KeyCode

Alternative keyboard key for Direction::South NavRequest::Move

key_action: KeyCode

Keyboard key for NavRequest::Action

key_cancel: KeyCode

Keyboard key for NavRequest::Cancel

key_next: KeyCode

Keyboard key for ScopeDirection::Next NavRequest::ScopeMove

key_next_alt: KeyCode

Alternative keyboard key for ScopeDirection::Next NavRequest::ScopeMove

key_previous: KeyCode

Keyboard key for ScopeDirection::Previous NavRequest::ScopeMove

key_free: KeyCode

Keyboard key for NavRequest::Unlock

focus_follows_mouse: bool

Whether mouse hover gives focus to Focusable elements.

Trait Implementations

impl Default for InputMapping

fn default() -> Self

Returns the “default value” for a type.

impl FromReflect for InputMappingwhere bool: FromReflect, Vec<Gamepad>: FromReflect, f32: FromReflect, GamepadAxisType: FromReflect, GamepadButtonType: FromReflect, KeyCode: FromReflect,

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 InputMappingwhere bool: FromReflect, Vec<Gamepad>: FromReflect, f32: FromReflect, GamepadAxisType: FromReflect, GamepadButtonType: FromReflect, KeyCode: FromReflect,

fn get_type_registration() -> TypeRegistration

impl Reflect for InputMappingwhere bool: FromReflect, Vec<Gamepad>: FromReflect, f32: FromReflect, GamepadAxisType: FromReflect, GamepadButtonType: FromReflect, KeyCode: FromReflect,

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_ref(&self) -> ReflectRef<'_>

Returns an 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 type_name(&self) -> &str

👎Deprecated since 0.12.0: view the method documentation to find alternatives to this method.

Returns the type path of the underlying type.

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 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 InputMappingwhere bool: FromReflect, Vec<Gamepad>: FromReflect, f32: FromReflect, GamepadAxisType: FromReflect, GamepadButtonType: FromReflect, KeyCode: FromReflect,

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 InputMappingwhere bool: FromReflect, Vec<Gamepad>: FromReflect, f32: FromReflect, GamepadAxisType: FromReflect, GamepadButtonType: FromReflect, KeyCode: FromReflect,

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 InputMappingwhere bool: FromReflect, Vec<Gamepad>: FromReflect, f32: FromReflect, GamepadAxisType: FromReflect, GamepadButtonType: FromReflect, KeyCode: FromReflect,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Resource for InputMappingwhere Self: Send + Sync + 'static,