bz eShotFiredEvent

From BZFlagWiki
Revision as of 08:05, 25 August 2011 by 70.190.212.232 (Talk) (Data: Mentioned you use abbreviations.)

Jump to: navigation, search
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. 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.