class-description NEWS COMMUNITY STORE TUTORIALS SIGN UP LOGIN LOGOUT ROKOJORI NEWSLETTER SIGN UP LOGIN LOGOUT NEWS COMMUNITY STORE TUTORIALS TOGGLE FULLSCREEN VOLLBILD AN/AUS ObjectRefCountedResource Animation
Holds data that can be used to animate anything in the engine.

This resource holds data that can be used to animate anything 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 2.0 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, 2.0, 100) animation.length = 2.0

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

 Enum TrackType<>():Enum

TYPE_VALUE = 0

Value tracks set values in node properties, but only those which can be interpolated. For 3D position/rotation/scale, using the dedicated TYPE_POSITION_3D, TYPE_ROTATION_3D and TYPE_SCALE_3D track types instead of TYPE_VALUE is recommended for performance reasons.


TYPE_POSITION_3D = 1

3D position track (values are stored in Vector3s).


TYPE_ROTATION_3D = 2

3D rotation track (values are stored in Quaternions).


TYPE_SCALE_3D = 3

3D scale track (values are stored in Vector3s).


TYPE_BLEND_SHAPE = 4

Blend shape track.


TYPE_METHOD = 5

Method tracks call functions with given arguments per key.


TYPE_BEZIER = 6

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 = 7

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 = 8

Animation tracks play animations in other AnimationPlayer nodes.

 Enum InterpolationType<>():Enum

INTERPOLATION_NEAREST = 0

No interpolation (nearest value).


INTERPOLATION_LINEAR = 1

Linear interpolation.


INTERPOLATION_CUBIC = 2

Cubic interpolation. This looks smoother than linear interpolation, but is more expensive to interpolate. Stick to INTERPOLATION_LINEAR for complex 3D animations imported from external software, even if it requires using a higher animation framerate in return.


INTERPOLATION_LINEAR_ANGLE = 3

Linear interpolation with shortest path rotation.


INTERPOLATION_CUBIC_ANGLE = 4

Cubic interpolation with shortest path rotation.

 Enum UpdateMode<>():Enum

UPDATE_CONTINUOUS = 0

Update between keyframes and hold the value.


UPDATE_DISCRETE = 1

Update at the keyframes.


UPDATE_CAPTURE = 2

Same as UPDATE_CONTINUOUS but works as a flag to capture the value of the current object and perform interpolation in some methods. See also AnimationMixer.capture(), AnimationPlayer.playback_auto_capture, and AnimationPlayer.play_with_capture().

 Enum LoopMode<>():Enum

LOOP_NONE = 0

At both ends of the animation, the animation will stop playing.


LOOP_LINEAR = 1

At both ends of the animation, the animation will be repeated without changing the playback direction.


LOOP_PINGPONG = 2

Repeats playback and reverse playback at both ends of the animation.

 Enum LoopedFlag<>():Enum

LOOPED_FLAG_NONE = 0

This flag indicates that the animation proceeds without any looping.


LOOPED_FLAG_END = 1

This flag indicates that the animation has reached the end of the animation and just after loop processed.


LOOPED_FLAG_START = 2

This flag indicates that the animation has reached the start of the animation and just after loop processed.

 Enum FindMode<>():Enum

FIND_MODE_NEAREST = 0

Finds the nearest time key.


FIND_MODE_APPROX = 1

Finds only the key with approximating the time.


FIND_MODE_EXACT = 2

Finds only the key with matching the time.

 bool capture_included<>():bool

Returns true if the capture track is included. This is a cached readonly value for performance.

 float length<>():float

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.

 LoopMode loop_mode<>():LoopMode

Determines the behavior of both ends of the animation timeline during animation playback. This is used for correct interpolation of animation cycles, and for hinting the player that it must restart the animation.

 float step<>():float

The animation step value.

 void add_marker<>( StringName name=, name:StringName=, float time=, time:float=, ):void

Adds a marker to this Animation.

 int add_track<>( TrackType type=, type:TrackType=, int at_position=-1, at_position:int=-1, ):int

