This wiki is archived and useful information is being migrated to the main bzflag.org website
bz ePlayerPausedEvent
From BZFlagWiki
Revision as of 09:31, 19 October 2011 by Sigonasr2 (Talk | contribs) (→Data: Clarify which value is returned for which pause state.)
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_ePlayerPausedEvent is an API event that is called each time a playing tank is paused.
Data
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) |
time | double | Time local server time for the event. |