Wrayth protocol

The official GemStone IV encyclopedia.
Revision as of 12:04, 18 December 2005 by Maintenance script (talk | contribs) (Added output, prompt)
Jump to navigation Jump to search

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 Ildran'>GAZE {self}</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
<output> Changes the typeface
  • class - The typeface to be used
<output class="mono"/> No contents Only valid values for class appear to be "mono" (fixed-width font) and "" (normal font)
<prompt> Signals a prompt
  • time - A timestamp for the prompt
<prompt time="1134928732">R&gt;</prompt> Sends the contents to the story window
<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.