This wiki is archived and useful information is being migrated to the main bzflag.org website

bz_getPlayerBySlotOrCallsign

From BZFlagWiki
Revision as of 04:19, 30 June 2015 by Allejo (Talk | contribs) (Grammatical errors)

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

bz_BasePlayerRecord* bz_getPlayerBySlotOrCallsign (const char* name)


Minimum API Version: 2.4.3
Gets the information for the player with the specified slot index or callsign. 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:
name  -  The callsign of a player or the slot number (e.g. #2) of the player with the pound sign (#)
Returns:
an instance of bz_BasePlayerRecord for the target player