Struct bevy_ui_navigation::menu::MenuSetting

pub struct MenuSetting {
    pub wrapping: bool,
    pub scope: bool,
}

A menu that isolate children Focusables from other focusables and specify navigation method within itself.

Usage

A MenuSetting can be used to:

• Prevent navigation from one specific submenu to another
• Specify if 2d navigation wraps around the screen, see MenuSetting::wrapping.
• Specify “scope menus” such that sending a NavRequest::ScopeMove when the focused element is a Focusable nested within this MenuSetting will move cursor within this menu. See MenuSetting::scope.
• Specify submenus and specify from where those submenus are reachable.
• Specify which entity will be the parents of this MenuSetting. See MenuBuilder.

If you want to specify which Focusable should be focused first when entering a menu, you should mark one of the children of this menu with Focusable::prioritized.

Limitations

Menu navigation relies heavily on the bevy hierarchy being consistent. You might get inconsistent state under the folowing conditions:

• You despawned an entity in the FocusState::Active state
• You changed the parent of a Focusable member of a menu to a new menu.

The navigation system might still work as expected, however, Focusable::state may be missleading for the length of one frame.

Panics

Menu loops will cause a panic. A menu loop is a way to go from menu A to menu B and then from menu B to menu A while never going back.

Don’t worry though, menu loops are really hard to make by accident, and it will only panic if you use a NavRequest::FocusOn(entity) where entity is inside a menu loop.

Fields

wrapping: bool

Whether to wrap navigation.

When the player moves to a direction where there aren’t any focusables, if this is true, the focus will “wrap” to the other direction of the screen.

scope: bool

Whether this is a scope menu.

A scope menu is controlled with NavRequest::ScopeMove even when the focused element is not in this menu, but in a submenu reachable from this one.

Implementations

impl MenuSetting

pub fn new() -> Self

Create a new non-wrapping, non-scopped MenuSetting, those are the default values.

To create a wrapping/scopped menu, you can use: MenuSetting::new().wrapping().scope().

pub fn wrapping(self) -> Self

Set wrapping to true.

pub fn scope(self) -> Self

Set scope to true.

Trait Implementations

impl Clone for MenuSetting

fn clone(&self) -> MenuSetting

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for MenuSettingwhere Self: Send + Sync + 'static,

type Storage = TableStorage

impl Debug for MenuSetting

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

Formats the value using the given formatter.

impl Default for MenuSetting

fn default() -> MenuSetting

Returns the “default value” for a type.

impl GetTypeRegistration for MenuSettingwhere bool: Reflect,

fn get_type_registration() -> TypeRegistration

impl PartialEq<MenuSetting> for MenuSetting

fn eq(&self, other: &MenuSetting) -> 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 Reflect for MenuSettingwhere bool: Reflect,

fn type_name(&self) -> &str

Returns the type name of the underlying type.

fn get_type_info(&self) -> &'static TypeInfo

Returns the [TypeInfo] of the underlying type.

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

impl Struct for MenuSettingwhere bool: Reflect,

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 Typed for MenuSettingwhere bool: Reflect,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for MenuSetting

impl StructuralPartialEq for MenuSetting