summaryrefslogtreecommitdiff
path: root/doc/classes/AnimationNodeStateMachineTransition.xml
blob: d18d5ee63088e64a13f294468768b300f91c5e6f (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeStateMachineTransition" inherits="Resource" category="Core" version="3.2">
	<brief_description>
	</brief_description>
	<description>
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
	</methods>
	<members>
		<member name="advance_condition" type="String" setter="set_advance_condition" getter="get_advance_condition">
			Turn on auto advance when this condition is set. This is a custom text field that can be filled with a variable name. The variable can be modified from code.
		</member>
		<member name="auto_advance" type="bool" setter="set_auto_advance" getter="has_auto_advance">
			Turn on the transition automatically when this state is reached. This works best with [code]SWITCH_MODE_AT_END[/code].
		</member>
		<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled">
			Don't use this transition during [method AnimationNodeStateMachinePlayback.travel] or [member auto_advance].
		</member>
		<member name="priority" type="int" setter="set_priority" getter="get_priority">
			Lower priority transitions are preferred when travelling through the tree via [method AnimationNodeStateMachinePlayback.travel] or [member auto_advance].
		</member>
		<member name="switch_mode" type="int" setter="set_switch_mode" getter="get_switch_mode" enum="AnimationNodeStateMachineTransition.SwitchMode">
			The transition type.
		</member>
		<member name="xfade_time" type="float" setter="set_xfade_time" getter="get_xfade_time">
			The time to cross-fade between this state and the next.
		</member>
	</members>
	<signals>
		<signal name="advance_condition_changed">
			<description>
			</description>
		</signal>
	</signals>
	<constants>
		<constant name="SWITCH_MODE_IMMEDIATE" value="0" enum="SwitchMode">
			Switch to the next state immediately. The current state will end and blend into the beginning of the new one.
		</constant>
		<constant name="SWITCH_MODE_SYNC" value="1" enum="SwitchMode">
			Switch to the next state immediately, but will seek the new state to the playback position of the old state.
		</constant>
		<constant name="SWITCH_MODE_AT_END" value="2" enum="SwitchMode">
			Wait for the current state playback to end, then switch to the beginning of the next state animation.
		</constant>
	</constants>
</class>