bevy_spritesheet_animation 6.1.0

A Bevy plugin for animating sprites
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

use bevy::prelude::*;

use crate::{
    animation::Animation, animator::Animator,
    components::spritesheet_animation::SpritesheetAnimation, events::AnimationEvent,
    systems::spritesheet_animation,
};

#[cfg(feature = "3d")]
use crate::components::sprite3d::Sprite3d;
#[cfg(feature = "3d")]
use crate::systems::sprite3d;

/// Set for systems that update animations
#[derive(Debug, PartialEq, Eq, Clone, Hash, SystemSet)]
pub struct AnimationSystemSet;

/// Set for systems that manage 3D sprites
#[cfg(feature = "3d")]
#[derive(Debug, PartialEq, Eq, Clone, Hash, SystemSet)]
pub struct Sprite3dSystemSet;

/// The spritesheet animation plugin to add to Bevy apps.
///
/// This plugin injects the systems required for running animations and inserts the `Assets<Animation>` resource through which you can create new animations.
///
/// # Examples
///
/// ```
/// # use bevy::prelude::*;
/// # use bevy_spritesheet_animation::prelude::*;
/// fn create_app() {
///     let app = App::new()
///         .add_plugins(DefaultPlugins)
///         .add_plugins(SpritesheetAnimationPlugin);
///
///     // ...
/// }
///
/// fn create_animated_sprite(
///     assets: Res<AssetServer>,
///     mut animations: ResMut<Assets<Animation>>
/// ) {
///     let image = assets.load("character.png");
///
///     let animation = Spritesheet::new(&image, 8, 4)
///         .create_animation()
///         .add_indices([1, 2, 3])
///         .build();
///
///     let animation_handle = animations.add(animation);
///
///     // ...
/// }
/// ```
#[derive(Default)]
pub struct SpritesheetAnimationPlugin;

impl Plugin for SpritesheetAnimationPlugin {
    fn build(&self, app: &mut App) {
        app
            // Register animation assets
            // TODO other types?
            .init_asset::<Animation>()
            .register_type::<Animation>()
            .register_type::<SpritesheetAnimation>()
            // Main animation system
            .init_resource::<Animator>()
            .register_type::<Animator>()
            .add_systems(
                PostUpdate,
                spritesheet_animation::play_animations.in_set(AnimationSystemSet),
            )
            // Animations events
            .add_message::<AnimationEvent>();

        #[cfg(feature = "3d")]
        app
            // 3D sprites
            .init_resource::<sprite3d::Cache>()
            .register_type::<sprite3d::Cache>()
            .register_type::<Sprite3d>()
            .add_systems(
                PostUpdate,
                (
                    sprite3d::setup_rendering,
                    sprite3d::sync_when_sprites_change,
                    sprite3d::sync_when_atlases_change,
                )
                    .in_set(Sprite3dSystemSet)
                    .after(AnimationSystemSet),
            );
    }
}