Difference between revisions of "GMCP Packages"
| Line 1: | Line 1: | ||
| − | The following packages are available via GMCP. Some packages may only be requested from the MUD, others may only be broadcast from the MUD, and others may be requested or broadcast. | + | The following packages are available via [[GMCP]]. Some packages may only be requested from the MUD, others may only be broadcast from the MUD, and others may be requested or broadcast. |
== Char == | == Char == | ||
Revision as of 07:33, 6 January 2021
The following packages are available via GMCP. Some packages may only be requested from the MUD, others may only be broadcast from the MUD, and others may be requested or broadcast.
Char[edit]
char.prompt[edit]
Request and broadcast
The char.prompt message includes all values available in the prompt. This list can be seen in the PROMPT CODES help file.
The char.prompt package does not require any parameters and can be sent an empty object as the request message.
Example: {}
char.offer[edit]
Request only
The char.offer message includes a list of all items as they would appear in the OFFER command. This list includes the name of each item, as well as their weight and rent.
In addition to the list of items, the message will also include the total count, the total weight, and the total rent of items.
The char.offer package does not require any parameters and can be sent an empty object as the request message.
Example: {}
char.status[edit]
Request only
The char.status message includes all values visible from the STATUS command. This includes conditions, affects, and timers. If only one of these sets of values is needed, consider using one of the char.status sub packages.
The char.status package does not require any parameters and can be sent an empty object as the request message.
Example: {}
char.status.conditions[edit]
Request only
The char.status.conditions message includes all of the conditions as seen in the STATUS command.
The char.status.conditions package does not require any parameters and can be sent an empty object as the request message.
Example: {}
char.status.affectedby[edit]
Request only
The char.status.affectedby message includes all of the affects as seen in the STATUS command.
The char.status.affectedby package does not require any parameters and can be sent an empty object as the request message.
Example: {}
char.status.timers[edit]
Request only
The char.status.timers message includes all of the timers as seen in the STATUS command.
The char.status.timers package does not require any parameters and can be sent an empty object as the request message.
Example: {}
Room[edit]
room.info[edit]
Request and broadcast
The room.info messsage includes the name and description of the character's current room. If the character is in the dark or can otherwise not see the room name and description, the message will not contain the accurate name and description. This message also includes the name of the area for the current room.
The room.info package does not require any parameters and can be sent an empty object as the request message.
Example: {}
Group[edit]
group.info[edit]
Request only
The group.info message includes the information as seen in the GROUP command. If the character is not in a group, it will not include any information.
The group.info package does not require any parameters and can be sent an empty object as the request message.
Example: {}
Logging[edit]
logging.error[edit]
Broadcast only
The logging.error message includes information about the error that was encountered while processing the GMCP request or broadcast.