Difference between revisions of "Bz ePlayerPausedEvent"

From BZFlagWiki
Jump to: navigation, search
m (paused typo fix.)
m (Data: Clarify which value is returned for which pause state.)
Line 23: Line 23:
 
   |pause
 
   |pause
 
   |bool
 
   |bool
   |Whether the player is pausing or unpausing
+
   |Whether the player is pausing(true) or unpausing(false)
 
   |-
 
   |-
 
   |time
 
   |time

Revision as of 09:31, 19 October 2011

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.