RangeParser
Class: RangeParser
Defined in: packages/tagscript/src/lib/Parsers/Range.ts:27
The range tag picks a random number from a range of numbers separated by - or ,.
Both ends are included, so {range:1-6} can return 1 and can return 6.
The rangef tag picks a number to one decimal place instead.
Aliases: rangef
Examples
{range:1-3}Your lucky number is {range:10-30}!
# Your lucky number is 14!
# Your lucky number is 25!
{=(height):{rangef:5-7}}
I am guessing your height is {height}ft.
# I am guessing your height is 5.3ft.Extends
Implements
Constructors
Constructor
new RangeParser(): RangeParser
Defined in: packages/tagscript/src/lib/Parsers/Range.ts:28
Returns
RangeParser
Overrides
Properties
acceptedNames
protected acceptedNames: string[]
Defined in: packages/tagscript/src/lib/Parsers/Base.ts:8
Inherited from
requiredParameter
protected requiredParameter: boolean
Defined in: packages/tagscript/src/lib/Parsers/Base.ts:10
Inherited from
requiredPayload
protected requiredPayload: boolean
Defined in: packages/tagscript/src/lib/Parsers/Base.ts:12
Inherited from
Methods
parse()
parse(ctx): string
Defined in: packages/tagscript/src/lib/Parsers/Range.ts:32
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
The context of the tag.
Returns
string
Implementation of
toJSON()
toJSON(): object
Defined in: packages/tagscript/src/lib/Parsers/Base.ts:29
Returns
object
acceptedNames
acceptedNames: string[]
requiredParameter
requiredParameter: boolean
requiredPayload
requiredPayload: boolean
Inherited from
willAccept()
willAccept(ctx): boolean
Defined in: packages/tagscript/src/lib/Parsers/Base.ts:20
Whether the parser can handle the given tag.
Parameters
ctx
Returns
boolean