Wrayth protocol: Difference between revisions

The official GemStone IV encyclopedia.
Jump to navigation Jump to search
(Added pushBold, popBold, pushStream, popStream, clearStream)
(Added d)
Line 12: Line 12:
|-
|-
| <a>
| <a>
| Displays a link that is clickable to obtain a menu of interaction options
| Displays a link that is clickable to obtain a menu of interaction options or to send a command
|
|
*exist - A unique identifier for the object, for use in menus
*exist - A unique identifier for the object, for use in menus
*noun - The noun of the object, for use in menus
*noun - The noun of the object, for use in menus or commands
*coord - An identifier for a command (optional)
| a <a exist="-26211" noun="door">heavy ironwood door</a>
| a <a exist="-26211" noun="door">heavy ironwood door</a>
<a exist="-10374531" coord="2524,1741" noun="ARMOR">ARMOR</a>
| Displays the contents as a clickable link
| Displays the contents as a clickable link
| Does not suppress following newlines
| Does not suppress following newlines
If coord is not specified, it is a menu, and exist and noun refer to the target of the menu. If it is specified, it is a command, and the exist and noun may be used in the command.
|-
|-
| <clearStream>
| <clearStream>
Line 27: Line 30:
| No contents
| No contents
|
|
|-
| <d>
| Displays a link that is clickable to send a command to the game
|
*cmd - The command to send to the game (optional)
| <d cmd='gaze'>GAZE</d>
| Displays the contents as a clickable link
| If the command portion is omitted, will send the contents of the tag
|-
|-
| <left>
| <left>

Revision as of 12:57, 18 December 2005

The StormFront protocol is the XML protocol used to pass information between the game and the StormFront front end.

Tags

Tag name Description Parameters Example Contents Notes
<a> Displays a link that is clickable to obtain a menu of interaction options or to send a command
  • exist - A unique identifier for the object, for use in menus
  • noun - The noun of the object, for use in menus or commands
  • coord - An identifier for a command (optional)
a <a exist="-26211" noun="door">heavy ironwood door</a>

<a exist="-10374531" coord="2524,1741" noun="ARMOR">ARMOR</a>

Displays the contents as a clickable link Does not suppress following newlines

If coord is not specified, it is a menu, and exist and noun refer to the target of the menu. If it is specified, it is a command, and the exist and noun may be used in the command.

<clearStream> Removes all text within the specified window
  • id - The identifier for the window to remove text from
<clearStream id="spellfront"/> No contents
<d> Displays a link that is clickable to send a command to the game
  • cmd - The command to send to the game (optional)
<d cmd='gaze'>GAZE</d> Displays the contents as a clickable link If the command portion is omitted, will send the contents of the tag
<left>

<right>

Changes the text of the left and right hand panels
  • exist - Same as in <a>
  • noun - Same as in <a>
<right exist="674831" noun="dagger">dagger</right> Sends the contents to the left or right hand panel
<pushBold>

<popBold>

Makes text bold until a matching <popBold> tag

None

<pushBold/>You have unread news articles.<popBold/> No contents Does not suppress following newlines

May nest

<pushStream>

<popStream>

Sends text to specified window if it exists (story window instead) until next <popStream> tag
  • id - The identifier of the window to send text to
<pushStream id="logons"/> * <a exist="-10374531" noun="Ildran">Ildran</a> joins the adventure.
<popStream/>
No contents May nest
<spell> Changes the text of the prepared spell panel
  • exist - Same as in <a>
<spell exist='spell'>Spirit Warding I</spell> Sends the contents to the prepared spell panel

Special handling

  • Tags followed by newlines suppress the newline output to the screen except where noted above.