Struct bevy_ui_navigation::prelude::Focusable

pub struct Focusable { /* private fields */ }

An [Entity] that can be navigated to, using the cursor navigation system.

It is in one of multiple FocusState, you can check its state with the Focusable::state method.

A Focusable can execute a variety of FocusAction when receiving NavRequest::Action, the default one is FocusAction::Normal.

Note: You should avoid updating manually the state of Focusables. You should instead use NavRequest to manipulate and change focus.

Implementations

impl Focusable

pub fn new() -> Self

Default Focusable.

pub fn state(&self) -> FocusState

The FocusState of this Focusable.

pub fn action(&self) -> FocusAction

The FocusAction of this Focusable.

pub fn cancel() -> Self

A “cancel” focusable, see FocusAction::Cancel.

pub fn lock() -> Self

A “lock” focusable, see FocusAction::Lock.

pub fn prioritized(self) -> Self

A focusable that will get highlighted in priority when none are set yet.

WARNING: Only use this when creating the UI. Any of the following state is unspecified and will likely result in broken behavior:

• Having multiple prioritized Focusables in the same menu.
• Updating an already existing Focusable with this.

Example

fn setup(mut commands: Commands) {
    commands.spawn_bundle(FocusableButtonBundle {
        focus: Focusable::new().prioritized(),
        ..default()
    });
}

pub fn blocked(self) -> Self

A FocusState::Blocked focusable.

This focusable will not be able to take focus until Focusable::unblock is called on it.

Example

fn setup(mut commands: Commands) {
    commands.spawn_bundle(FocusableButtonBundle {
        focus: Focusable::new().blocked(),
        ..default()
    });
}

pub fn block(&mut self) -> bool

Prevent this Focusable from gaining focus until it is unblocked.

Note: Due to the way focus is handled, this does nothing when the Focusable::state is FocusState::Active or FocusState::Focused.

Returns true if self has succesfully been blocked (its Focusable::state was either Inert or Prioritized).

Limitations

• If all the children of a menu are blocked, when activating the menu’s parent, the block state of the last active focusable will be ignored.
• When FocusOn to an focusable in a menu reachable from an blocked focusable, its block state will be ignored.

pub fn unblock(&mut self) -> bool

Allow this Focusable to gain focus again, setting it to FocusState::Inert.

Returns true if self’s state was FocusState::Blocked.

Trait Implementations

impl Clone for Focusable

fn clone(&self) -> Focusable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Focusable where
    Self: Send + Sync + 'static, 

type Storage = TableStorage

impl Debug for Focusable

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

Formats the value using the given formatter.

impl Default for Focusable

fn default() -> Self

Returns the “default value” for a type.