Animation

Inherits: Resource < Reference < Object

Category: Core

Brief Description

Contains data used to animate everything in the engine.

Properties

Methods

Signals

• tracks_changed ( )

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
• TYPE_AUDIO = 4
• TYPE_ANIMATION = 5

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

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 1 second.
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.

Tutorials

• Animation

Property Descriptions

• float length

The total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping.

• bool 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.

• float step

The animation step value.

Method Descriptions

• int add_track ( TrackType type, int at_position=-1 )

Add a track to the Animation. The track type must be specified as any of the values in the TYPE_* enumeration.

• String animation_track_get_key_animation ( int idx, int key_idx ) const

• int animation_track_insert_key ( int track, float time, String animation )

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

• float audio_track_get_key_end_offset ( int idx, int key_idx ) const

• float audio_track_get_key_start_offset ( int idx, int key_idx ) const

• Resource audio_track_get_key_stream ( int idx, int key_idx ) const

• int audio_track_insert_key ( int track, float time, Resource stream, float start_offset=0, float end_offset=0 )

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

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

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

• Vector2 bezier_track_get_key_in_handle ( int idx, int key_idx ) const

• Vector2 bezier_track_get_key_out_handle ( int idx, int key_idx ) const

• float bezier_track_get_key_value ( int idx, int key_idx ) const

• int bezier_track_insert_key ( int track, float time, float value, Vector2 in_handle=Vector2( 0, 0 ), Vector2 out_handle=Vector2( 0, 0 ) )

• float bezier_track_interpolate ( int track, float time ) const

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

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

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

• void clear ( )

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

• void copy_track ( int track, Animation to_animation )

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

• int find_track ( NodePath path ) const

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.

• PoolIntArray method_track_get_key_indices ( int idx, float time_sec, float delta ) const

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

• String method_track_get_name ( int idx, int key_idx ) const

Returns the method name of a method track.

• Array method_track_get_params ( int 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 idx )

Remove a track by specifying the track index.

• int track_find_key ( int idx, float time, bool exact=false ) const

Find 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 idx ) const

Returns true if the track at idx wraps the interpolation loop. Default value: true.

• InterpolationType track_get_interpolation_type ( int idx ) const

Returns the interpolation type of a given track, from the INTERPOLATION_* enum.

• int track_get_key_count ( int idx ) const

Returns the amount of keys in a given track.

• float track_get_key_time ( int idx, int key_idx ) const

Returns the time at which the key is located.

• float track_get_key_transition ( int idx, int key_idx ) const

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

• Variant track_get_key_value ( int idx, int key_idx ) const

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

• NodePath track_get_path ( int idx ) const

Get the path of a track. for more information on the path format, see track_set_path

• TrackType track_get_type ( int idx ) const

Get the type of a track.

• void track_insert_key ( int idx, float time, Variant key, float transition=1 )

Insert a generic key in a given track.

• bool track_is_enabled ( int idx ) const

Returns true if the track at index idx is enabled.

• bool track_is_imported ( int idx ) const

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

• void track_move_down ( int idx )

Move a track down.

• void track_move_up ( int idx )

Move a track up.

• void track_remove_key ( int idx, int key_idx )

Remove a key by index in a given track.

• void track_remove_key_at_position ( int idx, float position )

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

• void track_set_enabled ( int idx, bool enabled )

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

• void track_set_imported ( int idx, bool imported )

Set the given track as imported or not.

• void track_set_interpolation_loop_wrap ( int idx, bool interpolation )

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

• void track_set_interpolation_type ( int idx, InterpolationType interpolation )

Set the interpolation type of a given track, from the INTERPOLATION_* enum.

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

Set the transition curve (easing) for a specific key (see built-in math function “ease”).

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

Set the value of an existing key.

• void track_set_path ( int idx, NodePath path )

Set 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 “:”.

Example: “character/skeleton:ankle” or “character/mesh:transform/local”.

• void track_swap ( int idx, int with_idx )

• int transform_track_insert_key ( int idx, float time, Vector3 location, Quat rotation, Vector3 scale )

Insert a transform key for a transform track.

• Array transform_track_interpolate ( int 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).

• PoolIntArray value_track_get_key_indices ( int idx, float time_sec, float delta ) const

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

• UpdateMode value_track_get_update_mode ( int idx ) const

Returns the update mode of a value track.

• void value_track_set_update_mode ( int idx, UpdateMode mode )

Set the update mode (UPDATE_*) of a value track.