Bz eAllowPlayer - Revision history

Zehra: redirect, since events are in official docs

2025-11-27T02:08:58Z

redirect, since events are in official docs

← Older revision		Revision as of 02:08, 27 November 2025
Line 1:		Line 1:
	~~{{BZFS_API_Doc}}~~		#REDIRECT [[Category:BZFS API Docs]]
	~~{{BZFS_API_Events}}~~

	~~==Overview==~~
	~~The '''bz_eAllowPlayer''' is an API event that is called each time a player connects to the server. This event is called after all internal allow/deny logic.~~

	~~==Data==~~
	~~'''bz_eAllowPlayer''' returns the '''bz_AllowPlayerEventData_V1''' data class.~~

	~~{\| border="1" cellpadding="20" cellspacing="0"~~
	~~!name~~
	~~!type~~
	~~!value description~~
	\|-
	~~\|eventType~~
	\|[[~~Event(~~API~~)\|bz_eEventType]]~~
	~~\|bz_eAllowPlayer~~
	\|-
	~~\|playerID~~
	~~\|int~~
	~~\|This value is the player ID for the joining player.~~
	\|-
	~~\|callsign~~
	~~\|[[bz_ApiString]]~~
	~~\|This value is the callsign for the player.~~
	\|-
	~~\|ipAddress~~
	~~\|[[bz_ApiString]]~~
	~~\|This value is the IPv4 address of the player.~~
	\|-
	~~\|reason~~
	~~\|[[bz_ApiString~~]]
	~~\|This value is the reason for any denials of admittance, it will be reported back to the player.~~
	\|-
	~~\|allow~~
	~~\|bool~~
	~~\|This value is the current allow/deny state for the join. Plug-ins wishing to overide the server allow/deny logic can change this value.~~
	\|-
	~~\|eventTime~~
	~~\|double~~
	~~\|This value is the local server time of the event.~~
	\|}
	~~==Uses==~~
	~~This is a modification event, plug-ins may override the allow/deny logic choice themselves. This is the primary hook for plug-ins that wish to implement custom ban list systems.~~

Zehra: typo fix

2016-11-25T01:27:03Z

typo fix

← Older revision		Revision as of 01:27, 25 November 2016
Line 3:		Line 3:

	==Overview==		==Overview==
	The '''bz_eAllowPlayer''' is an API event that is called each time a player connects to the server. This event is called ~~affter~~ all internal allow/deny logic.		The '''bz_eAllowPlayer''' is an API event that is called each time a player connects to the server. This event is called after all internal allow/deny logic.

	==Data==		==Data==

JeffM2501 at 21:47, 30 November 2007

2007-11-30T21:47:11Z

← Older revision		Revision as of 21:47, 30 November 2007
Line 1:		Line 1:
	{{BZFS_API_Doc}}		{{BZFS_API_Doc}}
	{{BZFS_API_Events}}		{{BZFS_API_Events}}
	~~{{API_Docs_that_need_work}}~~

	==Overview==		==Overview==
	The '''bz_eAllowPlayer''' is an API event that is called each time a player ~~joins~~ to ~~allow a plug-in to override~~ the ~~servers~~ allow or deny ~~choice~~.		The '''bz_eAllowPlayer''' is an API event that is called each time a player connects to the server. This event is called affter all internal allow/deny logic.

	==Data==		==Data==
	'''bz_eAllowPlayer''' returns the '''bz_AllowPlayerEventData_V1''' data class.		'''bz_eAllowPlayer''' returns the '''bz_AllowPlayerEventData_V1''' data class.
Line 19:		Line 19:
	\|playerID		\|playerID
	\|int		\|int
	\|~~Each client has a~~ player ID~~, even if that client is not yet in~~ the ~~game yet. This way, every client can be identified using an integer value~~.		\|This value is the player ID for the joining player.
	\|-		\|-
	\|callsign		\|callsign
	\|[[bz_ApiString]]		\|[[bz_ApiString]]
	\|~~The~~ player~~'s callsign~~		\|This value is the callsign for the player.
	\|-		\|-
	\|ipAddress		\|ipAddress
	\|[[bz_ApiString]]		\|[[bz_ApiString]]
	\|~~The IP~~ address of the ~~client which is trying to get into the game~~		\|This value is the IPv4 address of the player.
	\|-		\|-
	\|reason		\|reason
	\|[[bz_ApiString]]		\|[[bz_ApiString]]
	\|~~If a plugin denies~~ the ~~entrance~~ of a player~~, then that plugin can explain why in this field~~.		\|This value is the reason for any denials of admittance, it will be reported back to the player.
	\|-		\|-
	\|allow		\|allow
	\|bool		\|bool
	\|This value ~~should be set to true by~~ the ~~plugin if that plugin decided to~~ allow the ~~player~~ to ~~enter~~ the ~~game, and false otherwise~~.		\|This value is the current allow/deny state for the join. Plug-ins wishing to overide the server allow/deny logic can change this value.
	\|-		\|-
	\|eventTime		\|eventTime
	\|double		\|double
	\|This value is the time ~~at which the client requested to enter the game (and thus~~ the event ~~was created)~~.		\|This value is the local server time of the event.
	\|}		\|}
	==Uses==		==Uses==
	~~A plugin can use this~~ event ~~to use an alternative to a ban list to decide whether a user should be allowed to play on~~ the ~~server~~. ~~For example, if the server load~~ is ~~temporarily high, then a plugin could deny~~ the ~~entrance of even more users temporarily~~.		This is a modification event, plug-ins may override the allow/deny logic choice themselves. This is the primary hook for plug-ins that wish to implement custom ban list systems.

	~~[[Category:BZFS_API_Docs]]~~
	~~[[Category:BZFS_API_Events]]~~

Tulcod: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} {{API_Docs_that_need_work}} ==Overview== The '''bz_eAllowPlayer''' is an API event that is called each time a player joins to allow a plug-in to overr...

2007-11-30T21:33:25Z

New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} {{API_Docs_that_need_work}} ==Overview== The '''bz_eAllowPlayer''' is an API event that is called each time a player joins to allow a plug-in to overr...

New page

{{BZFS_API_Doc}}
{{BZFS_API_Events}}
{{API_Docs_that_need_work}}

==Overview==
The '''bz_eAllowPlayer''' is an API event that is called each time a player joins to allow a plug-in to override the servers allow or deny choice.
==Data==
'''bz_eAllowPlayer''' returns the '''bz_AllowPlayerEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eAllowPlayer
|-
|playerID
|int
|Each client has a player ID, even if that client is not yet in the game yet. This way, every client can be identified using an integer value.
|-
|callsign
|[[bz_ApiString]]
|The player's callsign
|-
|ipAddress
|[[bz_ApiString]]
|The IP address of the client which is trying to get into the game
|-
|reason
|[[bz_ApiString]]
|If a plugin denies the entrance of a player, then that plugin can explain why in this field.
|-
|allow
|bool
|This value should be set to true by the plugin if that plugin decided to allow the player to enter the game, and false otherwise.
|-
|eventTime
|double
|This value is the time at which the client requested to enter the game (and thus the event was created).
|}
==Uses==
A plugin can use this event to use an alternative to a ban list to decide whether a user should be allowed to play on the server. For example, if the server load is temporarily high, then a plugin could deny the entrance of even more users temporarily.

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]