Difference between revisions of "Bz eBanEvent"

From BZFlagWiki
Jump to: navigation, search
(New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_eBanEvent''' is an API event that is called each time a regular ban is executed. ==Data== '''bz_eBanEvent''' returns the '''bz...)
 
(Uses: hyphenated compound adjective)
 
(3 intermediate revisions by 2 users not shown)
Line 44: Line 44:
 
   |}
 
   |}
 
==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.

Latest revision as of 23:30, 27 January 2013

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_eBanEvent is an API event that is called each time a regular ban is executed.

Data[edit]

bz_eBanEvent returns the bz_BanEventData_V1 data class.

name type value description
eventType bz_eEventType bz_eBanEvent
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.
ipAddress bz_ApiString This value contains the ipaddress of the bannee.
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.