Adds a track to the Animation.

 StringName animation_track_get_key_animation<>( int track_idx=, track_idx:int=, int key_idx=, key_idx:int=, ):StringName

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

 int animation_track_insert_key<>( int track_idx=, track_idx:int=, float time=, time:float=, StringName animation=, animation:StringName=, ):int

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=, track_idx:int=, int key_idx=, key_idx:int=, StringName animation=, animation:StringName=, ):void

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=, track_idx:int=, int key_idx=, key_idx:int=, ):float

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=, track_idx:int=, int key_idx=, key_idx:int=, ):float

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=, track_idx:int=, int key_idx=, key_idx:int=, ):Resource

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

 int audio_track_insert_key<>( int track_idx=, track_idx:int=, float time=, time:float=, Resource stream=, stream:Resource=, float start_offset=0, start_offset:float=0, float end_offset=0, end_offset:float=0, ):int

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.

 bool audio_track_is_use_blend<>( int track_idx=, track_idx:int=, ):bool

Returns true if the track at track_idx will be blended with other animations.

 void audio_track_set_key_end_offset<>( int track_idx=, track_idx:int=, int key_idx=, key_idx:int=, float offset=, offset:float=, ):void

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=, track_idx:int=, int key_idx=, key_idx:int=, float offset=, offset:float=, ):void

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=, track_idx:int=, int key_idx=, key_idx:int=, Resource stream=, stream:Resource=, ):void

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

 void audio_track_set_use_blend<>( int track_idx=, track_idx:int=, bool enable=, enable:bool=, ):void

Sets whether the track will be blended with other animations. If true, the audio playback volume changes depending on the blend value.

 Vector2 bezier_track_get_key_in_handle<>( int track_idx=, track_idx:int=, int key_idx=, key_idx:int=, ):Vector2

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=, track_idx:int=, int key_idx=, key_idx:int=, ):Vector2

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=, track_idx:int=, int key_idx=, key_idx:int=, ):float

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

 int bezier_track_insert_key<>( =, :=, =, :=, ):int

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=, track_idx:int=, float time=, time:float=, ):float

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=, track_idx:int=, int key_idx=, key_idx:int=, Vector2 in_handle=, in_handle:Vector2=, float balanced_value_time_ratio=1.0, balanced_value_time_ratio:float=1.0, ):void

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=, track_idx:int=, int key_idx=, key_idx:int=, Vector2 out_handle=, out_handle:Vector2=, float balanced_value_time_ratio=1.0, balanced_value_time_ratio:float=1.0, ):void

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=, track_idx:int=, int key_idx=, key_idx:int=, float value=, value:float=, ):void

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.

 int blend_shape_track_insert_key<>( int track_idx=, track_idx:int=, float time=, time:float=, float amount=, amount:float=, ):int

Inserts a key in a given blend shape track. Returns the key index.

 float blend_shape_track_interpolate<>( int track_idx=, track_idx:int=, float time_sec=, time_sec:float=, bool backward=false, backward:bool=false, ):float

Returns the interpolated blend shape value at the given time (in seconds). The track_idx must be the index of a blend shape track.

 void clear<>():void

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

 void compress<>( int page_size=8192, page_size:int=8192, int fps=120, fps:int=120, float split_tolerance=4.0, split_tolerance:float=4.0, ):void

Compress the animation and all its tracks in-place. This will make track_is_compressed() return true once called on this Animation. Compressed tracks require less memory to be played, and are designed to be used for complex 3D animations (such as cutscenes) imported from external 3D software. Compression is lossy, but the difference is usually not noticeable in real world conditions.

Note: Compressed tracks have various limitations (such as not being editable from the editor), so only use compressed animations if you actually need them.

 void copy_track<>( int track_idx=, track_idx:int=, Animation to_animation=, to_animation:Animation=, ):void

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

 int find_track<>( NodePath path=, path:NodePath=, TrackType type=, type:TrackType=, ):int

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

 StringName get_marker_at_time<>( float time=, time:float=, ):StringName

Returns the name of the marker located at the given time.

 Color get_marker_color<>( StringName name=, name:StringName=, ):Color

Returns the given marker's color.

 PackedStringArray get_marker_names<>():PackedStringArray

Returns every marker in this Animation, sorted ascending by time.

 float get_marker_time<>( StringName name=, name:StringName=, ):float

Returns the given marker's time.

 StringName get_next_marker<>( float time=, time:float=, ):StringName

Returns the closest marker that comes after the given time. If no such marker exists, an empty string is returned.

 StringName get_prev_marker<>( float time=, time:float=, ):StringName

Returns the closest marker that comes before the given time. If no such marker exists, an empty string is returned.

 int get_track_count<>():int

Returns the amount of tracks in the animation.

 bool has_marker<>( StringName name=, name:StringName=, ):bool

Returns true if this Animation contains a marker with the given name.

 StringName method_track_get_name<>( int track_idx=, track_idx:int=, int key_idx=, key_idx:int=, ):StringName

Returns the method name of a method track.

 Array method_track_get_params<>( int track_idx=, track_idx:int=, int key_idx=, key_idx:int=, ):Array

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

 void optimize<>( float allowed_velocity_err=0.01, allowed_velocity_err:float=0.01, float allowed_angular_err=0.01, allowed_angular_err:float=0.01, int precision=3, precision:int=3, ):void

Optimize the animation and all its tracks in-place. This will preserve only as many keys as are necessary to keep the animation within the specified bounds.

 int position_track_insert_key<>( int track_idx=, track_idx:int=, float time=, time:float=, Vector3 position=, position:Vector3=, ):int

Inserts a key in a given 3D position track. Returns the key index.

 Vector3 position_track_interpolate<>( int track_idx=, track_idx:int=, float time_sec=, time_sec:float=, bool backward=false, backward:bool=false, ):Vector3

Returns the interpolated position value at the given time (in seconds). The track_idx must be the index of a 3D position track.

 void remove_marker<>( StringName name=, name:StringName=, ):void

Removes the marker with the given name from this Animation.

 void remove_track<>( int track_idx=, track_idx:int=, ):void

Removes a track by specifying the track index.

 int rotation_track_insert_key<>( int track_idx=, track_idx:int=, float time=, time:float=, Quaternion rotation=, rotation:Quaternion=, ):int

Inserts a key in a given 3D rotation track. Returns the key index.

 Quaternion rotation_track_interpolate<>( int track_idx=, track_idx:int=, float time_sec=, time_sec:float=, bool backward=false, backward:bool=false, ):Quaternion

Returns the interpolated rotation value at the given time (in seconds). The track_idx must be the index of a 3D rotation track.

 int scale_track_insert_key<>( int track_idx=, track_idx:int=, float time=, time:float=, Vector3 scale=, scale:Vector3=, ):int

Inserts a key in a given 3D scale track. Returns the key index.

 Vector3 scale_track_interpolate<>( int track_idx=, track_idx:int=, float time_sec=, time_sec:float=, bool backward=false, backward:bool=false, ):Vector3

Returns the interpolated scale value at the given time (in seconds). The track_idx must be the index of a 3D scale track.

 void set_marker_color<>( StringName name=, name:StringName=, Color color=, color:Color=, ):void

Sets the given marker's color.

 int track_find_key<>( int track_idx=, track_idx:int=, float time=, time:float=, FindMode find_mode=0, find_mode:FindMode=0, bool limit=false, limit:bool=false, bool backward=false, backward:bool=false, ):int

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

If limit is true, it does not return keys outside the animation range.

If backward is true, the direction is reversed in methods that rely on one directional processing.

For example, in case find_mode is FIND_MODE_NEAREST, if there is no key in the current position just after seeked, the first key found is retrieved by searching before the position, but if backward is true, the first key found is retrieved after the position.

 bool track_get_interpolation_loop_wrap<>( int track_idx=, track_idx:int=, ):bool

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

 InterpolationType track_get_interpolation_type<>( int track_idx=, track_idx:int=, ):InterpolationType

Returns the interpolation type of a given track.

 int track_get_key_count<>( int track_idx=, track_idx:int=, ):int

