Description

A resource to add to anAnimationNodeBlendTree. Only has one output port using theanimation property. Used as an input forAnimationNodes that blend animations together.

Tutorials

• Using AnimationTree

• 3D Platformer Demo

• Third Person Shooter (TPS) Demo

Properties

Enumerations

enumPlayMode:🔗

PlayModePLAY_MODE_FORWARD =0

Plays animation in forward direction.

PlayModePLAY_MODE_BACKWARD =1

Plays animation in backward direction.

Property Descriptions

booladvance_on_start =false🔗

• voidset_advance_on_start(value:bool)

• boolis_advance_on_start()

Iftrue, on receiving a request to play an animation from the start, the first frame is not drawn, but only processed, and playback starts from the next frame.

See also the notes ofAnimationPlayer.play().

StringNameanimation =&""🔗

• voidset_animation(value:StringName)

• StringNameget_animation()

Animation to use as an output. It is one of the animations provided byAnimationTree.anim_player.

LoopModeloop_mode🔗

• voidset_loop_mode(value:LoopMode)

• LoopModeget_loop_mode()

Ifuse_custom_timeline istrue, override the loop settings of the originalAnimation resource with the value.

Note: If theAnimation.loop_mode isn't set to looping, theAnimation.track_set_interpolation_loop_wrap() option will not be respected. If you cannot get the expected behavior, consider duplicating theAnimation resource and changing the loop settings.

PlayModeplay_mode =0🔗

• voidset_play_mode(value:PlayMode)

• PlayModeget_play_mode()

Determines the playback direction of the animation.

floatstart_offset🔗

• voidset_start_offset(value:float)

• floatget_start_offset()

Ifuse_custom_timeline istrue, offset the start position of the animation.

This is useful for adjusting which foot steps first in 3D walking animations.

boolstretch_time_scale🔗

• voidset_stretch_time_scale(value:bool)

• boolis_stretching_time_scale()

Iftrue, scales the time so that the length specified intimeline_length is one cycle.

This is useful for matching the periods of walking and running animations.

Iffalse, the original animation length is respected. If you set the loop toloop_mode, the animation will loop intimeline_length.

floattimeline_length🔗

• voidset_timeline_length(value:float)

• floatget_timeline_length()

Ifuse_custom_timeline istrue, offset the start position of the animation.

booluse_custom_timeline =false🔗

• voidset_use_custom_timeline(value:bool)

• boolis_using_custom_timeline()

Iftrue,AnimationNode provides an animation based on theAnimation resource with some parameters adjusted.