Difference between revisions of "Text Commands"

From ALFA
Jump to: navigation, search
(Revamp to show actual commands.)
Line 2: Line 2:
 
The text commands presented on this page carry different formatting. Text in monospaced fonts are meant to be typed. Often, to explain what a command does when there are multiple displayed at once, an inline comment will be given. This is not meant to be typed. Additionally, some parameters are user defined, and must be filled in by the user. Content inside bold '''<brackets>''' should be replaced with actual content.
 
The text commands presented on this page carry different formatting. Text in monospaced fonts are meant to be typed. Often, to explain what a command does when there are multiple displayed at once, an inline comment will be given. This is not meant to be typed. Additionally, some parameters are user defined, and must be filled in by the user. Content inside bold '''<brackets>''' should be replaced with actual content.
  
−
For example, <code>#tradescroll '''<Spell ID>'''</code> says you should type something like <code>#tradescroll 3113</code> to make a tradescroll for [[Water Breathing]].
+
For example, <code>#sethp '''<Target HP>'''</code> says you should type something like <code>#sethp 1</code> to set a creature's hit points to 1.
  
−
== Targets ==
+
== General Commands ==
−
By using certain text inserts, you can define the target for your command. Valid target definitions are:
+
These commands are available for anyone.
−
* <code>$self</code> -- To target the caller of the function.
+
{| class="wikitable_standard leftLastColumn"
−
* <code>$target</code> -- To target the currently selected object in-game.
+
! Command
−
* <code>$companion</code> -- To target the caller's companion.
+
! Example
−
* <code>$'''<object ID>'''</code> -- To specify a unique object ID. ''Only do this if you know what you are doing.''
+
! Description
 +
|-
 +
| <code>#'''<Anchor Number>'''</code>
 +
| <code>#1</code>
 +
| Establishes the current target as an [[Anchor]]. Setting an anchor with nothing selected will clear a previous anchor. Players may only anchor characters they control ([[Animal Companion]]s, [[Familiar]]s). You listen through your anchors.
 +
|-
 +
| <code>#'''<Anchor Number> <Text>'''</code>
 +
| <code>#1 I am a mighty puppet!</code>
 +
| Speaks through an [[Anchor]]. In this example, whatever is anchored to <code>#1</code> will say, "I am a mighty puppet!"
 +
|-
 +
| <code>#alist</code>
 +
| <code>#alist</code>
 +
| Lists all current [[Anchor]]s.
 +
|-
 +
| <code>#dm '''<Message>'''</code>
 +
| <code>#dm Bob would like to inspect the trap.</code>
 +
| Sends a message to the [[Dungeon Master|DM]] message queue. They may click the notification later to read it. This is useful for notifying DMs in other areas, or to send low-priority messages.
 +
|-
 +
| <code>@'''<Language Code>'''</code>
 +
| *The chiseled elven warrior nods.* <code>@elf</code> "You are safe, should you behave."
 +
| Allows the character to speak in a given [[Language|language]]. Players must know the language to speak it. Clicking the @ symbol on the chat window will list your current languages, and their language code.
 +
|}
  
−
== Commands ==
 
−
=== Subdual Mode ===
 
−
Subdual mode can be set or toggled via a text command. Valid uses:
 
−
: <code>#subdual</code> -- Toggles subdual mode (on->off, off->on).
 
−
: <code>#subdual on</code> -- Forces subdual mode on.
 
