Class CombatantPF

Combatant extension.

Hierarchy

  • Combatant
    • CombatantPF

Constructors

constructor

Methods

_getInitiativeFormula duplicateWithData getInitiativeRoll updateResource

Constructors

constructor

  • new CombatantPF(
        data: undefined | CombatantDataConstructorData,
        context: undefined | Context<Combat>,
    ): CombatantPF

  • 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

Methods

_getInitiativeFormula

  • _getInitiativeFormula(d20?: string): 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

    • Optionald20: string

      Default check roll

    Returns string

    Initiative formula

    Synchronized with Foundry 12.331

    Todo

    Build proper formula

duplicateWithData

  • duplicateWithData(data?: object, context?: object): Promise<Combatant>

  • Duplicate combatant with added data.

    Parameters

    • data: object = {}

      Override data

    • context: object = {}

      Creation context

    Returns Promise<Combatant>

    • Created combatant

getInitiativeRoll

  • getInitiativeRoll(formula?: string, d20?: string, bonus?: number): D20RollPF

  • Get unevaluated initiative roll instance.

    Parameters

    • Optionalformula: string

      Initiative formula override

    • Optionald20: string = null

      D20 override. Non-standard option.

    • Optionalbonus: number = null

      Bonus to initiative. Non-standard option.

    Returns D20RollPF

    Initiative roll instance

    Synchronized with Foundry VTT 12.331

updateResource

  • updateResource(): any

  • Combat tracker resource update.

    Required to deal with 0 values disappearing with core implementation

    Returns any

    Resource value.

    Synchronized with Foundry 12.331

Settings

Member Visibility

On This Page

Constructors
Methods