bz eFlagDroppedEvent

From BZFlagWiki
Revision as of 23:21, 13 August 2007 by JeffM2501 (Talk | contribs) (New page: {{BZFS_API_Doc}} {{BZFS_API_EVENT}} ==Overview== The bz eFlagDroppedEvent is an API event that is called each time a flag is drooped by a player. ==Data== As of version 2.1 of BZFS the e...)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server.
Template:BZFS API EVENT

Overview

The bz eFlagDroppedEvent is an API event that is called each time a flag is drooped by a player.

Data

As of version 2.1 of BZFS the event callback will contain the bz_FlagDroppedEventData_V1 data class. This class contains the following data members

* eventType    ( always bz eFlagDroppedEvent )
* playerID     ( the player that dropped the flag )
* flagID       ( the flag ID that was dropped )
* pos[3]       ( the postion the flag was dropped at )

Uses

This event is a notification only event, none of the data returned can be changed. If the plug-in wishes to change the spawning position of a flag it should use the bz_eFlagResetEvent