TagScript

Class: RequiredParser

Defined in: tagscript-plugin-discord/src/lib/Parsers/AllowDeny.ts:39

The require tag will attempt to convert the given parameter into a channel, user or role, using name or Id. If the user running the tag is not in the targeted channel or doesn't have the targeted role or their id isn't same as targeted user's id, the tag will stop processing and it will send the response if one is given. Multiple role, user or channel requirements can be given, and should be split by a ,.

Aliases: allowlist, whitelist

Examples

{require(user,role,channel):response}

{require(Moderator)}
{require(#general, #bot-commands):This tag can only be run in #general and #bot-cmds.}
{require(757425366209134764, 668713062186090506, 737961895356792882):You aren't allowed to use this tag.}

Developers need to add the check themselves.

const { Interpreter } = require("tagscript")
const { RequiredParser } = require("@tagscript/plugin-discord")

const ts = new Interpreter(new RequiredParser())

const result = await ts.run("{require(id1, id2):You aren't allowed to use this tag.}")

if (!result.actions.require.ids.includes(interaction.user.id)) {
// add channel, role check here or check using name instead of id
return interaction.reply(result.actions.require.message)
}

Extends

• BaseParser

Implements

• IParser

Constructors

Constructor

Defined in: tagscript-plugin-discord/src/lib/Parsers/AllowDeny.ts:40

Returns

RequiredParser

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/AllowDeny.ts:44

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

"" | null

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