Command

From StealthBot Wiki
Jump to: navigation, search

StealthBot features 160 built-in commands and the ability for scripts to create any number of additional commands.

Built-in commands

Main article: List of commands

StealthBot has tons of functionality in its many commands. Read about each command in the list of commands.

Scripted commands

Main article: Script commands

You can create many

How to use

In order to use a command, you need to first have enough access, then you must be using the correct syntax for that command.

To see what rank or flags is required for a command, and what syntax it has, use the help command or the command manager.

Command access

Main article: Access

Commands can have a requirement of rank or flags for use. If the command speaker has any one of the required flags, or the required numeric rank, he/she can use the command.

Command restrictions can raise the access requirement for doing specific things with commands. For example, using the say command with a message starting with a forward slash (/) to execute Battle.net commands is restricted to users with a rank of 90 with a command restriction.

Command trigger

Main article: Trigger

Every command must be executed with the bot's trigger followed by the command's name. In this documentation, . is the trigger used in examples, but this can be changed by the bot's settings.

Commands always require a trigger of some sort. In the following cases, another built-in trigger can be used instead of the one set in the bot:

  • In the bot (called the console):
    • The trigger required is a "/" to respond back without going to Battle.net.
    • You may also use the trigger "//" to send the response to the current Battle.net channel.
  • Outside of the bot, using a special trigger:
    • The special trigger "all, " or "all: " allows you to trigger the command on any StealthBot which you have access to use the command on.
    • The special trigger "ops, " or "ops: " allows you to trigger the command on any operator which you have access to use the command on.
    • You may also use the bot's own name as a special trigger, followed by a "" or "".
  • Outside of the bot, for two special commands:
    • The trigger command can optionally (and preferably) use the "?" trigger, since the user executing the command does not know what the internal setting is set to.
    • The inbox command can optionally (and preferably) use the "!" trigger, since the user executing the command may not know what the internal setting is set to.

Command syntax

The syntax for commands on this wiki and in the bot are always represented in the form where parts enclosed in angle brackets (< and >) are required, and parts enclosed in square brackets ([ and ]) are optional.

With that said, the general format of a command will always be:

<trigger><commandword> [parameters]

Where <trigger> is the bot's trigger.

<commandword> is the name of the command, or one of its command aliases, which you want to execute. Each command can have some or no required or optional command parameters, depending on its function. The help command or the command manager can be used to view any command's specific required and optional arguments.

See also