This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz ePlayerPausedEvent"
From BZFlagWiki
m (→Data: Clarify which value is returned for which pause state.) |
(time to eventTime) |
||
Line 25: | Line 25: | ||
|Whether the player is pausing(true) or unpausing(false) | |Whether the player is pausing(true) or unpausing(false) | ||
|- | |- | ||
− | | | + | |eventTime |
|double | |double | ||
− | | | + | |The server time at which the event occurred (in seconds). |
|} | |} |
Latest revision as of 07:54, 1 May 2014
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). |