Struct bevy_spritesheet_animation::library::SpritesheetLibrary

pub struct SpritesheetLibrary { /* private fields */ }

The library is the global store for clips and animations.

When the SpritesheetAnimationPlugin is added to the app, the SpritesheetLibrary becomes available as a resource.

You can then create new clips, new animations and new markers from any system.

Example

fn my_system(mut library: ResMut<SpritesheetLibrary>) {
    let marker_id = library.new_marker();

    let clip_id = library.new_clip(|clip| {
        // Configure your clip here...

        // Let's use the marker created above
        clip.add_marker(marker_id, 5);
    });

    let animation_id = library.new_animation(|animation| {
        // Configure your animation here...

        // Let's use the clip created above
        animation.add_stage(clip_id.into());
    });

    // ... Assign the animation to a SpritesheetAnimation component ...
}

Implementations

impl SpritesheetLibrary

pub fn new_clip<F: Fn(&mut AnimationClip)>( &mut self, builder: F ) -> AnimationClipId

Creates a clip and returns a unique ID to refer to it.

The clip can then be referenced in one or several AnimationStages.

Arguments

• builder - a builder function that takes the new clip as an argument so that you can configure it

Example

let clip_id = library.new_clip(|clip| {
    clip
        .push_frame_indices([0, 4, 5])
        .set_default_repeat(10);
});

let stage = AnimationStage::from_clip(clip_id);

pub fn name_clip( &mut self, clip_id: AnimationClipId, name: impl Into<String> ) -> Result<(), LibraryError>

Associates a unique name to a clip.

The clip ID can then later be queried from that name with SpritesheetLibrary::clip_with_name.

Returns a LibraryError::NameAlreadyTaken error if the name is already in use.

Arguments

• clip_id - the ID of the clip to name
• name - the name to assign

Example

let clip_id = library.new_clip(|clip| {
    // ...
});

library.name_clip(clip_id, "jump");

assert_eq!(library.clip_with_name("jump"), Some(clip_id));
assert!(library.is_clip_name(clip_id, "jump"));

pub fn clip_with_name(&self, name: impl Into<String>) -> Option<AnimationClipId>

Returns the ID of the clip with the given name if it exists.

Arguments

• name - the clip name

pub fn is_clip_name( &self, clip_id: AnimationClipId, name: impl Into<String> ) -> bool

Returns true if a clip has the given name.

Arguments

• clip_id - the ID of the clip to check the name of
• name - the name to check

pub fn clips(&self) -> &HashMap<AnimationClipId, AnimationClip>

Returns all the clips registered in the library.

pub fn new_animation<F: Fn(&mut Animation)>( &mut self, builder: F ) -> AnimationId

Creates an animation and returns a unique ID to refer to it.

The animation can then be referenced in crate::prelude::SpritesheetAnimation components.

Arguments

• builder - a builder function that takes the new animation as an argument so that you can configure it

Example

fn f(
    mut commands: Commands,
    mut library: SpritesheetLibrary,
    // ...
) {

    let animation_id = library.new_animation(|animation| {
        animation
            .add_stage(some_clip_id.into())
            .set_duration(AnimationDuration::PerCycle(1500));
    });

    // The animation can then be assigned to an entity

    // ... Load a texture and create an atlas layout for the sprite ...

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

pub fn name_animation( &mut self, animation_id: AnimationId, name: impl Into<String> ) -> Result<(), LibraryError>

Associates a unique name to an animation.

The animation ID can then later be queried from that name with SpritesheetLibrary::animation_with_name.

Returns a LibraryError::NameAlreadyTaken error if the name is already in use.

Arguments

• animation_id - the ID of the animation to name
• name - the name to assign

Example

let animation_id = library.new_animation(|animation| {
    // ...
});

library.name_animation(animation_id, "crouch");

assert_eq!(library.animation_with_name("crouch"), Some(animation_id));
assert!(library.is_animation_name(animation_id, "crouch"));

pub fn animation_with_name( &self, name: impl Into<String> ) -> Option<AnimationId>

Returns the ID of the animation with the given name if it exists.

Arguments

• name - the animation name

pub fn is_animation_name( &self, animation_id: AnimationId, name: impl Into<String> ) -> bool

Returns true if an animation has the given name.

Arguments

• animation_id - the ID of the animation to check the name of
• name - the name to check

pub fn animations(&self) -> &HashMap<AnimationId, Animation>

Returns all the animations registered in the library.

pub fn new_marker(&mut self) -> AnimationMarkerId

Creates a new animation marker and returns a unique ID to refer to it.

The marker can then be inserted into AnimationClips and an AnimationEvent::MarkerHit event will be emitted whenever an animation reaches it.

For more details, see the documentation of AnimationEvent.

Example

let marker = library.new_marker();

let clip_id = library.new_clip(|clip| {
    clip
        .push_frame_indices([7, 8, 9, 10, 11, 12])
        .add_marker(marker, 3);
});

pub fn name_marker( &mut self, marker_id: AnimationMarkerId, name: impl Into<String> ) -> Result<(), LibraryError>

Associates a unique name to an animation marker.

The marker ID can then later be queried from that name with SpritesheetLibrary::marker_with_name.

Returns a LibraryError::NameAlreadyTaken error if the name is already in use.

Arguments

• marker_id - the ID of the marker to name
• name - the name to assign

Example

let marker_id = library.new_marker();

library.name_marker(marker_id, "raise sword");

assert_eq!(library.marker_with_name("raise sword"), Some(marker_id));
assert!(library.is_marker_name(marker_id, "raise sword"));

pub fn marker_with_name( &self, name: impl Into<String> ) -> Option<AnimationMarkerId>

Returns the ID of the marker with the given name if it exists.

Arguments

• name - the marker name

pub fn is_marker_name( &self, marker_id: AnimationMarkerId, name: impl Into<String> ) -> bool

Returns true if an animation marker has the given name.

Arguments

• marker_id - the ID of the marker to check the name of
• name - the name to check

pub fn markers(&self) -> &HashSet<AnimationMarkerId>

Returns all the animation markers registered in the library.

Trait Implementations

impl Resource for SpritesheetLibrary

where Self: Send + Sync + 'static,