Struct 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(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(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 a focusable in a menu reachable from a 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 duplicate 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

A marker type indicating the storage type used for this component. This must be either TableStorage or SparseStorage.

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.

impl FromReflect for Focusable

where FocusState: FromReflect + TypePath, FocusAction: FromReflect + TypePath,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect>, ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for Focusable

where FocusState: FromReflect + TypePath, FocusAction: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Reflect for Focusable

where FocusState: FromReflect + TypePath, FocusAction: FromReflect + TypePath,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, value: &dyn Reflect)

Applies a reflected value to this value.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn type_name(&self) -> &str

👎Deprecated since 0.12.0: view the method documentation to find alternatives to this method.

Returns the type path of the underlying type.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Struct for Focusable

where FocusState: FromReflect + TypePath, FocusAction: FromReflect + TypePath,

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for Focusable

where FocusState: FromReflect + TypePath, FocusAction: FromReflect + TypePath,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for Focusable

where FocusState: FromReflect + TypePath, FocusAction: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.