Skip to main content

Class: PluginPatternCommandsMessageParseListener

pattern-commands/src.PluginPatternCommandsMessageParseListener

Hierarchy

  • Listener<typeof Events.PreMessageParsed>

    PluginPatternCommandsMessageParseListener

Constructors

constructor

new PluginPatternCommandsMessageParseListener(context)

Parameters

NameType
contextPieceContext

Overrides

Listener<typeof Events.PreMessageParsed\>.constructor

Defined in

projects/plugins/packages/pattern-commands/src/listeners/PluginMessageParse.ts:10

Properties

emitter

Readonly emitter: null | EventEmitter

The emitter, if any.

since 2.0.0

Inherited from

Listener.emitter

Defined in

node_modules/@sapphire/framework/dist/index.d.ts:1829


enabled

enabled: boolean

Whether or not the piece is enabled.

Inherited from

Listener.enabled

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:447


event

Readonly event: string

The name of the event the listener listens to.

since 2.0.0

Inherited from

Listener.event

Defined in

node_modules/@sapphire/framework/dist/index.d.ts:1834


location

Readonly location: PieceLocation

The location metadata for the piece's file.

Inherited from

Listener.location

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:439


name

Readonly name: string

The name of the piece.

Inherited from

Listener.name

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:443


once

Readonly once: boolean

Whether or not the listener will be unloaded after the first run.

since 2.0.0

Inherited from

Listener.once

Defined in

node_modules/@sapphire/framework/dist/index.d.ts:1839


options

Readonly options: ListenerOptions

The raw options passed to this {@link Piece}

Inherited from

Listener.options

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:451


requiredPermissions

Private Readonly requiredPermissions: Readonly<BitField<PermissionString, bigint>>

Defined in

projects/plugins/packages/pattern-commands/src/listeners/PluginMessageParse.ts:9


store

Readonly store: Store<Piece<PieceOptions>>

The store that contains the piece.

Inherited from

Listener.store

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:435

Accessors

container

get container(): Container

A reference to the {@link Container} object for ease of use.

see container

Returns

Container

Inherited from

Listener.container

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:457

Methods

canRunInChannel

Private canRunInChannel(message): Promise<boolean>

Parameters

NameType
messageMessage<boolean>

Returns

Promise<boolean>

Defined in

projects/plugins/packages/pattern-commands/src/listeners/PluginMessageParse.ts:70


onLoad

onLoad(): unknown

Returns

unknown

Inherited from

Listener.onLoad

Defined in

node_modules/@sapphire/framework/dist/index.d.ts:1843


onUnload

onUnload(): unknown

Returns

unknown

Inherited from

Listener.onUnload

Defined in

node_modules/@sapphire/framework/dist/index.d.ts:1844


reload

reload(): Promise<void>

Reloads the piece by loading the same path in the store.

Returns

Promise<void>

Inherited from

Listener.reload

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:475


run

run(message): Promise<void>

Parameters

NameType
messageMessage<boolean>

Returns

Promise<void>

Overrides

Listener.run

Defined in

projects/plugins/packages/pattern-commands/src/listeners/PluginMessageParse.ts:14


toJSON

toJSON(): ListenerJSON

Returns

ListenerJSON

Inherited from

Listener.toJSON

Defined in

node_modules/@sapphire/framework/dist/index.d.ts:1845


unload

unload(): Promise<void>

Unloads and disables the piece.

Returns

Promise<void>

Inherited from

Listener.unload

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:471