Constructor
new Client(options)
Parameters:
| Name | Type | Description |
|---|---|---|
options |
ForgeClientOptions | The options to pass to the client |
- Source:
Extends
Members
commandHandler :CommandHandler
Client command handler
Type:
- Source:
options :ForgeClientOptions
Default Options to use
Type:
- Source:
registry :ForgeRegistry
Client plugin and command registry
Type:
- Source:
Methods
getConfigOption(guild, prop) → {Promise.<(string|number|Array|Object)>}
Default function for getting per guild config options
Parameters:
| Name | Type | Description |
|---|---|---|
guild |
Guild | The guild to get the config option from |
prop |
string | The property to get from the guild's config file |
- Source:
Returns:
- Type
- Promise.<(string|number|Array|Object)>
loadHelp(command)
Loads the help command for a command
Parameters:
| Name | Type | Description |
|---|---|---|
command |
Command | The command to register help for |
- Source:
setConfigOption(guild, prop, value)
Default function for changing per guilf config options
Parameters:
| Name | Type | Description |
|---|---|---|
guild |
Guild | The guild to set the config option for |
prop |
string | The property in the config to change |
value |
string | number | Array | Object | The value to set the config property to |
- Source:
Events
command
Emmited when a command has been ran
Parameters:
| Name | Type | Description |
|---|---|---|
Command |
Command | The command that was ran |
plainMessage
Emmited when a non command message is received
Parameters:
| Name | Type | Description |
|---|---|---|
Message |
Message | The message received |