This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz eFlagGrabbedEvent"
From BZFlagWiki
(→Uses: hyphenated compound adjective) |
(added eventTime here too) |
||
| (One intermediate revision by the same user not shown) | |||
| 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 | ||
|float[3] | |float[3] | ||
|The position at which the flag was grabbed | |The position at which the flag was grabbed | ||
| + | |- | ||
| + | |eventTime | ||
| + | |double | ||
| + | |The server time at which the event occurred (in seconds). | ||
|} | |} | ||
==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. | ||
Latest revision as of 07:46, 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[edit]
The bz_eFlagGrabbedEvent is an API event that is called each time a flag is grabbed by a player.
Data[edit]
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 |
| eventTime | double | The server time at which the event occurred (in seconds). |
Uses[edit]
This event is a notification-only event, none of the data returned can be changed.
