|
|
| Line 1: |
Line 1: |
| {{BZFS_API_Doc}}
| | #REDIRECT [[Category:BZFS API Docs]] |
| {{BZFS_API_Events}}
| |
| | |
| ==Overview==
| |
| The '''bz_eAllowFlagGrab''' is an API event that is called each time a player is about to grab a flag.
| |
| ==Data==
| |
| '''bz_eAllowFlagGrab''' returns the '''bz_AllowFlagGrabData_V1''' data class.
| |
| | |
| {| border="1" cellpadding="20" cellspacing="0"
| |
| !name
| |
| !type
| |
| !value description
| |
| |-
| |
| |eventType
| |
| |[[Event(API)|bz_eEventType]]
| |
| |bz_eAllowFlagGrab
| |
| |-
| |
| |playerID
| |
| |int
| |
| |The ID of the player who is grabbing the flag
| |
| |-
| |
| |pos
| |
| |float[3]
| |
| |The position of the player about to grab the flag (Only available in 2.99.x)
| |
| |-
| |
| |flagID
| |
| |int
| |
| |The ID of the flag that is going to be grabbed
| |
| |-
| |
| |flagType
| |
| |const char*
| |
| |The type of the flag about to be grabbed
| |
| |-
| |
| |allow
| |
| |bool
| |
| |Whether or not to allow the flag grab
| |
| |-
| |
| |eventTime
| |
| |double
| |
| |The server time at which the event occurred (in seconds).
| |
| |}
| |