SpriteFrames

Inherits: Resource < Reference < Object

Category: Core

Brief Description

Sprite frame library for AnimatedSprite.

Properties

Array frames

Methods

void add_animation ( String anim )
void add_frame ( String anim, Texture frame, int at_position=-1 )
void clear ( String anim )
void clear_all ( )
bool get_animation_loop ( String anim ) const
PoolStringArray get_animation_names ( ) const
float get_animation_speed ( String anim ) const
Texture get_frame ( String anim, int idx ) const
int get_frame_count ( String anim ) const
bool has_animation ( String anim ) const
void remove_animation ( String anim )
void remove_frame ( String anim, int idx )
void rename_animation ( String anim, String newname )
void set_animation_loop ( String anim, bool loop )
void set_animation_speed ( String anim, float speed )
void set_frame ( String anim, int idx, Texture txt )

Description

Sprite frame library for AnimatedSprite. Contains frames and animation data for playback.

Property Descriptions

Method Descriptions

  • void add_animation ( String anim )

Adds a new animation to the library.

Adds a frame to the given animation.

Removes all frames from the given animation.

  • void clear_all ( )

Removes all animations. A “default” animation will be created.

If true the given animation will loop.

Returns an array containing the names associated to each animation. Values are placed in alphabetical order.

The animation’s speed in frames per second.

Returns the animation’s selected frame.

Returns the number of frames in the animation.

If true the named animation exists.

  • void remove_animation ( String anim )

Removes the given animation.

Removes the animation’s selected frame.

Changes the animation’s name to newname.

  • void set_animation_loop ( String anim, bool loop )

If true the animation will loop.

  • void set_animation_speed ( String anim, float speed )

The animation’s speed in frames per second.

Sets the texture of the given frame.