BasePlugin
Vocality Documentation › Globals › BasePlugin
Hierarchy
- BasePlugin
Implements
- Plugin
Index
Constructors
Properties
Methods
Constructors
constructor
+ new BasePlugin(config?: PluginConfig): BasePlugin
Defined in packages/vocality-core/src/common/BasePlugin.ts:5
Parameters:
| Name | Type |
|---|---|
config? | PluginConfig |
Returns: BasePlugin
Properties
commands
• commands: Command[]
Defined in packages/vocality-core/src/common/BasePlugin.ts:5
config
• config: PluginConfig
Defined in packages/vocality-core/src/common/BasePlugin.ts:4
Methods
disable
▸ disable(guildId: string): void
Defined in packages/vocality-core/src/common/BasePlugin.ts:17
Parameters:
| Name | Type |
|---|---|
guildId | string |
Returns: void
enable
▸ enable(guildId: string): void
Defined in packages/vocality-core/src/common/BasePlugin.ts:12
Parameters:
| Name | Type |
|---|---|
guildId | string |
Returns: void
Protected Optional load
▸ load(guildId: string): void
Defined in packages/vocality-core/src/common/BasePlugin.ts:26
Returns a new instance of the plugin. First method executed when a plugin gets loaded.
Parameters:
| Name | Type |
|---|---|
guildId | string |
Returns: void
Protected Optional unload
▸ unload(guildId: string): void
Defined in packages/vocality-core/src/common/BasePlugin.ts:31
Last tasks to execute before the plugin gets unloaded.
Parameters:
| Name | Type |
|---|---|
guildId | string |
Returns: void