Bz eGetPlayerInfoEvent - Revision history

Zehra: redirect, since events are in official docs

2025-11-09T22:36:09Z

redirect, since events are in official docs

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

	~~==Overview==~~
	~~The '''bz_eGetPlayerInfoEvent''' is an API event that is called each time the server sends out a player info update message to a remote player.~~

	~~==Data==~~
	~~'''bz_eGetPlayerInfoEvent''' returns the '''bz_GetPlayerInfoEventData_V1''' data class.~~

	~~{\| border="1" cellpadding="20" cellspacing="0"~~
	~~!name~~
	~~!type~~
	~~!value description~~
	\|-
	~~\|eventType~~
	\|[[~~Event(~~API~~)\|bz_eEventType]]~~
	~~\|bz_eGetPlayerInfoEvent~~
	\|-
	~~\|playerID~~
	~~\|int~~
	~~\|The playerID the record refers too.~~
	\|-
	~~\|callsign~~
	~~\|[[bz_ApiString]]~~
	~~\|The callsign for the player.~~
	\|-
	~~\|ipAddress~~
	~~\|[[bz_ApiString]]~~
	~~\|The IPv4 address for the player. (not set in 2.4.0, fixed in 2.4.1.)~~
	\|-
	~~\|team~~
	~~\|[[bz_eTeamType~~]]
	~~\|The team the player is current only.~~
	\|-
	~~\|admin~~
	~~\|bool~~
	~~\|The admin permission state of the player, indicating if they will be displayed with an '@' symbol in the scoreboard.~~
	\|-
	~~\|verified~~
	~~\|bool~~
	~~\|The authentication state of the player, indicating if they will be displayed with an '+' symbol in the scoreboard.~~
	\|-
	~~\|registered~~
	~~\|bool~~
	~~\|The state of the player's username. This value is true if the username is registered. If the user is not verified, but registered then they will be displayed with an '-' symbol in the scoreboard.~~
	\|-
	~~\|eventTime~~
	~~\|double~~
	~~\|The local server time of the event.~~
	\|}

	~~==Uses==~~
	This is a modification event. The state members can be changed ( admin, verified, and registered ). Changes to these values only change the data sent to the remote user, they do not change any internal permission states or access permissions. This event is only to allow plug-ins to overide the logic used for the display of the various scoreboard symbols.

Allejo: Fix typos

2017-01-05T04:04:09Z

Fix typos

← Older revision		Revision as of 04:04, 5 January 2017
Line 35:		Line 35:
	\|admin		\|admin
	\|bool		\|bool
	\|The admin ~~permision~~ state of the player, indicating if they will be displayed with an '@' symbol in the scoreboard.		\|The admin permission state of the player, indicating if they will be displayed with an '@' symbol in the scoreboard.
	\|-		\|-
	\|verified		\|verified
Line 43:		Line 43:
	\|registered		\|registered
	\|bool		\|bool
	\|The state of the player's username. This value is true if the username is registered. If the user is not ~~veriried~~, but registered then they will be displayed with an '-' symbol in the scoreboard.		\|The state of the player's username. This value is true if the username is registered. If the user is not verified, but registered then they will be displayed with an '-' symbol in the scoreboard.
	\|-		\|-
	\|eventTime		\|eventTime

JeffM2501: /* Data */

2011-09-28T23:30:44Z

Data

← Older revision		Revision as of 23:30, 28 September 2011
Line 27:		Line 27:
	\|ipAddress		\|ipAddress
	\|[[bz_ApiString]]		\|[[bz_ApiString]]
	\|The IPv4 address for the player. (~~Defunctional~~ in ~~Version~~ 2.4. ~~Get the player record ipAddress member instead~~.)		\|The IPv4 address for the player. (not set in 2.4.0, fixed in 2.4.1.)
	\|-		\|-
	\|team		\|team

70.190.212.232: /* Data */ sigonasr2 found out ipAddress does not work.

