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...)
 
(Data)
Line 25: Line 25:
 
   |banneeID
 
   |banneeID
 
   |int
 
   |int
   |This value is the player ID for the bannee.
+
   |This value is the player ID for the banner.
 
   |-
 
   |-
 
   |duration
 
   |duration
Line 43: Line 43:
 
   |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 07:33, 23 July 2009

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

Data

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 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.
ipAddress bz_ApiString This value contains the ipaddress of the bannee.
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.