bz_getPlayerCurrentState()

Available since 2.4.0

Gets the specified player's current state. This includes information about how fast they're traveling, if they're in the air, if they're rotating, and more.

A player's state changes very frequently (since players are typically on the move, fighting, and jumping, just to name a few), so the data obtained from this method won't be valid for very long.

Usage

void bz_getPlayerCurrentState(int playerID, bz_PlayerUpdateState &state)

Parameters
int	playerID	The id of the player to target
bz_PlayerUpdateState	&state	A reference to a bz_PlayerUpdateState object to put the player state information into.

Other Player State Functions

• bz_getPlayerSpawnAtBase()
• bz_isPlayerPaused()
• bz_isPlayerSpawnable()
• bz_setPlayerSpawnAtBase()
• bz_setPlayerSpawnable()

Back to bzfs API Functions