Skip to Content

bz_eHostBanModifyEvent

This event is called each time before a hostban is going to happen

Data Object Type

2.4.0 bz_HostBanEventData_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 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 hostPattern

This value contains the host pattern that is banned.

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_HostBanEventData_V1* dataObject = (bz_HostBanEventData_V1*)eventData;

// Data
// ---
// (int)          bannerID - This value is the player ID for the banner.
// (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) hostPattern - This value contains the host pattern that is banned.
// (double)       eventTime - This value is the local server time of the event.

Other Administrative Events

Back to bzfs API Events

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

Give us Feedback Edit this Page