File: AnimationNodeStateMachinePlayback.xml

package info (click to toggle)
godot 3.2.3-stable-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 121,308 kB
  • sloc: cpp: 804,285; ansic: 597,434; xml: 77,823; asm: 17,127; cs: 13,535; lisp: 12,017; python: 9,376; java: 7,474; sh: 973; javascript: 659; perl: 264; pascal: 203; objc: 116; makefile: 105
file content (70 lines) | stat: -rw-r--r-- 2,138 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeStateMachinePlayback" inherits="Resource" version="3.2">
	<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>https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link>
	</tutorials>
	<methods>
		<method name="get_current_node" qualifiers="const">
			<return type="String">
			</return>
			<description>
				Returns the currently playing animation state.
			</description>
		</method>
		<method name="get_travel_path" qualifiers="const">
			<return type="PoolStringArray">
			</return>
			<description>
				Returns the current travel path as computed internally by the A* algorithm.
			</description>
		</method>
		<method name="is_playing" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Returns [code]true[/code] if an animation is playing.
			</description>
		</method>
		<method name="start">
			<return type="void">
			</return>
			<argument index="0" name="node" type="String">
			</argument>
			<description>
				Starts playing the given animation.
			</description>
		</method>
		<method name="stop">
			<return type="void">
			</return>
			<description>
				Stops the currently playing animation.
			</description>
		</method>
		<method name="travel">
			<return type="void">
			</return>
			<argument index="0" name="to_node" type="String">
			</argument>
			<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" override="true" default="true" />
	</members>
	<constants>
	</constants>
</class>