Difference between revisions of "Bz eListServerUpdateEvent"

From BZFlagWiki
Jump to: navigation, search
(Data: Added eventTime field.)
m (Added info on handled bool)
 
(One intermediate revision by one other user not shown)
Line 23: Line 23:
 
   |description
 
   |description
 
   |[[bz_ApiString]]
 
   |[[bz_ApiString]]
   |The public description of the server, as specified with the '''-public''' [[BZFS_Command_Line_Options |command-line option]].
+
   |The public description of the server, as specified with the '''-publictitle''' [[BZFS_Command_Line_Options |command-line option]].
 
   |-
 
   |-
 
   |groups
 
   |groups
Line 31: Line 31:
 
   |handled
 
   |handled
 
   |bool
 
   |bool
   |
+
   |Whether or not the plugin will be overriding the values
 
   |-
 
   |-
 
   |eventTime
 
   |eventTime

Latest revision as of 01:12, 23 December 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_eListServerUpdateEvent is an API event called before the server adds itself to the list server.

Data[edit]

bz_eListServerUpdateEvent returns the bz_ListServerUpdateEvent_V1 data class.

name type value description
eventType bz_eEventType bz_eListServerUpdateEvent
address bz_ApiString The public address of the server, as specified with the -publicaddr command-line option.
description bz_ApiString The public description of the server, as specified with the -publictitle command-line option.
groups bz_ApiString The groups the server will be advertised to, as specified with the -advertise command-line option.
handled bool Whether or not the plugin will be overriding the values
eventTime double The server time the event occurred (in seconds.)

Uses[edit]

Allows the plugin to programmatically change the information sent to the list server; all fields (except the event type) are read/write.