Class Bot

Hierarchy

Bot

Index

Properties

Methods

Properties

client

client: any = new Discord.Client()

Discord.js Client

commands

commands: Array<CommandBase> = []

Array of Command Class References

Methods

getCommandByEvent

getCommandByEvent(event: Event): CommandBase

- Defined in Common/Bot.ts:268
Retrieves a registered command by it's event type.

Parameters
- event: Event
Returns CommandBase

getCommandByName

getCommandByName(name: string): CommandBase

- Defined in Common/Bot.ts:251
Retrieves a registered command by it's name.

Parameters
- name: string
  
  Name of the command.
Returns CommandBase

handleEvent

handleEvent(event: Event, eventobject: EVENT_OBJECT): void

- Defined in Common/Bot.ts:69
Handle an incoming event.

Parameters
- event: Event
  
  Event type.
- eventobject: EVENT_OBJECT
  
  Event Object from discord.js.
Returns void

handleMessage

handleMessage(event: Event, message: MESSAGE_TYPE): void

- Defined in Common/Bot.ts:82
Parameters
- event: Event
- message: MESSAGE_TYPE
Returns void

preCommand

preCommand(event: Event, parsedCommand: CommandParser): boolean

- Defined in Common/Bot.ts:110
Parameters
- event: Event
- parsedCommand: CommandParser
Returns boolean

register

register(commandRef: CommandBase): void

- Defined in Common/Bot.ts:33
Called by the @Command decorated classes

Parameters
- commandRef: CommandBase
  
  Command class reference.
Returns void

runCommand

runCommand(event: Event, command: CommandParser): void

- Defined in Common/Bot.ts:212
Parameters
- event: Event
- command: CommandParser
Returns void

runEvent

runEvent(event: Event, eventobject: EVENT_OBJECT): void

- Defined in Common/Bot.ts:234
Run a command based on an event.

Parameters
- event: Event
  
  Event type.
- eventobject: EVENT_OBJECT
  
  Event object.
Returns void

start

start(): void

- Defined in Common/Bot.ts:44
Start the bot.

Returns void

Generated using TypeDoc