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.

Invariants

You need to follow those rules (invariants) to avoid panics:

1. A MenuSetting must have at least one Focusable child in the UI hierarchy.
2. There must not be a menu loop. i.e.: a way to go from menu A to menu B and then from menu B to menu A while never going back.

Panics

Thankfully, programming errors are caught early and you’ll probably get a panic fairly quickly if you don’t follow the invariants.

• Invariant (1) panics as soon as you add the menu without focusable children.
• Invariant (2) panics if the focus goes into 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

pub fn wrapping(self) -> Self

pub fn scope(self) -> Self

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 MenuSetting where
    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 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: &MenuSetting) -> bool

This method tests for !=.

impl Copy for MenuSetting

impl StructuralPartialEq for MenuSetting