This wiki is archived and useful information is being migrated to the main bzflag.org website
bz eHostBanNotifyEvent
From BZFlagWiki
Revision as of 23:31, 27 January 2013 by Khonkhortisan (Talk | contribs) (→Uses: hyphenated compound adjective)
| BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server. |
BZFS Event. This page documents a BZFS event that is called by the game server to notify plug-ins of various actions and state changes in the game world.
Overview
The bz_eHostBanNotifyEvent is an API event that is called each time a hostban is executed.
Data
bz_eHostBanNotifyEvent returns the bz_HostBanEventData_V1 data class.
| name | type | value description |
|---|---|---|
| eventType | bz_eEventType | bz_eHostBanNotifyEvent |
| 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 | 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 | This value is the local server time of the event. |
Uses
This event is a notification-only event, none of the data returned can be changed.
