Struct de_spawner::despawner::DespawnEventsPlugin

pub struct DespawnEventsPlugin<T, F = ()>
where
    T: Component + ToOwned,
    <T as ToOwned>::Owned: Send + Sync,
    F: QueryFilter + Send + Sync + 'static,
{
    _marker: PhantomData<(T, F)>,
}

This plugin sends events with data of type DespData<T> when entities with component T matching query F are despawned. The events are send from systems in set DespawnerSet::Events.

Type Parameters

• T - a component implementing ToOwned to be send as part of the despawn events.
• F - filter for entities to watch for despawning. (optional, defaults to ()). e.g. With<Bar>.

Usage

use bevy::prelude::*;
use de_spawner::DespawnEventsPlugin;

#[derive(Clone, Component)] // we must Clone implement here
struct Bar(f32);

let mut app = App::new();

// watch for despawning of entities with `Bar` component
app.add_plugins(DespawnEventsPlugin::<Bar>::default());

Fields

_marker: PhantomData<(T, F)>

Trait Implementations

impl<T, F> Debug for DespawnEventsPlugin<T, F>

where T: Component + ToOwned + Debug, <T as ToOwned>::Owned: Send + Sync, F: QueryFilter + Send + Sync + 'static + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, F> Default for DespawnEventsPlugin<T, F>

where T: Component + ToOwned, <T as ToOwned>::Owned: Send + Sync, F: QueryFilter + Send + Sync + 'static,

fn default() -> Self

Returns the “default value” for a type.

impl<T, F> Plugin for DespawnEventsPlugin<T, F>

where T: Component + ToOwned, <T as ToOwned>::Owned: Send + Sync, F: QueryFilter + Send + Sync + 'static,

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.