This wiki is archived and useful information is being migrated to the main bzflag.org website
bz eAutoPilotChangeEvent
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_eAutoPilotChangeEvent is an API event that is called each time a player is about to change autopilot.
Data[edit]
bz_eAutoPilotChangeEvent returns the bz_eAutoPilotChangeData_V1 data class.
name | type | value description |
---|---|---|
eventType | bz_eEventType | bz_eAutoPilotChangeEvent |
playerID | int | Who is changing their autopilot |
autopilot | bool | Whether the player is turning auto pilot on / off |
allow | bool | Whether or not to allow the change |