SpriteFrames¶
Inherits: Resource < Reference < Object
Sprite frame library for AnimatedSprite.
Description¶
Sprite frame library for AnimatedSprite. Contains frames and animation data for playback.
Note: You can associate a set of normal maps by creating additional SpriteFrames
resources with a _normal
suffix. For example, having 2 SpriteFrames
resources run
and run_normal
will make it so the run
animation uses the normal map.
Methods¶
void |
add_animation ( String anim ) |
void |
add_frame ( String anim, Texture frame, int at_position=-1 ) |
void |
|
void |
clear_all ( ) |
get_animation_loop ( String anim ) const |
|
get_animation_names ( ) const |
|
get_animation_speed ( String anim ) const |
|
get_frame_count ( String anim ) const |
|
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 |
Method Descriptions¶
void add_animation ( String anim )
Adds a new animation to the library.
Adds a frame to the given animation.
void clear ( String anim )
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.
PoolStringArray get_animation_names ( ) const
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
.
If true
, the animation will loop.
The animation's speed in frames per second.
Sets the texture of the given frame.