Difference between revisions of "Bz eShotEndedEvent"

From BZFlagWiki
Jump to: navigation, search
m (documented `explode`)
(fixed returned data)
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"

Revision as of 06:22, 14 April 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

The bz_eShotEndedEvent is an API event that is called each time a shot ends.

Data

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