Class DamageRoll

A specialized Roll class which is used to evaluate damage rolls. Provides additional utility getters for data relevant to damage rolls (e.g. damage type).

Hierarchy (View Summary)

Constructors

constructor

Properties

CHAT_TEMPLATE TYPES

Accessors

damageType isCritical totalHalved type

Methods

getTooltip render cleanFlavor getTermTooltipData safeRoll safeRollSync

Constructors

constructor

  • new DamageRoll(formula: string, data: object, options?: object): DamageRoll

  • Parameters

    • formula: string

      The formula to parse.

    • data: object

      The data object against which to parse attributes within the formula.

    • options: object = {}

      Additional options which customize the created Roll instance.

    Returns DamageRoll

Properties

StaticCHAT_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'

StaticTYPES

TYPES: { CRITICAL: string; NON_CRITICAL: string; NORMAL: string } = ...

Types of damage rolls with regard to their critical status.

Accessors

damageType

isCritical

totalHalved

type

Methods

getTooltip

  • getTooltip(): Promise<string>

  • Render the tooltip HTML for a RollPF instance

    Returns Promise<string>

    The rendered HTML tooltip as a string

render

  • render(
        __namedParameters: { flavor: any; isPrivate?: boolean; template?: any },
    ): Promise<string>

  • Synced with Foundry v12.331

    Parameters

    • __namedParameters: { flavor: any; isPrivate?: boolean; template?: any }

    Returns Promise<string>

StaticcleanFlavor

StaticgetTermTooltipData

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

    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
Properties
Accessors
Methods