bz_getPlayerBySlotOrCallsign()

Available since 2.4.0

Gets the information for the player with the specified slot index or callsign. This function is intended to be used when implementing custom slash commands that take a player as a parameter.

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().

Usage

bz_BasePlayerRecord* bz_getPlayerBySlotOrCallsign(const char* name)

Parameters
const char*	name	The callsign of a player or the slot number (e.g. #2) of the player with the pound sign (#)

Returns

bz_BasePlayerRecord* - A pointer to the player record or NULL

Other Player Records Functions

• bz_freePlayerRecord()
• bz_getPlayerByIndex()
• bz_updatePlayerData()

Back to bzfs API Functions