This wiki is archived and useful information is being migrated to the main bzflag.org website
bz eFlagTransferredEvent
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_eFlagTransferredEvent is an API event that is called each time a player with Thief steals a flag.
Data[edit]
bz_eFlagTransferredEvent returns the bz_FlagTransferredEventData_V1 data class.
name | type | value desription |
---|---|---|
eventType | bz_eEventType | bz_eFlagTransferredEvent |
fromPlayerID | int | The ID of the player that stole the flag |
toPlayerID | int | The ID of the player whose flag was stolen |
flagType | const char* | The flag code of the stolen flag |
action | enum Action | The action taken for the transfer. Values: ContinueSteal, CancelSteal, DropThief |
eventTime | double | The server time at which the event occurred (in seconds). |