Class default

Adds a help command dynamically generated from content in the config file, with a nice name, description, and invocation example for each annotated command.

Hierarchy

Plugin<{}>
- default

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new default(context: DiscordBot, _config?: {}): default

Inherited from Plugin.constructor
- Defined in src/typedef/Plugin.ts:9
Parameters
- context: DiscordBot
- Optional _config: {}
Returns default

Properties

Protected config

config: {}

Type declaration

Protected context

context: DiscordBot

Static defaultConfig

defaultConfig: any

Methods

clearHandlers

clearHandlers(): void

Inherited from Plugin.clearHandlers
- Defined in src/typedef/Plugin.ts:39
Returns void

declareHandler

declareHandler(name: string, handler: (event: CommunicationEvent) => void): void

Inherited from Plugin.declareHandler
- Defined in src/typedef/Plugin.ts:32
Parameters
- name: string
- handler: (event: CommunicationEvent) => void
  - - (event: CommunicationEvent): void
    - Parameters
      - event: CommunicationEvent
      Returns void
Returns void

extract

extract(): void

Overrides Plugin.extract
- Defined in src/plugins/advancedHelp.ts:46
Returns void

inject

inject(): void

Overrides Plugin.inject
- Defined in src/plugins/advancedHelp.ts:11
Returns void

listPermissions

listPermissions(event: CommunicationEvent): void

- Defined in src/plugins/advancedHelp.ts:37
Parameters
- event: CommunicationEvent
Returns void

writeHelp

writeHelp(event: CommunicationEvent): void

- Defined in src/plugins/advancedHelp.ts:16
Parameters
- event: CommunicationEvent
Returns void

Generated using TypeDoc