Enum bevy_ui_navigation::menu::MenuBuilder

pub enum MenuBuilder {
    NamedParent(Name),
    EntityParent(Entity),
    Root,
}

Tell the navigation system to turn this UI node into a menu.

Note that MenuBuilder is replaced by a private component when encoutered.

Variants

NamedParent(Name)

Create a menu as reachable from a Focusable with a [Name] component.

This is useful if, for example, you just want to spawn your UI without keeping track of entity ids of buttons that leads to submenus.

See MenuBuilder::from_named for an easier to use method if you don’t have a [Name] ready to use.

Important

You must ensure this doesn’t create a cycle. Eg: you shouldn’t be able to reach MenuSetting X from Focusable Y if there is a path from MenuSetting X to Focusable Y.

EntityParent(Entity)

Create a menu as reachable from a given Focusable.

When requesting NavRequest::Action when Entity is focused, the focus will be changed to a focusable within this menu.

Important

You must ensure this doesn’t create a cycle. Eg: you shouldn’t be able to reach MenuSetting X from Focusable Y if there is a path from MenuSetting X to Focusable Y.

Root

Create a menu with no parents.

No Focusable will “lead to” this menu. You either need to programmatically give focus to this menu tree with NavRequest::FocusOn or have only one root menu.

Implementations

impl MenuBuilder

pub fn from_named(parent: impl Into<Cow<'static, str>>) -> Self

Create a MenuBuilder::NamedParent directly from String or &str.

Trait Implementations

impl Clone for MenuBuilder

fn clone(&self) -> MenuBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

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

type Storage = TableStorage

impl Debug for MenuBuilder

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

Formats the value using the given formatter.

impl From<Option<Entity>> for MenuBuilder

fn from(parent: Option<Entity>) -> Self

Converts to this type from the input type.

impl TryFrom<&MenuBuilder> for Option<Entity>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: &MenuBuilder) -> Result<Self, Self::Error>

Performs the conversion.