Class RollTerm

An abstract class which represents a single token that can be used as part of a Roll formula. Every portion of a Roll formula is parsed into a subclass of RollTerm in order for the Roll to be fully evaluated.

Hierarchy (view full)

Constructors

constructor

Properties

options _evaluated _root isIntermediate FLAVOR_REGEXP_STRING FLAVOR_REGEXP REGEXP SERIALIZE_ATTRIBUTES

Accessors

expression formula total flavor isDeterministic resolver

Methods

evaluate toJSON _evaluate isDeterministic fromData fromParseNode fromJSON _fromData

Constructors

constructor

  • new RollTerm(options?): RollTerm

  • Parameters

    • Optional options: object = {}

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

    Returns RollTerm

Properties

options

options: object

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

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?

Static FLAVOR_REGEXP_STRING

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

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

Static FLAVOR_REGEXP

FLAVOR_REGEXP: RegExp = ...

A regular expression which identifies term-level flavor text

Static REGEXP

REGEXP: RegExp = undefined

A regular expression used to match a term of this type

Static SERIALIZE_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

formula

  • get formula(): string

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

    Returns string

total

  • get total(): string | number

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

    Returns string | number

flavor

  • get flavor(): string

  • Optional flavor text which modifies and describes this term.

    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

Methods

evaluate

  • evaluate(options?): RollTerm | Promise<RollTerm>

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

    Parameters

    • Optional options: {
          minimize: boolean;
          maximize: boolean;
          allowStrings: boolean;
      } = {}

      Options which modify how the RollTerm is evaluated

      • minimize: boolean

        Minimize the result, obtaining the smallest possible value.

      • maximize: boolean

        Maximize the result, obtaining the largest possible value.

      • allowStrings: boolean

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

    Returns RollTerm | Promise<RollTerm>

    Returns a Promise if the term is non-deterministic.

toJSON

  • toJSON(): object

  • 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 object

Protected _evaluate

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

    Evaluate the term.

    Parameters

    • Optional options: 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.

Static isDeterministic

  • isDeterministic(term, options?): boolean

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

    Parameters

    • term: RollTerm

      The term.

    • Optional options: {
          maximize: boolean;
          minimize: boolean;
      } = {}

      Options for evaluating the term.

      • maximize: boolean

        Force the result to be maximized.

      • minimize: boolean

        Force the result to be minimized.

    Returns boolean

Static fromData

  • fromData(data): RollTerm

  • Construct a RollTerm from a provided data object

    Parameters

    • data: object

      Provided data from an un-serialized term

    Returns RollTerm

    The constructed RollTerm

Static fromParseNode

Static fromJSON

  • fromJSON(json): 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

Static Protected _fromData

  • _fromData(data): RollTerm
  • Protected

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

    Parameters

    • data: object

      The de-serialized term data

    Returns RollTerm

    The re-constructed RollTerm object

Settings

Member Visibility

Theme

On This Page

constructoroptions_evaluated_rootisIntermediateFLAVOR_REGEXP_STRINGFLAVOR_REGEXPREGEXPSERIALIZE_ATTRIBUTESexpressionformulatotalflavorisDeterministicresolverevaluatetoJSON_evaluateisDeterministicfromDatafromParseNodefromJSON_fromData