This wiki is archived and useful information is being migrated to the main bzflag.org website
Editing Bz eFlagDroppedEvent
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: Archived wiki
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 | + | The '''bz_eFlagDroppedEvent''' is an API event that is called each time a flag is drooped by a player. |
==Data== | ==Data== | ||
Line 14: | Line 14: | ||
|- | |- | ||
|eventType | |eventType | ||
− | |[[ | + | |[[Events(API)|bz_eEventType]] |
|bz_eFlagDroppedEvent | |bz_eFlagDroppedEvent | ||
|- | |- | ||
|playerID | |playerID | ||
|int | |int | ||
− | |The player that dropped the flag | + | |The player that dropped the flag |
|- | |- | ||
|flagID | |flagID | ||
|int | |int | ||
|The flag ID that was dropped | |The flag ID that was dropped | ||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
|pos | |pos | ||
|float[3] | |float[3] | ||
− | | | + | |the position the flag was dropped at |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
|} | |} | ||
==Uses== | ==Uses== | ||
− | This event is a notification | + | 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 ''' | + | 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]] |