Difference between revisions of "Bz eShotFiredEvent"

From BZFlagWiki
Jump to: navigation, search
(Data: Mentioned you use abbreviations.)
(Data: Mentioned you have to change changed in order to affect the shot type.)
Line 23: Line 23:
 
   |changed
 
   |changed
 
   |bool
 
   |bool
   |Whether or not the shot has been modified
+
   |Whether or not the shot has been modified. Shot type will not change unless this is set to 1 (true).
 
   |-
 
   |-
 
   |pos
 
   |pos

Revision as of 08:07, 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. Shot type will not change unless this is set to 1 (true).
pos float[3] Where the shot was fired
type Bz_APIString The shot type. This is the abbreviation, such as "PZ" or "SW"

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.