bz_getPlayerCurrentState

From BZFlagWiki
Revision as of 07:03, 15 December 2008 by Javawizard2539 (Talk | contribs) (New page: {{apicall | name = bz_getPlayerCurrentState | description = Gets the specified player's current state. This includes information about how fast they're traveling, if they're in ...)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

void bz_getPlayerCurrentState (int playerID, bz_PlayerUpdateState& state)


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.

Parameters:
playerID  -  The id of the player to get the state for
state  -  A bz_PlayerUpdateState to put the information of the player specified by playerID into