ROOM

Name

ROOM -- List entry describing one room

Synopsis

<ROOM ID="id" NAME="name" REFNAME="name" GAME="game" PLAYERS="players"> <DESC>desc</DESC> </ROOM>
Data	Type	Example
ID	int	0
NAME	string	TicTacToeTranslated
REFNAME	string	TicTacToe
GAME	int	4
PLAYERS	int	14
DESC	string	Sample TTT room

Description

A list entry describing one room at a GGZ server

Message Data

ID	Unique identifier for this room
NAME	Room name, potentially translated, for displaying to user
REFNAME	Room name for internal use, including URIs, should not be shown to user
GAME	The identifier of the game associated with this room
PLAYERS	The number of players currently in the room. This value is sent in the room list and may be periodically updated. However this information is not updated immediately, so the client's knowledge may become stale. For the current room the client should use the list of players in the room as a more accurate value.
DESC	Verbose room description (sent only if requested)

Usage

A list of room tags is sent when requesting the list of available rooms on a server, typically done after logging in.