This wiki is archived and useful information is being migrated to the main bzflag.org website
bz eHostBanModifyEvent
From BZFlagWiki
Revision as of 16:21, 23 April 2008 by Catay (Talk | contribs) (New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_eHostBanModifyEvent''' is an API event that is called each time before a hostban is going to happen. ==Data== '''bz_eHostBanM...)
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_eHostBanModifyEvent is an API event that is called each time before a hostban is going to happen.
Data[edit]
bz_eHostBanModifyEvent returns the bz_HostBanEventData_V1 data class.
name | type | value description |
---|---|---|
eventType | bz_eEventType | bz_eHostBanModifyEvent |
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[edit]
This event is a modification event, all the members except evenTime can be changed. In case bannerID is changed to a non-existant ID , the ban will fail.