Bot
Vocality Documentation › Globals › Bot
Hierarchy
- Bot
Index
Constructors
Properties
Methods
Constructors
constructor
+ new Bot(options?: ClientOptions | undefined): Bot
Defined in packages/vocality-core/src/bot.ts:11
Creates a new instance.
Parameters:
| Name | Type |
|---|---|
options? | ClientOptions | undefined |
Returns: Bot
Properties
Private bot
• bot: BotClient
Defined in packages/vocality-core/src/bot.ts:11
Methods
addCustomCommands
▸ addCustomCommands(commands: Command[]): void
Defined in packages/vocality-core/src/bot.ts:26
Add a custom command to the bot which will be enabled for all guilds. Commands added this way will not belong to any plugin.
Parameters:
| Name | Type |
|---|---|
commands | Command[] |
Returns: void
addPlugins
▸ addPlugins(plugins: Plugin[], loaded?: undefined | false | true): void
Defined in packages/vocality-core/src/bot.ts:44
Adds plugins to all guilds.
Parameters:
| Name | Type |
|---|---|
plugins | Plugin[] |
loaded? | undefined | false | true |
Returns: void
removeCustomCommand
▸ removeCustomCommand(command: Command | string): void
Defined in packages/vocality-core/src/bot.ts:35
Remove a custom command from all guilds.
Parameters:
| Name | Type | Description |
|---|---|---|
command | Command | string | Instance or name of the command |
Returns: void
start
▸ start(token?: undefined | string): Promise‹void›
Defined in packages/vocality-core/src/bot.ts:56
Start the bot.
Parameters:
| Name | Type |
|---|---|
token? | undefined | string |
Returns: Promise‹void›