Animation

Inherits: Resource < Reference < Object

Contains data used to animate everything in the engine.

Description

An Animation resource contains data used to animate everything in the engine. Animations are divided into tracks, and each track must be linked to a node. The state of that node can be changed through time, by adding timed keys (events) to the track.

# This creates an animation that makes the node "Enemy" move to the right by
# 100 pixels in 0.5 seconds.
var animation = Animation.new()
var track_index = animation.add_track(Animation.TYPE_VALUE)
animation.track_set_path(track_index, "Enemy:position:x")
animation.track_insert_key(track_index, 0.0, 0)
animation.track_insert_key(track_index, 0.5, 100)

Animations are just data containers, and must be added to nodes such as an AnimationPlayer or AnimationTreePlayer to be played back. Animation tracks have different types, each with its own set of dedicated methods. Check TrackType to see available types.

Properties

float length 1.0
bool loop false
float step 0.1

Methods

int add_track ( TrackType type, int at_position=-1 )
String animation_track_get_key_animation ( int track_idx, int key_idx ) const
int animation_track_insert_key ( int track_idx, float time, String animation )
void animation_track_set_key_animation ( int track_idx, int key_idx, String animation )
float audio_track_get_key_end_offset ( int track_idx, int key_idx ) const
float audio_track_get_key_start_offset ( int track_idx, int key_idx ) const
Resource audio_track_get_key_stream ( int track_idx, int key_idx ) const
int audio_track_insert_key ( int track_idx, float time, Resource stream, float start_offset=0, float end_offset=0 )
void audio_track_set_key_end_offset ( int track_idx, int key_idx, float offset )
void audio_track_set_key_start_offset ( int track_idx, int key_idx, float offset )
void audio_track_set_key_stream ( int track_idx, int key_idx, Resource stream )
Vector2 bezier_track_get_key_in_handle ( int track_idx, int key_idx ) const
Vector2 bezier_track_get_key_out_handle ( int track_idx, int key_idx ) const
float bezier_track_get_key_value ( int track_idx, int key_idx ) const
int bezier_track_insert_key ( int track_idx, float time, float value, Vector2 in_handle=Vector2( 0, 0 ), Vector2 out_handle=Vector2( 0, 0 ) )
float bezier_track_interpolate ( int track_idx, float time ) const
void bezier_track_set_key_in_handle ( int track_idx, int key_idx, Vector2 in_handle )
void bezier_track_set_key_out_handle ( int track_idx, int key_idx, Vector2 out_handle )
void bezier_track_set_key_value ( int track_idx, int key_idx, float value )
void clear ( )
void copy_track ( int track_idx, Animation to_animation )
int find_track ( NodePath path ) const
int get_track_count ( ) const
PoolIntArray method_track_get_key_indices ( int track_idx, float time_sec, float delta ) const
String method_track_get_name ( int track_idx, int key_idx ) const
Array method_track_get_params ( int track_idx, int key_idx ) const
void remove_track ( int track_idx )
int track_find_key ( int track_idx, float time, bool exact=false ) const
bool track_get_interpolation_loop_wrap ( int track_idx ) const
InterpolationType track_get_interpolation_type ( int track_idx ) const
int track_get_key_count ( int track_idx ) const
float track_get_key_time ( int track_idx, int key_idx ) const
float track_get_key_transition ( int track_idx, int key_idx ) const
Variant track_get_key_value ( int track_idx, int key_idx ) const
NodePath track_get_path ( int track_idx ) const
TrackType track_get_type ( int track_idx ) const
void track_insert_key ( int track_idx, float time, Variant key, float transition=1 )
bool track_is_enabled ( int track_idx ) const
bool track_is_imported ( int track_idx ) const
void track_move_down ( int track_idx )
void track_move_to ( int track_idx, int to_idx )
void track_move_up ( int track_idx )
void track_remove_key ( int track_idx, int key_idx )
void track_remove_key_at_position ( int track_idx, float position )
void track_set_enabled ( int track_idx, bool enabled )
void track_set_imported ( int track_idx, bool imported )
void track_set_interpolation_loop_wrap ( int track_idx, bool interpolation )
void track_set_interpolation_type ( int track_idx, InterpolationType interpolation )
void track_set_key_time ( int track_idx, int key_idx, float time )
void track_set_key_transition ( int track_idx, int key_idx, float transition )
void track_set_key_value ( int track_idx, int key, Variant value )
void track_set_path ( int track_idx, NodePath path )
void track_swap ( int track_idx, int with_idx )
int transform_track_insert_key ( int track_idx, float time, Vector3 location, Quat rotation, Vector3 scale )
Array transform_track_interpolate ( int track_idx, float time_sec ) const
PoolIntArray value_track_get_key_indices ( int track_idx, float time_sec, float delta ) const
UpdateMode value_track_get_update_mode ( int track_idx ) const
void value_track_set_update_mode ( int track_idx, UpdateMode mode )

