<?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>GetAnimationWeight</title>
    <category>Animations</category>
    <version>5.1 OC</version>
    <syntax>
      <rtype>int</rtype>
      <params>
        <param>
          <type>int</type>
          <name>animation_number</name>
          <desc>Animation number of which the weight must be queried.</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 weight of a combination node. The weight specifies the relative portion the combined animations contribute to the resulting animation. The number is always between 0 (only the first animation contributes) and 1000 (only the second animation contributes). Returns <code>nil</code> if there is no such animation with the calling number or if the number refers to an animation node.</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>GetAnimationWeight</funclink>(animation_number) == 1000) <funclink>StopAnimation</funclink>(animation_number);</code>
        <text>Removes the combination node "animation_number" if its weight has reached the value 1000.</text>
      </example>
    </examples>
    <related>
      <funclink>PlayAnimation</funclink>
      <funclink>GetAnimationPosition</funclink>
      <funclink>SetAnimationPosition</funclink>
      <funclink>SetAnimationWeight</funclink>
    </related>
  </func>
  <author>Clonk-Karl</author><date>2010-01</date>
</funcs>
