Struct bevy_spritesheet_animation::component::SpritesheetAnimation

pub struct SpritesheetAnimation {
    pub animation_id: AnimationId,
    pub playing: bool,
    pub speed_factor: f32,
    /* private fields */
}

A Bevy component that enables spritesheet animations.

It contains an AnimationId that references an Animation created with SpritesheetLibrary::new_animation.

The animation can be paused and resumed by toggling the playing field.

The speed of the animation can be tweaked with speed_factor.

Note

For this component to take effect, the entity must also have a Bevy TextureAtlas component.

Example

fn my_system(
    mut commands: Commands,
    mut library: ResMut<SpritesheetLibrary>,
) {
    let animation_id = library.new_animation(|animation| {
        // ...
    });

    // ... omitted: load a texture and an atlas layout ...

    commands.spawn((
        SpriteSheetBundle {
            texture: texture.clone(),
            atlas: TextureAtlas {
                layout: layout.clone(),
                ..default()
            },
            ..default()
        },
        SpritesheetAnimation::from_id(animation_id),
    ));
}

Fields

animation_id: AnimationId

The ID of the animation to play

playing: bool

Is the animation currently playing?

The animation can alternatively be stopped by removing the SpritesheetAnimation component from its entity entirely. However, re-inserting the component at a later stage will restart it from scratch whereas pausing/resuming the animation with playing keeps its progress.

speed_factor: f32

A speed multiplier for the animation, defaults to 1

Implementations

impl SpritesheetAnimation

pub fn from_id(animation_id: AnimationId) -> Self

Creates a SpritesheetAnimation component from an AnimationId returned by SpritesheetLibrary::new_animation.

Arguments

• animation_id - the ID of the animation to play

pub fn reset(&mut self)

Resets the animation to its initial state.

Trait Implementations

impl Clone for SpritesheetAnimation

fn clone(&self) -> SpritesheetAnimation

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for SpritesheetAnimation

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl Debug for SpritesheetAnimation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.