2022-03-15 13:29:32 +01:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-10-12 01:59:32 +02:00
<class name= "AnimationNodeStateMachinePlayback" inherits= "Resource" version= "4.2" >
2022-03-15 13:29:32 +01:00
<brief_description >
Playback control for [AnimationNodeStateMachine].
</brief_description>
<description >
Allows control of [AnimationTree] state machines created with [AnimationNodeStateMachine]. Retrieve with [code]$AnimationTree.get("parameters/playback")[/code].
[b]Example:[/b]
[codeblock]
var state_machine = $AnimationTree.get("parameters/playback")
state_machine.travel("some_state")
[/codeblock]
</description>
<tutorials >
2023-08-29 22:33:15 +02:00
<link > $DOCS_URL/tutorials/animation/animation_tree.md</link>
2022-03-15 13:29:32 +01:00
</tutorials>
<methods >
<method name= "get_current_length" qualifiers= "const" >
<return type= "float" />
<description >
</description>
</method>
<method name= "get_current_node" qualifiers= "const" >
2022-03-24 01:22:45 +01:00
<return type= "StringName" />
2022-03-15 13:29:32 +01:00
<description >
Returns the currently playing animation state.
</description>
</method>
<method name= "get_current_play_position" qualifiers= "const" >
<return type= "float" />
<description >
Returns the playback position within the current animation state.
</description>
</method>
<method name= "get_travel_path" qualifiers= "const" >
<return type= "PoolStringArray" />
<description >
Returns the current travel path as computed internally by the A* algorithm.
</description>
</method>
<method name= "is_playing" qualifiers= "const" >
<return type= "bool" />
<description >
Returns [code]true[/code] if an animation is playing.
</description>
</method>
<method name= "start" >
<return type= "void" />
2022-03-24 01:22:45 +01:00
<argument index= "0" name= "node" type= "StringName" />
2022-03-15 13:29:32 +01:00
<description >
</description>
</method>
<method name= "stop" >
<return type= "void" />
<description >
Stops the currently playing animation.
</description>
</method>
<method name= "travel" >
<return type= "void" />
2022-03-24 01:22:45 +01:00
<argument index= "0" name= "to_node" type= "StringName" />
2022-03-15 13:29:32 +01:00
<description >
</description>
</method>
</methods>
<members >
<member name= "resource_local_to_scene" type= "bool" setter= "set_local_to_scene" getter= "is_local_to_scene" overrides= "Resource" default= "true" />
</members>
<constants >
</constants>
</class>