This wiki is archived and useful information is being migrated to the main bzflag.org website

Difference between revisions of "Bz eCaptureEvent"

From BZFlagWiki
Jump to: navigation, search
Line 19: Line 19:
 
   |teamCapped
 
   |teamCapped
 
   |[[bz_eTeamType]]
 
   |[[bz_eTeamType]]
   |The team whose flag has been captured
+
   |The team whose flag was captured.
 
   |-
 
   |-
 
   |teamCapping
 
   |teamCapping
 
   |[[bz_eTeamType]]
 
   |[[bz_eTeamType]]
   |The team who has captured a flag
+
   |The team who did the capturing.
 
   |-
 
   |-
 
   |playerCapping
 
   |playerCapping
 
   |int
 
   |int
   |The player who captured the flag
+
   |The player who captured the flag.
 
   |-
 
   |-
 
   |pos
 
   |pos
 
   |float[3]
 
   |float[3]
   |Position where the flag has been captured
+
   |The world position(X,Y,Z) where the flag has been captured
 
   |-
 
   |-
 
   |rot
 
   |rot
 
   |float
 
   |float
   |Rotation of the capturing player
+
   |The rotational orientation of the capturing player
 
   |-
 
   |-
 
   |time
 
   |time

Revision as of 17:10, 28 November 2007

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 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.