This wiki is archived and useful information is being migrated to the main bzflag.org website
bz eIdBanEvent
From BZFlagWiki
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[edit]
The bz_eIdBanEvent is an API event that is called each time a ban on bzid (idban) is executed.
Data[edit]
bz_eIdBanEvent returns the bz_IdBanEventData_V1 data class.
name | type | value description |
---|---|---|
eventType | bz_eEventType | bz_eIdBanEvent |
bannerID | int | This value is the player ID for the banner. |
banneeID | int | This value is the player ID for the bannee. |
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. |
bzId | bz_ApiString | This value contains the BZFlag unique player identifier aka the bzid. |
eventTime | double | This value is the local server time of the event. |
Uses[edit]
This event is a notification-only event, none of the data returned can be changed.