This wiki is archived and useful information is being migrated to the main bzflag.org website
bz eGetWorldEvent
From BZFlagWiki
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_eGetWorldEvent is an API event that is called when the world is defined.
Data
bz_eGetWorldEvent returns the bz_GetWorldEventData_V1 data class.
name | type | value description |
---|---|---|
eventType | bz_eEventType | bz_eGetWorldEvent |
generated | bool | Set to true if the world is generated (ie, not literally loaded from a file) |
ctf | bool | Set to true if the game is a CTF-type game |
rabit | bool | Set to true if the game is a Rabbit Hunt-type game |
openFFA | bool | Set to true if the game is a Free For All-type game |
worldFile | bz_ApiString | Path to the world file, set to "" (empty string) if not used |
eventTime | double | Time of the event |
Uses
This event is a notification only event, none of the data returned can be changed.