Signals

  • tracks_changed ( )

Emitted when there's a change in the list of tracks, e.g. tracks are added, moved or have changed paths.

Enumerations

enum TrackType:

  • TYPE_VALUE = 0 --- Value tracks set values in node properties, but only those which can be Interpolated.
  • TYPE_TRANSFORM = 1 --- Transform tracks are used to change node local transforms or skeleton pose bones. Transitions are interpolated.
  • TYPE_METHOD = 2 --- Method tracks call functions with given arguments per key.
  • TYPE_BEZIER = 3 --- Bezier tracks are used to interpolate a value using custom curves. They can also be used to animate sub-properties of vectors and colors (e.g. alpha value of a Color).
  • TYPE_AUDIO = 4 --- Audio tracks are used to play an audio stream with either type of AudioStreamPlayer. The stream can be trimmed and previewed in the animation.
  • TYPE_ANIMATION = 5 --- Animation tracks play animations in other AnimationPlayer nodes.

enum InterpolationType:

  • INTERPOLATION_NEAREST = 0 --- No interpolation (nearest value).
  • INTERPOLATION_LINEAR = 1 --- Linear interpolation.
  • INTERPOLATION_CUBIC = 2 --- Cubic interpolation.

enum UpdateMode:

  • UPDATE_CONTINUOUS = 0 --- Update between keyframes.
  • UPDATE_DISCRETE = 1 --- Update at the keyframes and hold the value.
  • UPDATE_TRIGGER = 2 --- Update at the keyframes.
  • UPDATE_CAPTURE = 3 --- Same as linear interpolation, but also interpolates from the current value (i.e. dynamically at runtime) if the first key isn't at 0 seconds.

Property Descriptions

Default 1.0
Setter set_length(value)
Getter get_length()

The total length of the animation (in seconds).

Note: Length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping.


Default false
Setter set_loop(value)
Getter has_loop()

A flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation.


Default 0.1
Setter set_step(value)
Getter get_step()

The animation step value.

Method Descriptions

Adds a track to the Animation.


  • String animation_track_get_key_animation ( int track_idx, int key_idx ) const

Returns the animation name at the key identified by key_idx. The track_idx must be the index of an Animation Track.


Inserts a key with value animation at the given time (in seconds). The track_idx must be the index of an Animation Track.


  • void animation_track_set_key_animation ( int track_idx, int key_idx, String animation )

Sets the key identified by key_idx to value animation. The track_idx must be the index of an Animation Track.


  • float audio_track_get_key_end_offset ( int track_idx, int key_idx ) const

Returns the end offset of the key identified by key_idx. The track_idx must be the index of an Audio Track.

End offset is the number of seconds cut off at the ending of the audio stream.


  • float audio_track_get_key_start_offset ( int track_idx, int key_idx ) const

Returns the start offset of the key identified by key_idx. The track_idx must be the index of an Audio Track.

Start offset is the number of seconds cut off at the beginning of the audio stream.


  • Resource audio_track_get_key_stream ( int track_idx, int key_idx ) const

Returns the audio stream of the key identified by key_idx. The track_idx must be the index of an Audio Track.


Inserts an Audio Track key at the given time in seconds. The track_idx must be the index of an Audio Track.

stream is the AudioStream resource to play. start_offset is the number of seconds cut off at the beginning of the audio stream, while end_offset is at the ending.


  • void audio_track_set_key_end_offset ( int track_idx, int key_idx, float offset )

Sets the end offset of the key identified by key_idx to value offset. The track_idx must be the index of an Audio Track.


  • void audio_track_set_key_start_offset ( int track_idx, int key_idx, float offset )

Sets the start offset of the key identified by key_idx to value offset. The track_idx must be the index of an Audio Track.


  • void audio_track_set_key_stream ( int track_idx, int key_idx, Resource stream )

Sets the stream of the key identified by key_idx to value offset. The track_idx must be the index of an Audio Track.


  • Vector2 bezier_track_get_key_in_handle ( int track_idx, int key_idx ) const

Returns the in handle of the key identified by key_idx. The track_idx must be the index of a Bezier Track.


  • Vector2 bezier_track_get_key_out_handle ( int track_idx, int key_idx ) const

Returns the out handle of the key identified by key_idx. The track_idx must be the index of a Bezier Track.


  • float bezier_track_get_key_value ( int track_idx, int key_idx ) const

