Trigger

From StealthBot Wiki
Jump to: navigation, search

Every StealthBot command must be executed with the bot's trigger followed by the command's name.

Setting

In this documentation, . is the trigger used in examples, but this can be changed by the bot's settings.

Special triggers

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:

Console triggers

When executing commands from the console, you must use one of the following slash-triggers instead of the set trigger. If you use the set trigger, the bot will not execute it as a command!

/

The trigger required is a "/" to respond back without going to Battle.net.

Example using the time command:

After typing /time
[6:19:03 PM] The current time on this computer is 6:19:03 PM on 09-02-2009.

//

You may also use the trigger "//" to send the response to the current Battle.net channel.

Example:

After typing //time
[6:19:04 PM] <StealthBot> The current time on this computer is 6:19:04 PM on 09-02-2009.

///

This special trigger bypasses internal processing completely and sends a / command to Battle.net normally.

Example:

After typing ///time
[6:19:05] Battle.net time: Wed Sep 2  10:19 PM
[6:19:05] Your local time: Wed Sep 2  6:19 PM

External triggers

When executing commands from outside of the bot use the bot's trigger as set in the settings. Throughout this wiki, the default trigger . will be used in examples. You must use the trigger set in the bot. Determine your current trigger setting with the trigger command and change it with the settrigger command.

Example:

Typing .time
[6:19:04 PM] <Stealth> .time
[6:19:06 PM] <StealthBot> The current time on this computer is 6:19:06 PM on 09-02-2009.

All trigger

Use "all, " or "all: " as a special trigger to use the command on all bots who are present.

Example:

Typing all, time
[6:19:55 PM] <Stealth> all, time
[6:19:55 PM] <StealthBot> The current time on this computer is 6:19:55 PM on 09-02-2009.
[6:19:55 PM] <PhiX[BoT]@Azeroth> The current time on this computer is 12:19:45 AM on 09-03-2009.
[6:19:55 PM] <Ribose[BoT]@Azeroth> The current time on this computer is 6:19:51 PM on 09-02-2009.
[6:19:55 PM] <Pyro[BoT]@Azeroth> The current time on this computer is 3:19:56 PM on 09-02-2009.

Operator trigger

Use "ops, " or "ops: " as a special trigger to use the command on all bots who are present as an operator in the channel.

Example:

Typing ops, time
[6:19:55 PM] <Stealth> ops, time
[6:19:55 PM] <StealthBot> The current time on this computer is 6:19:55 PM on 09-02-2009.
[6:19:55 PM] <PhiX[BoT]@Azeroth> The current time on this computer is 12:19:45 AM on 09-03-2009.
[6:19:55 PM] <Pyro[BoT]@Azeroth> The current time on this computer is 3:19:56 PM on 09-02-2009.

Username trigger

Use the Username trigger as a special trigger by typing the bot's name followed by "" or " followed by the command. For this, wildcards are acceptable. This trigger is not case sensitive.

Examples:

Typing StealthBot, time
[6:19:55 PM] <Stealth> StealthBot, time
[6:19:55 PM] <StealthBot> The current time on this computer is 6:19:55 PM on 09-02-2009.
Typing P*, time
[6:19:55 PM] <Stealth> P*, time
[6:19:55 PM] <PhiX[BoT]@Azeroth> The current time on this computer is 12:19:45 AM on 09-03-2009.
[6:19:55 PM] <Pyro[BoT]@Azeroth> The current time on this computer is 3:19:56 PM on 09-02-2009.

?trigger

Main article: Trigger command

This special command takes the trigger ? in place of your trigger, since the command is meant for when the trigger is not known.

!inbox

Main article: Inbox command

This special command takes the trigger ! in place of your trigger, so that someone who has mail will always know they can do "!inbox" to retrieve their bot mail.