This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz eTeleportEvent"
From BZFlagWiki
(New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_eTeleportEvent''' is called when a tank passes through a teleportor. ==Data== '''bz_eTeleportEvent''' returns the '''bz_Tele...) |
(→Uses: hyphenated compound adjective) |
||
Line 31: | Line 31: | ||
==Uses== | ==Uses== | ||
− | This event is a notification only event, none of the data returned can be changed. | + | This event is a notification-only event, none of the data returned can be changed. |
[[Category:BZFS_API_Docs]] | [[Category:BZFS_API_Docs]] | ||
[[Category:BZFS_API_Events]] | [[Category:BZFS_API_Events]] |
Latest revision as of 23:31, 27 January 2013
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.