−
: <code>#subdual off</code> -- Forces subdual mode off.
 
  
−
=== Prepare Spells ===
+
== DM Commands ==
−
Preparing spells can now be done via text commands. Valid uses:
+
These commands are available only to [[Dungeon Master]]s.
−
: <code>#pray</code> -- Pray for divine spells.
+
{| class="wikitable_standard leftLastColumn"
−
: <code>#spellbook</code> -- Memorize spells from spellbook.
+
! Command
−
 
+
! Example
−
These commands have you pray for spells and memorize from your spellbook respectively.
+
! Description
−
 
+
|-
−
=== Crafting ===
+
| <code>#ifl'''<DC>''' '''<Message>'''</code>
−
By using text commands, you can progress crafting on an item or open a crafting store.
+
| <code>#ifl05 The sound of a heavy falling rock comes from the nearby cliffs.</code>
−
: <code>#craft scroll</code>
+
| Sends a notification to all players in the area who succeed a [[Listen]] check. They may click the notification to read the full text of the message. In this example, the [[Difficulty Class|DC]] is 5. <code>#ifl12</code> would be DC 12. You are provided a list of who failed and who succeeded the check.
−
: <code>#craft potion</code>
+
|-
−
: <code>#craft wand</code>
+
| <code>#ifs'''<DC>''' '''<Message>'''</code>
−
 
+
| <code>#ifs30 The ceiling far above your head is dark, but you make out the form of a large spider.</code>
−
To progress crafting on an item, you must first select that item, then type:
+
| Sends a notification to all players in the area who succeed a [[Spot]] check. They may click the notification to read the full text of the message. In this example, the [[Difficulty Class|DC]] is 30. <code>#ifl05</code> would be DC 5. You are provided a list of who failed and who succeeded the check.
−
: <code>#craft $target</code>
+
|-
−
 
+
| <code>#not '''<Message>'''</code>
−
=== Create Tradescroll ===
+
| <code>#not A loud roar echoes through the cave.</code>
−
Text commands can create tradescrolls. This helps when a spell isn't normally able to be cast on a spellbook. Usage:
+
| Sends a notification to all players in the area. They may click the notification to read the full text of the message.
−
: <code>#tradescroll '''<Spell ID>'''</code>
+
|-
−
 
+
| <code>#setdesc '''<Description>'''</code>
−
You may need to research the spell's ID from the ACR's [[spells.2da]] or by looking at the individual spell page.
+
| <code>#setdesc This bear moves as fast as lightning, tearing through the forest.</code>
 +
| Changes the description of any object. This can be used to give items custom descriptions, make notes/books, etc.
 +
|-
 +
| <code>#sethp '''<Target HP>'''</code>
 +
| <code>#sethp 1</code>
 +
| Damages or heals a creature that is currently selected. A target HP greater than a creature's max hit points will set them to full. The example sets a creature to a single hit point.
 +
|}

Revision as of 18:40, 21 May 2014

The text commands presented on this page carry different formatting. Text in monospaced fonts are meant to be typed. Often, to explain what a command does when there are multiple displayed at once, an inline comment will be given. This is not meant to be typed. Additionally, some parameters are user defined, and must be filled in by the user. Content inside bold <brackets> should be replaced with actual content.

For example, #sethp <Target HP> says you should type something like #sethp 1 to set a creature's hit points to 1.

General Commands

These commands are available for anyone.

Command Example Description
#<Anchor Number> #1 Establishes the current target as an Anchor. Setting an anchor with nothing selected will clear a previous anchor. Players may only anchor characters they control (Animal Companions, Familiars). You listen through your anchors.
#<Anchor Number> <Text> #1 I am a mighty puppet! Speaks through an Anchor. In this example, whatever is anchored to #1 will say, "I am a mighty puppet!"
#alist #alist Lists all current Anchors.
#dm <Message> #dm Bob would like to inspect the trap. Sends a message to the DM message queue. They may click the notification later to read it. This is useful for notifying DMs in other areas, or to send low-priority messages.
@<Language Code> *The chiseled elven warrior nods.* @elf "You are safe, should you behave." Allows the character to speak in a given language. Players must know the language to speak it. Clicking the @ symbol on the chat window will list your current languages, and their language code.


DM Commands

These commands are available only to Dungeon Masters.

Command Example Description
#ifl<DC> <Message> #ifl05 The sound of a heavy falling rock comes from the nearby cliffs. Sends a notification to all players in the area who succeed a Listen check. They may click the notification to read the full text of the message. In this example, the DC is 5. #ifl12 would be DC 12. You are provided a list of who failed and who succeeded the check.
#ifs<DC> <Message> #ifs30 The ceiling far above your head is dark, but you make out the form of a large spider. Sends a notification to all players in the area who succeed a Spot check. They may click the notification to read the full text of the message. In this example, the DC is 30. #ifl05 would be DC 5. You are provided a list of who failed and who succeeded the check.
#not <Message> #not A loud roar echoes through the cave. Sends a notification to all players in the area. They may click the notification to read the full text of the message.
#setdesc <Description> #setdesc This bear moves as fast as lightning, tearing through the forest. Changes the description of any object. This can be used to give items custom descriptions, make notes/books, etc.
#sethp <Target HP> #sethp 1 Damages or heals a creature that is currently selected. A target HP greater than a creature's max hit points will set them to full. The example sets a creature to a single hit point.
Retrieved from "https://www.alandfaraway.info/Wiki/index.php?title=Text_Commands&oldid=2240"