MUME Help
GMCP ROOM.CHARS
These are the messages in the GMCP
Room.Chars
module.
Sent by server
-
Room.Chars.<command>
are sent from the server as something changes about the characters in the room. -
The client must keep a set of currently known
characters (in their room), as identified by their
id
numbers. This set is maintained using theAdd
,Update
,Remove
, andSet
commands. -
A <character> is an
object with the following (optional) keys:
id
a number identifying this character (the only mandatory field) name
the character's name (a string) type
character type (see below) desc
the current one-line description (a string) flags
temporary states (an array of strings) labels
labels (an array of strings); only Ainur can have multiple position
current position (a string) weapon
current weapon ( false
or a string)fighting
currently attacking (*) driving
currently driving; first rider of (*) riding
currently riding; not-first rider (*) (*) These fields can be a string ( "you"
,"Someone"
, …), anid
number representing another character, ornull
.The
type
field can have one of these string values:npc
non-player characters ally
a player character from an allied (sub)race enemy
a player character from an enemy (sub)race neutral
other player characters
Room.Chars.Add
Room.Chars.Update
-
Sent whenever state for an already known
character, as identified by the
id
key, should be updated - Message body is a <character>; the included keys are the ones that should be updated
Room.Chars.Remove
-
Sent when a character, identified by its
id
key, is removed from the set - Message body is the <id> (a number)
Room.Chars.Set
- Sent when the set of characters should be completely replaced
- Message body is an array of <character>
Generated on Thu Sep 5 18:09:40 2024