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

Difference between revisions of "Bz eShotEndedEvent"

From BZFlagWiki
Jump to: navigation, search
m (documented `explode`)
(added eventTime)
 
(One intermediate revision by the same user not shown)
Line 5: Line 5:
 
The '''bz_eShotEndedEvent''' is an API event that is called each time a shot ends.
 
The '''bz_eShotEndedEvent''' is an API event that is called each time a shot ends.
 
==Data==
 
==Data==
'''bz_eShotEndedEvent''' returns the '''bz_eShotEndedEvent_V1''' data class.
+
'''bz_eShotEndedEvent''' returns the '''bz_ShotEndedEventData_V1''' data class.
  
 
   {| border="1" cellpadding="20" cellspacing="0"
 
   {| border="1" cellpadding="20" cellspacing="0"
Line 27: Line 27:
 
   |bool
 
   |bool
 
   |Whether the shot exploded or not
 
   |Whether the shot exploded or not
 +
  |-
 +
  |eventTime
 +
  |double
 +
  |The server time at which the event occurred (in seconds).
 
   |}
 
   |}

Latest revision as of 07:56, 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_eShotEndedEvent is an API event that is called each time a shot ends.

Data[edit]

bz_eShotEndedEvent returns the bz_ShotEndedEventData_V1 data class.

name type value description
eventType bz_eEventType bz_eShotEndedEvent
playerID int The player ending the shot
shotID int The shot ID
explode bool Whether the shot exploded or not
eventTime double The server time at which the event occurred (in seconds).