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
(Use {{BZFS_API_Doc}} {{BZFS_API_Events}})
(Some fixes to what the event's members actually are. Also name clarity.)
Line 6: Line 6:
  
 
==Data==
 
==Data==
'''bz_ePlayerPausedEvent''' returns the '''bz_ePlayerPausedEvent_V1''' data class.
+
'''bz_ePlayerPausedEvent''' returns the '''bz_PlayerPausedEventData_V1''' data class.
  
 
   {| border="1" cellpadding="20" cellspacing="0"
 
   {| border="1" cellpadding="20" cellspacing="0"
Line 17: Line 17:
 
   |bz_ePlayerPausedEvent
 
   |bz_ePlayerPausedEvent
 
   |-
 
   |-
   |playerID
+
   |player
 
   |int
 
   |int
 
   |ID of the player who paused.
 
   |ID of the player who paused.

Revision as of 02:45, 3 July 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 pauses.

Data

bz_ePlayerPausedEvent returns the bz_PlayerPausedEventData_V1 data class.

name type value description
eventType bz_eEventType bz_ePlayerPausedEvent
player 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.