AnimationPlayer
Category: Core
Container and player of resources.
Properties
Methods
Error | ( String name, animation ) |
void | advance ( delta ) |
String | ( String anim_from ) const |
void | ( String anim_from, anim_to ) |
void | clear_caches ( ) |
void | ( ) |
String | ( Animation animation ) const |
get_animation ( name ) const | |
PoolStringArray | ( ) const |
float | ( String anim_from, anim_to ) const |
float | ( ) const |
PoolStringArray | ( ) |
bool | ( String name ) const |
is_playing ( ) const | |
void | ( String name=”“, custom_blend=-1, float custom_speed=1.0, from_end=false ) |
void | play_backwards ( name=”“, float custom_blend=-1 ) |
void | ( String name ) |
void | ( String name ) |
void | ( String name, newname ) |
void | seek ( seconds, bool update=false ) |
void | ( String anim_from, anim_to, float sec ) |
void | ( bool reset=true ) |
- animation_changed ( old_name, String new_name )
If the currently being played animation changes, this signal will notify of such change.
- animation_finished ( anim_name )
Notifies when an animation finished playing.
- animation_started ( String anim_name )
Notifies when an animation starts playing.
- caches_cleared ( )
Enumerations
enum AnimationProcessMode:
- ANIMATION_PROCESS_PHYSICS = 0 — Process animation during the physics process. This is especially useful when animating physics bodies.
- ANIMATION_PROCESS_IDLE = 1 — Process animation during the idle process.
- ANIMATION_PROCESS_MANUAL = 2 — Do not process animation. Use the ‘advance’ method to process the animation manually.
Description
An animation player is used for general purpose playback of resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels.
Property Descriptions
- assigned_animation
Setter | set_assigned_animation(value) |
Getter | get_assigned_animation() |
If playing, the current animation; otherwise, the animation last played. When set, would change the animation, but would not play it unless currently playing. See also current_animation.
- autoplay
Setter | set_autoplay(value) |
Getter | get_autoplay() |
The name of the animation to play when the scene loads. Default value: .
- String current_animation
The name of the current animation, “” if not playing anything. When being set, does not restart the animation. See also . Default value: ""
.
- float current_animation_length
Getter | get_current_animation_length() |
The length (in seconds) of the currently being played animation.
- current_animation_position
Getter | get_current_animation_position() |
The position (in seconds) of the currently playing animation.
- bool playback_active
Setter | set_active(value) |
Getter | is_active() |
If true
, updates animations in response to process-related notifications. Default value: true
.
- playback_default_blend_time
- AnimationProcessMode playback_process_mode
Setter | set_animation_process_mode(value) |
Getter | get_animation_process_mode() |
The process notification in which to update animations. Default value: .
- float playback_speed
Setter | set_speed_scale(value) |
Getter | get_speed_scale() |
The speed scaling ratio. For instance, if this value is 1 then the animation plays at normal speed. If it’s 0.5 then it plays at half speed. If it’s 2 then it plays at double speed. Default value: 1
.
- root_node
Setter | set_root(value) |
Getter | get_root() |
The node from which node path references will travel. Default value: ".."
.
Method Descriptions
Adds animation
to the player accessible with the key name
.
- void advance ( delta )
Shifts position in the animation timeline. Delta is the time in seconds to shift. Events between the current frame and delta
are handled.
- String animation_get_next ( anim_from ) const
Returns the name of the next animation in the queue.
- void animation_set_next ( String anim_from, anim_to )
Triggers the anim_to
animation when the anim_from
animation completes.
- void clear_caches ( )
AnimationPlayer
caches animated nodes. It may not notice if a node disappears, so clear_caches forces it to update the cache again.
Clears all queued, unplayed animations.
- String find_animation ( animation ) const
Returns the name of animation
or empty string if not found.
- Animation get_animation ( name ) const
Returns the Animation with key name
or if not found.
- get_animation_list ( ) const
Returns the list of stored animation names.
Get the blend time (in seconds) between two animations, referenced by their names.
- get_playing_speed ( ) const
- PoolStringArray get_queue ( )
- has_animation ( String name ) const
Returns true
if the AnimationPlayer
stores an with key name
.
- bool is_playing ( ) const
Returns true
if playing an animation.
Play the animation with key name
. Custom speed and blend times can be set. If custom speed is negative (-1), ‘from_end’ being true
can play the animation backwards.
If the animation has been paused by stop(true)
it will be resumed. Calling play()
without arguments will also resume the animation.
- void play_backwards ( name=”“, float custom_blend=-1 )
Play the animation with key name
in reverse.
If the animation has been paused by stop(true)
it will be resumed backwards. Calling play_backwards()
without arguments will also resume the animation backwards.
- void queue ( name )
Queue an animation for playback once the current one is done.
- void remove_animation ( String name )
Remove the animation with key .
- void rename_animation ( name, String newname )
Rename an existing animation with key name
to newname
.
- void seek ( seconds, bool update=false )
Seek the animation to the seconds
point in time (in seconds). If update
is true
, the animation updates too, otherwise it updates at process time. Events between the current frame and seconds
are skipped.
- void set_blend_time ( anim_from, String anim_to, sec )
Specify a blend time (in seconds) between two animations, referenced by their names.
- void stop ( bool reset=true )
Stop the currently playing animation. If reset
is true
, the animation position is reset to 0
and the playback speed is reset to 1.0
.
If reset
is false
, then calling play()
without arguments or play("same_as_before")
will resume the animation. Works the same for the method.