Class NumericTerm

A type of RollTerm used to represent static numbers.

Hierarchy (View Summary)

Properties

_evaluated _root isIntermediate number options FLAVOR_REGEXP FLAVOR_REGEXP_STRING REGEXP SERIALIZE_ATTRIBUTES

Accessors

expression flavor formula isDeterministic resolver total

Methods

evaluate toJSON _evaluate fromData fromJSON fromMatch fromParseNode isDeterministic matchTerm _fromData

Properties

Internal_evaluated

_evaluated: boolean = false

An internal flag for whether the term has been evaluated

Internal_root

_root: Roll

A reference to the Roll at the root of the evaluation tree.

isIntermediate

isIntermediate: boolean = false

Is this term intermediate, and should be evaluated first as part of the simplification process?

number

number: number

The term's numeric value.

options

options: object

An object of additional options which describes and modifies the term.

StaticFLAVOR_REGEXP

FLAVOR_REGEXP: RegExp = ...

A regular expression which identifies term-level flavor text

StaticFLAVOR_REGEXP_STRING

FLAVOR_REGEXP_STRING: string = "(?:\\[([^\\]]+)\\])"

A regular expression pattern which identifies optional term-level flavor text

StaticREGEXP

REGEXP: RegExp = ...

A regular expression used to match a term of this type

StaticSERIALIZE_ATTRIBUTES

SERIALIZE_ATTRIBUTES: string[] = ...

An array of additional attributes which should be retained when the term is serialized

Accessors

expression

  • get expression(): string

    A string representation of the formula expression for this RollTerm, prior to evaluation.

    Returns string

flavor

  • get flavor(): string

    Optional flavor text which modifies and describes this term.

    Returns string

formula

  • get formula(): string

    A string representation of the formula, including optional flavor text.

    Returns string

isDeterministic

  • get isDeterministic(): boolean

    Whether this term is entirely deterministic or contains some randomness.

    Returns boolean

resolver

  • get resolver(): RollResolver

    A reference to the RollResolver app being used to externally resolve this term.

    Returns RollResolver

total

  • get total(): number

    A string or numeric representation of the final output for this term, after evaluation.

    Returns number

Methods

evaluate

  • evaluate(
        options?: {
            allowStrings?: boolean;
            maximize?: boolean;
            minimize?: boolean;
        },
    ): RollTerm
    | Promise<RollTerm>

    Evaluate the term, processing its inputs and finalizing its total.

    Parameters

    • Optionaloptions: { allowStrings?: boolean; maximize?: boolean; minimize?: boolean } = {}

      Options which modify how the RollTerm is evaluated

      • OptionalallowStrings?: boolean

        If true, string terms will not throw an error when evaluated.

      • Optionalmaximize?: boolean

        Maximize the result, obtaining the largest possible value.

      • Optionalminimize?: boolean

        Minimize the result, obtaining the smallest possible value.

    Returns RollTerm | Promise<RollTerm>

    Returns a Promise if the term is non-deterministic.

toJSON

  • toJSON(): RollTermData

    Serialize the RollTerm to a JSON string which allows it to be saved in the database or embedded in text. This method should return an object suitable for passing to the JSON.stringify function.

    Returns RollTermData

Protected_evaluate

  • _evaluate(options?: object): RollTerm | Promise<RollTerm>
    Protected

    Evaluate the term.

    Parameters

    • Optionaloptions: object = {}

      Options which modify how the RollTerm is evaluated, see RollTerm#evaluate

    Returns RollTerm | Promise<RollTerm>

    Returns a Promise if the term is non-deterministic.

StaticfromData

StaticfromJSON

  • fromJSON(json: string): RollTerm

    Reconstruct a RollTerm instance from a provided JSON string

    Parameters

    • json: string

      A serialized JSON representation of a DiceTerm

    Returns RollTerm

    A reconstructed RollTerm from the provided JSON

StaticfromMatch

  • fromMatch(match: RegExpMatchArray): NumericTerm

    Construct a term of this type given a matched regular expression array.

    Parameters

    • match: RegExpMatchArray

      The matched regular expression array

    Returns NumericTerm

    The constructed term

StaticfromParseNode

StaticisDeterministic

  • isDeterministic(
        term: RollTerm,
        options?: { maximize?: boolean; minimize?: boolean },
    ): boolean

    Determine if evaluating a given RollTerm with certain evaluation options can be done so deterministically.

    Parameters

    • term: RollTerm

      The term.

    • Optionaloptions: { maximize?: boolean; minimize?: boolean } = {}

      Options for evaluating the term.

      • Optionalmaximize?: boolean

        Force the result to be maximized.

      • Optionalminimize?: boolean

        Force the result to be minimized.

    Returns boolean

StaticmatchTerm

  • matchTerm(expression: string): null | RegExpMatchArray

    Determine whether a string expression matches a NumericTerm

    Parameters

    • expression: string

      The expression to parse

    Returns null | RegExpMatchArray

Protected Static_fromData

  • _fromData(data: RollTermData): RollTerm
    Protected

    Define term-specific logic for how a de-serialized data object is restored as a functional RollTerm

    Parameters

    Returns RollTerm

    The re-constructed RollTerm object

Settings

Member Visibility

On This Page

Properties
Accessors
Methods