bz_getPlayerByIndex

From BZFlagWiki
Jump to: navigation, search

bz_BasePlayerRecord* bz_getPlayerByIndex (int index)


Gets the information for the player at the index specified. The index should be one of the elements of the list returned by bz_getPlayerIndexList. The returned player info won't update as the game progresses. If you need new updates on the player's info, you can call bz_updatePlayerData.

After you're done with the player info returned from this method, you must release it by calling bz_freePlayerRecord.

Parameters:
index  -  The index of the player in question, as obtained from bz_getPlayerIndexList
Returns:
an instance of bz_BasePlayerRecord that contains the player in question's information