Tagscript

Class: IfStatementParser

The if tag returns a message based on the passed expression to the parameter. An expression is represented by two values compared with an operator. The payload is a required message that must be split by pipe (|). If the expression evaluates true, then the message before the pipe (|) is returned, else the message after is returned.

Operators: {

Examples

{if(expression):message}
{if({args}==63):You guessed it! The number I was thinking of was 63!|Too {if({args}<63):low|high}, try again.}
# if args is 63
# You guessed it! The number I was thinking of was 63!
# if args is 73
# Too high, try again.
# if args is 14
# Too low, try again.

Extends

Implements

Constructors

new IfStatementParser()

new IfStatementParser(): IfStatementParser

Returns

IfStatementParser

Overrides

BaseParser.constructor

Defined in

Parsers/Control.ts:55

Properties

acceptedNames

protected acceptedNames: string[]

Inherited from

BaseParser.acceptedNames

Defined in

Parsers/Base.ts:8


requiredParameter

protected requiredParameter: boolean

Inherited from

BaseParser.requiredParameter

Defined in

Parsers/Base.ts:10


requiredPayload

protected requiredPayload: boolean

Inherited from

BaseParser.requiredPayload

Defined in

Parsers/Base.ts:12

Methods

parse()

parse(ctx): string

Parses the given tag.

Parameters

ctx: Context

The context of the tag.

Returns

string

Implementation of

IParser.parse

Defined in

Parsers/Control.ts:59


toJSON()

toJSON(): object

Returns

object

acceptedNames

acceptedNames: string[]

requiredParameter

requiredParameter: boolean

requiredPayload

requiredPayload: boolean

Inherited from

BaseParser.toJSON

Defined in

Parsers/Base.ts:29


willAccept()

willAccept(ctx): boolean

Whether the parser can handle the given tag.

Parameters

ctx: Context

Returns

boolean

Implementation of

IParser.willAccept

Inherited from

BaseParser.willAccept

Defined in

Parsers/Base.ts:20

On this page