2011-09-28T23:10:00Z

Data: sigonasr2 found out ipAddress does not work.

← Older revision		Revision as of 23:10, 28 September 2011
Line 27:		Line 27:
	\|ipAddress		\|ipAddress
	\|[[bz_ApiString]]		\|[[bz_ApiString]]
	\|The IPv4 address for the player.		\|The IPv4 address for the player. (Defunctional in Version 2.4. Get the player record ipAddress member instead.)
	\|-		\|-
	\|team		\|team
Line 49:		Line 49:
	\|The local server time of the event.		\|The local server time of the event.
	\|}		\|}

	==Uses==		==Uses==
	This is a modification event. The state members can be changed ( admin, verified, and registered ). Changes to these values only change the data sent to the remote user, they do not change any internal permission states or access permissions. This event is only to allow plug-ins to overide the logic used for the display of the various scoreboard symbols.		This is a modification event. The state members can be changed ( admin, verified, and registered ). Changes to these values only change the data sent to the remote user, they do not change any internal permission states or access permissions. This event is only to allow plug-ins to overide the logic used for the display of the various scoreboard symbols.

JeffM2501 at 22:32, 30 November 2007

2007-11-30T22:32:43Z

← Older revision		Revision as of 22:32, 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==

JeffM2501 at 22:32, 30 November 2007

2007-11-30T22:32:27Z

← Older revision		Revision as of 22:32, 30 November 2007
Line 4:		Line 4:

	==Overview==		==Overview==
	The '''bz_eGetPlayerInfoEvent''' is an API event that is called to ~~tell plugins about~~ a ~~new user and find out their permissions. A plugin can use this to modify the state of being administrator, being verified and being registered of every user~~.		The '''bz_eGetPlayerInfoEvent''' is an API event that is called each time the server sends out a player info update message to a remote player.

	==Data==		==Data==
