Skip to Content

bz_eGetPlayerInfoEvent

This event is called each time the server sends out a player info update message to a remote player

Data Object Type

2.4.0 bz_GetPlayerInfoEventData_V1

Parameters

These are the values accessible in the bz_EventData variable that's made available in the Event method.

Data Type Name Description
int playerID

The playerID the record refers too.

bz_ApiString callsign

The callsign for the player.

bz_ApiString ipAddress

The IPv4 address for the player. (not set in 2.4.0, fixed in 2.4.1.)

bz_eTeamType team

The team the player is current only.

bool admin

The admin permision state of the player, indicating if they will be displayed with an '@' symbol in the scoreboard.

bool verified

The authentication state of the player, indicating if they will be displayed with an '+' symbol in the scoreboard.

bool registered

The state of the player's username. This value is true if the username is registered.

double eventTime

The local server time of the event.

Plug-in Usage

Here's a list of plug-ins part of the official distribution that makes use of this event:

Plug-in Example

This block of code can be used to get started when implementing the Event() function of your plug-in.

bz_GetPlayerInfoEventData_V1* dataObject = (bz_GetPlayerInfoEventData_V1*)eventData;

// Data
// ---
// (int)          playerID - The playerID the record refers too.
// (bz_ApiString) callsign - The callsign for the player.
// (bz_ApiString) ipAddress - The IPv4 address for the player. (not set in 2.4.0, fixed in 2.4.1.)
// (bz_eTeamType) team - The team the player is current only.
// (bool)         admin - The admin permision state of the player, indicating if they will be displayed with an '@' symbol in the scoreboard.
// (bool)         verified - The authentication state of the player, indicating if they will be displayed with an '+' symbol in the scoreboard.
// (bool)         registered - The state of the player's username. This value is true if the username is registered.
// (double)       eventTime - The local server time of the event.

Other Player Events

Back to bzfs API Events

This content is maintained on GitHub. We welcome any feedback and improvements!

Give us Feedback Edit this Page