Wrayth protocol: Difference between revisions
Jump to navigation
Jump to search
(Added output, prompt) |
(Added clearContainer, inv, mode) |
||
Line 22: | Line 22: | ||
| 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. |
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. |
||
|- |
|||
| <clearContainer> |
|||
| Removes all text within the specified container window |
|||
| |
|||
*id - The id of the container window |
|||
| <clearContainer id="stow"/> |
|||
| No contents |
|||
| |
|||
|- |
|- |
||
| <clearStream> |
| <clearStream> |
||
Line 37: | Line 45: | ||
| <d cmd='gaze Ildran'>GAZE {self}</d> |
| <d cmd='gaze Ildran'>GAZE {self}</d> |
||
| Displays the contents as a clickable link |
| Displays the contents as a clickable link |
||
| If the |
| If the cmd parameter is omitted, will send the contents of the tag |
||
|- |
|||
| <inv> |
|||
| Adds text to a container window |
|||
| |
|||
*id - The id of the container window |
|||
| <inv id='stow'> a <a exist="675003" noun="cards">deck of red and green cards</a></inv> |
|||
| Appends contents (plus a newline) to the container window specified |
|||
| |
|||
|- |
|- |
||
| <left> |
| <left> |
||
Line 48: | Line 64: | ||
| Sends the contents to the left or right hand panel |
| Sends the contents to the left or right hand panel |
||
| |
| |
||
|- |
|||
| <mode> |
|||
| Changes the execution mode |
|||
| |
|||
*id - The id of the new mode |
|||
| <mode id="CMGR"/> |
|||
| No contents |
|||
| Valid modes appear to be "GAME" (the usual execution mode) and "CMGR" (ignore all tags except another <mode> tag) |
|||
|- |
|- |
||
| <output> |
| <output> |
Revision as of 12:10, 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 |
|
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. |
<clearContainer> | Removes all text within the specified container window |
|
<clearContainer id="stow"/> | No contents | |
<clearStream> | Removes all text within the specified window |
|
<clearStream id="spellfront"/> | No contents | |
<d> | Displays a link that is clickable to send a command to the game |
|
<d cmd='gaze Ildran'>GAZE {self}</d> | Displays the contents as a clickable link | If the cmd parameter is omitted, will send the contents of the tag |
<inv> | Adds text to a container window |
|
<inv id='stow'> a <a exist="675003" noun="cards">deck of red and green cards</a></inv> | Appends contents (plus a newline) to the container window specified | |
<left>
<right> |
Changes the text of the left and right hand panels |
|
<right exist="674831" noun="dagger">dagger</right> | Sends the contents to the left or right hand panel | |
<mode> | Changes the execution mode |
|
<mode id="CMGR"/> | No contents | Valid modes appear to be "GAME" (the usual execution mode) and "CMGR" (ignore all tags except another <mode> tag) |
<output> | Changes the typeface |
|
<output class="mono"/> | No contents | Only valid values for class appear to be "mono" (fixed-width font) and "" (normal font) |
<prompt> | Signals a prompt |
|
<prompt time="1134928732">R></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 |
|
<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 |
|
<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.