Difference between revisions of "Bz eAllowFlagGrab"

From BZFlagWiki
Jump to: navigation, search
(bz_eAllowFlagGrabEvent)
 
m (moved Bz eAllowFlagGrabEvent to Bz eAllowFlagGrab: this is the real name for the event)
(No difference)

Revision as of 16:36, 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_eAllowFlagGrabEvent is an API event that is called each time a player is about to grab a flag.

Data

bz_eAllowFlagGrabEvent returns the bz_eAllowFlagGrabEvent_V1 data class.

name type value description
eventType bz_eEventType bz_eAllowFlagGrabEvent
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