virtualx-engine/doc/classes/AnimationNodeTransition.xml
Tomasz Chabora 3739f03d98 Add LOTS of missing docs
(cherry picked from commit e103f21a40)
2020-03-13 17:26:30 +01:00

60 lines
1.9 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeTransition" inherits="AnimationNode" version="3.2">
<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>https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link>
</tutorials>
<methods>
<method name="get_input_caption" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="input" type="int">
</argument>
<description>
</description>
</method>
<method name="is_input_set_as_auto_advance" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="input" type="int">
</argument>
<description>
</description>
</method>
<method name="set_input_as_auto_advance">
<return type="void">
</return>
<argument index="0" name="input" type="int">
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_input_caption">
<return type="void">
</return>
<argument index="0" name="input" type="int">
</argument>
<argument index="1" name="caption" type="String">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="input_count" type="int" setter="set_enabled_inputs" getter="get_enabled_inputs" default="0">
The number of available input ports for this node.
</member>
<member name="xfade_time" type="float" setter="set_cross_fade_time" getter="get_cross_fade_time" default="0.0">
Cross-fading time (in seconds) between each animation connected to the inputs.
</member>
</members>
<constants>
</constants>
</class>