This wiki was in read-only mode for many years, but can now be edited again. A lot of information will need to be updated.
bz eGamePauseEvent
Jump to navigation
Jump to 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.
Overview
The bz_eGamePauseEvent and bz_eGameResumeEvent are API events triggered when a game (i.e., a time- or score-limited match) pauses or resumes, respectively.
Data
Both bz_eGamePauseEvent and bz_eGameResumeEvent return the bz_GamePauseResumeEventData_V2 data class.
| name | type | value description |
|---|---|---|
| eventType | bz_eEventType | bz_eGamePauseEvent or bz_eGameResumeEvent |
| playerID | int | The id of the player who paused countdown. This will be set to 253 if no player information was given. |
| actionBy | bz_ApiString | The callsign of the player who triggered the event. By default, it's "SERVER." |
| eventTime | double | The server time the event occurred (in seconds.) |