bz ePlayerPausedEvent

From BZFlagWiki
Revision as of 07:54, 1 May 2014 by Allejo (Talk | contribs) (time to eventTime)

(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.


Overview[edit]

The bz_ePlayerPausedEvent is an API event that is called each time a playing tank is paused.

Data[edit]

bz_ePlayerPausedEvent returns the bz_PlayerPausedEventData_V1 data class.

name type value description
eventType bz_eEventType bz_ePlayerPausedEvent
playerID int ID of the player who paused.
pause bool Whether the player is pausing(true) or unpausing(false)
eventTime double The server time at which the event occurred (in seconds).