Class RollPF

Optionalerr

StaticCHAT_TEMPLATE

getTooltip

• getTooltip(): Promise<string>

  Render the tooltip HTML for a RollPF instance

  Returns Promise<string>

  The rendered HTML tooltip as a string

StaticcleanFlavor

• cleanFlavor(flavor: any): any

  Parameters

  • flavor: any

  Returns any

StaticgetTermTooltipData

• getTermTooltipData(term: any): any

  Parameters

  • term: any

  Returns any

StaticsafeRoll

• safeRoll(
      formula: string,
      rollData?: object,
      context: object,
      options?: { suppressError?: boolean },
      evalOpts?: object,
  ): 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?: boolean } = {}

    Additional options

    • OptionalsuppressError?: 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: string,
      rollData?: object,
      context?: any,
      options?: { suppressError?: boolean },
      evalOpts?: object,
  ): RollPF

  Synchronous and thrown error consuming roll evaluation.

  Parameters

  • formula: string

    Roll formula

  • OptionalrollData: object = {}

    Data supplied to roll

  • Optionalcontext: any

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

  • Optionaloptions: { suppressError?: boolean } = {}

    Additional options

    • OptionalsuppressError?: boolean

      If true, no error will be printed

  • OptionalevalOpts: object = {}

    Additional options to pass to Roll.evaluate()

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