forked from Mirrors/openclonk
42 lines
1.8 KiB
XML
42 lines
1.8 KiB
XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
|
|
<!DOCTYPE funcs
|
|
SYSTEM '../../../clonk.dtd'>
|
|
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
|
|
<funcs>
|
|
<func>
|
|
<title>GetAnimationName</title>
|
|
<category>Animations</category>
|
|
<version>5.1 OC</version>
|
|
<syntax>
|
|
<rtype>string</rtype>
|
|
<params>
|
|
<param>
|
|
<type>int</type>
|
|
<name>animation_number</name>
|
|
<desc>Animation number of the animation whose name to retrieve.</desc>
|
|
</param>
|
|
<param>
|
|
<type>int</type>
|
|
<name>attach_number</name>
|
|
<desc>If given, refers to the number of the attached mesh to query instead of the object's main mesh.</desc>
|
|
<optional />
|
|
</param>
|
|
</params>
|
|
</syntax>
|
|
<desc>Returns the name of the animation with the given number. If there is no such animation with the given number or the number refers to a combination node then this function returns <code>nil</code>.</desc>
|
|
<remark>See the <emlink href="definition/animations.html">animation documentation</emlink> for further explanations of the animation system.</remark>
|
|
<examples>
|
|
<example>
|
|
<code><funclink>if</funclink>(<funclink>GetAnimationName</funclink>(<funclink>GetRootAnimation</funclink>(5)) == "Walk") <funclink>StopAnimation</funclink>(<funclink>GetRootAnimation</funclink>(5));</code>
|
|
<text>If there is only one animation being played in slot 5 and its name is "Walk" then that animation is stopped.</text>
|
|
</example>
|
|
</examples>
|
|
<related>
|
|
<funclink>PlayAnimation</funclink>
|
|
<funclink>StopAnimation</funclink>
|
|
<funclink>GetRootAnimation</funclink>
|
|
</related>
|
|
</func>
|
|
<author>Clonk-Karl</author><date>2010-01</date>
|
|
</funcs>
|