|
|
| Line 1: |
Line 1: |
| {{BZFS_API_Doc}}
| | #REDIRECT [[Category:BZFS API Docs]] |
| {{BZFS_API_Events}}
| |
| | |
| ==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.
| |
| | |
| {| border="1" cellpadding="20" cellspacing="0"
| |
| !name
| |
| !type
| |
| !value desription
| |
| |-
| |
| |eventType
| |
| |[[Event(API)|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==
| |
| 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_FlagDroppedEventData''' and contains the same data.
| |
| | |
| [[Category:BZFS_API_Docs]] | |
| [[Category:BZFS_API_Events]]
| |