diff options
Diffstat (limited to 'doc/classes/AnimationNodeStateMachinePlayback.xml')
| -rw-r--r-- | doc/classes/AnimationNodeStateMachinePlayback.xml | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/classes/AnimationNodeStateMachinePlayback.xml b/doc/classes/AnimationNodeStateMachinePlayback.xml index 8f53ef0dcf..4772c1d819 100644 --- a/doc/classes/AnimationNodeStateMachinePlayback.xml +++ b/doc/classes/AnimationNodeStateMachinePlayback.xml @@ -24,12 +24,15 @@ <method name="get_current_length" qualifiers="const"> <return type="float" /> <description> + Returns the current state length. + [b]Note:[/b] It is possible that any [AnimationRootNode] can be nodes as well as animations. This means that there can be multiple animations within a single state. Which animation length has priority depends on the nodes connected inside it. Also, if a transition does not reset, the remaining length at that point will be returned. </description> </method> <method name="get_current_node" qualifiers="const"> <return type="StringName" /> <description> Returns the currently playing animation state. + [b]Note:[/b] When using a cross-fade, the current state changes to the next state immediately after the cross-fade begins. </description> </method> <method name="get_current_play_position" qualifiers="const"> @@ -38,6 +41,12 @@ Returns the playback position within the current animation state. </description> </method> + <method name="get_fading_from_node" qualifiers="const"> + <return type="StringName" /> + <description> + Returns the starting state of currently fading animation. + </description> + </method> <method name="get_travel_path" qualifiers="const"> <return type="PackedStringArray" /> <description> @@ -50,11 +59,19 @@ Returns [code]true[/code] if an animation is playing. </description> </method> + <method name="next"> + <return type="void" /> + <description> + If there is a next path by travel or auto advance, immediately transitions from the current state to the next state. + </description> + </method> <method name="start"> <return type="void" /> <param index="0" name="node" type="StringName" /> + <param index="1" name="reset" type="bool" default="true" /> <description> Starts playing the given animation. + If [param reset] is [code]true[/code], the animation is played from the beginning. </description> </method> <method name="stop"> @@ -66,8 +83,11 @@ <method name="travel"> <return type="void" /> <param index="0" name="to_node" type="StringName" /> + <param index="1" name="reset_on_teleport" type="bool" default="true" /> <description> Transitions from the current state to another one, following the shortest path. + If the path does not connect from the current state, the animation will play after the state teleports. + If [param reset_on_teleport] is [code]true[/code], the animation is played from the beginning when the travel cause a teleportation. </description> </method> </methods> |