summaryrefslogtreecommitdiff
path: root/doc/classes/AnimationNodeOneShot.xml
blob: 4ba0b82df64997e9619ba35f7393cfa132aa35ca (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeOneShot" inherits="AnimationNode" version="4.0">
	<brief_description>
		Plays an animation once in [AnimationNodeBlendTree].
	</brief_description>
	<description>
		A resource to add to an [AnimationNodeBlendTree]. This node will execute a sub-animation and return once it finishes. Blend times for fading in and out can be customized, as well as filters.
	</description>
	<tutorials>
		<link>https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link>
	</tutorials>
	<methods>
		<method name="get_mix_mode" qualifiers="const">
			<return type="int" enum="AnimationNodeOneShot.MixMode">
			</return>
			<description>
			</description>
		</method>
		<method name="set_mix_mode">
			<return type="void">
			</return>
			<argument index="0" name="mode" type="int" enum="AnimationNodeOneShot.MixMode">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="autorestart" type="bool" setter="set_autorestart" getter="has_autorestart" default="false">
			If [code]true[/code], the sub-animation will restart automatically after finishing.
		</member>
		<member name="autorestart_delay" type="float" setter="set_autorestart_delay" getter="get_autorestart_delay" default="1.0">
			The delay after which the automatic restart is triggered, in seconds.
		</member>
		<member name="autorestart_random_delay" type="float" setter="set_autorestart_random_delay" getter="get_autorestart_random_delay" default="0.0">
			If [member autorestart] is [code]true[/code], a random additional delay (in seconds) between 0 and this value will be added to [member autorestart_delay].
		</member>
		<member name="fadein_time" type="float" setter="set_fadein_time" getter="get_fadein_time" default="0.1">
		</member>
		<member name="fadeout_time" type="float" setter="set_fadeout_time" getter="get_fadeout_time" default="0.1">
		</member>
		<member name="sync" type="bool" setter="set_use_sync" getter="is_using_sync" default="false">
		</member>
	</members>
	<constants>
		<constant name="MIX_MODE_BLEND" value="0" enum="MixMode">
		</constant>
		<constant name="MIX_MODE_ADD" value="1" enum="MixMode">
		</constant>
	</constants>
</class>