This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz eAllowFlagGrab"
From BZFlagWiki
m (moved Bz eAllowFlagGrabEvent to Bz eAllowFlagGrab: this is the real name for the event) |
(added eventTime field) |
||
(2 intermediate revisions by 2 users not shown) | |||
Line 3: | Line 3: | ||
==Overview== | ==Overview== | ||
− | The ''' | + | The '''bz_eAllowFlagGrab''' is an API event that is called each time a player is about to grab a flag. |
==Data== | ==Data== | ||
− | ''' | + | '''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_eAllowFlagGrab |
|- | |- | ||
|playerID | |playerID | ||
Line 22: | Line 22: | ||
|pos | |pos | ||
|float[3] | |float[3] | ||
− | |The position of the player about to grab the flag | + | |The position of the player about to grab the flag (Only available in 2.99.x) |
|- | |- | ||
|flagID | |flagID | ||
Line 35: | Line 35: | ||
|bool | |bool | ||
|Whether or not to allow the flag grab | |Whether or not to allow the flag grab | ||
+ | |- | ||
+ | |eventTime | ||
+ | |double | ||
+ | |The server time at which the event occurred (in seconds). | ||
|} | |} |
Latest revision as of 07:44, 1 May 2014
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[edit]
The bz_eAllowFlagGrab is an API event that is called each time a player is about to grab a flag.
Data[edit]
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 (Only available in 2.99.x) |
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 |
eventTime | double | The server time at which the event occurred (in seconds). |