Template:Command/doc

From Mibbit Wiki
Jump to: navigation, search
Parameters
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:

{{#set:Client=Widget}}{{#set:Type=}}/says <text>

Outputs <text> to channel without formatting.

Disabled, One-Liner

{{Command
|name=evil
|parameters=<user> <password>
|disabled=true
}}

Shows as:

{{#set:Client=Main}} {{#set:Client=Widget}}{{#set:Type=}}/evil <user> <password> [true]