Trait bevy::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:

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§

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 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.

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.

Implementors§

impl Plugin for AccessibilityPlugin

impl Plugin for AnimationPlugin

impl Plugin for AssetPlugin

impl Plugin for AudioPlugin

impl Plugin for FrameCountPlugin

impl Plugin for TaskPoolPlugin

impl Plugin for TypeRegistrationPlugin

impl Plugin for AutoExposurePlugin

impl Plugin for BlitPlugin

impl Plugin for BloomPlugin

impl Plugin for CASPlugin

impl Plugin for Core2dPlugin

impl Plugin for Core3dPlugin

impl Plugin for CopyDeferredLightingIdPlugin

impl Plugin for TemporalAntiAliasPlugin

impl Plugin for FxaaPlugin

impl Plugin for MotionBlurPlugin

impl Plugin for MsaaWritebackPlugin

impl Plugin for CorePipelinePlugin

impl Plugin for TonemappingPlugin

impl Plugin for UpscalingPlugin

impl Plugin for FpsOverlayPlugin

impl Plugin for DevToolsPlugin

impl Plugin for DebugUiPlugin

impl Plugin for DiagnosticsPlugin

impl Plugin for EntityCountDiagnosticsPlugin

impl Plugin for FrameTimeDiagnosticsPlugin

impl Plugin for LogDiagnosticsPlugin

impl Plugin for SystemInformationDiagnosticsPlugin

impl Plugin for GilrsPlugin

impl Plugin for AabbGizmoPlugin

impl Plugin for LightGizmoPlugin

impl Plugin for GizmoPlugin

impl Plugin for GltfPlugin

impl Plugin for HierarchyPlugin

Available on crate feature bevy_app only.

impl Plugin for InputPlugin

impl Plugin for LogPlugin

impl Plugin for DeferredPbrLightingPlugin

impl Plugin for MeshletPlugin

impl Plugin for FogPlugin

impl Plugin for GpuMeshPreprocessPlugin

impl Plugin for LightProbePlugin

impl Plugin for LightmapPlugin

impl Plugin for MeshRenderPlugin

impl Plugin for PbrPlugin

impl Plugin for ScreenSpaceAmbientOcclusionPlugin

impl Plugin for WireframePlugin

impl Plugin for BatchingPlugin

impl Plugin for CameraPlugin

impl Plugin for RenderDiagnosticsPlugin

impl Plugin for GlobalsPlugin

impl Plugin for MorphPlugin

impl Plugin for MeshPlugin

impl Plugin for PipelinedRenderingPlugin

impl Plugin for ImagePlugin

impl Plugin for RenderPlugin

impl Plugin for ViewPlugin

impl Plugin for VisibilityPlugin

impl Plugin for VisibilityRangePlugin

impl Plugin for WindowRenderPlugin

impl Plugin for ScreenshotPlugin

impl Plugin for ScenePlugin

Available on crate feature serialize only.

impl Plugin for ColorMaterialPlugin

impl Plugin for Mesh2dRenderPlugin

impl Plugin for SpritePlugin

impl Plugin for Wireframe2dPlugin

impl Plugin for TextPlugin

impl Plugin for TimePlugin

impl Plugin for TransformPlugin

impl Plugin for UiPlugin

impl Plugin for WindowPlugin

impl Plugin for AccessKitPlugin

impl Plugin for WinitPlugin

impl Plugin for MainSchedulePlugin

impl Plugin for PanicHandlerPlugin

impl Plugin for ScheduleRunnerPlugin

impl<A, AFTER> Plugin for RenderAssetPlugin<A, AFTER>
where A: RenderAsset, AFTER: RenderAssetDependency + 'static,

impl<BPI, GFBD> Plugin for BinnedRenderPhasePlugin<BPI, GFBD>
where BPI: BinnedPhaseItem, GFBD: GetFullBatchData + Sync + Send + 'static,

impl<C> Plugin for ExtractComponentPlugin<C>
where C: ExtractComponent,

impl<C> Plugin for UniformComponentPlugin<C>
where C: Component + ShaderType + WriteInto + Clone,

impl<C> Plugin for GpuComponentArrayBufferPlugin<C>
where C: Component + GpuArrayBufferable,

impl<EI> Plugin for ExtractInstancesPlugin<EI>
where EI: ExtractInstance,

impl<M> Plugin for MaterialPlugin<M>
where M: Material, <M as AsBindGroup>::Data: PartialEq + Eq + Hash + Clone,

impl<M> Plugin for PrepassPipelinePlugin<M>
where M: Material, <M as AsBindGroup>::Data: PartialEq + Eq + Hash + Clone,

impl<M> Plugin for PrepassPlugin<M>
where M: Material, <M as AsBindGroup>::Data: PartialEq + Eq + Hash + Clone,

impl<M> Plugin for Material2dPlugin<M>
where M: Material2d, <M as AsBindGroup>::Data: PartialEq + Eq + Hash + Clone,

impl<M> Plugin for UiMaterialPlugin<M>
where M: UiMaterial, <M as AsBindGroup>::Data: PartialEq + Eq + Hash + Clone,

impl<R> Plugin for ExtractResourcePlugin<R>
where R: ExtractResource,

impl<SPI, GFBD> Plugin for SortedRenderPhasePlugin<SPI, GFBD>
where SPI: SortedPhaseItem + CachedRenderPipelinePhaseItem, GFBD: GetFullBatchData + Sync + Send + 'static,

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

Available on crate feature bevy_app only.

impl<T> Plugin for PbrProjectionPlugin<T>
where T: CameraProjection + Component,

impl<T> Plugin for CameraProjectionPlugin<T>
where T: CameraProjection + Component + GetTypeRegistration,

impl<T> Plugin for T
where T: Fn(&mut App) + Send + Sync + 'static,