elmabot - v0.5.5
Options
All
  • Public
  • Public/Protected
  • All
Menu

Returns a simple eightball response from a set of templates The templates should exist in the 'res' folder as eightball.json

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns Eightball

Properties

Protected aliases

aliases: string | string[]

Protected commandName

commandName: string

Protected desc

desc: string = "Gazes into to beyond to bring a vision of the future"

error

error: Error

errorString

errorString: string

Protected member

member: GuildMember

Protected message

message: Message

Protected needParamValues

needParamValues: boolean = true

Protected paramValues

paramValues: string[]

Protected params

params: string

Protected reply

reply: string | object

Protected replyTo

replyTo: boolean = false

Private Readonly responses

responses: Iresponses | boolean

Protected server

server: string

warning

warning: Error

Methods

errorRespond

  • errorRespond(): void

  • Wrapper function which sets a generic error message to respond with and calls respond()

    Returns void

Protected exec

  • exec(): Promise<{}>

  • Returns Promise<{}>

Protected getParams

  • getParams(): string[]

  • Gets an an array with all the parameters passed to a command

    Returns string[]

    string[]

Private getResponses

  • parses the eightball.json file and returns the templates within as an object

    Returns Iresponses | boolean

    object containing the templates in a series of arrays

respond

  • respond(): void

  • A base function that returns whatever reply has been set by other base functions, the command object returns this response after the command has been successfully ran defaults to sending it as a normal message, but can send it as reply if replyTo is set to true

    Returns void

returnProperties

  • returnProperties(): { alias: string | string[]; desc: string; name: string; syntax: string }

  • Returns the commands properties, for use in the Help command

    Returns { alias: string | string[]; desc: string; name: string; syntax: string }

    object

    • alias: string | string[]
    • desc: string
    • name: string
    • syntax: string

run

  • run(message: Message): Promise<{}>

  • The meat of the object, this function is called by the commander object and instantiates the object proper with all required values, then runs the encompassing function and returns the resulting promise object

    Parameters

    • message: Message

    Returns Promise<{}>

Legend

  • Variable
  • Function
  • Class
  • Constructor
  • Inherited property
  • Inherited method
  • Protected property
  • Protected method
  • Private property
  • Private method
  • Interface

Generated using TypeDoc