Enum bevy_ui_navigation::prelude::FocusAction

#[non_exhaustive]
pub enum FocusAction {
    Normal,
    Cancel,
    Lock,
}

The actions triggered by a Focusable.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Normal

Acts like a standard navigation node.

Goes into relevant menu if any MenuSetting is reachable from this Focusable.

Cancel

If we receive NavRequest::Action while this Focusable is focused, it will act as a NavRequest::Cancel (leaving submenu to enter the parent one).

Lock

If we receive NavRequest::Action while this Focusable is focused, the navigation system will freeze until NavRequest::Unlock is received, sending a NavEvent::Unlocked.

This is useful to implement widgets with complex controls you don’t want to accidentally unfocus, or suspending the navigation system while in-game.

Trait Implementations

impl Clone for FocusAction

fn clone(&self) -> FocusAction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FocusAction

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

Formats the value using the given formatter.

impl Default for FocusAction

fn default() -> FocusAction

Returns the “default value” for a type.

impl PartialEq<FocusAction> for FocusAction

fn eq(&self, other: &FocusAction) -> 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 FocusAction

impl Eq for FocusAction

impl StructuralEq for FocusAction

impl StructuralPartialEq for FocusAction