bz_eListServerUpdateEvent

This event is called before the server adds itself to the list server

Data Object Type

2.4.0 bz_ListServerUpdateEvent_V1

Parameters

These are the values accessible in the bz_EventData variable that's made available in the Event method.

Data Type	Name	Description
bz_ApiString	address	The public address of the server, as specified with the -publicaddr command-line option.
bz_ApiString	description	The public description of the server, as specified with the -publictitle command-line option.
bz_ApiString	groups	The groups the server will be advertised to, as specified with the -advertise command-line option.
bool	handled	Whether or not the plug-in will override the values
double	eventTime	The server time the event occurred (in seconds.)

Plug-in Usage

Here's a list of plug-ins part of the official distribution that makes use of this event:

• pushstats

Plug-in Example

This block of code can be used to get started when implementing the Event() function of your plug-in.

bz_ListServerUpdateEvent_V1* dataObject = (bz_ListServerUpdateEvent_V1*)eventData;

// Data
// ---
// (bz_ApiString) address - The public address of the server, as specified with the `-publicaddr` command-line option.
// (bz_ApiString) description - The public description of the server, as specified with the `-publictitle` command-line option.
// (bz_ApiString) groups - The groups the server will be advertised to, as specified with the `-advertise` command-line option.
// (bool)         handled - Whether or not the plug-in will override the values
// (double)       eventTime - The server time the event occurred (in seconds.)

Other Other Events

• bz_eNewNonPlayerConnection
• bz_eTickEvent

Back to bzfs API Events