ApplyAnimation
From SA-MP Wiki
(Difference between revisions)
Revision as of 09:28, 12 October 2014 JernejL (Talk | contribs) ← Previous diff |
Current revision RoboN1X (Talk | contribs) (note) |
||
Line 17: | Line 17: | ||
{{Returns|This function always returns '''1''', even if the player specified does not exist, or any of the parameters are invalid (e.g. invalid library).}} | {{Returns|This function always returns '''1''', even if the player specified does not exist, or any of the parameters are invalid (e.g. invalid library).}} | ||
- | {{Note2|An invalid animation library will crash the player's game.}} | + | {{Note2| |
+ | *An invalid animation library will crash the player's game. | ||
+ | *An empty animation library or name will crash the server. | ||
+ | }} | ||
{{Example}} | {{Example}} |
Current revision
Description:
Apply an animation to a player.
(playerid, animlib[], animname[], Float:fDelta, loop, lockx, locky, freeze, time, forcesync)
playerid | The ID of the player to apply the animation to. |
animlib[] | The animation library from which to apply an animation. |
animname[] | The name of the animation to apply, within the specified library. |
fDelta | The speed to play the animation (use 4.1). |
loop | If set to 1, the animation will loop. If set to 0, the animation will play once. |
lockx | If set to 0, the player is returned to their old X coordinate once the animation is complete (for animations that move the player such as walking). 1 will not return them to their old position. |
locky | Same as above but for the Y axis. Should be kept the same as the previous parameter. |
freeze | Setting this to 1 will freeze the player at the end of the animation. 0 will not. |
time | Timer in milliseconds. For a never-ending loop it should be 0. |
forcesync | Set to 1 to make server sync the animation with all other players in streaming radius (optional). 2 works same as 1, but will ONLY apply the animation to streamed-in players, but NOT the actual player being animated (useful for npc animations and persistent animations when players are being streamed) |
Return Values:
This function always returns 1, even if the player specified does not exist, or any of the parameters are invalid (e.g. invalid library).
Important |
|
Example Usage:
ApplyAnimation(playerid, "PED", "WALK_DRUNK", 4.1, 1, 1, 1, 1, 1, 1);
[edit]
Related Functions
The following functions may be useful, as they are related to this function in one way or another.
- ClearAnimations: Clear any animations a player is performing.
- SetPlayerSpecialAction: Set a player's special action.