|
| vector | GetCameraPosition (void) |
| | Get the current 3D viewport's camera position.
|
| |
| vector | GetCameraAngles (void) |
| | Get the current 3D viewport's camera angle.
|
| |
| float | GetArmor (void) |
| | Get the current player's armor value.
|
| |
| float | GetHealth (void) |
| | Get the current player's health value.
|
| |
| float | GetStamina (void) |
| | Get the current player's stamina value.
|
| |
| int | GetTeam (void) |
| | Get the current player's team ID.
|
| |
| bool | IsStanding (void) |
| | Check if the current player is standing upright.
|
| |
| bool | IsLeaning (void) |
| | Check if the current player is leaning in any direction.
|
| |
| bool | IsSprinting (void) |
| | Check if the current player is actively sprinting.
|
| |
| bool | IsCrouched (void) |
| | Check if the current player is actively crouched/ducked.
|
| |
| bool | IsProne (void) |
| | Check if the current player is actively prone/laying flat on the ground.
|
| |
| bool | IsMoving (void) |
| | Check if the current player is actively moving.
|
| |
| bool | IsFalling (void) |
| | Check if the current player is not on ground.
|
| |
| bool | HasItem (string itemClassName) |
| | Check if the current player has a particular item.
|
| |
| string | GetString (string userKey) |
| | Returns the string value of the current/active player's info-key.
|
| |
| int | GetInteger (string userKey) |
| | Returns the integer value of a current/active player's info-key.
|
| |
| float | GetFloat (string userKey) |
| | Returns the floating-point value of a current/active player's info-key.
|
| |
| bool | GetBool (string userKey) |
| | Returns the boolean value of a current/active player's info-key.
|
| |
| vector | GetVector (string userKey) |
| | Returns the vector value of a current/active player's info-key.
|
| |
| float | GetGameFlags (void) |
| | Returns the game flags of the player entity.
|
| |
◆ GetArmor()
| float playerAPI_t::GetArmor |
( |
void | | ) |
|
Get the current player's armor value.
- Returns
- the current armor value.
◆ GetBool()
| bool playerAPI_t::GetBool |
( |
string | userKey | ) |
|
Returns the boolean value of a current/active player's info-key.
- Parameters
-
| userKey | specifies the user info-key to query. |
- Returns
- The value in boolean form.
◆ 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.
◆ GetFloat()
| float playerAPI_t::GetFloat |
( |
string | userKey | ) |
|
Returns the floating-point value of a current/active player's info-key.
- Parameters
-
| userKey | specifies the user info-key to query. |
- Returns
- The value in floating-point format.
◆ GetGameFlags()
| float playerAPI_t::GetGameFlags |
( |
void | | ) |
|
Returns the game flags of the player entity.
These are highly performant, predicted, game specific flags. Use these if infokeys are too expensive.
- Returns
- The gameflag bitfield in float form.
◆ GetHealth()
| float playerAPI_t::GetHealth |
( |
void | | ) |
|
Get the current player's health value.
- Returns
- the current health value.
◆ GetInteger()
| int playerAPI_t::GetInteger |
( |
string | userKey | ) |
|
Returns the integer value of a current/active player's info-key.
- Parameters
-
| userKey | specifies the user info-key to query. |
- Returns
- The value in integer format.
◆ 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.
◆ GetString()
| string playerAPI_t::GetString |
( |
string | userKey | ) |
|
Returns the string value of the current/active player's info-key.
- Parameters
-
| userKey | specifies the user info-key to query. |
- Returns
- The value in string format.
◆ GetTeam()
| int playerAPI_t::GetTeam |
( |
void | | ) |
|
Get the current player's team ID.
- Returns
- the current player's team ID.
◆ GetVector()
| vector playerAPI_t::GetVector |
( |
string | userKey | ) |
|
Returns the vector value of a current/active player's info-key.
- Parameters
-
| userKey | specifies the user info-key to query. |
- Returns
- The value in vector form.
◆ 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.
◆ IsFalling()
| bool playerAPI_t::IsFalling |
( |
void | | ) |
|
Check if the current player is not on ground.
- Returns
- whether the current player is falling.
◆ IsLeaning()
| bool playerAPI_t::IsLeaning |
( |
void | | ) |
|
Check if the current player is leaning in any direction.
- Returns
- whether the current player is leaning.
◆ IsMoving()
| bool playerAPI_t::IsMoving |
( |
void | | ) |
|
Check if the current player is actively moving.
- Returns
- whether the current player is moving.
◆ 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:
