openclonk/docs/sdk/script/fn/SetAnimationWeight.xml

<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<!DOCTYPE funcs SYSTEM "../../../clonk.dtd">
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
  <func>
    <title>SetAnimationWeight</title>
    <category>Animationen</category>
    <version>4.10.0.0 OC</version>
    <syntax>
      <rtype>bool</rtype>
      <params>
        <param>
          <type>int</type>
          <name>animation_number</name>
          <desc>Animationsnummer der Animation deren Position gesetzt werden soll.</desc>
        </param>
        <param>
          <type>array</type>
          <name>weight</name>
          <desc>Bestimmt, wie die aktuelle Gewichtung der Animation berechnet wird, falls die Animation mit einer anderen Animation im gegebenen Slot kombiniert wird. Diese wird mittels Animationsfunktionen der Form "Anim_" angegeben.</desc>
        </param>
      </params>
    </syntax>

    <desc>Setzt die Gewichtung der angegebenen Animation neu. R<>ckgabewert true falls der neue AVP gesetzt wurde oder false wenn es keine Animation mit der angegebenen Nummer gibt oder es sich bei ihr um einen Animationsknoten handelt.</desc>

    <remark>Siehe die <emlink href="definition/animations.html">Animations-Dokumentation</emlink> f<>r eine Beschreibung des Animationssystems.</remark>

    <examples>
      <example>
	      <code>var angle = <funclink>Angle</funclink>(0, 0, <funclink>GetXDir</funclink>(), <funclink>GetYDir</funclink>());
<funclink>if</funclink>(angle > 360) angle = 360 - angle;
<funclink>SetAnimationWeight</funclink>(swim_comb, <funclink>Anim_Const</funclink>(500+<funclink>Cos</funclink>(angle, 500)));</code>
	<text>Ist in swim_comb die Animationsnummer eines Animationsknoten gespeichert, welcher eine Nach-Oben-Schwimmen- und eine Nach-Unten-Schwimmen-Animation kombiniert (siehe Beispiel zu <funclink>PlayAnimation</funclink>), so wird hier das Gewicht kosinusf<73>rmig abh<62>ngig von der aktuellen Schwimmrichtung gesetzt.</text>
      </example>
    </examples>

    <related>
      <funclink>PlayAnimation</funclink>
      <funclink>GetAnimationPosition</funclink>
      <funclink>SetAnimationPosition</funclink>
      <funclink>GetAnimationWeight</funclink>
      <funclink>Anim_Const</funclink>
      <funclink>Anim_Linear</funclink>
      <funclink>Anim_X</funclink>
      <funclink>Anim_Y</funclink>
      <funclink>Anim_AbsX</funclink>
      <funclink>Anim_AbsY</funclink>
      <funclink>Anim_XDir</funclink>
      <funclink>Anim_YDir</funclink>
      <funclink>Anim_Action</funclink>    </related>
  </func>
  <author>Clonk-Karl</author><date>Januar 2010</date>
</funcs>