Struct bevy_ui_navigation::systems::InputMapping

source · [−]

pub struct InputMapping {Show 29 fields
    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 mouse_action: MouseButton,
}

Expand description

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::Free

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::Free

mouse_action: MouseButton

Mouse button for NavRequest::Action

Trait Implementations

source

impl Default for InputMapping

source

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl RefUnwindSafe for InputMapping

impl Send for InputMapping

impl Sync for InputMapping

impl Unpin for InputMapping

impl UnwindSafe for InputMapping

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T, U> AsBindGroupShaderType for T where
U: ShaderType,
&'a T: for<'a> Into,

fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U

Return the T [ShaderType] for self. When used in [AsBindGroup] derives, it is safe to assume that all images in self exist. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> Downcast for T where
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

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

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

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

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more