This wiki was in read-only mode for many years, but can now be edited again. A lot of information will need to be updated.
Bz eFlagTransferredEvent: Difference between revisions
		
		
		
		Jump to navigation
		Jump to search
		
Strakowski (talk | contribs)  Started page. Still very vague. Will revisit soon.  | 
				 added eventTime  | 
				||
| Line 32: | Line 32: | ||
   |enum Action  |    |enum Action  | ||
   |The action taken for the transfer. Values: ContinueSteal, CancelSteal, DropThief  |    |The action taken for the transfer. Values: ContinueSteal, CancelSteal, DropThief  | ||
  |-  | |||
  |eventTime  | |||
  |double  | |||
  |The server time at which the event occurred (in seconds).  | |||
   |}  |    |}  | ||
Latest revision as of 07:47, 1 May 2014
| 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_eFlagTransferredEvent is an API event that is called each time a player with Thief steals a flag.
Data
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). |