This wiki is archived and useful information is being migrated to the main bzflag.org website

Difference between revisions of "Bz ePlayerPausedEvent"

From BZFlagWiki
Jump to: navigation, search
(Data: playerID, not player)
m (paused typo fix.)
Line 3: Line 3:
  
 
==Overview==
 
==Overview==
The '''bz_ePlayerPausedEvent''' is an API event that is called each time a playing tank is pauses.
+
The '''bz_ePlayerPausedEvent''' is an API event that is called each time a playing tank is paused.
  
 
==Data==
 
==Data==

Revision as of 19:12, 15 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 or unpausing
time double Time local server time for the event.