godot/doc/classes/AnimationNodeStateMachinePlayback.xml
Rémi Verschelde 32ddd4f4e0
Doctool: Remove version attribute from XML header
We don't use that info for anything, and it generates unnecessary diffs
every time we bump the minor version (and CI failures if we forget to
sync some files from opt-in modules (mono, text_server_fb).

(cherry picked from commit 81064cc239)
2024-09-11 12:41:48 +02:00

73 lines
2.4 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeStateMachinePlayback" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<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>
<link>$DOCS_URL/tutorials/animation/animation_tree.html</link>
</tutorials>
<methods>
<method name="get_current_length" qualifiers="const">
<return type="float" />
<description>
</description>
</method>
<method name="get_current_node" qualifiers="const">
<return type="String" />
<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" />
<argument index="0" name="node" type="String" />
<description>
Starts playing the given animation.
</description>
</method>
<method name="stop">
<return type="void" />
<description>
Stops the currently playing animation.
</description>
</method>
<method name="travel">
<return type="void" />
<argument index="0" name="to_node" type="String" />
<description>
Transitions from the current state to another one, following the shortest path.
</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>