TypeDoc API
TagScript
classes
Rangeparser

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

Example

{range(1-3)}

Example

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.

Hierarchy

Implements

Constructors

constructor

new RangeParser()

Overrides

BaseParser.constructor

Properties

acceptedNames

Protected acceptedNames: string[]

Inherited from

BaseParser.acceptedNames


requiredParameter

Protected requiredParameter: boolean

Inherited from

BaseParser.requiredParameter


requiredPayload

Protected requiredPayload: boolean

Inherited from

BaseParser.requiredPayload

Methods

parse

parse(ctx): string

Parses the given tag.

Parameters

NameTypeDescription
ctxContextThe context of the tag.

Returns

string

Implementation of

IParser.parse


willAccept

willAccept(ctx): boolean

Whether the parser can handle the given tag.

Parameters

NameTypeDescription
ctxContextThe context of the tag.

Returns

boolean

Implementation of

IParser.willAccept

Inherited from

BaseParser.willAccept