Class CombatantPF

Combatant extension.

Hierarchy

  • Combatant
    • CombatantPF

Constructors

constructor

Properties

resource

Methods

_getInitiativeFormula duplicateWithData getInitiativeRoll updateResource

Constructors

constructor

  • Parameters

    • data: undefined | CombatantDataConstructorData

      Initial data provided to construct the Combatant document

    • context: undefined | Context<Combat>

      The document context, see foundry.abstract.Document

    Returns CombatantPF

Properties

resource

resource: null | number | boolean | `${number}`

Methods

_getInitiativeFormula

  • _getInitiativeFormula(d20?): string

  • Override the default Initiative formula to customize special behaviors of the game system. Apply tiebreaker if desired See Combat._getInitiativeFormula for more detail.

    Parameters

    • Optional d20: string

      Default check roll

    Returns string

    Initiative formula

duplicateWithData

  • Duplicate combatant with added data.

    Parameters

    • data: object = {}

      Override data

    • context: object = {}

      Creation context

    Returns Promise<Combatant>

    • Created combatant

getInitiativeRoll

  • Get unevaluated initiative roll instance.

    Parameters

    • Optional formula: string

      Initiative formula override

    • Optional d20: string = null

      D20 override

    • Optional bonus: number = null

      Bonus to initiative

    Returns D20RollPF

    Initiative roll instance

    Synchronized with Foundry VTT 10.291

updateResource

  • Combat tracker resource update. Required to deal with 0 values disappearing with core implementation

    Synchronized with Foundry 10.291

    Returns any

    Resource value.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc