Struct SpritesheetAnimationPlugin

pub struct SpritesheetAnimationPlugin {
    pub enable_3d: bool,
}

The spritesheet animation plugin to add to Bevy apps.

This plugin injects the systems required for running animations and inserts the AnimationLibrary resource with which you can create new clips and animations.

Examples

let app = App::new()
    .add_plugins(DefaultPlugins)
    .add_plugins(SpritesheetAnimationPlugin::default());

// ...

Adding the plugin to a Bevy app makes the AnimationLibrary available as a resource:

fn my_system(mut library: ResMut<AnimationLibrary>) {
    let clip = Clip::from_frames([1, 2, 3]);
    let clip_id = library.register_clip(clip);

    let animation = Animation::from_clip(clip_id);
    let animation_id = library.register_animation(animation);

    // ...
}

Fields

enable_3d: bool

Determines whether to run 3D-related systems.

This allows using the plugin without bevy_render, for example in a headless environment with MinimalPlugin.

Trait Implementations

impl Default for SpritesheetAnimationPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for SpritesheetAnimationPlugin

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.