bz eFlagDroppedEvent

From BZFlagWiki
Revision as of 07:45, 1 May 2014 by Allejo (Talk | contribs) (also added eventTime here)

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

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_eFlagDroppedEvent is an API event that is called each time a flag is dropped by a player.

Data[edit]

bz_eFlagDroppedEvent returns the bz_FlagDroppedEventData_V1 data class.

name type value desription
eventType bz_eEventType bz_eFlagDroppedEvent
playerID int The player that dropped the flag (this value may be set to -1 if the player ID is unknown).
flagID int The flag ID that was dropped
flagType bz_ApiString The flag abbreviation of the flag that was grabbed
pos float[3] The position at which the flag was dropped
eventTime double The server time at which the event occurred (in seconds).

Uses[edit]

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

History[edit]

In Version 2.0.x of BZFlag the data class for this event was named bz_FlagDroppedEventData and contains the same data.