This wiki is archived and useful information is being migrated to the main bzflag.org website
|BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server.|
The bz_eHostBanEvent is an API event that is called each time a regular ban is executed.
bz_eHostBanEvent returns the bz_HostBanEventData_V1 data class.
|bannerID||int||This value is the player ID for the banner.|
|duration||int||This value is the duration of the ban in minutes.|
|reason||bz_ApiString==Uses==||This value contains the reason why and by who a player got banned.|
|hostPattern||bz_ApiString||This value contains the host pattern that is banned.|
|eventTime||double==Uses==||This value is the local server time of the event.|
This event is a notification only event, none of the data returned can be changed.