Class RollPF

Hierarchy (view full)

Constructors

constructor

Accessors

totalHalved

Methods

getTooltip cleanFlavor getTermTooltipData safeRoll safeRollSync

Constructors

constructor

  • new RollPF(formula, data?, options?): RollPF

  • Parameters

    • formula: string

      The string formula to parse

    • Optionaldata: any

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

    • Optionaloptions: InexactPartial<EvaluationOptions>

      (default: {})

    Returns RollPF

Accessors

totalHalved

Methods

getTooltip

  • getTooltip(): Promise<string>

  • Render the tooltip HTML for a RollPF instance

    Returns Promise<string>

    The rendered HTML tooltip as a string

StaticcleanFlavor

StaticgetTermTooltipData

StaticsafeRoll

  • safeRoll(formula, rollData?, context, options?, evalOpts?): Promise<RollPF>

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

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

      Additional options

      • suppressError: undefined | boolean

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

    • OptionalevalOpts: 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.

StaticsafeRollSync

  • safeRollSync(formula, rollData?, context, options?, evalOpts?): RollPF

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

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

        Additional options

        • suppressError: undefined | boolean

          If true, no error will be printed

      • evalOpts: {} = {}

        Additional options to pass to Roll.evaluate()

        Returns RollPF

        • Evaluated roll

        Remarks

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

      Settings

      Member Visibility

      On This Page

      Constructors
      Accessors
      Methods