Bz eAllowFlagGrab - Revision history

Zehra: redirect, since events are in official docs

2025-11-05T03:06:36Z

redirect, since events are in official docs

← Older revision		Revision as of 03:06, 5 November 2025
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).~~
	\|}

Allejo: added eventTime field

2014-05-01T07:44:01Z

added eventTime field

← Older revision		Revision as of 07:44, 1 May 2014
Line 35:		Line 35:
	\|bool		\|bool
	\|Whether or not to allow the flag grab		\|Whether or not to allow the flag grab
			\|-
			\|eventTime
			\|double
			\|The server time at which the event occurred (in seconds).
	\|}		\|}

Allejo: Made a note that the position isn't part of the data

2014-05-01T05:18:28Z

Made a note that the position isn't part of the data

← Older revision		Revision as of 05:18, 1 May 2014
Line 22:		Line 22:
	\|pos		\|pos
	\|float[3]		\|float[3]
	\|The position of the player about to grab the flag		\|The position of the player about to grab the flag (Only available in 2.99.x)
	\|-		\|-
	\|flagID		\|flagID

Brad at 16:37, 15 October 2012

2012-10-15T16:37:28Z

← Older revision		Revision as of 16:37, 15 October 2012
Line 3:		Line 3:

	==Overview==		==Overview==
	The '''~~bz_eAllowFlagGrabEvent~~''' is an API event that is called each time a player is about to grab a flag.		The '''bz_eAllowFlagGrab''' is an API event that is called each time a player is about to grab a flag.
	==Data==		==Data==
	'''~~bz_eAllowFlagGrabEvent~~''' returns the '''~~bz_eAllowFlagGrabEvent_V1~~''' data class.		'''bz_eAllowFlagGrab''' returns the '''bz_AllowFlagGrabData_V1''' data class.

	{\| border="1" cellpadding="20" cellspacing="0"		{\| border="1" cellpadding="20" cellspacing="0"
Line 14:		Line 14:
	\|eventType		\|eventType
	\|[[Event(API)\|bz_eEventType]]		\|[[Event(API)\|bz_eEventType]]
	\|~~bz_eAllowFlagGrabEvent~~		\|bz_eAllowFlagGrab
	\|-		\|-
	\|playerID		\|playerID

Brad: moved Bz eAllowFlagGrabEvent to Bz eAllowFlagGrab: this is the real name for the event

2012-10-15T16:36:19Z

moved Bz eAllowFlagGrabEvent to Bz eAllowFlagGrab: this is the real name for the event

← Older revision		Revision as of 16:36, 15 October 2012
(No difference)

Mrapple: /* bz_eAllowFlagGrabEvent */

2010-09-25T01:49:24Z

bz_eAllowFlagGrabEvent

New page

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eAllowFlagGrabEvent''' is an API event that is called each time a player is about to grab a flag.
==Data==
'''bz_eAllowFlagGrabEvent''' returns the '''bz_eAllowFlagGrabEvent_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eAllowFlagGrabEvent
|-
|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
|-
|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
|}