This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz eHostBanNotifyEvent"
From BZFlagWiki
(New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_eHostBanEvent''' is an API event that is called each time a regular ban is executed. ==Data== '''bz_eHostBanEvent''' returns t...) |
(→Data) |
||
Line 28: | Line 28: | ||
|- | |- | ||
|reason | |reason | ||
− | |[[bz_ApiString]] | + | |[[bz_ApiString]] |
|This value contains the reason why and by who a player got banned. | |This value contains the reason why and by who a player got banned. | ||
|- | |- | ||
Line 36: | Line 36: | ||
|- | |- | ||
|eventTime | |eventTime | ||
− | |double | + | |double |
|This value is the local server time of the event. | |This value is the local server time of the event. | ||
|} | |} | ||
+ | |||
==Uses== | ==Uses== | ||
This event is a notification only event, none of the data returned | This event is a notification only event, none of the data returned | ||
can be changed. | can be changed. |
Revision as of 00:31, 20 April 2008
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_eHostBanEvent is an API event that is called each time a regular ban is executed.
Data
bz_eHostBanEvent returns the bz_HostBanEventData_V1 data class.
name | type | value description |
---|---|---|
eventType | bz_eEventType | bz_eHostBanEvent |
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.