• Public
  • Public/Protected
  • All

A type of RollTerm used to represent static numbers.




  • new NumericTerm(__namedParameters?: { number: any; options: any }): NumericTerm


number: number
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

isIntermediate: boolean = false

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

REGEXP: RegExp = ...

A regular expression used to match a term of this type


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


  • get expression(): string
  • inheritdoc

    Returns string

  • get total(): number
  • inheritdoc

    Returns number

  • 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

  • get isDeterministic(): boolean
  • Whether this term is entirely deterministic or contains some randomness.

    Returns boolean


  • 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

  • matchTerm(expression: string): RegExpMatchArray
  • Determine whether a string expression matches a NumericTerm


    • expression: string

      The expression to parse

    Returns RegExpMatchArray

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


    • match: RegExpMatchArray

      The matched regular expression array

    Returns NumericTerm

    The constructed term

  • 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