Template:Command/doc
Name | Description |
---|---|
name | Name of command, without the beginning slash. |
parameters | Parameters of the command. |
desc | Description of the command. Optional. Only one line if it doesn't exist, good for Category:Commands |
disabled | Sometimes commands are disabled for security reasons. If so, this parameter should be used. |
client | Which clients are allowed to use this command. "m", "w", or "mw" |
Examples
Normal command
{{Command |name=says |parameters=<text> |desc=Outputs <text> to channel without formatting. |client=w }}
Shows as:
{{#switch: w |m={{#set:Client=Main}} |w={{#set:Client=Widget}} |mw={{#set:Client=Main}} {{#set:Client=Widget}} }}{{#set:Type=}}/says {{#if:<text>|<text>|}}{{#if: | [{{{disabled}}}]|}}{{#if: Outputs <text> to channel without formatting.|:Outputs <text> to channel without formatting.|}}{{#if:
| :Output: {{{output}}}
| }}
Disabled, One-Liner
{{Command |name=evil |parameters=<user> <password> |disabled=true }}
Shows as:
{{#switch: mw |m={{#set:Client=Main}} |w={{#set:Client=Widget}} |mw={{#set:Client=Main}} {{#set:Client=Widget}} }}{{#set:Type=}}/evil {{#if:<user> <password>|<user> <password>|}}{{#if: true| [true]|}}{{#if: |:{{{desc}}}|}}{{#if:
| :Output: {{{output}}}
| }}