• Public
  • Public/Protected
  • All

A type of RollTerm used to apply a function from the Math library.




  • new MathTerm(__namedParameters?: { fn: any; terms: any[]; options: any }): MathTerm
  • Parameters

    • __namedParameters: { fn: any; terms: any[]; options: any } = {}
      • fn: any
      • terms: any[]
      • options: any

    Returns MathTerm


fn: string

The named function in the Math environment which should be applied to the term

terms: string[]

An array of string argument terms for the function

rolls: Roll[] = []

The cached Roll instances for each function argument

result: number = undefined

The cached result of evaluating the method arguments

isIntermediate: boolean = true

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

options: any

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

_evaluated: boolean

An internal flag for whether the term has been evaluated


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

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

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


A regular expression which identifies term-level flavor text

REGEXP: RegExp = undefined

A regular expression used to match a term of this type


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

    Returns DiceTerm[]

  • get total(): number
  • inheritdoc

    Returns number

  • get expression(): string
  • inheritdoc

    Returns string

  • get isDeterministic(): boolean
  • inheritdoc

    Returns boolean

  • get formula(): string
  • A string representation of the formula, including optional flavor text.

    Returns string

  • get flavor(): string
  • Optional flavor text which modifies and describes this term.

    Returns string


  • _evaluateSync(__namedParameters?: { minimize: boolean; maximize: boolean }): MathTerm
  • This method is temporarily factored out in order to provide different behaviors synchronous evaluation. This will be removed in 0.10.x


    • __namedParameters: { minimize: boolean; maximize: boolean } = {}
      • minimize: boolean
      • maximize: boolean

    Returns MathTerm

  • _evaluate(__namedParameters?: { minimize: boolean; maximize: boolean }): Promise<MathTerm>
  • Evaluate the term.


    • __namedParameters: { minimize: boolean; maximize: boolean } = {}

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

      • minimize: boolean
      • maximize: boolean

    Returns Promise<MathTerm>

  • evaluate([options={}]?: { minimize: boolean; maximize: boolean; async: boolean }): RollTerm
  • Evaluate the term, processing its inputs and finalizing its total.


    • [options={}]: { minimize: boolean; maximize: boolean; async: boolean } = {}

      Options which modify how the RollTerm is evaluated

      • minimize: boolean
      • maximize: boolean
      • async: boolean

    Returns RollTerm

    The evaluated RollTerm

  • toJSON(): any
  • 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 any

  • Construct a RollTerm from a provided data object


    • data: any

      Provided data from an un-serialized term

    Returns RollTerm

    The constructed RollTerm

  • Reconstruct a RollTerm instance from a provided JSON string


    • json: string

      A serialized JSON representation of a DiceTerm

    Returns RollTerm

    A reconstructed RollTerm from the provided JSON

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


    • data: any

      The de-serialized term data

    Returns RollTerm

    The re-constructed RollTerm object