bz_getPlayerIndexList()

Available since 2.4.0

Get a list of player IDs who are currently on the server.

If you pass a pointer to an bz_APIIntList* as a parameter, it will write to that pointer. If no parameter is given, the API will create a new pointer and return it.

The pointer returned by this function must be freed when you're done by calling bz_deleteIntList(). This list is not updated as players join or part; a new list must be created each time you wish to get a list of players.

Usage

bz_APIIntList* bz_getPlayerIndexList()

bool bz_getPlayerIndexList(bz_APIIntList* playerList)

Parameters
bz_APIIntList*	playerList	A pointer for an already created list

Returns

bz_APIIntList* - A pointer to an integer list of player IDs

bool - True if the player list was created with the given pointer

Other Player Lists Functions

Back to bzfs API Functions