Editing Bz eFlagDroppedEvent

Jump to: navigation, search

Warning: The database has been locked for maintenance, so you will not be able to save your edits right now. You may wish to copy and paste your text into a text file and save it for later.

The administrator who locked it offered this explanation: Server migration

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 3: Line 3:
  
 
==Overview==
 
==Overview==
The '''bz_eFlagDroppedEvent''' is an API event that is called each time a flag is dropped by a player.
+
The '''bz_eFlagDroppedEvent''' is an API event that is called each time a flag is drooped by a player.
  
 
==Data==
 
==Data==
Line 19: Line 19:
 
   |playerID     
 
   |playerID     
 
   |int
 
   |int
   |The player that dropped the flag (this value may be set to -1 if the player ID is unknown).
+
   |The player that dropped the flag
 
   |-
 
   |-
 
   |flagID       
 
   |flagID       
 
   |int
 
   |int
 
   |The flag ID that was dropped
 
   |The flag ID that was dropped
  |-
 
  |flagType     
 
  |[[bz_ApiString]]
 
  |The flag abbreviation of the flag that was grabbed
 
 
   |-
 
   |-
 
   |pos
 
   |pos
 
   |float[3]
 
   |float[3]
   |The position at which the flag was dropped
+
   |the position the flag was dropped at
  |-
+
  |eventTime
+
  |double
+
  |The server time at which the event occurred (in seconds).
+
 
   |}
 
   |}
  
 
==Uses==
 
==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]]
+
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==
 
==History==
In Version 2.0.x of BZFlag the data class for this event was named '''bz_FlagDroppedEventData''' and contains the same data.
+
In Version 2.0.x of BZFlag the data class for this event was named '''bz_FlagDroppedEvenData''' and contains the same data.
  
 
[[Category:BZFS_API_Docs]]
 
[[Category:BZFS_API_Docs]]
 
[[Category:BZFS_API_Events]]
 
[[Category:BZFS_API_Events]]

Please note that all contributions to BZFlagWiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see BZFlagWiki:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel | Editing help (opens in new window)

Templates used on this page: