MUME Help
GMCP MUME.CLIENT
These are the messages in the GMCP
MUME.Client module.
Sent by server
MUME.Client.CancelEdit
-
Sent in response to a client's
MUME.Client.CancelEditmessage. -
Message body is an object with these keys:
id(optional) If the client's MUME.Client.CancelEditcontained a non-negativeid, this is that identifier.resultEither trueon a successful cancel; or an error string on error.
MUME.Client.Edit
- Sent as the player wants to edit a text message.
-
The body is an object with these keys:
ida non-negative integer identifying this edit session title(optional) a string with the description of the text texta string containing the text that should be edited -
The client is expected to (at some
point) respond using one of
MUME.Client.WriteorMUME.Client.CancelEdit(see below).
MUME.Client.Error
- Sent on (some) protocol errors.
-
Message body is an object with a single
messagekey whose value is a string containing an error message.
MUME.Client.View
- Sent as the player wants to view a text message.
-
The body is an object with these keys:
title(optional) a string with the description of the text texta string containing the text that should be viewed
MUME.Client.Write
-
Sent in response to a client's
MUME.Client.Writemessage. -
Message body is an object with these keys:
id(optional) If the client's MUME.Client.Writecontained a non-negativeid, this is that identifier.resultEither trueon a successful write; or an error string on error.
Sent by client
MUME.Client.CancelEdit
-
This message is used to cancel an edit session initiated from a server's
MUME.Client.Editmessage. -
Message body is an object with a single
id, which must match that of theMUME.Client.Editmessage.
MUME.Client.Write
-
This message is used to finalize an edit session initiated from a server's
MUME.Client.Editmessage. -
Message body is an object with these keys:
idthe number from the MUME.Client.Editmessagetexta string containing the new text -
The
textstring can only contain a subset of all Unicode characters.- Today, only those in the ISO 8859-1 character set, except NUL, are allowed.
- This is subject to change.
- The text may not be arbitrariliy long.
-
Unless a
MUME.Client.Errormessage was triggered, the server will respond with aMUME.Client.Writeof its own; see above.
MUME.Client.XML
- Sent to change XML settings.
-
Message body is an object with these optional keys:
enabletrueorfalseto enable or disable XML modesilenttrueorfalseto make XML mode change without sending an<xml>or</xml>messagegratuitous-outputtrueorfalseto enable or disable always sending descriptions regardless ofchange spamsettings; in that case, encloses output in a<gratuitous>XML tag
Generated on Mon Dec 15 12:43:16 2025