bz_eFlagGrabbedEvent

This event is called each time a flag is grabbed by a player

Data Object Type

2.4.0 bz_FlagGrabbedEventData_V1

Parameters

These are the values accessible in the bz_EventData variable that's made available in the Event method.

Data Type	Name	Description
int	playerID	The player that grabbed the flag
int	flagID	The flag ID that was grabbed
const char*	flagType	The flag abbreviation of the flag that was grabbed
float[3]	pos	The position at which the flag was grabbed
double	eventTime	This value is the local server time of the event.

Plug-in Usage

Here's a list of plug-ins part of the official distribution that makes use of this event:

• customflagsample
• flagStay

Plug-in Example

This block of code can be used to get started when implementing the Event() function of your plug-in.

bz_FlagGrabbedEventData_V1* dataObject = (bz_FlagGrabbedEventData_V1*)eventData;

// Data
// ---
// (int)          playerID - The player that grabbed the flag
// (int)          flagID - The flag ID that was grabbed
// (const char*)  flagType - The flag abbreviation of the flag that was grabbed
// (float[3])     pos - The position at which the flag was grabbed
// (double)       eventTime - This value is the local server time of the event.

Other Flags Events

• bz_eAllowFlagGrab
• bz_eFlagDroppedEvent
• bz_eFlagTransferredEvent

Back to bzfs API Events