This wiki is archived and useful information is being migrated to the main bzflag.org website

Difference between revisions of "Bz eFlagDroppedEvent"

From BZFlagWiki
Jump to: navigation, search
(Overview)
(Data)
Line 6: Line 6:
  
 
==Data==
 
==Data==
As of version 2.1 of BZFS the event callback will contain the bz_FlagDroppedEventData_V1 data class.
+
'''bz_eFlagDroppedEvent''' returns the '''bz_FlagDroppedEventData_V1''' data class.
This class contains the following data members
+
  
* eventType    ( always bz eFlagDroppedEvent )
+
  {| border="1" cellpadding="20" cellspacing="0"
* playerID    ( the player that dropped the flag )
+
  !name
* flagID      ( the flag ID that was dropped )
+
  !type
* pos[3]       ( the postion the flag was dropped at )
+
  !value desription
 +
  |-
 +
  |eventType     
 +
  |[[Events(API)|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 the flag was dropped at
 +
  |}
  
 
==Uses==
 
==Uses==

Revision as of 02:31, 14 August 2007

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 drooped 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 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