This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz eAllowCTFCaptureEvent"
From BZFlagWiki
(→bz_eAllowCTFCaptureEvent) |
(updated event info) |
||
Line 5: | Line 5: | ||
The '''bz_eAllowCTFCapEvent''' is an API event that is called each time a flag is about to be captured. | The '''bz_eAllowCTFCapEvent''' is an API event that is called each time a flag is about to be captured. | ||
==Data== | ==Data== | ||
− | ''' | + | '''bz_eAllowCTFCaptureEvent''' returns the '''bz_AllowCTFCaptureEventData_V1''' data class. |
{| border="1" cellpadding="20" cellspacing="0" | {| border="1" cellpadding="20" cellspacing="0" |
Revision as of 04:41, 29 January 2013
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_eAllowCTFCapEvent is an API event that is called each time a flag is about to be captured.
Data
bz_eAllowCTFCaptureEvent returns the bz_AllowCTFCaptureEventData_V1 data class.
name | type | value description |
---|---|---|
eventType | bz_eEventType | bz_eAllowCTFCapEvent |
playerCapping | int | The ID of the player making the capture |
teamCapped | bz_eTeamType | The team making the capture |
teamCapping | bz_eTeamType | The team whose flag is being captured |
pos | float[3] | The position of the player |
rot | float | The direction the player is facing |
allow | bool | Whether or not to allow the capture |
time | double | The server time at which the event occurred (in seconds). |