Class RollPF

Hierarchy

Constructors

constructor

Accessors

dice totalHalved

Methods

getTooltip _splitParentheses cleanFlavor safeRoll safeTotal simplifyTerms

Constructors

constructor

  • Parameters

    • formula: string

      The string formula to parse

    • Optional data: any

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

    • Optional options: InexactPartial<EvaluationOptions>

      (default: {})

    Returns RollPF

Accessors

dice

  • get dice(): DiceTerm[]

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

    Returns DiceTerm[]

totalHalved

Methods

getTooltip

  • Render the tooltip HTML for a RollPF instance

    Returns Promise<string>

    The rendered HTML tooltip as a string

Static Private _splitParentheses

  • _splitParentheses(_formula): string[]
  • Private

    Split a formula by identifying its outer-most parenthetical and math terms

    Parameters

    • _formula: string

      The raw formula to split

    Returns string[]

    An array of terms, split on parenthetical terms

Static cleanFlavor

Static safeRoll

  • Parameters

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

      Returns Evaluated<Roll<{}>>

    Static safeTotal

    • Parameters

      • formula: any
      • data: any

      Returns number

    Static simplifyTerms

    • Parameters

      • terms: any

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc