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 eFlagGrabbedEvent: Difference between revisions
Jump to navigation
Jump to search
→Uses: hyphenated compound adjective |
Added flagType which wasn't documented |
||
| Line 24: | Line 24: | ||
|int | |int | ||
|The flag ID that was grabbed | |The flag ID that was grabbed | ||
|- | |||
|flagType | |||
|[[bz_ApiString]] | |||
|The flag abbreviation of the flag that was grabbed | |||
|- | |- | ||
|pos | |pos | ||
Revision as of 19:30, 19 April 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_eFlagGrabbedEvent is an API event that is called each time a flag is grabbed by a player.
Data
bz_eFlagGrabbedEvent returns the bz_FlagGrabbedEventData_V1 data class.
| name | type | value desription |
|---|---|---|
| eventType | bz_eEventType | bz_eFlagGrabbedEvent |
| playerID | int | The player that grabbed the flag |
| flagID | int | The flag ID that was grabbed |
| flagType | bz_ApiString | The flag abbreviation of the flag that was grabbed |
| pos | float[3] | The position at which the flag was grabbed |
Uses
This event is a notification-only event, none of the data returned can be changed.