PLAYER

Name

PLAYER --  List entry describing one player.

Synopsis

<PLAYER ID='id' TYPE='type' TABLE='table' PERMS='perms' LAG='lag' WINS='wins' LOSSES='losses' TIES='ties' FORFEITS='forfeits' RATING='rating' RANKING='rating' HIGHSCORE='highscore'/>
DataTypeExample
IDstringGrubby
TYPEstringguest
TABLEint-1
PERMSint/hex0x0000000F
LAGint1
WINSint7
LOSSESint3
TIESint1
RATINGint1500
RANKINGint3
HIGHSCORElong49807

Description

List entry containing the description of one player

Message Data

ID

Unique identifier of this player

TYPE

Player type (can be 'guest', 'normal', 'admin' or 'bot')

TABLE

ID number of table at which player is "sitting"; -1 or not present if the player is not at a table.

PERMS

Player permission set - an integer bitfield giving which permissions the player has, according to the enumeration in ggz_common.h.

LAG

Lag value of the player, which ranges from zero (ideal connection) to five (slow connection).

WINS

The number of wins the player has. This will be a non-negative integer, if present. It will not be present if the player has no stats of this type (for whatever reason). WINS, LOSSES, TIES, and FORFEITS will all be either present or not present (as a group).

LOSSES

The number of losses the player has - a non-negative integer. See WINS.

TIES

The number of ties the player has - a non-negative integer. See WINS.

FORFEITS

The number of forfeits (abandoned games) the player has - a non-negative integer. See WINS.

RATING

If present, it represents the player's rating. This is generally done on an ELO scale, although the parameters may differ from those used for Chess. It will not be given if the player has no rating.

RANKING

If present, provides the absolute ranking of the player. This will be a positive integer. It will not be given if the player has no ranking.

HIGHSCORE

If present, provides the highest score the player has achieved at the current game. It will not be given if there is no available highscore for this player.

Usage

The PLAYER is contained in a list sent from the server to the client in response to LIST request tag of type 'player'. It may also be contained within the UPDATE tag send from the server when player information changes. If sent as part of a LIST then the information will be complete - and any omissions are intentional. If sent as part of an UPDATE then only some attributes will be present.