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

bz eShotFiredEvent

From BZFlagWiki
Revision as of 07:56, 1 May 2014 by Allejo (Talk | contribs) (moar eventTime's)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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. 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"
eventTime double The server time at which the event occurred (in seconds).

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. Note that changing the shot type will NOT affect your client's shot. Only others will see the changes to your bullet being sent while your client shoots a regular bullet.