Important update to voice commands

Started by Johannes, March 05, 2012, 09:30:44 AM

Previous topic - Next topic

Johannes

Voice commands have just undergone a significant upgrade in standard. This means a lot of things, but especially concerning those things that affect you as players :
  • A voice command has the potential to have options in the form of -o (Short options with single characters) or --some-long-command (Long options with multiple characters), denoted by the prefixed "-".
  • Short options may be grouped together, i.e :

Quote/c somecommand -a -1 -x -o
is semantically equivalent to :

Quote/c somecommand -a1xo
  • Options may sometimes need to be supplied with parameters. For short options, the syntax is as follows :

Quote/c somecommand -o myparameter
Or you can even omit the space entirely like this :

Quote/c somecommand -omyparameter
Long command parameters differ slightly :

Quote/c somecommand --long-command=myparameter
  • The ordering of options in a command is meaningless. They can precede, follow and even be intermingled between standard command arguments.
  • If you are familiar with GNU-style options, then you will recognize their influence in this convention. Note this important difference, however :
  • Command arguments with more than one character may require < and > (not " ") as opening and closing brackets to properly delimit them if they consist of any spaces, or if they are non-options prefixed with the '-' character. If in doubt, use the delimiters.
  • All voice commands are now documented and versioned as a standard. Appending the --help long option to any command will display detailed documentation on its usage, including valid parameters.
  • You may list voice commands with the 'commands' voice command.
  • Although effort has been made to keep command structure consistent, some voice commands have been changed slightly to comply to standard. These changes are viewable in the commands' respective documentations.
Due to all of our voice commands being partially overwritten as a consequence, there may be bugs. Please remain conscious of these and report any unusual behaviour promptly on the bug forum.