This wiki is archived and useful information is being migrated to the main bzflag.org website
bz eShotStoppedEvent
From BZFlagWiki
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[edit]
The bz_eShotStoppedEvent is an API event that is called each time a shot stops.
Data[edit]
bz_eShotStoppedEvent returns the bz_ShotStoppedEventData_V1 data class.
name | type | value description |
---|---|---|
eventType | bz_eEventType | bz_eShotStoppedEvent |
playerID | int | ID of the player whos shot stopped |
shotID | int | ID of the shot that stopped |
type | bz_APIString | What type the shot was |
pos | float[3] | Where the shot stopped |
obstacleGUID | unsigned int | ID of what obstacle the shot stopped on |
Usage[edit]
Data returned can not be modified.