TagScript API Docs Getting StartedClasses

Class: RangeParser

The range tag picks a random number from a range of numbers separated by -. The number range is inclusive, so it can pick the starting/ending number as well. Using the rangef tag will pick a number to the tenth decimal place.

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

BaseParser

Implements

IParser

Constructors

new RangeParser()

new RangeParser(): RangeParser

Returns

Overrides

BaseParser.constructor

Defined in

Parsers/Range.ts:28

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/Range.ts:32

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

Previous

RandomParser

Next

ReplaceParser