Class RollPF

Hierarchy

Constructors

constructor

Accessors

dice flavor totalHalved

Methods

getTooltip cleanFlavor getTermTooltipData parse safeRoll safeRollSync simplifyTerms

Constructors

constructor

  • Parameters

    • formula: string

      The string formula to parse

    • Optional data: any

      The data object against which to parse attributes within the formula (default: {})

    • Optional options: InexactPartial<EvaluationOptions>

      (default: {})

    Returns RollPF

Accessors

dice

  • get dice(): DiceTerm[]

  • Return an Array of the individual DiceTerm instances contained within this Roll. Override to recognize dice in SizeRollTerm.

    Returns DiceTerm[]

flavor

totalHalved

Methods

getTooltip

  • Render the tooltip HTML for a RollPF instance

    Returns Promise<string>

    The rendered HTML tooltip as a string

Static cleanFlavor

Static getTermTooltipData

Static parse

  • Parameters

    • formula: any
    • data: any

    Returns RollTerm[]

Static safeRoll

  • Synchronous and thrown error consuming roll evaluation.

    Parameters

    • formula: string

      Roll formula

    • rollData: object = {}

      Data supplied to roll

    • context: object

      If error occurs, this will be included in the error message.

    • Optional options: {
          suppressError: undefined | boolean;
      } = {}

      Additional options

      • suppressError: undefined | boolean

        If true, no error will be printed even if one occurs.

    • Optional evalOpts: object = {}

      Additional options to pass to Roll.evaluate()

    Returns Promise<RollPF>

    • Evaluated roll, or placeholder if error occurred.

    Remarks

    • Returned roll has .err set if an error occurred during evaluation.
    • If error occurs, the returned roll will have its formula replaced.

Static safeRollSync

  • Synchronous and thrown error consuming roll evaluation.

    Parameters

    • formula: any

      Roll formula

    • rollData: {} = {}

      Data supplied to roll

      • context: any

        If error occurs, this will be included in the error message.

      • root0: {
            suppressError: undefined | boolean;
        } = {}

        Additional options

        • suppressError: undefined | boolean
      • evalOpts: {} = {}

        Additional options to pass to Roll.evaluate()

        Returns any

        • Evaluated roll, or placeholder if error occurred.

        Remarks

        • Returned roll has .err set if an error occurred during evaluation.
        • If error occurs, the returned roll will have its formula replaced.

      Static simplifyTerms

      • Parameters

        • terms: any

        Returns any

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc