TagScript

Class: CooldownParser

Defined in: tagscript-plugin-discord/src/lib/Parsers/Cooldown.ts:21

The cooldown tag implements cooldowns when running a tag. The parameter is the number of seconds to wait before running the tag again. The payload is the optional cooldown message to send if the tag is on cooldown. Payload can have {retryAfter}, {name} which will be replaced with the time remaining and the name of the tag respectively.

Examples

{ cooldown(seconds): response }

Aliases: cd

{ cooldown(5): This tag is on cooldown. }
{ cooldown(5): The tag {name} is on cooldown. Please try again in {retryAfter}. }

Extends

• BaseParser

Implements

• IParser

Constructors

Constructor

Defined in: tagscript-plugin-discord/src/lib/Parsers/Cooldown.ts:22

Returns

CooldownParser

Overrides

BaseParser.constructor

Properties

acceptedNames

Defined in: tagscript/dist/manifest-UlUsUErx.d.mts:9

Inherited from

BaseParser.acceptedNames

requiredParameter

Defined in: tagscript/dist/manifest-UlUsUErx.d.mts:10

Inherited from

BaseParser.requiredParameter

requiredPayload

Defined in: tagscript/dist/manifest-UlUsUErx.d.mts:11

Inherited from

BaseParser.requiredPayload

Methods

parse()

Defined in: tagscript-plugin-discord/src/lib/Parsers/Cooldown.ts:26

Parses the given tag.

Returning null or undefined means this parser did not handle the tag, and the interpreter moves on to the next one that accepted it.

Parameters

ctx

Context

The context of the tag.

Returns

string

Implementation of

IParser.parse

toJSON()

Defined in: tagscript/dist/manifest-UlUsUErx.d.mts:14

Returns

object

acceptedNames

requiredParameter

requiredPayload

Inherited from

BaseParser.toJSON

willAccept()

Defined in: tagscript/dist/manifest-UlUsUErx.d.mts:13

Parameters

ctx

Context

Returns

boolean

Implementation of

IParser.willAccept

Inherited from

BaseParser.willAccept