Difference between revisions of "Bz eHostBanNotifyEvent"

From BZFlagWiki
Jump to: navigation, search
(Data)
(Uses: hyphenated compound adjective)
 
(3 intermediate revisions by one other user not shown)
Line 3: Line 3:
  
 
==Overview==
 
==Overview==
The '''bz_eHostBanEvent''' is an API event that is called each time a
+
The '''bz_eHostBanNotifyEvent''' is an API event that is called each time a
regular ban is executed.
+
hostban is executed.
  
 
==Data==
 
==Data==
'''bz_eHostBanEvent''' returns the '''bz_HostBanEventData_V1''' data
+
'''bz_eHostBanNotifyEvent''' returns the '''bz_HostBanEventData_V1''' data
 
class.
 
class.
 
 
   {| border="1" cellpadding="20" cellspacing="0"
 
   {| border="1" cellpadding="20" cellspacing="0"
 
   !name
 
   !name
Line 17: Line 16:
 
   |eventType
 
   |eventType
 
   |[[Event(API)|bz_eEventType]]
 
   |[[Event(API)|bz_eEventType]]
   |bz_eHostBanEvent
+
   |bz_eHostBanNotifyEvent
 
   |-
 
   |-
 
   |bannerID
 
   |bannerID
Line 41: Line 40:
  
 
==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:31, 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_eHostBanNotifyEvent is an API event that is called each time a hostban is executed.

Data[edit]

bz_eHostBanNotifyEvent returns the bz_HostBanEventData_V1 data class.

name type value description
eventType bz_eEventType bz_eHostBanNotifyEvent
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 notification-only event, none of the data returned can be changed.