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

Constructors

constructor

Properties

TYPES

Accessors

damageType dice isCritical totalHalved type

Methods

getTooltip cleanFlavor safeRoll safeTotal simplifyTerms

Constructors

constructor

  • 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

Static TYPES

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

Types of damage rolls with regard to their critical status.

Type declaration

  • CRITICAL: string
  • NON_CRITICAL: string
  • NORMAL: string

Accessors

damageType

  • get damageType(): {
        custom: string;
        values: string[];
    }

  • The damage type of this damage roll.

    Returns {
        custom: string;
        values: string[];
    }

    • custom: string
    • values: string[]

dice

  • get dice(): DiceTerm[]

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

    Returns DiceTerm[]

isCritical

totalHalved

type

Methods

getTooltip

  • Render the tooltip HTML for a RollPF instance

    Returns Promise<string>

    The rendered HTML tooltip as a string

Static cleanFlavor

Static safeRoll

  • Parameters

    • formula: any
    • data: {} = {}
      • context: any
      • options: {
            suppressError: boolean;
        } = ...
        • suppressError: boolean

      Returns Evaluated<Roll<{}>>

    Static safeTotal

    Static simplifyTerms

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc