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