Struct SimpleStateMachinePlugin

pub struct SimpleStateMachinePlugin { /* private fields */ }

Plugin that handles all state machine executions

Include this in your app to enable this crate

App::new()
    .add_plugins(DefaultPlugins)
    .add_plugins(SimpleStateMachinePlugin::new());

Implementations

impl SimpleStateMachinePlugin

pub fn new() -> Self

Creates a new instance of SimpleStateMachinePlugin

Its systems are scheduled in Update

pub fn new_in_schedule(schedule: impl ScheduleLabel) -> Self

Creates a new instance of SimpleStateMachinePlugin

Its systems will be registered in the specified schedule

Trait Implementations

impl Default for SimpleStateMachinePlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for SimpleStateMachinePlugin

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.