Views
Merge
It has been suggested that Command Syntax be merged into Command. Reason: No need for different articals, syntax could just be a section within Command.
Introduction
This is about the grammar used for command arguments both on command pages in this wiki, and in the ingame help text. The arguments must be given in the order specified.
Example
\commandname <mandatory arg> [optional arg] [repeating optional arg] ...
Overview
| Grammar | Meaning |
|---|---|
| \commandname | The name of the command to run, prefixed by either a \ or a /. |
| <arg> | A required argument that must be given. |
| [arg] | An optional argument that may be given, but if not given will use a sane default. |
| [arg]... | An argument that can be repeated more than once. |
Command parsing
The arguments are delimited by spaces, and commands are separated by new-lines or semicolons (;). If you wish to provide an argument that contains a space or semicolon, then you must enclose it in double quotes ("). For example:
/echo ^1hello world /echo "^1hello world"
In the first example, the two words are separate arguments, and so are printed separately, and so the colours reset at the end of hello. In the second example, the quotes cause them to be seen as one argument, so the colour effects both words printed.