Pathfinder 1e for Foundry VTT
    Preparing search index...

    Class HauntModel

    Haunt actor data model

    Hierarchy (View Summary)

    Index

    General

    _rollData attributes details resources templates traits auraStrength system _onItemReady _prepareCR _preparePostChanges _prepareTemplates _updateResources getCR getSourceDetails prepareBaseData prepareDerivedData

    Document

    _updateResource

    Extension API

    _finalizeData _prepareChangeFlags _prepareChanges _prepareDependentData getChangeTargets getInitiativeOptions getLabels getTokenSize

    General

    _rollData

    _rollData: any
    attributes: {
        hp: { base: number; max: number; offset: number; value: number };
        init: { total: number; value: number };
    }
    details: {
        alignment: "tn" | "lg" | "ng" | "cg" | "ln" | "cn" | "le" | "ne" | "ce";
        area: { size: number; type: MEASURED_TEMPLATE_TYPES };
        aura: {
            custom: boolean;
            school:
                | "misc"
                | "con"
                | "abj"
                | "div"
                | "enc"
                | "evo"
                | "ill"
                | "nec"
                | "trs"
                | "uni"
                | FreeText;
        };
        cl: number;
        cr: { offset: number; total: number };
        destruction: HTML;
        effect: HTML;
        notes: HTML;
        notice: { dc: number; desc: FreeText; value: FreeText };
        reset: {
            units:
                | "round"
                | "minute"
                | "hour"
                | "day"
                | "perm"
                | "seeText"
                | "spec"
                | "inst"
                | "turn"
                | "month"
                | "year";
            value: string;
        };
        trigger: FreeText;
        weakness: FreeText;
        xp: { value: number };
    }
    resources: any
    templates: Trait<HauntTemplates, string> | undefined
    traits: {
        size:
            | "med"
            | "fine"
            | "dim"
            | "tiny"
            | "sm"
            | "lg"
            | "huge"
            | "grg"
            | "col";
    }
    • get auraStrength(): number

      Aura strength as number from 0 to 4.

      Returns number

      pf1.config.auraStrengths

    • get system(): this

      Returns this

      REMOVE BEFORE RELEASE

    Abstract_onItemReady

    _prepareCR

    • _prepareCR(): void

      Returns void

    _preparePostChanges

    _prepareTemplates

    • _prepareTemplates(): void

      Returns void

    _updateResources

    • _updateResources(error: boolean): void
      Internal

      Parameters

      • error: boolean

      Returns void

    • Get challenge rating.

      Returns number

      • CR

    • Parameters

      • path: any

      Returns never[]

    Document

    _updateResource

    • _updateResource(
          item: ItemPF<BaseItemModel>,
          options?: { warnOnDuplicate?: boolean },
      ): boolean
      Internal

      Update Item Resource

      Parameters

      • item: ItemPF<BaseItemModel>

        the item to add to the actor's resources

      • Optionaloptions: { warnOnDuplicate?: boolean } = {}

        extra options

        • OptionalwarnOnDuplicate?: boolean

          Skips warning if item tag already exists in dictionary flags

      Returns boolean

      True if resources were set

    Extension API

    Abstract_finalizeData

    • _finalizeData(): void

      Returns void

    Abstract_prepareChangeFlags

    • _prepareChangeFlags(): void

      Prepare actor.changeFlags alterations.

      Returns void

    _prepareChanges

    • _prepareChanges(changes: any): void

      Prepare changes specific to this actor type

      Parameters

      • changes: any

      Returns void

    Abstract_prepareDependentData

    • _prepareDependentData(): void

      Prepare data post embedded documents have been prepared.

      This is before changes and before prepareDerivedData()

      Returns void

    • Custom change targets for this actor type

      Returns string[]

    • Initiative rolling options

      Returns { check: boolean }

    • Generate generic labels.

      Returns object

    Settings

    Member Visibility

    On This Page

    General
    Document
    Extension API