Interface CommandConfig

Base configuration for module parts

Hierarchy

Properties

aliases? cooldown? description? guildOnly? id initFunction? mainFunction name ownerOnly? permissions? requiredArgs? requiresArgs? usage?

Properties

Optional aliases

aliases?: string[]

List of alternative names

Optional cooldown

cooldown?: number

Minimum time (in seconds) between usages

Optional description

description?: string

Description of the command

Optional guildOnly

guildOnly?: boolean

If the command can only be executed in a guild

id

id: string

ID of the part

Optional initFunction

initFunction?: ((artibot: Artibot) => Promise<void>)

Type declaration

mainFunction

mainFunction: ((message: Message<boolean>, args: string[], artibot: Artibot) => Promise<void>)

Type declaration

name

name: string

Name of the command

Optional ownerOnly

ownerOnly?: boolean

If the command can only be executed by the owner of the bot

Optional permissions

permissions?: PermissionResolvable

Required permissions

Optional requiredArgs

requiredArgs?: number

Minimum amount of arguments

Since

5.0.0

Optional requiresArgs

requiresArgs?: boolean

Set to true if the command needs at least one argument

Deprecated

Use requiredArgs instead.

Optional usage

usage?: string

Help text on how to use the command

Settings

Member Visibility

Theme

Generated using TypeDoc v0.23.28