UPDATE

Name

UPDATE --  Notification that the list of players or the list of tables in a room has changed, or the list of rooms or game types on a server.

Synopsis

<UPDATE TYPE="type" ACTION="action" ROOM="room" FROMROOM="from" TOROOM="to">
DataTypeExample
TYPEstringplayer
ACTIONstringadd
ROOMint1
FROMROOMint2
TOROOMint3

Description

Notification from the server that the list of players in the current room has been modified since the last update, or that a table has been added, removed or changed its state, or that a room or game type has been added or removed.

Message Data

TYPE

Update type. Can be 'player' or 'table' for room updates, or 'room' or 'game' for server updates.

ACTION

Action to do. Can be 'add', 'delete', 'lag', 'perms', or 'stats' for players; 'add', 'delete', 'join', 'leave', 'status', 'desc', or 'seat' for tables; 'add, 'delete', 'close', or 'players' for rooms. No game updates are possible at this time.

ROOM

Room to which the update applies. Only used for types 'player' and 'table'.

FROMROOM

Room the player is coming from. Only used for type 'players' with action 'add'. The room may be -1 indicating "no room".

TOROOM

Room the player is going to. Only used for type 'players' with action 'delete'. The room may be -1 indicating "no room".

Usage

An UPDATE tag is sent from the server to the client if the list of players, tables, rooms or games has changed since the last update. It is not sent upon initial entry to a room or server; the information is originally sent in a LIST. An update is sent when the information of that type changes.

The UPDATE tag contains one or more tags of type PLAYER, TABLE, ROOM, or GAME. The information included in the subtags depends on the ACTION attribute of the update. For instance a "table" "desc" update would include only the description of the table, while a "player" "add" update includes the full information about the player. A full list of these dependencies is not available at this time.