asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #73112 from TokageItLab/more-animation-docs

Browse source 
Completion of parameters not described in some animation resources
This commit is contained in:
Rémi Verschelde 2023-02-11 22:02:47 +01:00
commit 612533da80
No known key found for this signature in database
GPG key ID: C3336907360768E1
3 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/classes/AnimationNodeAnimation.xml
View file

@ -21,8 +21,10 @@
</members> </members>
<constants> <constants>
<constant name="PLAY_MODE_FORWARD" value="0" enum="PlayMode"> <constant name="PLAY_MODE_FORWARD" value="0" enum="PlayMode">
Plays animation in forward direction.
</constant> </constant>
<constant name="PLAY_MODE_BACKWARD" value="1" enum="PlayMode"> <constant name="PLAY_MODE_BACKWARD" value="1" enum="PlayMode">
Plays animation in backward direction.
</constant> </constant>
</constants> </constants>
</class> </class>

2
doc/classes/AnimationNodeOneShot.xml
View file

@ -46,7 +46,7 @@
The fade-in duration. For example, setting this to [code]1.0[/code] for a 5 second length animation will produce a crossfade that starts at 0 second and ends at 1 second during the animation. The fade-in duration. For example, setting this to [code]1.0[/code] for a 5 second length animation will produce a crossfade that starts at 0 second and ends at 1 second during the animation.
</member> </member>
<member name="fadeout_time" type="float" setter="set_fadeout_time" getter="get_fadeout_time" default="0.0"> <member name="fadeout_time" type="float" setter="set_fadeout_time" getter="get_fadeout_time" default="0.0">
The fade-in duration. For example, setting this to [code]1.0[/code] for a 5 second length animation will produce a crossfade that starts at 4 second and ends at 5 second during the animation. The fade-out duration. For example, setting this to [code]1.0[/code] for a 5 second length animation will produce a crossfade that starts at 4 second and ends at 5 second during the animation.
</member> </member>
<member name="mix_mode" type="int" setter="set_mix_mode" getter="get_mix_mode" enum="AnimationNodeOneShot.MixMode" default="0"> <member name="mix_mode" type="int" setter="set_mix_mode" getter="get_mix_mode" enum="AnimationNodeOneShot.MixMode" default="0">
The blend type. The blend type.

3
doc/classes/AnimationNodeStateMachineTransition.xml
View file

@ -1,8 +1,11 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeStateMachineTransition" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <class name="AnimationNodeStateMachineTransition" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description> <brief_description>
A resource to connect each node to make a path for [AnimationNodeStateMachine].
</brief_description> </brief_description>
<description> <description>
The path generated when using [method AnimationNodeStateMachinePlayback.travel] is limited to the nodes connected by [AnimationNodeStateMachineTransition].
You can set the timing and conditions of the transition in detail.
</description> </description>
<tutorials> <tutorials>
<link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link> <link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link>