Struct BehaviorPlugin

pub struct BehaviorPlugin<T: Behavior>(/* private fields */);

A Plugin for any Behavior type.

This plugin must be added to the App for behavior Transitions to work correctly. You must also add the transition system separately somewhere in your schedule.

Example

use bevy::prelude::*;
use moonshine_behavior::prelude::*;

#[derive(Component, Debug, Reflect)]
#[reflect(Component)]
struct B;

impl Behavior for B {}

fn main() {
    App::new()
        /* ... */
        .add_plugins(BehaviorPlugin::<B>::default())
        .add_systems(Update, transition::<B>)
        /* ... */;
}

Trait Implementations

impl<T: Behavior> Default for BehaviorPlugin<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: RegisterableBehavior> Plugin for BehaviorPlugin<T>

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.