This wiki is archived and useful information is being migrated to the main bzflag.org website
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.
Overview
The bz_eCaptureEvent is an API event that is called each time a team's flag has been captured.
Data
bz_eCaptureEvent returns the bz_CTFCaptureEventData data class.
| name | type | value description |
|---|---|---|
| eventType | bz_eEventType | bz_eCaptureEvent |
| teamCapped | bz_eTeamType | The team whose flag has been captured |
| teamCapping | bz_eTeamType | The team who has captured a flag |
| playerCapping | int | The player who captured the flag |
| pos | float[3] | Position where the flag has been captured |
| rot | float | Rotation of the capturing player |
| time | double | The time on which the flag was captured |
Uses
This event is a notification only event, none of the data returned can be changed.
