ApplyActorAnimation

ApplyActorAnimation

Description:

Function ApplyActorAnimation apply an animation to an actor.

Function ApplyActorAnimation was added in 0.3.7 and will not work in earlier versions!

You must preload the animation library for the player the actor will be applying the animation for, and not for the actor. Otherwise, the animation won't be applied to the actor until the function is executed again.

Parameters:

(actorid, animlib[], animname[], Float:fDelta, loop, lockx, locky, freeze, time)

int

actorid

The ID of the actor to apply the animation to.

string

animlib

The animation library from which to apply an animation.

string

animname

The name of the animation to apply, within the specified library.

float

fDelta

The speed to play the animation (use 4.1).

bool

loop

If set to 1, the animation will loop. If set to 0, the animation will play once.

bool

lockx

If set to 0, the actor is returned to their old X coordinate once the animation is complete (for animations that move the actor such as walking). 1 will not return them to their old position.

bool

locky

Same as above but for the Y axis. Should be kept the same as the previous parameter.

bool

freeze

Setting this to 1 will freeze an actor at the end of the animation. 0 will not.

int

time

Timer in milliseconds. For a never-ending loop it should be 0.

Return Values:

• 1: The function was executed successfully.
• 0: The function failed to execute. The actor specified does not exist.

Examples:

Example 1

new MyActor;
 
public OnGameModeInit()
{
    MyActor = CreateActor(179, 316.1, -134.0, 999.6, 90.0); // Actor as salesperson in Ammunation
    ApplyActorAnimation(MyActor, "DEALER", "shop_pay", 4.1, 0, 0, 0, 0, 0); // Pay anim
    return 1;
}

Related Functions

The following functions may be useful, as they are related to this function in one way or another.

• CreateActor: Create a static 'actor' in the world.
• DestroyActor: Destroy an actor which was created with CreateActor.
• SetActorPos: Set the position of an actor.
• GetActorPos: Get the position of an actor.
• SetActorFacingAngle: Set the facing angle of an actor.
• GetActorFacingAngle: Get the facing angle of an actor.
• SetActorVirtualWorld: Set the virtual world of an actor.
• GetActorVirtualWorld: Get the virtual world of an actor.
• ClearActorAnimations: Clear any animations that are applied to an actor.
• GetPlayerCameraTargetActor: Get the ID of the actor (if any) a player is looking at.
• IsActorStreamedIn: Checks if an actor is streamed in for a player.
• SetActorHealth: Set the health of an actor.
• GetActorHealth: Gets the health of an actor.
• SetActorInvulnerable: Set actor invulnerable.
• IsActorInvulnerable: Check if actor is invulnerable.
• IsValidActor: Check if actor id is valid.
• GetActorPoolSize: Gets the highest actorid created on the server.
• GetPlayerTargetActor: Gets the ID of an actor which is aimed by certain player.

Related Callbacks

The following callbacks might be useful as well, as they are related to this callback in one way or another.

• OnActorStreamIn: Called when an actor is streamed in by a player.
• OnActorStreamOut: Called when an actor is streamed out by a player.
• OnPlayerGiveDamageActor: This callback is called when a player gives damage to an actor.