Wrayth protocol: Difference between revisions
Jump to navigation
Jump to search
(Added left, right, spell) |
(Added pushBold, popBold, pushStream, popStream, clearStream) |
||
Line 4: | Line 4: | ||
{| {{prettytable}} |
{| {{prettytable}} |
||
! Tag name |
|||
! Description |
|||
! Parameters |
|||
! Example |
|||
! Contents |
|||
! Notes |
|||
|- |
|- |
||
| <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 |
||
| |
|||
*exist - A unique identifier for the object, for use in menus |
|||
*noun - The noun of the object, for use in menus |
|||
| a <a exist="-26211" noun="door">heavy ironwood door</a> |
| a <a exist="-26211" noun="door">heavy ironwood door</a> |
||
| Displays the contents as a clickable link |
| Displays the contents as a clickable link |
||
| Does not suppress following newlines |
|||
|- |
|- |
||
| < |
| <clearStream> |
||
| Removes all text within the specified window |
|||
| |
|||
*id - The identifier for the window to remove text from |
|||
| <clearStream id="spellfront"/> |
|||
| No contents |
|||
| |
|||
|- |
|||
| <left> |
|||
<right> |
|||
| Changes the text of the left and right hand panels |
| Changes the text of the left and right hand panels |
||
| |
|||
*exist - Same as in <a> |
|||
⚫ | |||
| <right exist="674831" noun="dagger">dagger</right> |
| <right exist="674831" noun="dagger">dagger</right> |
||
| Sends the contents to the left or right hand panel |
| 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.<br><popStream/> |
|||
| No contents |
|||
| May nest |
|||
|- |
|- |
||
| <spell> |
| <spell> |
||
| Changes the text of the prepared spell panel |
| Changes the text of the prepared spell panel |
||
| |
|||
⚫ | |||
*exist - Same as in <a> |
|||
| <spell exist='spell'>Spirit Warding I</spell> |
| <spell exist='spell'>Spirit Warding I</spell> |
||
| Sends the contents to the prepared spell panel |
| Sends the contents to the prepared spell panel |
||
| |
|||
|} |
|} |
||
== Special handling == |
== Special handling == |
||
* Tags followed by newlines suppress the newline output to the screen |
* Tags followed by newlines suppress the newline output to the screen except where noted above. |
Revision as of 11:47, 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 |
|
a <a exist="-26211" noun="door">heavy ironwood door</a> | Displays the contents as a clickable link | Does not suppress following newlines |
<clearStream> | Removes all text within the specified window |
|
<clearStream id="spellfront"/> | No contents | |
<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 | |
<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.