This wiki is archived and useful information is being migrated to the main bzflag.org website
bz eTeleportEvent
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_eTeleportEvent is called when a tank passes through a teleportor.
Data[edit]
bz_eTeleportEvent returns the bz_TeleportEventData_V1 data class.
name | type | value description |
---|---|---|
eventType | bz_eEventType | bz_eTeleportEvent |
playerID | int | The player who teleported |
from | int | The teleporter side ID entered by the player |
to | int | The teleporter side ID exited by the player |
Uses[edit]
This event is a notification-only event, none of the data returned can be changed.