Class FunctionTerm

A type of RollTerm used to apply a function.

Hierarchy (View Summary)

Properties

_root fn isIntermediate options result rolls terms FLAVOR_REGEXP FLAVOR_REGEXP_STRING REGEXP SERIALIZE_ATTRIBUTES

Accessors

dice expression flavor formula function isDeterministic resolver total

Methods

_evaluate evaluate toJSON _evaluateAsync _evaluateSync _fromData fromData fromJSON fromParseNode isDeterministic

Properties

Internal_root

_root: Roll

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

fn

fn: string

The name of the configured function, or one in the Math environment, which should be applied to the term

isIntermediate

isIntermediate: boolean = true

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

options

options: object

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

result

result: string | number

The cached result of evaluating the method arguments

rolls

rolls: Roll[]

The cached Roll instances for each function argument

terms

terms: string[]

An array of string argument terms for the function

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 = undefined

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

dice

  • get dice(): DiceTerm[]

    An array of evaluated DiceTerm instances that should be bubbled up to the parent Roll

    Returns DiceTerm[]

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

function

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(): string | number

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

    Returns string | number

Methods

_evaluate

  • _evaluate(options?: {}): RollTerm | Promise<RollTerm>

    Evaluate the term.

    Parameters

    • options: {} = {}

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

    Returns RollTerm | Promise<RollTerm>

    Returns a Promise if the term is non-deterministic.

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_evaluateAsync

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

    Evaluate this function when it contains any non-deterministic sub-terms.

    Parameters

    • Optionaloptions: object = {}

    Returns Promise<RollTerm>

Protected_evaluateSync

  • _evaluateSync(options?: object): RollTerm
    Protected

    Evaluate this function when it contains only deterministic sub-terms.

    Parameters

    • Optionaloptions: object = {}

    Returns RollTerm

Static_fromData

  • _fromData(data: any): RollTerm

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

    Parameters

    • data: any

      The de-serialized term data

    Returns RollTerm

    The re-constructed RollTerm object

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

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

Settings

Member Visibility

On This Page

Properties
Accessors
Methods