Bz eCaptureEvent

From BZFlagWiki

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.

[edit] Overview

The bz_eCaptureEvent is an API event that is called each time a team's flag has been captured.

[edit] Data

bz_eCaptureEvent returns the bz_CTFCaptureEventData_V1 data class.

name	type	value description
eventType	bz_eEventType	bz_eCaptureEvent
teamCapped	bz_eTeamType	The team whose flag was captured.
teamCapping	bz_eTeamType	The team who did the capturing.
playerCapping	int	The player who captured the flag.
pos	float[3]	The world position(X,Y,Z) where the flag has been captured
rot	float	The rotational orientation of the capturing player
time	double	The time on which the flag was captured

[edit] Uses

This event is a notification only event, none of the data returned can be changed.