bz ePlayerPausedEvent

From BZFlagWiki
Revision as of 21:36, 10 October 2011 by 70.190.212.232 (Talk) (Data: playerID, not player)

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

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

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 or unpausing
time double Time local server time for the event.