Template:ConsoleCommand/doc

This template is used to describe a console command.

Parameters

 * name
 * name of the command


 * syntax
 * Optional. Used to describe a special syntax, other than space separated parameters. Otherwise the argX parameters will be listed.


 * argX, typeX, noteX
 * Description of the parameters. Instead of X use numbers or whatever you like. Use as many of these combinations as needed.
 * arg: name of the parameter
 * type: something like String or Boolean
 * note: description of the parameter


 * parameters
 * optional, additional text for arguments or if argX/typeX/noteX can't be used


 * cheat
 * Every kind of entry results to a "Yes". Leave empty if this command is not a cheat.


 * target
 * What or who is the target of the command? Leave empty if not relevant.


 * added
 * optional, if release version is known


 * description
 * description of the command


 * example
 * one or more examples how to use this command


 * consoleCompatible
 * Is this command compatible with gaming consoles. If partial compatibility describe limitations.