Pronto logo

Pronto

Namespace

commands

Members

Type Definitions

BaseCommand

The base of each of Pronto's commands, with the base properties to construct a complete <Command>

Type

  • Object

Properties

  • command commands.CommandName

    The name of the command

  • aliases Array.<string>

    The aliases for the command

  • description commands.CommandDescription

    The <CommandDescription> object of the command

  • allowDirect boolean

    Whether to allow the command to execute from a direct message

  • requiredRoles Array.<Discord.Snowflake>

    A <Role.id[]> of which the <GuildMember> must have at least one to execute the command

  • deniedRoles Array.<Discord.Snowflake>

    A <Role.id[]> of which the <GuildMember> must have none to execute the command

  • developerOnly boolean

    Whether the command is only executable by the developer defined by config.ids.DEVELOPER_ID

  • displayInList boolean

    Whether to display the command in the guild's commands list

  • help Readonly.<string>

    The help text to display for the command

  • error Readonly.<?string>

    The error text to display for the command

Source

CommandDescription

The description of the command, which may differ depending on whether the message command is qualified with a different <CommandName> as an argument

Type

  • Object

Properties

  • general string

    The description of the command, or the description to display in the command's base help text if the command supports a dynamic description

  • unqualified string <nullable>

    The description to display as the command's base description if the command supports a dynamic description

  • qualified string <nullable>

    The description to display as the command's description if qualified with a different <CommandName>, if the command supports a dynamic description

Source

CommandParameters

An <Object> of the valid parameters accepted by the <Command.execute()> method

Type

  • Object

Properties

  • msg Discord.Message

    The <Message> that executed the <Command>, or the <Message> that the reaction collector was attached to

  • args Array.<string> <nullable>

    The <string[]> containing the command arguments

  • msgCommand string <nullable>

    The message argument that was parsed to this <BaseCommand>, i.e. either <BaseCommand.command> or <BaseCommand.aliases.includes(msgCommand)>

  • user Discord.User <nullable>

    The <User> that triggered the reaction collector

Source