GetActorHealth

GetActorHealth

Description:

Function GetActorHealth get the health of an actor.

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

Parameters:

(actorid, &Float:health)

int

actorid

The ID of the actor to get the health of.

float

health

A float variable, passed by reference, in to which to store the actor's health.

Return Values:

• 1 - success
• 0 - failure (i.e. actor is not created).
• NOTE: The actor's health is stored in the specified variable, not in the return value.

Examples:

Example 1

new MyActor;
 
public OnGameModeInit()
{
    MyActor = CreateActor(179, 316.1, -134.0, 999.6, 90.0); // Actor as salesperson in Ammunation
    SetActorHealth(MyActor, 100);
 
    new Float:actorHealth;
    GetActorHealth(MyActor, actorHealth);
    printf("Actor ID %d has %.2f health.", MyActor, actorHealth);
    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.
• ApplyActorAnimation: Apply an animation to an actor.
• ClearActorAnimations: Clear any animations applied to an actor.
• GetPlayerCameraTargetActor: Allows you to retrieve the ID of the actor the player is looking at (in any).
• IsActorStreamedIn: Checks if an actor is streamed in for a player.
• SetActorHealth: Set 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.