This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz eCaptureEvent"
From BZFlagWiki
(→Uses: hyphenated compound adjective) |
|||
Line 42: | Line 42: | ||
|} | |} | ||
==Uses== | ==Uses== | ||
− | This event is a notification only event, none of the data returned can be changed. | + | This event is a notification-only event, none of the data returned can be changed. |
[[Category:BZFS_API_Docs]] | [[Category:BZFS_API_Docs]] | ||
[[Category:BZFS_API_Events]] | [[Category:BZFS_API_Events]] |
Revision as of 23:30, 27 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_eCaptureEvent is an API event that is called each time a team's flag has been captured.
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 |
Uses
This event is a notification-only event, none of the data returned can be changed.