Struct bevy_spine::SpineSynchronizerPlugin

pub struct SpineSynchronizerPlugin<T: SpineSynchronizer, After: SystemSet + Copy> { /* private fields */ }

A plugin for synchronizing SpineBone components with a rig.

This plugin is added automatically in SpinePlugin for SpineSync and does not need to be added manually. However, custom synchronization steps can be added to allow for multiple syncs in a single frame.

use bevy_spine::{prelude::*, SpineSynchronizerSet, SpineSynchronizerPlugin};

#[derive(Component, Debug, Hash, Clone, Copy, PartialEq, Eq)]
pub struct MySpineSync;
pub type MySpineSyncSet = SpineSynchronizerSet<MySpineSync>;
pub type MySpineSyncPlugin = SpineSynchronizerPlugin<MySpineSync, SpineSyncSet>; // add after SpineSync

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .add_plugin(SpinePlugin)
        .add_plugin(MySpineSyncPlugin::default())
        .add_system(spawn)
        .add_system(during_sync.in_set(SpineSyncSet::DuringSync))
        .add_system(during_my_sync.in_set(MySpineSyncSet::DuringSync))
        // ...
        .run();
}

fn spawn(mut commands: Commands) {
    // .. load spine ..
    commands.spawn((
        SpineBundle {
            // ..
            ..Default::default()
        },
        // synchronize in both steps
        SpineSync,
        MySpineSync,
    ));
}

fn during_sync() {
    // runs first
}

fn during_my_sync() {
    // runs second
}

Trait Implementations

impl<T: SpineSynchronizer, S: SpineSynchronizer> Default for SpineSynchronizerPlugin<T, SpineSynchronizerSet<S>>where SpineSynchronizerSet<S>: Copy,

fn default() -> Self

Returns the “default value” for a type.

impl<T: SpineSynchronizer, A: SystemSet + Copy> Plugin for SpineSynchronizerPlugin<T, A>

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

Configures the [App] to which this plugin is added.

fn setup(&self, _app: &mut App)

Runs after all plugins are built, but before the app runner is called. 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.