GetPlayerTargetActor

GetPlayerTargetActor

Description:

Function GetPlayerTargetActor gets id of an actor which is aimed by certain player.

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

Does not work for joypads/controllers, and after a certain distance. Does not work for the sniper rifle, as it doesn't lock on to anything and as such can't and won't return a player.

Parameters:

(playerid)

int

playerid

The ID of the player to get the target of.

Return Values:

The ID of the targeted actor, or INVALID_ACTOR_ID if none.

Examples:

Example 1

public OnPlayerUpdate(playerid)
{
    new actorid = GetPlayerTargetActor(playerid);
 
    new string[32];
    format(string, sizeof(string), "You are aiming at actor id %d", actorid);
    SendClientMessage(playerid, -1, string);
    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.
• GetActorHealth: Get the health of an actor.
• SetActorInvulnerable: Toggle an actor's invulnerability.
• IsActorInvulnerable: Check if an actor is invulnerable.
• IsValidActor: Checks if an actor ID is valid.
• GetActorPoolSize: Gets the highest actorid created on the server.

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.