Bz BasePlayerRecord

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

BZFS Class. This page documents a BZFS API class that is defined by the game server API. Plug-ins receive various classes in able to retrieve information about players and the game state from the server.

Overview

The bz_bz_BasePlayerRecord is an API class that is provided to expose information about a connected player to the plug-in.

Data

bz_BasePlayerRecord contains

name	type	value desription
version	int	The version number of the record.
playerID	int	The player ID for the player.
callsign	bz_ApiString	The username/callsign for the player.
email	bz_ApiString	The e-mail address provided by the user
team	bz_eTeamType	The team the player is currently on.
lastUpdateTime	float	The server time of the last player update
lastKnownState	bz_PlayerUpdateState	The state record that was last sent
currentState	bz_PlayerUpdateState	The predicted state at the current time, representing where the server and all remote users show the player at.
ipAddress	bz_ApiString	The internet protocols version 4 address of the user.
currentFlag	bz_ApiString	The name of the current flag the player is holding. This will be empty if the player has no flag.
flagHistory	bz_APIStringList	A list of strings representing the names of all the flags the player has held, in order from newest to oldest.
spawned	bool	True if the user has spawned and is playing.
verified	bool	True if the user has authenticated with the login system. Comparable to a user having a "+" in the scoreboard.
globalUser	bool	True if the user name was authenticated using the global login system as opposed to a local one.
bzID	bz_ApiString	The globally unique ID for authenticated users.
admin	bool	True if the user has kick and ban permissions.
op	bool	True if the user is identified as a server operator.
canSpawn	bool	True if the user has permisions to spawn.
groups	bz_APIStringList	The list of groups the user is a member of
lag	int	The user's current lag amount in milliseconds.
jitter	int	The user's current jitter amount in milliseconds.
packetloss	float	The user's current packet loss percentage.
wins	int	The number of kills the user has had.
losses	int	The number of deaths the user has had
teamkills	int	The number of team mates the user has killed.

Methods

The class provides a number of methods for various utility functions;

void update ( void );

This method will update the player record with the most current data. This is usefull if a plug-in stores the pointer to the class and wishes to use it with current data.

bool hasPerm ( const char* perm );

This method will return true if the user has the permission with the specified name.

bool grantPerm ( const char* perm );

This method will give the user the permission with the specified name, and return true if the operation was successful.

bool revokePerm ( const char* perm );

This method will remove the user the permission with the specified name, and return true if the operation was successful.

Uses

This class is returned by a number of API functions and events. This class is used any time player specific data is requested.