bz_eKickEvent

This event is triggered when a player is kicked from the server

Data Object Type

2.4.0 bz_KickEventData_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	kickerID	The ID of the player who performed the kick.
int	kickedID	The ID of the player being kicked from the server.
bz_ApiString	reason	The reason (sent to kicked player).
double	eventTime	The server time the event occurred (in seconds.)

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_KickEventData_V1* dataObject = (bz_KickEventData_V1*)eventData;

// Data
// ---
// (int)          kickerID - The ID of the player who performed the kick.
// (int)          kickedID - The ID of the player being kicked from the server.
// (bz_ApiString) reason - The reason (sent to kicked player).
// (double)       eventTime - The server time the event occurred (in seconds.)

Other Administrative Events

• bz_eBZDBChange
• bz_eBanEvent
• bz_eHostBanModifyEvent
• bz_eKillEvent
• bz_eMuteEvent
• bz_ePermissionModificationEvent
• bz_eReportFiledEvent
• bz_eUnmuteEvent

Back to bzfs API Events