Added some explanations that should make it easier to use the AnimationTreePlayer
This commit is contained in:
Grosskopf
Rémi Verschelde
parent
1ca4ad2cca
commit
a9b18041fc
1 changed files with 27 additions and 8 deletions
|
|
@ -1,10 +1,11 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="AnimationTreePlayer" inherits="Node" category="Core" version="3.0-beta">
|
||||
<brief_description>
|
||||
Animation Player that uses a node graph for the blending.
|
||||
Animation Player that uses a node graph for blending Animations.
|
||||
</brief_description>
|
||||
<description>
|
||||
A node graph tool for blending multiple animations bound to an [AnimationPlayer]. Especially useful for animating characters or other skeleton-based rigs. It can combine several animations to form a desired pose.
|
||||
It takes [Animation]s from an [AnimationPlayer] node and mixes them depending on the graph.
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
|
|
@ -37,7 +38,7 @@
|
|||
<argument index="0" name="id" type="String">
|
||||
</argument>
|
||||
<description>
|
||||
Returns the [AnimationPlayer]'s animation bound to the [code]AnimationTreePlayer[/code]'s animation node with name [code]id[/code].
|
||||
Returns the [AnimationPlayer]'s [Animation] bound to the [code]AnimationTreePlayer[/code]'s animation node with name [code]id[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="animation_node_get_master_animation" qualifiers="const">
|
||||
|
|
@ -46,7 +47,7 @@
|
|||
<argument index="0" name="id" type="String">
|
||||
</argument>
|
||||
<description>
|
||||
Returns the name of the [member master_player]'s animation bound to this animation node.
|
||||
Returns the name of the [member master_player]'s [Animation] bound to this animation node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="animation_node_set_animation">
|
||||
|
|
@ -57,7 +58,7 @@
|
|||
<argument index="1" name="animation" type="Animation">
|
||||
</argument>
|
||||
<description>
|
||||
Binds a new animation from the [member master_player] to the [code]AnimationTreePlayer[/code]'s animation node with name [code]id[/code].
|
||||
Binds a new [Animation] from the [member master_player] to the [code]AnimationTreePlayer[/code]'s animation node with name [code]id[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="animation_node_set_filter_path">
|
||||
|
|
@ -81,7 +82,7 @@
|
|||
<argument index="1" name="source" type="String">
|
||||
</argument>
|
||||
<description>
|
||||
Binds the animation named [code]source[/code] from [member master_player] to the animation node [code]id[/code]. Recalculates caches.
|
||||
Binds the [Animation] named [code]source[/code] from [member master_player] to the animation node [code]id[/code]. Recalculates caches.
|
||||
</description>
|
||||
</method>
|
||||
<method name="are_nodes_connected" qualifiers="const">
|
||||
|
|
@ -115,6 +116,10 @@
|
|||
</argument>
|
||||
<description>
|
||||
Sets the blend amount of a Blend2 node given its name and value.
|
||||
A Blend2 Node blends two animations with the amount between 0 and 1.
|
||||
At 0, Output is input a.
|
||||
Towards 1, the influence of a gets lessened, the influence of b gets raised.
|
||||
At 1, Output is input b.
|
||||
</description>
|
||||
</method>
|
||||
<method name="blend2_node_set_filter_path">
|
||||
|
|
@ -148,6 +153,12 @@
|
|||
</argument>
|
||||
<description>
|
||||
Sets the blend amount of a Blend3 node given its name and value.
|
||||
A Blend3 Node blends three animations with the amount between -1 and 1.
|
||||
At -1, Output is input b-.
|
||||
From -1 to 0, the influence of b- gets lessened, the influence of a gets raised and the influence of b+ is 0.
|
||||
At 0, Output is input a.
|
||||
From 0 to 1, the influence of a gets lessened, the influence of b+ gets raised and the influence of b+ is 0.
|
||||
At 1, Output is input b+.
|
||||
</description>
|
||||
</method>
|
||||
<method name="blend4_node_get_amount" qualifiers="const">
|
||||
|
|
@ -168,6 +179,8 @@
|
|||
</argument>
|
||||
<description>
|
||||
Sets the blend amount of a Blend4 node given its name and value.
|
||||
A Blend4 Node blends two pairs of animations.
|
||||
The two pairs are blended like blend2 and then added together.
|
||||
</description>
|
||||
</method>
|
||||
<method name="connect_nodes">
|
||||
|
|
@ -198,7 +211,7 @@
|
|||
<return type="PoolStringArray">
|
||||
</return>
|
||||
<description>
|
||||
Returns a PoolStringArray containing the name of all nodes.
|
||||
Returns a [PoolStringArray] containing the name of all nodes.
|
||||
</description>
|
||||
</method>
|
||||
<method name="mix_node_get_amount" qualifiers="const">
|
||||
|
|
@ -219,6 +232,7 @@
|
|||
</argument>
|
||||
<description>
|
||||
Sets mix amount of a Mix node given its name and value.
|
||||
A Mix node adds input b to input a by a the amount given by ratio.
|
||||
</description>
|
||||
</method>
|
||||
<method name="node_exists" qualifiers="const">
|
||||
|
|
@ -450,7 +464,7 @@
|
|||
<return type="void">
|
||||
</return>
|
||||
<description>
|
||||
Resets this AnimationTreePlayer.
|
||||
Resets this [code]AnimationTreePlayer[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="timescale_node_get_scale" qualifiers="const">
|
||||
|
|
@ -471,6 +485,8 @@
|
|||
</argument>
|
||||
<description>
|
||||
Sets the time scale of the TimeScale node with name [code]id[/code] to [code]scale[/code].
|
||||
The timescale node is used to speed [Animation]s up if the scale is above 1 or slow them down if it is below 1.
|
||||
If applied after a blend or mix, affects all input animations to that blend or mix.
|
||||
</description>
|
||||
</method>
|
||||
<method name="timeseek_node_seek">
|
||||
|
|
@ -482,6 +498,7 @@
|
|||
</argument>
|
||||
<description>
|
||||
Sets the time seek value of the TimeSeek node with name [code]id[/code] to [code]seconds[/code]
|
||||
This functions as a seek in the [Animation] or the blend or mix of [Animation]s input in it.
|
||||
</description>
|
||||
</method>
|
||||
<method name="transition_node_delete_input">
|
||||
|
|
@ -510,7 +527,7 @@
|
|||
<argument index="0" name="id" type="String">
|
||||
</argument>
|
||||
<description>
|
||||
Returns the number of inputs for the transition node with name [code]id[/code].
|
||||
Returns the number of inputs for the transition node with name [code]id[/code]. You can add inputs by rightclicking on the transition node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="transition_node_get_xfade_time" qualifiers="const">
|
||||
|
|
@ -586,9 +603,11 @@
|
|||
</member>
|
||||
<member name="base_path" type="NodePath" setter="set_base_path" getter="get_base_path">
|
||||
The node from which to relatively access other nodes. Default value: [code]".."[/code].
|
||||
It accesses the Bones, so it should point to the same Node the AnimationPlayer would point its Root Node at.
|
||||
</member>
|
||||
<member name="master_player" type="NodePath" setter="set_master_player" getter="get_master_player">
|
||||
The path to the [AnimationPlayer] from which this [code]AnimationTreePlayer[/code] binds animations to animation nodes.
|
||||
Once set, Animation nodes can be added to the AnimationTreePlayer.
|
||||
</member>
|
||||
<member name="playback_process_mode" type="int" setter="set_animation_process_mode" getter="get_animation_process_mode" enum="AnimationTreePlayer.AnimationProcessMode">
|
||||
The thread in which to update animations. Default value: [enum ANIMATION_PROCESS_IDLE].
|
||||
|
|
|
|||
Loading…
Reference in a new issue