This wiki is archived and useful information is being migrated to the main bzflag.org website
bz eFlagGrabbedEvent
From BZFlagWiki
Revision as of 19:30, 19 April 2014 by Allejo (Talk | contribs) (Added flagType which wasn't documented)
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.