This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz eFlagGrabbedEvent"
From BZFlagWiki
Strakowski (Talk | contribs) (Started the page. Almost identical to flag dropped event. Page still needs history.) |
(→Uses: hyphenated compound adjective) |
||
| Line 31: | Line 31: | ||
==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. |
Revision as of 23:31, 27 January 2013
| 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 |
| 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.
