playerAPI_t Struct Reference

About this class

Player library.

Public Member Functions
vector	GetCameraPosition (void)
	Get the current 3D viewport's camera position. More...
vector	GetCameraAngles (void)
	Get the current 3D viewport's camera angle. More...
float	GetArmor (void)
	Get the current player's armor value. More...
float	GetHealth (void)
	Get the current player's health value. More...
float	GetStamina (void)
	Get the current player's stamina value. More...
int	GetTeam (void)
	Get the current player's team ID. More...
bool	IsStanding (void)
	Check if the current player is standing upright. More...
bool	IsLeaning (void)
	Check if the current player is leaning in any direction. More...
bool	IsSprinting (void)
	Check if the current player is actively sprinting. More...
bool	IsCrouched (void)
	Check if the current player is actively crouched/ducked. More...
bool	IsProne (void)
	Check if the current player is actively prone/laying flat on the ground. More...
bool	HasItem (string itemClassName)
	Check if the current player has a particular item. More...

Member Function Documentation

GetArmor()

float playerAPI_t::GetArmor

(

void

)

Get the current player's armor value.

Returns

the current armor value.

GetCameraAngles()

vector playerAPI_t::GetCameraAngles

(

void

)

Get the current 3D viewport's camera angle.

Returns

the direction the camera is facing in euler-angle form.

GetCameraPosition()

vector playerAPI_t::GetCameraPosition

(

void

)

Get the current 3D viewport's camera position.

Returns

the absolute world-space coordinate of the camera.

GetHealth()

float playerAPI_t::GetHealth

(

void

)

Get the current player's health value.

Returns

the current health value.

GetStamina()

float playerAPI_t::GetStamina

(

void

)

Get the current player's stamina value.

Returns

the current stamina value, ranging from 0.0f to 1.0f.

GetTeam()

int playerAPI_t::GetTeam

(

void

)

Get the current player's team ID.

Returns

the current player's team ID.

HasItem()

bool playerAPI_t::HasItem

(

string

itemClassName

)

Check if the current player has a particular item.

Parameters

itemClassName

the classname of the item. E.g. "item_suit"

Returns

whether the named item exists in the current player's inventory.

IsCrouched()

bool playerAPI_t::IsCrouched

(

void

)

Check if the current player is actively crouched/ducked.

Returns

whether the current player is crouched.

IsLeaning()

bool playerAPI_t::IsLeaning

(

void

)

Check if the current player is leaning in any direction.

Returns

whether the current player is leaning.

IsProne()

bool playerAPI_t::IsProne

(

void

)

Check if the current player is actively prone/laying flat on the ground.

Returns

whether the current player is prone.

IsSprinting()

bool playerAPI_t::IsSprinting

(

void

)

Check if the current player is actively sprinting.

Returns

whether the current player is sprinting.

IsStanding()

bool playerAPI_t::IsStanding

(

void

)

Check if the current player is standing upright.

As in, not ducking, prone. They may still be walking or running.

Returns

whether the current player is standing upright.

---

The documentation for this struct was generated from the following file:

• src/client/api_func.h