|
|
| Line 1: |
Line 1: |
| {{BZFS_API_Doc}}
| | #REDIRECT [[Category:BZFS API Docs]] |
| {{BZFS_API_Events}}
| |
| | |
| ==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_V2''' data class.
| |
| | |
| {| border="1" cellpadding="20" cellspacing="0"
| |
| !name
| |
| !type
| |
| !value description
| |
| |-
| |
| |eventType
| |
| |[[Event(API)|bz_eEventType]]
| |
| |bz_eGameStartEvent or bz_eGameEndEvent
| |
| |-
| |
| |playerID
| |
| |int
| |
| |The id of the player who ended the countdown. This will be set to 253 if no player information was given.
| |
| |-
| |
| |duration
| |
| |double
| |
| |The duration (in seconds) of the game.
| |
| |-
| |
| |gameOver
| |
| |bool
| |
| |This is set to true if the countdown was ended by a gameover or superkill action.
| |
| |-
| |
| |eventTime
| |
| |double
| |
| |The server time the event occurred (in seconds.)
| |
| |}
| |
| | |
| [[Category:BZFS_API_Docs]] | |
| [[Category:BZFS_API_Events]]
| |