Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HelpCommand

Hierarchy

Index

Constructors

Properties

aliases: string[] = ...

Aliases for this command

category: string = "No Category"

The category of the command used on the default help command

cmd: string = "help"

The name of the command

description: string = "Help Command"

The description of the command (visible if you are using the default HelpCommand class)

disableUsageChecking: boolean = false

Disables usage arguments checking

enabled: boolean = true

Is the command enabled?

hidden: boolean = false

Hides the command from (prefix)help

usage: string = ""

The usage of the command used for getting the arguments of the command The type of the argument can be either string, int or float <> means its required [] means its optional

whitelist: string[] = []

List of homes that are allowed to run this command

Methods

  • isWhitelisted(user: User): boolean
  • Function that checks if the user is whitelisted

    Parameters

    • user: User

      The user to check

    Returns boolean

    True if the user is whitelisted, false otherwise

  • userCanRunCommand(user: User): boolean
  • Checks if the specified user can run this command

    Parameters

    • user: User

      The user to check

    Returns boolean

    True if the user can run this command, false otherwise

Generated using TypeDoc