summaryrefslogtreecommitdiff
path: root/doc/classes/AnimationNodeTransition.xml
blob: 90bae41586fe519fdebe76ad7407f15562d6011d (plain)
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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeTransition" inherits="AnimationNodeSync" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A generic animation transition node for [AnimationTree].
	</brief_description>
	<description>
		Simple state machine for cases which don't require a more advanced [AnimationNodeStateMachine]. Animations can be connected to the inputs and transition times can be specified.
	</description>
	<tutorials>
		<link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link>
		<link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link>
		<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>
	</tutorials>
	<methods>
		<method name="find_input_caption" qualifiers="const">
			<return type="int" />
			<param index="0" name="caption" type="String" />
			<description>
				Returns the input index which corresponds to [param caption]. If not found, returns [code]-1[/code].
			</description>
		</method>
		<method name="get_input_caption" qualifiers="const">
			<return type="String" />
			<param index="0" name="input" type="int" />
			<description>
				Returns the name of the input at the given [param input] index. This name is displayed in the editor next to the node input.
			</description>
		</method>
		<method name="is_input_set_as_auto_advance" qualifiers="const">
			<return type="bool" />
			<param index="0" name="input" type="int" />
			<description>
				Returns [code]true[/code] if auto-advance is enabled for the given [param input] index.
			</description>
		</method>
		<method name="set_input_as_auto_advance">
			<return type="void" />
			<param index="0" name="input" type="int" />
			<param index="1" name="enable" type="bool" />
			<description>
				Enables or disables auto-advance for the given [param input] index. If enabled, state changes to the next input after playing the animation once. If enabled for the last input state, it loops to the first.
			</description>
		</method>
		<method name="set_input_caption">
			<return type="void" />
			<param index="0" name="input" type="int" />
			<param index="1" name="caption" type="String" />
			<description>
				Sets the name of the input at the given [param input] index. This name is displayed in the editor next to the node input.
			</description>
		</method>
	</methods>
	<members>
		<member name="enabled_inputs" type="int" setter="set_enabled_inputs" getter="get_enabled_inputs" default="0">
			The number of enabled input ports for this node. The maximum is [code]31[/code].
		</member>
		<member name="reset" type="bool" setter="set_reset" getter="is_reset" default="true">
			If [code]true[/code], the destination animation is played back from the beginning when switched.
		</member>
		<member name="xfade_curve" type="Curve" setter="set_xfade_curve" getter="get_xfade_curve">
			Determines how cross-fading between animations is eased. If empty, the transition will be linear.
		</member>
		<member name="xfade_time" type="float" setter="set_xfade_time" getter="get_xfade_time" default="0.0">
			Cross-fading time (in seconds) between each animation connected to the inputs.
		</member>
	</members>
</class>