-
Notifications
You must be signed in to change notification settings - Fork 17
Command Syntax
IB.ai's command syntax may be a little confusing, which is why it is explained more in depth here.
Arguments are denoted either in <> or [], whereas literals are not. The text inside the bracket is called the argument name.
Brackets | Name | Purpose |
---|---|---|
<> |
Required arguments | All arguments in angled brackets are required and the command will not work if they are not provided |
[] |
Optional arguments | All arguments in square brackets are optional and the command will work without them |
As an example, the following (nonexistent, for demonstration purposes only) command:
&ban <user> [time]
.
This would denote that the command takes in a required user and an optional time. Using common reasoning, one arrives at the conclusion that the user is permanently banned unless a time is specified. An example of how to use that command could be: &ban Arraying#7363 3h
. Please note that "user" and "time" inputs are elaborated upon here.
If an argument is not surrounded in brackets, please take it literally. For example &roast user <user>
could be &roast user Arraying#7363
and not &roast Arraying#7363 Arraying#7363
.
Sometimes, there's only a few possible arguments. For this, argument lists are used, which are delimited by the pipe symbol (|
).
Example (hypothetical) | Explanation | Possible Example |
---|---|---|
&onlinestatus <online|away|dnd> |
The argument must be one of the ones in the provided list | &onlinestatus dnd |
&onlinestatus [online|away|dnd] |
The argument is optional but if present must be one of the ones provided in the list |
&onlinestatus or &onlinestatus dnd
|
An IB Discord Server project. Community funded and available CAS hours for IB students.