GetPlayerStatus

From The KillerJim Mod Wiki

PlayerProxy::GetPlayerStatus

GetPlayerStatus.png

Client/Server Function - This API calls works on both clients and servers

Description

This function is commonly used to get important information about the player; it provides a number of fields that provide health, whether the layer is dead, etc.

On the server information is updated immediately (i.e. after a SetHealth the health value will be correct], on clients the information is replicated out so is made available after any network latency has been taken into account.

This function is normally used on server-side for AI functions, i.e. for NPC's to attach an alive player reducing their health or on the client side to visualize the health, etc. of a player.

Arguments

None

Return Values
1 KJModPlayerStatus Status
A structure providing key player information

Playing

Developers

Developer Reference