Trait valence::app::Plugin

pub trait Plugin: Downcast + Any + Send + Sync {
    // Required method
    fn build(&self, app: &mut App);

    // Provided methods
    fn ready(&self, _app: &App) -> bool { ... }
    fn finish(&self, _app: &mut App) { ... }
    fn cleanup(&self, _app: &mut App) { ... }
    fn name(&self) -> &str { ... }
    fn is_unique(&self) -> bool { ... }
}
Expand description

A collection of Bevy app logic and configuration.

Plugins configure an App. When an App registers a plugin, the plugin’s Plugin::build function is run. By default, a plugin can only be added once to an App.

If the plugin may need to be added twice or more, the function is_unique() should be overridden to return false. Plugins are considered duplicate if they have the same name(). The default name() implementation returns the type name, which means generic plugins with different type parameters will not be considered duplicates.

Lifecycle of a plugin

When adding a plugin to an App:

Required Methods§

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

Configures the App to which this plugin is added.

Provided Methods§

fn ready(&self, _app: &App) -> bool

Has the plugin finished it’s setup? This can be useful for plugins that needs something asynchronous to happen before they can finish their setup, like renderer initialization. Once the plugin is ready, finish should be called.

fn finish(&self, _app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.

Implementations§

§

impl dyn Plugin

pub fn is<__T>(&self) -> bool
where __T: Plugin,

Returns true if the trait object wraps an object of type __T.

pub fn downcast<__T>(self: Box<dyn Plugin>) -> Result<Box<__T>, Box<dyn Plugin>>
where __T: Plugin,

Returns a boxed object from a boxed trait object if the underlying object is of type __T. Returns the original boxed trait if it isn’t.

pub fn downcast_rc<__T>(self: Rc<dyn Plugin>) -> Result<Rc<__T>, Rc<dyn Plugin>>
where __T: Plugin,

Returns an Rc-ed object from an Rc-ed trait object if the underlying object is of type __T. Returns the original Rc-ed trait if it isn’t.

pub fn downcast_ref<__T>(&self) -> Option<&__T>
where __T: Plugin,

Returns a reference to the object within the trait object if it is of type __T, or None if it isn’t.

pub fn downcast_mut<__T>(&mut self) -> Option<&mut __T>
where __T: Plugin,

Returns a mutable reference to the object within the trait object if it is of type __T, or None if it isn’t.

Implementations on Foreign Types§

source§

impl Plugin for AdvancementPlugin

source§

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

source§

impl Plugin for AnvilPlugin

source§

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

source§

impl Plugin for BossBarPlugin

source§

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

source§

impl Plugin for CommandPlugin

source§

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

source§

impl Plugin for CommandScopePlugin

source§

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

source§

impl Plugin for InventoryPlugin

source§

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

source§

impl Plugin for NetworkPlugin

source§

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

source§

impl Plugin for PlayerListPlugin

source§

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

source§

impl Plugin for ScoreboardPlugin

source§

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

source§

impl Plugin for WeatherPlugin

source§

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

source§

impl Plugin for WorldBorderPlugin

source§

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

§

impl Plugin for FrameCountPlugin

§

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

§

impl Plugin for HierarchyPlugin

§

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

§

impl Plugin for LogPlugin

§

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

§

impl Plugin for TaskPoolPlugin

§

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

§

impl Plugin for TypeRegistrationPlugin

§

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

source§

impl<T> Plugin for CommandHandlerPlugin<T>
where T: Command + Send + Sync + 'static,

source§

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

§

impl<T> Plugin for ValidParentCheckPlugin<T>
where T: Component,

§

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

Implementors§