Struct bevy_ui_navigation::GenericNavigationPlugin

source · [−]

pub struct GenericNavigationPlugin<STGY>(_);

Expand description

The navigation plugin.

Add it to your app with .add_plugin(NavigationPlugin::new()) and send NavRequests to move focus within declared Focusable entities.

You should prefer bevy_ui provided defaults if you don’t want to bother with that.

Note on generic parameters

The STGY type parameter might seem complicated, but all you have to do is for your type to implement [SystemParam] and MenuNavigationStrategy.

Implementations

source

impl<STGY: MenuNavigationStrategy> GenericNavigationPlugin<STGY>

source

pub fn new() -> Self

Trait Implementations

source

impl<STGY: Default> Default for GenericNavigationPlugin<STGY>

source

fn default() -> GenericNavigationPlugin<STGY>

Returns the “default value” for a type. Read more

source

impl<STGY: SystemParam + 'static> Plugin for GenericNavigationPlugin<STGY> where
for<'w, 's> SystemParamItem<'w, 's, STGY>: MenuNavigationStrategy,

source

fn build(&self, app: &mut App)

Configures the [App] to which this plugin is added.

fn name(&self) -> &str

Configures a name for the [Plugin] which is primarily used for debugging.

Auto Trait Implementations

impl<STGY> RefUnwindSafe for GenericNavigationPlugin<STGY>

impl<STGY> Send for GenericNavigationPlugin<STGY>

impl<STGY> Sync for GenericNavigationPlugin<STGY>

impl<STGY> Unpin for GenericNavigationPlugin<STGY>

impl<STGY> UnwindSafe for GenericNavigationPlugin<STGY>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T, U> AsBindGroupShaderType for T where
U: ShaderType,
&'a T: for<'a> Into,

fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U

Return the T [ShaderType] for self. When used in [AsBindGroup] derives, it is safe to assume that all images in self exist. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> Downcast for T where
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source