This wiki is archived and useful information is being migrated to the main bzflag.org website

bz eListServerUpdateEvent

From BZFlagWiki
Jump to: navigation, search
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_eListServerUpdateEvent is an API event called before the server adds itself to the list server.

Data

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

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