This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz eGameEndEvent"
From BZFlagWiki
(Created Documentation for this API Event.) |
(Updated incorrect information about the event being only a notification) |
||
Line 5: | Line 5: | ||
The '''bz_eGameEndEvent''' is an API event that is called each time a game ends. This '''only''' triggers when the game countdown ends (A Game Over), or when /superkill is initiated. This is not to be confused with BZFS being shutdown, /shutdown being initiated, or a game ending due to the '''-g''' option enabled on servers. | The '''bz_eGameEndEvent''' is an API event that is called each time a game ends. This '''only''' triggers when the game countdown ends (A Game Over), or when /superkill is initiated. This is not to be confused with BZFS being shutdown, /shutdown being initiated, or a game ending due to the '''-g''' option enabled on servers. | ||
− | == | + | ==Data== |
− | + | Both '''bz_eGameStartEvent''' and '''bz_eGameEndEvent''' return the '''bz_GameStartEndEventData_V1''' data class. | |
+ | |||
+ | {| border="1" cellpadding="20" cellspacing="0" | ||
+ | !name | ||
+ | !type | ||
+ | !value description | ||
+ | |- | ||
+ | |eventType | ||
+ | |[[Event(API)|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.) | ||
+ | |} | ||
[[Category:BZFS_API_Docs]] | [[Category:BZFS_API_Docs]] | ||
[[Category:BZFS_API_Events]] | [[Category:BZFS_API_Events]] |
Revision as of 01:15, 23 December 2013
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_eGameEndEvent is an API event that is called each time a game ends. This only triggers when the game countdown ends (A Game Over), or when /superkill is initiated. This is not to be confused with BZFS being shutdown, /shutdown being initiated, or a game ending due to the -g option enabled on servers.
Data
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.) |