Bz eFlagGrabbedEvent: Difference between revisions

Latest revision as of 03:49, 5 November 2025

Redirect to:

@@ Line 1: / Line 1: @@
-{{BZFS_API_Doc}}
+#REDIRECT [[Category:BZFS API Docs]]
-{{BZFS_API_Events}}
-==Overview==
-The '''bz_eFlagGrabbedEvent''' is an API event that is called each time a flag is grabbed by a player.
-==Data==
-'''bz_eFlagGrabbedEvent''' returns the '''bz_FlagGrabbedEventData_V1''' data class.
-  {| border="1" cellpadding="20" cellspacing="0"
-  !name
-  !type
-  !value desription
-  |-
-  |eventType
-  |[[Event(API)|bz_eEventType]]
-  |bz_eFlagGrabbedEvent
-  |-
-  |playerID
-  |int
-  |The player that grabbed the flag
-  |-
-  |flagID
-  |int
-  |The flag ID that was grabbed
-  |-
-  |flagType
-  |[[bz_ApiString]]
-  |The flag abbreviation of the flag that was grabbed
-  |-
-  |pos
-  |float[3]
-  |The position at which the flag was grabbed
-  |-
-  |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.