bz_eFlagTransferredEvent

This event is called each time a player with Thief steals a flag

Data Object Type

2.4.0 bz_FlagTransferredEventData_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	fromPlayerID	The ID of the player whose flag was stolen
int	toPlayerID	The ID of the player that stole the flag
const char*	flagType	The flag code of the stolen flag
enum	action	Action The action taken for the transfer. Values: ContinueSteal, CancelSteal, DropThief
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
• thiefControl

Plug-in Example

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

bz_FlagTransferredEventData_V1* dataObject = (bz_FlagTransferredEventData_V1*)eventData;

// Data
// ---
// (int)          fromPlayerID - The ID of the player whose flag was stolen
// (int)          toPlayerID - The ID of the player that stole the flag
// (const char*)  flagType - The flag code of the stolen flag
// (enum)         action - Action The action taken for the transfer. Values: ContinueSteal, CancelSteal, DropThief
// (double)       eventTime - This value is the local server time of the event.

Other Flags Events

• bz_eAllowFlagGrab
• bz_eFlagDroppedEvent
• bz_eFlagGrabbedEvent

Back to bzfs API Events