Class: CooldownParser
@tagscript/plugin-discord.CooldownParser
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.
Example
{ cooldown(seconds): response }Aliases: cd
Example
{ cooldown(5): This tag is on cooldown. }
{ cooldown(5): The tag {name} is on cooldown. Please try again in {retryAfter}. }Hierarchy
-
BaseParser↳
CooldownParser
Implements
IParser
Constructors
constructor
• new CooldownParser()
Overrides
BaseParser.constructor
Defined in
tagscript-plugin-discord/src/lib/Parsers/Cooldown.ts:22
Properties
acceptedNames
• Protected acceptedNames: string[]
Inherited from
BaseParser.acceptedNames
Defined in
tagscript/dist/index.d.ts:380
requiredParameter
• Protected requiredParameter: boolean
Inherited from
BaseParser.requiredParameter
Defined in
tagscript/dist/index.d.ts:381
requiredPayload
• Protected requiredPayload: boolean
Inherited from
BaseParser.requiredPayload
Defined in
tagscript/dist/index.d.ts:382
Methods
parse
▸ parse(ctx): string
Parameters
| Name | Type |
|---|---|
ctx | Context |
Returns
string
Implementation of
IParser.parse
Defined in
tagscript-plugin-discord/src/lib/Parsers/Cooldown.ts:26
willAccept
▸ willAccept(ctx): boolean
Parameters
| Name | Type |
|---|---|
ctx | Context |
Returns
boolean
Implementation of
IParser.willAccept
Inherited from
BaseParser.willAccept
Defined in
tagscript/dist/index.d.ts:384