Line 20:		Line 20:
	\|playerID		\|playerID
	\|int		\|int
	\|The ~~identification number of~~ the ~~player~~		\|The playerID the record refers too.
	\|-		\|-
	\|callsign		\|callsign
	\|[[bz_ApiString]]		\|[[bz_ApiString]]
	\|The callsign of the player		\|The callsign for the player.
	\|-		\|-
	\|ipAddress		\|ipAddress
	\|[[bz_ApiString]]		\|[[bz_ApiString]]
	\|The IP address of the player		\|The IPv4 address for the player.
	\|-		\|-
	\|team		\|team
	\|[[bz_eTeamType]]		\|[[bz_eTeamType]]
	\|The team the player ~~belongs to~~		\|The team the player is current only.
	\|-		\|-
	\|admin		\|admin
	\|bool		\|bool
	\|~~This flag is set to true if~~ the player is an ~~administrator~~.		\|The admin permision state of the player, indicating if they will be displayed with an '@' symbol in the scoreboard.
	\|-		\|-
	\|verified		\|verified
	\|bool		\|bool
	\|~~True~~ if ~~the user has authenticated~~ with ~~the login system. Comparable to a user having a "~~+" in the scoreboard.		\|The authentication state of the player, indicating if they will be displayed with an '+' symbol in the scoreboard.
	\|-		\|-
	\|registered		\|registered
	\|bool		\|bool
	\|This ~~flag~~ is ~~set to~~ true if the ~~player~~ is registered ~~with~~ the ~~server~~, ~~as opposed to being verified~~ with the ~~global login system (see the verified flag)~~.		\|The state of the player's username. This value is true if the username is registered. If the user is not veriried, but registered then they will be displayed with an '-' symbol in the scoreboard.
	\|-		\|-
	\|eventTime		\|eventTime
	\|double		\|double
	\|The time of the event		\|The local server time of the event.
	\|}		\|}
	==Uses==		==Uses==
	~~Some data in this~~ event can be ~~modified, namely the following flags:~~ admin, verified, registered. ~~A plugin can~~, for ~~example, let every other user be an admin~~.		This is a modification event. The state members can be changed ( admin, verified, and registered ). Changes to these values only change the data sent to the remote user, they do not change any internal permission states or access permissions. This event is only to allow plug-ins to overide the logic used for the display of the various scoreboard symbols.

	~~[[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_eGetPlayerInfoEvent''' is an API event that is called to tell plugins about a new user and find out...

2007-11-30T21:57:54Z

New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} {{API_Docs_that_need_work}} ==Overview== The '''bz_eGetPlayerInfoEvent''' is an API event that is called to tell plugins about a new user and find out...

New page

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

==Overview==
The '''bz_eGetPlayerInfoEvent''' is an API event that is called to tell plugins about a new user and find out their permissions. A plugin can use this to modify the state of being administrator, being verified and being registered of every user.

==Data==
'''bz_eGetPlayerInfoEvent''' returns the '''bz_GetPlayerInfoEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eGetPlayerInfoEvent
|-
|playerID
|int
|The identification number of the player
|-
|callsign
|[[bz_ApiString]]
|The callsign of the player
|-
|ipAddress
|[[bz_ApiString]]
|The IP address of the player
|-
|team
|[[bz_eTeamType]]
|The team the player belongs to
|-
|admin
|bool
|This flag is set to true if the player is an administrator.
|-
|verified
|bool
|True if the user has authenticated with the login system. Comparable to a user having a "+" in the scoreboard.
|-
|registered
|bool
|This flag is set to true if the player is registered with the server, as opposed to being verified with the global login system (see the verified flag).
|-
|eventTime
|double
|The time of the event
|}
==Uses==
Some data in this event can be modified, namely the following flags: admin, verified, registered. A plugin can, for example, let every other user be an admin.

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

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

	~~==Overview==~~
	~~The '''bz_eGetPlayerInfoEvent''' is an API event that is called each time the server sends out a player info update message to a remote player.~~

	~~==Data==~~
	~~'''bz_eGetPlayerInfoEvent''' returns the '''bz_GetPlayerInfoEventData_V1''' data class.~~

	~~{\| border="1" cellpadding="20" cellspacing="0"~~
	~~!name~~
	~~!type~~
	~~!value description~~
	\|-
	~~\|eventType~~
	\|[[~~Event(~~API~~)\|bz_eEventType]]~~
	~~\|bz_eGetPlayerInfoEvent~~
	\|-
	~~\|playerID~~
	~~\|int~~
	~~\|The playerID the record refers too.~~
	\|-
	~~\|callsign~~
	~~\|[[bz_ApiString]]~~
	~~\|The callsign for the player.~~
	\|-
	~~\|ipAddress~~
	~~\|[[bz_ApiString]]~~
	~~\|The IPv4 address for the player. (not set in 2.4.0, fixed in 2.4.1.)~~
	\|-
	~~\|team~~
	~~\|[[bz_eTeamType~~]]
	~~\|The team the player is current only.~~
	\|-
	~~\|admin~~
	~~\|bool~~
	~~\|The admin permission state of the player, indicating if they will be displayed with an '@' symbol in the scoreboard.~~
	\|-
	~~\|verified~~
	~~\|bool~~
	~~\|The authentication state of the player, indicating if they will be displayed with an '+' symbol in the scoreboard.~~
	\|-
	~~\|registered~~
	~~\|bool~~
	~~\|The state of the player's username. This value is true if the username is registered. If the user is not verified, but registered then they will be displayed with an '-' symbol in the scoreboard.~~
	\|-
	~~\|eventTime~~
	~~\|double~~
	~~\|The local server time of the event.~~
	\|}

	~~==Uses==~~
	This is a modification event. The state members can be changed ( admin, verified, and registered ). Changes to these values only change the data sent to the remote user, they do not change any internal permission states or access permissions. This event is only to allow plug-ins to overide the logic used for the display of the various scoreboard symbols.