Returns the value of the key identified by key_idx. The track_idx must be the index of a Bezier Track.


Inserts a Bezier Track key at the given time in seconds. The track_idx must be the index of a Bezier Track.

in_handle is the left-side weight of the added Bezier curve point, out_handle is the right-side one, while value is the actual value at this point.


  • float bezier_track_interpolate ( int track_idx, float time ) const

Returns the interpolated value at the given time (in seconds). The track_idx must be the index of a Bezier Track.


  • void bezier_track_set_key_in_handle ( int track_idx, int key_idx, Vector2 in_handle )

Sets the in handle of the key identified by key_idx to value in_handle. The track_idx must be the index of a Bezier Track.


  • void bezier_track_set_key_out_handle ( int track_idx, int key_idx, Vector2 out_handle )

Sets the out handle of the key identified by key_idx to value out_handle. The track_idx must be the index of a Bezier Track.


  • void bezier_track_set_key_value ( int track_idx, int key_idx, float value )

Sets the value of the key identified by key_idx to the given value. The track_idx must be the index of a Bezier Track.


  • void clear ( )

Clear the animation (clear all tracks and reset all).


Adds a new track that is a copy of the given track from to_animation.


Returns the index of the specified track. If the track is not found, return -1.


  • int get_track_count ( ) const

Returns the amount of tracks in the animation.


Returns all the key indices of a method track, given a position and delta time.


  • String method_track_get_name ( int track_idx, int key_idx ) const

Returns the method name of a method track.


  • Array method_track_get_params ( int track_idx, int key_idx ) const

Returns the arguments values to be called on a method track for a given key in a given track.


  • void remove_track ( int track_idx )

Removes a track by specifying the track index.


Finds the key index by time in a given track. Optionally, only find it if the exact time is given.


  • bool track_get_interpolation_loop_wrap ( int track_idx ) const

Returns true if the track at idx wraps the interpolation loop. New tracks wrap the interpolation loop by default.


Returns the interpolation type of a given track.


  • int track_get_key_count ( int track_idx ) const

Returns the amount of keys in a given track.


  • float track_get_key_time ( int track_idx, int key_idx ) const

Returns the time at which the key is located.


  • float track_get_key_transition ( int track_idx, int key_idx ) const

Returns the transition curve (easing) for a specific key (see the built-in math function @GDScript.ease).


  • Variant track_get_key_value ( int track_idx, int key_idx ) const

Returns the value of a given key in a given track.


Gets the path of a track. For more information on the path format, see track_set_path.


Gets the type of a track.


Insert a generic key in a given track.


  • bool track_is_enabled ( int track_idx ) const

Returns true if the track at index idx is enabled.


  • bool track_is_imported ( int track_idx ) const

Returns true if the given track is imported. Else, return false.


  • void track_move_down ( int track_idx )

Moves a track down.


  • void track_move_to ( int track_idx, int to_idx )

Changes the index position of track idx to the one defined in to_idx.


  • void track_move_up ( int track_idx )

Moves a track up.


  • void track_remove_key ( int track_idx, int key_idx )

Removes a key by index in a given track.


  • void track_remove_key_at_position ( int track_idx, float position )

Removes a key by position (seconds) in a given track.


  • void track_set_enabled ( int track_idx, bool enabled )

Enables/disables the given track. Tracks are enabled by default.


  • void track_set_imported ( int track_idx, bool imported )

Sets the given track as imported or not.


  • void track_set_interpolation_loop_wrap ( int track_idx, bool interpolation )

If true, the track at idx wraps the interpolation loop.


Sets the interpolation type of a given track.


  • void track_set_key_time ( int track_idx, int key_idx, float time )

Sets the time of an existing key.


  • void track_set_key_transition ( int track_idx, int key_idx, float transition )

Sets the transition curve (easing) for a specific key (see the built-in math function @GDScript.ease).


  • void track_set_key_value ( int track_idx, int key, Variant value )

Sets the value of an existing key.


Sets the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":".

For example, "character/skeleton:ankle" or "character/mesh:transform/local".


  • void track_swap ( int track_idx, int with_idx )

Swaps the track idx's index position with the track with_idx.


Insert a transform key for a transform track.


  • Array transform_track_interpolate ( int track_idx, float time_sec ) const

Returns the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position (Vector3), rotation (Quat) and scale (Vector3).


Returns all the key indices of a value track, given a position and delta time.


Returns the update mode of a value track.


  • void value_track_set_update_mode ( int track_idx, UpdateMode mode )

Sets the update mode (see UpdateMode) of a value track.