Struct TemplatePlugin

pub struct TemplatePlugin { /* private fields */ }

Implementations

impl TemplatePlugin

pub fn with_template<T: Component, Marker>( self, label: T, template: impl IntoTemplate<Marker>, ) -> Self

Examples found in repository

examples/app.rs (lines 15-29)

fn main() {
    App::new()
        .add_plugins(TemplatePlugin::default().with_template(
            // Spawning a Zombie will spawn the following components:
            Zombie,
            (
                // This only runs once.
                || Health(100),
                
                // This runs every time a `Health` component is updated,
                // and it's guraranteed to run after the `Health` component is updated.
                |entity: In<Entity>, health_query: Query<&Health>| {
                    let health = health_query.get(*entity).unwrap();
                    Damage(**health * 2)
                },
            ),
        ))
        .add_systems(Startup, setup)
        .add_systems(PostUpdate, debug)
        .run();
}

Trait Implementations

impl Default for TemplatePlugin

fn default() -> TemplatePlugin

Returns the “default value” for a type.

impl Plugin for TemplatePlugin

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

Configures the App to which this plugin is added.

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.