bz_eBanEvent

This event is called each time a regular ban is executed

Data Object Type

2.4.0 bz_BanEventData_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	bannerID	This value is the player ID for the banner.
int	banneeID	This value is the player ID for the bannee.
int	duration	This value is the duration of the ban in minutes.
bz_ApiString	reason	This value contains the reason why and by who a player got banned.
bz_ApiString	ipAddress	This value contains the ipaddress of the bannee.
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_BanEventData_V1* dataObject = (bz_BanEventData_V1*)eventData;

// Data
// ---
// (int)          bannerID - This value is the player ID for the banner.
// (int)          banneeID - This value is the player ID for the bannee.
// (int)          duration - This value is the duration of the ban in minutes.
// (bz_ApiString) reason - This value contains the reason why and by who a player got banned.
// (bz_ApiString) ipAddress - This value contains the ipaddress of the bannee.
// (double)       eventTime - This value is the local server time of the event.

Other Administrative Events

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

Back to bzfs API Events