note Help Needed

This wiki is the result of an ongoing community effort — thank you all for helping!

If you want to provide changes to this page then please click here.

ClearAnimations

Description

Clears all animations for the given player (it also cancels all current tasks such as jetpacking, parachuting, entering vehicles, driving (removes player out of vehicle), swimming, etc).

Name	Description
playerid	The ID of the player to clear the animations of.
FORCE_SYNC:forceSync	Set to `SYNC_ALL` to force playerid to sync the animation with other players in streaming radius (default=SYNC_NONE)

Returns

This function always returns true, even when the player specified is not connected.

Examples

public OnPlayerCommandText(playerid, cmdtext[])
{
    if (!strcmp(cmdtext, "/animclear", true))
    {
        ClearAnimations(playerid);
        return 1;
    }
    return 0;
}

Notes

tip

ClearAnimations doesn't do anything when the animation ends if we pass 'true' for the freeze parameter in ApplyAnimation.

tip

Unlike some other ways to remove player from a vehicle, this will also reset the vehicle's velocity to zero, instantly stopping the car. Player will appear on top of the vehicle with the same location as he was in his car seat.

Related Functions

ApplyAnimation: Apply an animation to a player.