Difference between revisions of "Bz eAllowFlagGrab"

From BZFlagWiki
Jump to: navigation, search
m (moved Bz eAllowFlagGrabEvent to Bz eAllowFlagGrab: this is the real name for the event)
Line 3: Line 3:
  
 
==Overview==
 
==Overview==
The '''bz_eAllowFlagGrabEvent''' is an API event that is called each time a player is about to grab a flag.
+
The '''bz_eAllowFlagGrab''' is an API event that is called each time a player is about to grab a flag.
 
==Data==
 
==Data==
'''bz_eAllowFlagGrabEvent''' returns the '''bz_eAllowFlagGrabEvent_V1''' data class.
+
'''bz_eAllowFlagGrab''' returns the '''bz_AllowFlagGrabData_V1''' data class.
  
 
   {| border="1" cellpadding="20" cellspacing="0"
 
   {| border="1" cellpadding="20" cellspacing="0"
Line 14: Line 14:
 
   |eventType     
 
   |eventType     
 
   |[[Event(API)|bz_eEventType]]
 
   |[[Event(API)|bz_eEventType]]
   |bz_eAllowFlagGrabEvent
+
   |bz_eAllowFlagGrab
 
   |-
 
   |-
 
   |playerID
 
   |playerID

Revision as of 16:37, 15 October 2012

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_eAllowFlagGrab is an API event that is called each time a player is about to grab a flag.

Data

bz_eAllowFlagGrab returns the bz_AllowFlagGrabData_V1 data class.

name type value description
eventType bz_eEventType bz_eAllowFlagGrab
playerID int The ID of the player who is grabbing the flag
pos float[3] The position of the player about to grab the flag
flagID int The ID of the flag that is going to be grabbed
flagType const char* The type of the flag about to be grabbed
allow bool Whether or not to allow the flag grab