2010-08-22 13:13:17 +00:00
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
< !DOCTYPE funcs
SYSTEM '../../../clonk.dtd'>
2010-01-24 22:12:49 +00:00
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs >
<func >
<title > SetAnimationPosition</title>
2010-08-22 13:13:17 +00:00
<category > Animations</category>
2011-06-30 10:52:55 +00:00
<version > 5.1 OC</version>
2010-01-24 22:12:49 +00:00
<syntax >
<rtype > bool</rtype>
<params >
<param >
<type > int</type>
2010-03-15 22:55:14 +00:00
<name > animation_number</name>
2010-08-22 13:13:17 +00:00
<desc > Animation number of the animation whose position to set.</desc>
2010-01-24 22:12:49 +00:00
</param>
<param >
<type > array</type>
2010-03-15 22:55:14 +00:00
<name > position</name>
2010-08-22 13:13:17 +00:00
<desc > Specifies how to compute the position of the animation. The value needs to be created with one of the "Anim_" animation functions.</desc>
2010-01-24 22:12:49 +00:00
</param>
2015-09-12 15:06:19 +00:00
<param >
<type > int</type>
<name > attach_number</name>
<desc > If given, refers to the number of the attached mesh whose animation to change.</desc>
<optional />
</param>
2010-01-24 22:12:49 +00:00
</params>
</syntax>
2011-07-30 23:32:02 +00:00
<desc > Sets a new position for the given animation. Returns <code > true</code> if the new AVP was set or <code > false</code> if there is no such animation with the given number or the number refers to a combination node.</desc>
2010-08-22 13:13:17 +00:00
<remark > See the <emlink href= "definition/animations.html" > animation documentation</emlink> for further explanations of the animation system.</remark>
2010-01-24 22:12:49 +00:00
<examples >
<example >
2010-03-15 22:55:14 +00:00
<code > <funclink > SetAnimationPosition</funclink> (animation_number, <funclink > Anim_Const</funclink> (<funclink > GetAnimationPosition</funclink> (animation_number)+100));</code>
2010-08-22 13:13:17 +00:00
<text > Script for a timer: For each call the animation is advanced by 100 milliseconds. If the timer is called periodically in same intervals <funclink > Anim_Linear</funclink> can be used instead.</text>
2010-01-24 22:12:49 +00:00
</example>
</examples>
<related >
<funclink > PlayAnimation</funclink>
<funclink > GetAnimationPosition</funclink>
<funclink > GetAnimationWeight</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_YDir</funclink>
2010-08-22 13:13:17 +00:00
<funclink > Anim_Action</funclink>
</related>
2010-01-24 22:12:49 +00:00
</func>
2010-08-22 13:13:17 +00:00
<author > Clonk-Karl</author> <date > 2010-01</date>
2010-01-24 22:12:49 +00:00
</funcs>