Bz eGetPlayerInfoEvent

BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server.

BZFS Event. This page documents a BZFS event that is called by the game server to notify plug-ins of various actions and state changes in the game world.

This page contains API documentation that needs to be reviewed and cleaned up. The information presented here is most likely correct but has not been verified, or may refer to an older version of the API.

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.

name	type	value description
eventType	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.