Difference between revisions of "Bz eShotFiredEvent"

From BZFlagWiki
Jump to: navigation, search
m (fixed typo)
(Data: Ugh, had to go into the API looking for the appropriate data class for this thing...Also no one mentioned you can edit the members! (Edited by sigonasr2))
Line 6: Line 6:
  
 
==Data==
 
==Data==
'''bz_eShotFiredEvent''' returns the '''bz_eShotFiredEvent_V1''' data class.
+
'''bz_eShotFiredEvent''' returns the '''bz_ShotFiredEventData_V1''' data class.
  
 
   {| border="1" cellpadding="20" cellspacing="0"
 
   {| border="1" cellpadding="20" cellspacing="0"
Line 33: Line 33:
 
   |The shot type
 
   |The shot type
 
   |}
 
   |}
 +
 +
==Uses==
 +
This is a modification event, plug-ins may change the changed and type fields to effect changes in the bullet type that is shot from the player.

Revision as of 08:04, 25 August 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_eShotFiredEvent is an API event that is called each time a shot is fired.

Data

bz_eShotFiredEvent returns the bz_ShotFiredEventData_V1 data class.

name type value description
eventType bz_eEventType bz_eShotFiredEvent
playerID int ID of the player that fired the shot
changed bool Whether or not the shot has been modified
pos float[3] Where the shot was fired
type Bz_APIString The shot type

Uses

This is a modification event, plug-ins may change the changed and type fields to effect changes in the bullet type that is shot from the player.