Returns the number of keys in a given track.

 float track_get_key_time<>( int track_idx=, track_idx:int=, int key_idx=, key_idx:int=, ):float

Returns the time at which the key is located.

 float track_get_key_transition<>( int track_idx=, track_idx:int=, int key_idx=, key_idx:int=, ):float

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

 Variant track_get_key_value<>( int track_idx=, track_idx:int=, int key_idx=, key_idx:int=, ):Variant

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

 NodePath track_get_path<>( int track_idx=, track_idx:int=, ):NodePath

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

 TrackType track_get_type<>( int track_idx=, track_idx:int=, ):TrackType

Gets the type of a track.

 int track_insert_key<>( int track_idx=, track_idx:int=, float time=, time:float=, Variant key=, key:Variant=, float transition=1, transition:float=1, ):int

Inserts a generic key in a given track. Returns the key index.

 bool track_is_compressed<>( int track_idx=, track_idx:int=, ):bool

Returns true if the track is compressed, false otherwise. See also compress().

 bool track_is_enabled<>( int track_idx=, track_idx:int=, ):bool

Returns true if the track at index track_idx is enabled.

 bool track_is_imported<>( int track_idx=, track_idx:int=, ):bool

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

 void track_move_down<>( int track_idx=, track_idx:int=, ):void

Moves a track down.

 void track_move_to<>( int track_idx=, track_idx:int=, int to_idx=, to_idx:int=, ):void

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

 void track_move_up<>( int track_idx=, track_idx:int=, ):void

Moves a track up.

 void track_remove_key<>( int track_idx=, track_idx:int=, int key_idx=, key_idx:int=, ):void

Removes a key by index in a given track.

 void track_remove_key_at_time<>( int track_idx=, track_idx:int=, float time=, time:float=, ):void

Removes a key at time in a given track.

 void track_set_enabled<>( int track_idx=, track_idx:int=, bool enabled=, enabled:bool=, ):void

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

 void track_set_imported<>( int track_idx=, track_idx:int=, bool imported=, imported:bool=, ):void

Sets the given track as imported or not.

 void track_set_interpolation_loop_wrap<>( int track_idx=, track_idx:int=, bool interpolation=, interpolation:bool=, ):void

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

 void track_set_interpolation_type<>( int track_idx=, track_idx:int=, InterpolationType interpolation=, interpolation:InterpolationType=, ):void

Sets the interpolation type of a given track.

 void track_set_key_time<>( int track_idx=, track_idx:int=, int key_idx=, key_idx:int=, float time=, time:float=, ):void

Sets the time of an existing key.

 void track_set_key_transition<>( int track_idx=, track_idx:int=, int key_idx=, key_idx:int=, float transition=, transition:float=, ):void

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

 void track_set_key_value<>( int track_idx=, track_idx:int=, int key=, key:int=, Variant value=, value:Variant=, ):void

Sets the value of an existing key.

 void track_set_path<>( int track_idx=, track_idx:int=, NodePath path=, path:NodePath=, ):void

Sets the path of a track. Paths must be valid scene-tree paths to a node and must be specified starting from the AnimationMixer.root_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=, track_idx:int=, int with_idx=, with_idx:int=, ):void

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

 UpdateMode value_track_get_update_mode<>( int track_idx=, track_idx:int=, ):UpdateMode

Returns the update mode of a value track.

 Variant value_track_interpolate<>( int track_idx=, track_idx:int=, float time_sec=, time_sec:float=, bool backward=false, backward:bool=false, ):Variant

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

A backward mainly affects the direction of key retrieval of the track with UPDATE_DISCRETE converted by AnimationMixer.ANIMATION_CALLBACK_MODE_DISCRETE_FORCE_CONTINUOUS to match the result with track_find_key().

 void value_track_set_update_mode<>( int track_idx=, track_idx:int=, UpdateMode mode=, mode:UpdateMode=, ):void

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


All social media brands are registrated trademarks and belong to their respective owners.





CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com We are using cookies on this site. Read more... Wir benutzen Cookies auf dieser Seite. Mehr lesen...