DestroyActor

DestroyActor

Description:

Function DestroyActor destroy an actor which was created with CreateActor.

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

Parameters:

(actorid)

int

actorid

The ID of the actor to destroy. Returned by CreateActor.

Return Values:

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

Examples:

Example 1

new MyActor;
 
public OnFilterScriptInit()
{
    MyActor = CreateActor(...);
    return 1;
}
 
public OnFilterScriptExit()
{
    DestroyActor(MyActor);
    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.
• 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.
• ApplyActorAnimation: Apply an animation to 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.