Difference between revisions of "Bz eFlagDroppedEvent"

From BZFlagWiki
Jump to: navigation, search
m (Overview: drooped -> dropped ;))
m (Fixed a sentence that ended with preposition.)
Line 27: Line 27:
 
   |pos
 
   |pos
 
   |float[3]
 
   |float[3]
   |the position the flag was dropped at
+
   |The position at which the flag was dropped
 
   |}
 
   |}
  

Revision as of 04:15, 3 October 2009

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

Data

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
flagID int The flag ID that was dropped
pos float[3] The position at which the flag was dropped

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

History

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