CooldownParser

cooldown records how long the bot should wait before running this tag again. The parser only records the request. Whether the cooldown is applied, and whether the number is allowed at all, is up to the bot.

For template authors

Syntax

{cooldown(seconds):message}

The message is optional and is shown when someone hits the cooldown. Two placeholders are available in it, {retryAfter} for the time left and {name} for the tag name.

Examples

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

Aliases

cooldown, cd

For developers

Register the parser

import { CooldownParser } from '@tagscript/plugin-discord';
import { Interpreter } from 'tagscript';

const ts = new Interpreter(new CooldownParser());

Behaviour

The parameter is required and goes through parseInt with radix 10. parse sets ctx.response.actions.cooldown to { cooldown, message } and returns an empty string. The message is null when the template gave no payload.

Nothing validates the number, so a template can ask for {cooldown(0)} or {cooldown(99999999)}. Clamp it:

const requested = response.actions.cooldown?.cooldown ?? 0;
const seconds = Math.min(Math.max(requested, MIN_COOLDOWN), MAX_COOLDOWN);

Unlike require and deny, a later cooldown tag overwrites an earlier one, so the last one in the template wins.

API reference

CooldownParser