bz eGameStartEvent

From BZFlagWiki
Revision as of 04:02, 8 May 2009 by Xalendare (Talk | contribs) (Added event description.)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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.


bz_eGameStartEvent and bz_eGameEndEvent are API events triggered when a game (i.e., a time- or score-limited match) begins or ends, respectively.


Both bz_eGameStartEvent and bz_eGameEndEvent return the bz_GameStartEndEventData_V1 data class.

name type value description
eventType bz_eEventType bz_eGameStartEvent or bz_eGameEndEvent
duration double The duration (in seconds) of the game.
eventTime double The server time the event occurred (in seconds.)