bz_eGetWorldEvent

This event is called before the BZFS server defines the world

Data Object Type

2.4.0 bz_GetWorldEventData_V1

Parameters

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

Data Type	Name	Description
bool	generated	The value representing the state of the world generation. If another
bool	ctf	This value represents the game state being a Capture the Flag (CTF) type
bool	rabbit	This value represents the game state being a Rabbit Chase type game.
bool	openFFA	This value represents the game state being a Free For All type game.
char*	worldBlob	A pointer to a memory location from which to read the world stream.
bz_ApiString	worldFile	The path to the map file that will be used when this event is completed.
double	eventTime	Local Server time of the event.

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_GetWorldEventData_V1* dataObject = (bz_GetWorldEventData_V1*)eventData;

// Data
// ---
// (bool)         generated - The value representing the state of the world generation. If another
// (bool)         ctf - This value represents the game state being a Capture the Flag (CTF) type
// (bool)         rabbit - This value represents the game state being a Rabbit Chase type game.
// (bool)         openFFA - This value represents the game state being a Free For All type game.
// (char*)        worldBlob - A pointer to a memory location from which to read the world stream.
// (bz_ApiString) worldFile - The path to the map file that will be used when this event is completed.
// (double)       eventTime - Local Server time of the event.

Other World Events

• bz_eWorldFinalized

Back to bzfs API Events