bz_eAllowPlayer

This event is called each time a player connects to the server. By setting allow to false, the player will be rejected and not allowed to join the server.

Data Object Type

2.4.0 bz_AllowPlayerEventData_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	This value is the player ID for the joining player.
bz_ApiString	callsign	This value is the callsign for the player.
bz_ApiString	ipAddress	This value is the IPv4 address of the player.
bz_ApiString	reason	This value is the reason for any denials of admittance, it will be reported back to the player.
bool	allow	Whether or not to allow the player to join
double	eventTime	This value is the local server time of the event.

Plug-in Usage

There are no plug-ins in the official distribution that make use of this event. Browse the Plug-in Releases forum for plug-ins which may make 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_AllowPlayerEventData_V1* dataObject = (bz_AllowPlayerEventData_V1*)eventData;

// Data
// ---
// (int)          playerID - This value is the player ID for the joining player.
// (bz_ApiString) callsign - This value is the callsign for the player.
// (bz_ApiString) ipAddress - This value is the IPv4 address of the player.
// (bz_ApiString) reason - This value is the reason for any denials of admittance, it will be reported back to the player.
// (bool)         allow - Whether or not to allow the player to join
// (double)       eventTime - This value is the local server time of the event.

Other Player Events

• bz_eAutoPilotEvent
• bz_eGetAutoTeamEvent
• bz_eGetPlayerInfoEvent
• bz_eGetPlayerMotto
• bz_ePlayerAuthEvent
• bz_ePlayerDeathFinalizedEvent
• bz_ePlayerDieEvent
• bz_ePlayerJoinEvent
• bz_ePlayerPartEvent
• bz_ePlayerPausedEvent
• bz_ePlayerUpdateEvent

Back to bzfs API Events