7adf4cc9b5
For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
49 lines
2.3 KiB
XML
49 lines
2.3 KiB
XML
<?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 title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link>
|
|
<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="get_mix_mode" qualifiers="const">
|
|
<return type="int" enum="AnimationNodeOneShot.MixMode" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_mix_mode">
|
|
<return type="void" />
|
|
<argument index="0" name="mode" type="int" enum="AnimationNodeOneShot.MixMode" />
|
|
<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>
|