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

40 lines
1.8 KiB
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>GetAnimationPosition</title>
<category>Animationen</category>
<version>4.10.0.0 OC</version>
<syntax>
<rtype>int</rtype>
<params>
<param>
<type>int</type>
<name>iAnimationNumber</name>
<desc>Animationsnummer der Animation deren Position abgefragt werden soll.</desc>
</param>
</params>
</syntax>
<desc>Gibt die Stelle zurück an der die Animation mit der angegebenen Nummer gerade ist. Die Zahl liegt zwischen 0 und <funclink>GetAnimationLength</funclink>(<funclink>GetAnimationName</funclink>(iAnimationNumber)). Falls es keine Animation mit der angegebenen Nummer gibt oder es sich dabei um einen Kombinationsknoten handelt gibt die Funktion nil zurück.</desc>
<remark>Siehe die <emlink href="definition/animations.html">Animations-Dokumentation</emlink> für eine Beschreibung des Animationssystems.</remark>
<examples>
<example>
<code><funclink>SetAnimationPosition</funclink>(iAnimationNumber, <funclink>Anim_Const</funclink>(<funclink>GetAnimationPosition</funclink>(iAnimationNumber)+100));</code>
<text>Script für einen Timer: Bei jeder Durchführung wird die Animation um 100 Millisekunden weitergespielt. Falls der Timer im gleichen Abstand aufgerufen wird kann stattdessen auch <funclink>Anim_Linear</funclink> verwendet werden.</text>
</example>
</examples>
<related>
<funclink>PlayAnimation</funclink>
<funclink>SetAnimationPosition</funclink>
<funclink>GetAnimationWeight</funclink>
<funclink>SetAnimationWeight</funclink>
</related>
</func>
<author>Clonk-Karl</author><date>Januar 2010</date>
</funcs>