This wiki is archived and useful information is being migrated to the main bzflag.org website
bz eShotTeleportEvent
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_eShotTeleportEvent is an API event that is called each time a shot teleports via a teleporter.
Data
bz_eShotTeleportEvent returns the bz_ShotTeleportEventData_V1 data class.
| name | type | value description |
|---|---|---|
| eventType | bz_eEventType | bz_eShotTeleportEvent |
| playerID | int | ID of the player whos shot was teleported |
| shotID | int | ID of the shot that teleported |
| type | bz_APIString | What type the shot was |
| pos | float[3] | Where the shot teleported |
| linkSrcID | int | ID of the teleporter the shot went into |
| linkDstID | int | ID of the teleporter the shot came out of |
Usage
Data returned can not be modified.
