2018-08-20 22:35:30 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 01:03:48 +00:00
<class name= "AnimationNodeStateMachinePlayback" inherits= "Resource" version= "4.0" >
2018-08-20 22:35:30 +00:00
<brief_description >
2020-01-23 10:14:14 +00:00
Playback control for [AnimationNodeStateMachine].
2018-08-20 22:35:30 +00:00
</brief_description>
<description >
2019-06-21 23:04:47 +00:00
Allows control of [AnimationTree] state machines created with [AnimationNodeStateMachine]. Retrieve with [code]$AnimationTree.get("parameters/playback")[/code].
[b]Example:[/b]
2019-05-21 02:45:23 +00:00
[codeblock]
var state_machine = $AnimationTree.get("parameters/playback")
state_machine.travel("some_state")
[/codeblock]
2018-08-20 22:35:30 +00:00
</description>
<tutorials >
2020-01-23 10:14:14 +00:00
<link > https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link>
2018-08-20 22:35:30 +00:00
</tutorials>
<methods >
<method name= "get_current_node" qualifiers= "const" >
2020-02-22 13:59:09 +00:00
<return type= "StringName" >
2018-08-20 22:35:30 +00:00
</return>
<description >
2019-05-21 02:45:23 +00:00
Returns the currently playing animation state.
2018-08-20 22:35:30 +00:00
</description>
</method>
<method name= "get_travel_path" qualifiers= "const" >
2020-02-18 12:59:24 +00:00
<return type= "PackedStringArray" >
2018-08-20 22:35:30 +00:00
</return>
<description >
2020-01-23 10:14:14 +00:00
Returns the current travel path as computed internally by the A* algorithm.
2018-08-20 22:35:30 +00:00
</description>
</method>
<method name= "is_playing" qualifiers= "const" >
<return type= "bool" >
</return>
<description >
2019-05-21 02:45:23 +00:00
Returns [code]true[/code] if an animation is playing.
2018-08-20 22:35:30 +00:00
</description>
</method>
<method name= "start" >
<return type= "void" >
</return>
2020-02-22 13:59:09 +00:00
<argument index= "0" name= "node" type= "StringName" >
2018-08-20 22:35:30 +00:00
</argument>
<description >
2019-05-21 02:45:23 +00:00
Starts playing the given animation.
2018-08-20 22:35:30 +00:00
</description>
</method>
<method name= "stop" >
<return type= "void" >
</return>
<description >
2019-05-21 02:45:23 +00:00
Stops the currently playing animation.
2018-08-20 22:35:30 +00:00
</description>
</method>
<method name= "travel" >
<return type= "void" >
</return>
2020-02-22 13:59:09 +00:00
<argument index= "0" name= "to_node" type= "StringName" >
2018-08-20 22:35:30 +00:00
</argument>
<description >
2019-05-21 02:45:23 +00:00
Transitions from the current state to another one, following the shortest path.
2018-08-20 22:35:30 +00:00
</description>
</method>
</methods>
2019-09-03 10:44:58 +00:00
<members >
2019-09-24 11:34:03 +00:00
<member name= "resource_local_to_scene" type= "bool" setter= "set_local_to_scene" getter= "is_local_to_scene" override= "true" default= "true" />
2019-09-03 10:44:58 +00:00
</members>
2018-08-20 22:35:30 +00:00
<constants >
</constants>
</class>
