LIST

Name

LIST --  Client request for list of rooms or games on the server, or of tables or players in a room

Synopsis

<LIST TYPE="type" FULL="full"/>
DataTypeExample
TYPEstringroom
FULLboolstringtrue

Description

Client request for list of rooms or game types on the server, or (when in a room) for list of tables or list of players

Message Data

TYPE

The type may be 'room' for the room list, and 'game' to receive the game types list. Likewise, 'player' and 'table' are used to retrieve room information.

FULL

Verbosity flag. Set to 'false' for short room descriptions, 'true' for full descriptions. This is only used for the 'room' type.


Usage

The <LIST> tag is sent from the client to the server to request a list of rooms, game types, tables or players. The server will respond with the appropriate RESULT tag which contains a LIST. This request is only valid once the player has successfully logged in for 'room' and 'game' types (ie. after the login RESULT), and only after the player has entered a room (for 'table' and 'player' types).