marko10_000
/
openclonk
forked from Mirrors/openclonk
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Document attach_mesh parameter of the PlayAnimation function.

shapetextures
Sven Eberhardt 2015-09-12 11:06:19 -04:00
parent 0df19491e7
commit 6face464aa
2 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/sdk/script/fn/PlayAnimation.xml
View File

@ -36,6 +36,12 @@
<desc>If the animation is combined with another animation then this refers to the node with which the new node is combined. If not given or <code>nil</code> then the animation is combined with the animation at the top of the slot as returned by <funclink>GetRootAnimation</funclink>.</desc>
<optional />
</param>
<param>
<type>int</type>
<name>attach_number</name>
<desc>If given, refers to the number of the attached mesh on which the animation is to be played.</desc>
<optional />
</param>
</params>
</syntax>
<desc>Starts playing a new animation. The return value of this function is the animation number of the animation node inserted which can be used to manipulate or remove the animation later. If there are already animations in the given slot then additionally a combination node is created. This combination node is assigned the returned number plus 1.</desc>

12
docs/sdk/script/fn/SetAnimationPosition.xml
View File

@ -20,12 +20,12 @@
<name>position</name>
<desc>Specifies how to compute the position of the animation. The value needs to be created with one of the "Anim_" animation functions.</desc>
</param>
<param>
<type>int</type>
<name>attach_number</name>
<desc>If given, refers to the number of the attached mesh whose animation to change.</desc>
<optional />
</param>
<param>
<type>int</type>
<name>attach_number</name>
<desc>If given, refers to the number of the attached mesh whose animation to change.</desc>
<optional />
</param>
</params>
</syntax>
<desc>Sets a new position for the given animation. Returns <code>true</code> if the new AVP was set or <code>false</code> if there is no such animation with the given number or the number refers to a combination node.</desc>