Enum bevy_ui_navigation::events::NavRequest

pub enum NavRequest {
    Move(Direction),
    ScopeMove(ScopeDirection),
    Action,
    Cancel,
    FocusOn(Entity),
    Lock,
    Unlock,
}

Requests to send to the navigation system to update focus.

Variants

Move(Direction)

Move in in provided direction according to the plugin’s navigation strategy.

Typically used by gamepads.

ScopeMove(ScopeDirection)

Move within the encompassing MenuSetting::scope.

Action

Activate the currently focused Focusable.

If a menu is reachable from

Cancel

Leave this submenu to enter the one it is reachable from.

FocusOn(Entity)

Move the focus to any arbitrary Focusable entity.

Note that resolving a FocusOn request is expensive, make sure you do not spam FocusOn messages in your input systems. Avoid sending FocusOn messages when you know the target entity is already focused.

Lock

Locks the navigation system.

A NavEvent::Locked will be emitted as a response if the navigation system was not already locked.

Unlock

Unlocks the navigation system.

A NavEvent::Unlocked will be emitted as a response if the navigation system was indeed locked.

Trait Implementations

impl Clone for NavRequest

fn clone(&self) -> NavRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NavRequest

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

Formats the value using the given formatter.

impl PartialEq<NavRequest> for NavRequest

fn eq(&self, other: &NavRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for NavRequest

impl StructuralPartialEq for NavRequest