bz_eGameStartEvent

This event is triggered when a timed game begins

Data Object Type

2.4.4 bz_GameStartEndEventData_V2

Deprecated Types

These data object types have been deprecated in favor of more recent versions, which contain more or corrected information.

• 2.4.0 bz_GameStartEndEventData_V1

Parameters

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

Data Type	Name	Description
double	duration	The duration (in seconds) of the game.
int	playerID	The player who started the /countdown. If no player is tied to this event, this defaults to -1 (available since V2 of the event)
bool	gameOver	Always false in the start event (available since V2 of the event)
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:

• HoldTheFlag
• nagware
• recordmatch

Plug-in Example

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

bz_GameStartEndEventData_V2* dataObject = (bz_GameStartEndEventData_V2*)eventData;

// Data
// ---
// (double)       duration - The duration (in seconds) of the game.
// (int)          playerID - The player who started the /countdown. If no player is tied to this event, this defaults to -1
// (bool)         gameOver - Always false in the start event
// (double)       eventTime - The server time the event occurred (in seconds).

Other Countdown Timer Events

• bz_eGameEndEvent
• bz_eGamePauseEvent
• bz_eGameResumeEvent

Back to bzfs API Events