Trait Plugin

Source

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:

the app calls Plugin::build immediately, and register the plugin
once the app started, it will wait for all registered Plugin::ready to return true
it will then call all registered Plugin::finish
and call all registered Plugin::cleanup

§Defining a plugin.

Most plugins are simply functions that add configuration to an App.

App::new().add_plugins(my_plugin).run();

// This function implements `Plugin`, along with every other `fn(&mut App)`.
pub fn my_plugin(app: &mut App) {
    app.add_systems(Update, hello_world);
}

For more advanced use cases, the Plugin trait can be implemented manually for a type.

pub struct AccessibilityPlugin {
    pub flicker_damping: bool,
    // ...
}

impl Plugin for AccessibilityPlugin {
    fn build(&self, app: &mut App) {
        if self.flicker_damping {
            app.add_systems(PostUpdate, damp_flickering);
        }
    }
}

Required Methods§

Source

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

Configures the App to which this plugin is added.

Provided Methods§

Source

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

Has the plugin finished its setup? This can be useful for plugins that need something asynchronous to happen before they can finish their setup, like the initialization of a renderer. Once the plugin is ready, finish should be called.

Source

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.

Source

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.

Source

fn name(&self) -> &str

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

Source

fn is_unique(&self) -> bool

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

Trait Plugin Copy item path

§Lifecycle of a plugin

§Defining a plugin.

Required Methods§

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

Implementations§

impl dyn Plugin

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

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

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

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

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

Implementations on Foreign Types§

impl Plugin for AccessibilityPlugin

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

impl Plugin for AutoExposurePlugin

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

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

impl Plugin for BlitPlugin

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

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

impl Plugin for BloomPlugin

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

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

impl Plugin for CASPlugin

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

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

impl Plugin for Core2dPlugin

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

impl Plugin for Core3dPlugin

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

impl Plugin for CopyDeferredLightingIdPlugin

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

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

impl Plugin for DepthOfFieldPlugin

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

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

impl Plugin for FxaaPlugin

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

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

impl Plugin for MotionBlurPlugin

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

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

impl Plugin for MsaaWritebackPlugin

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

impl Plugin for SmaaPlugin

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

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

impl Plugin for CorePipelinePlugin

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

impl Plugin for TemporalAntiAliasPlugin

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

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

impl Plugin for TonemappingPlugin

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

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

impl Plugin for UpscalingPlugin

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

impl Plugin for EntityCountDiagnosticsPlugin

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

impl Plugin for FrameTimeDiagnosticsPlugin

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

impl Plugin for LogDiagnosticsPlugin

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

impl Plugin for DiagnosticsPlugin

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

impl Plugin for GltfPlugin

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

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

impl Plugin for InputPlugin

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

impl Plugin for LogPlugin

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

impl Plugin for DeferredPbrLightingPlugin

Trait Plugin

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

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

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

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

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