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

57 lines
2.2 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>Anim_YDir</title>
<category>Animationen</category>
<version>4.10.0.0 OC</version>
<syntax>
<rtype>array</rtype>
<params>
<param>
<type>int</type>
<name>iBegin</name>
<desc>Beginn des Intervalls.</desc>
</param>
<param>
<type>int</type>
<name>iEnd</name>
<desc>Schluss des Intervalls. Wenn iEnd größer als iBegin ist, so nimmt der Wert mit größerer XDir zu, sonst nimmt er ab.</desc>
</param>
<param>
<type>int</type>
<name>iMaxYDir</name>
<desc>Größter Wert der YDir der abgebildet soll. Noch größere Geschwindigkeiten führen zum gleichen Animationswert (iEnd).</desc>
</param>
</params>
</syntax>
<desc>Der Wert ist proportional zur Y-Geschwindigkeit des Objekts. Die Geschwindigkeiten 0 bis iMaxYDir werden linear auf den Wertebereich von iBegin bis iEnd abgebildet.</desc>
<remark>Siehe die <emlink href="definition/animations.html">Animations-Dokumentation</emlink> für eine Beschreibung des Animationssystems.</remark>
<examples>
<example>
<code><funclink>PlayAnimation</funclink>("ShowSpeed", 10, <funclink>Anim_YDir</funclink>(0, <funclink>GetAnimationLength</funclink>("ShowSpeed"), 100), <funclink>Anim_Const</funclink>(1000));</code>
<text>Spielt die Animation "ShowSpeed" in Slot 10 ab. Diese könnte eine Geschwindigkeitsanzeige in einem Aufzug darstellen.</text>
</example>
</examples>
<related>
<funclink>PlayAnimation</funclink>
<funclink>SetAnimationPosition</funclink>
<funclink>SetAnimationWeight</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_Action</funclink>
</related>
</func>
<author>Clonk-Karl</author><date>Januar 2010</date>
</funcs>