Skip to main content

Class: PatternCommand

@sapphire/plugin-pattern-commands.PatternCommand

Hierarchy

  • Command<Args, Options>

    PatternCommand

Constructors

constructor

new PatternCommand(context, options)

Parameters

NameType
contextPieceContext
optionsPatternCommandOptions

Overrides

Command<Args, PatternCommand.Options\>.constructor

Defined in

projects/plugins/packages/pattern-commands/src/lib/structures/PatternCommand.ts:7

Properties

chance

Readonly chance: number

Defined in

projects/plugins/packages/pattern-commands/src/lib/structures/PatternCommand.ts:5


matchFullName

Readonly matchFullName: boolean

Defined in

projects/plugins/packages/pattern-commands/src/lib/structures/PatternCommand.ts:6

Methods

messageRun

Abstract messageRun(message): unknown

Executes the pattern command's logic.

Parameters

NameTypeDescription
messageMessage<boolean>The message that triggered the pattern command.

Returns

unknown

Overrides

Command.messageRun

Defined in

projects/plugins/packages/pattern-commands/src/lib/structures/PatternCommand.ts:17