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.

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

Create a “cancel” focusable, see FocusAction::Cancel.

pub fn lock() -> Self

Create a “lock” focusable, see FocusAction::Lock.

pub fn prioritized(self) -> Self

Create 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.

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.