Anim_AbsY

Category: Animations
Since engine version: 1.0 OC

Description

The value depends on the movement of the object into Y direction. Every pixel the object moves into Y direction increases the value a little bit. Once end is reached the value is reset to begin. In contrast to Anim_Y the value always moves towards end, not depending on whether the object moves upwards or downwards.

Syntax

array Anim_AbsY(int position, int begin, int end, int length);

Parameters

position:
Start value. Should be inside the interval given by begin and end.
begin:
Start of the interval.
end:
End of the interval. If end is greater than begin then the value increases with every movement of the object, otherwise it decreases.
length:
Number of pixels that need to be moved in Y direction for the animation to be played from begin to end.

Remark

See the animation documentation for further explanations of the animation system.

Example

PlayAnimation("Lift", 5, Anim_AbsY(0, 0, GetAnimationLength("Lift"), 25), Anim_Const(1000));
Plays the animation "Lift" in slot 5 and superimposes any other potential animations played in slot 5. The animation is playdethe faster the faster the object moves into Y direction. After it moved 25 pixels the animation has been played from its beginning to its end and will be restarted.
See also: Anim_AbsX, Anim_Action, Anim_Const, Anim_Dist, Anim_Linear, Anim_R, Anim_X, Anim_XDir, Anim_Y, Anim_YDir, PlayAnimation, SetAnimationPosition, SetAnimationWeight
Clonk-Karl, 2010-01