Class RollPF

Hierarchy (View Summary)

Roll
- RollPF
  - D20RollPF
  - DamageRoll

Index

Constructors

Properties

err? CHAT_TEMPLATE

Methods

getTooltip render cleanFlavor getTermTooltipData safeRoll safeRollSync

Constructors

constructor

new RollPF(formula: string, data?: EmptyObject, options?: Options): RollPF
Parameters
- formula: string
  The string formula to parse
- Optionaldata: EmptyObject
  The data object against which to parse attributes within the formula (default: {})
- Optionaloptions: Options
  (default: {})
Returns RollPF
Inherited from Roll.constructor
- Defined in node_modules/fvtt-types/src/foundry/client/dice/roll.d.mts:38

Properties

`Optional`err

err?: Error

`Static`CHAT_TEMPLATE

CHAT_TEMPLATE: string = "systems/pf1/templates/chat/roll.hbs"

The HTML template path used to render a complete Roll object to the chat log

Default Value

"templates/dice/roll.html"

Methods

getTooltip

getTooltip(): Promise<string>
Render the tooltip HTML for a RollPF instance

Returns Promise<string>
The rendered HTML tooltip as a string
Overrides Roll.getTooltip
- Defined in module/dice/roll.mjs:86

render

render(
__namedParameters?: { isPrivate?: boolean; template?: any },
): Promise<string>
Synced with Foundry v12.331
Parameters
- __namedParameters: { isPrivate?: boolean; template?: any } = {}
Returns Promise<string>
Overrides Roll.render
- Defined in module/dice/roll.mjs:122

`Static`cleanFlavor

cleanFlavor(flavor: any): any
Parameters
- flavor: any
Returns any
- Defined in module/dice/roll.mjs:63

`Static`getTermTooltipData

getTermTooltipData(term: any): any
Parameters
- term: any
Returns any
- Defined in module/dice/roll.mjs:67

`Static`safeRoll

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.
- Defined in module/dice/roll.mjs:18

`Static`safeRollSync

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
Remarks
- Returned roll has .err set if an error occurred during evaluation.
- If error occurs, the returned roll will have its formula replaced.
- Defined in module/dice/roll.mjs:47