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

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

Implementations§

source§

impl dyn Plugin

source

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

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

source

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.

source

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.

source

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.

source

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§

source§

impl Plugin for AccessibilityPlugin

source§

impl Plugin for AnimationPlugin

source§

impl Plugin for AssetPlugin

source§

impl Plugin for AudioPlugin

source§

impl Plugin for FrameCountPlugin

source§

impl Plugin for TaskPoolPlugin

source§

impl Plugin for TypeRegistrationPlugin

source§

impl Plugin for AutoExposurePlugin

source§

impl Plugin for BlitPlugin

source§

impl Plugin for BloomPlugin

source§

impl Plugin for CASPlugin

source§

impl Plugin for Core2dPlugin

source§

impl Plugin for Core3dPlugin

source§

impl Plugin for CopyDeferredLightingIdPlugin

source§

impl Plugin for DepthOfFieldPlugin

source§

impl Plugin for TemporalAntiAliasPlugin

source§

impl Plugin for FxaaPlugin

source§

impl Plugin for MotionBlurPlugin

source§

impl Plugin for MsaaWritebackPlugin

source§

impl Plugin for SmaaPlugin

source§

impl Plugin for CorePipelinePlugin

source§

impl Plugin for TonemappingPlugin

source§

impl Plugin for UpscalingPlugin

source§

impl Plugin for CiTestingPlugin

source§

impl Plugin for FpsOverlayPlugin

source§

impl Plugin for DevToolsPlugin

source§

impl Plugin for DebugUiPlugin

source§

impl Plugin for DiagnosticsPlugin

source§

impl Plugin for EntityCountDiagnosticsPlugin

source§

impl Plugin for FrameTimeDiagnosticsPlugin

source§

impl Plugin for LogDiagnosticsPlugin

source§

impl Plugin for SystemInformationDiagnosticsPlugin

source§

impl Plugin for GilrsPlugin

source§

impl Plugin for AabbGizmoPlugin

source§

impl Plugin for LightGizmoPlugin

source§

impl Plugin for GizmoPlugin

source§

impl Plugin for GltfPlugin

source§

impl Plugin for HierarchyPlugin

Available on crate feature bevy_app only.
source§

impl Plugin for InputPlugin

source§

impl Plugin for LogPlugin

source§

impl Plugin for DeferredPbrLightingPlugin

source§

impl Plugin for MeshletPlugin

source§

impl Plugin for FogPlugin

source§

impl Plugin for GpuMeshPreprocessPlugin

source§

impl Plugin for LightProbePlugin

source§

impl Plugin for LightmapPlugin

source§

impl Plugin for MeshRenderPlugin

source§

impl Plugin for PbrPlugin

source§

impl Plugin for ScreenSpaceAmbientOcclusionPlugin

source§

impl Plugin for ScreenSpaceReflectionsPlugin

source§

impl Plugin for VolumetricFogPlugin

source§

impl Plugin for WireframePlugin

source§

impl Plugin for BatchingPlugin

source§

impl Plugin for CameraPlugin

source§

impl Plugin for RenderDiagnosticsPlugin

source§

impl Plugin for GlobalsPlugin

source§

impl Plugin for MorphPlugin

source§

impl Plugin for MeshPlugin

source§

impl Plugin for PipelinedRenderingPlugin

source§

impl Plugin for ImagePlugin

source§

impl Plugin for RenderPlugin

source§

impl Plugin for ViewPlugin

source§

impl Plugin for VisibilityPlugin

source§

impl Plugin for VisibilityRangePlugin

source§

impl Plugin for WindowRenderPlugin

source§

impl Plugin for ScreenshotPlugin

source§

impl Plugin for ScenePlugin

Available on crate feature serialize only.
source§

impl Plugin for ColorMaterialPlugin

source§

impl Plugin for Mesh2dRenderPlugin

source§

impl Plugin for SpritePlugin

source§

impl Plugin for Wireframe2dPlugin

source§

impl Plugin for StatesPlugin

source§

impl Plugin for TextPlugin

source§

impl Plugin for TimePlugin

source§

impl Plugin for TransformPlugin

source§

impl Plugin for UiPlugin

source§

impl Plugin for WindowPlugin

source§

impl Plugin for AccessKitPlugin

source§

impl Plugin for MainSchedulePlugin

source§

impl Plugin for PanicHandlerPlugin

source§

impl Plugin for ScheduleRunnerPlugin

source§

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

source§

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

source§

impl<C> Plugin for ExtractComponentPlugin<C>

source§

impl<C> Plugin for UniformComponentPlugin<C>

source§

impl<C> Plugin for GpuComponentArrayBufferPlugin<C>

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

impl<SPI, GFBD> Plugin for SortedRenderPhasePlugin<SPI, GFBD>

source§

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

Available on crate feature bevy_app only.
source§

impl<T> Plugin for PbrProjectionPlugin<T>

source§

impl<T> Plugin for CameraProjectionPlugin<T>

source§

impl<T> Plugin for WinitPlugin<T>
where T: Event,

source§

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