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

    Class NPCModel

    NPC actor data model

    Hierarchy (View Summary)

    Index

    General

    _rollData abilities ac altCurrency attributes config currency details parent resources skills spells traits _skillTargets sourceInfo system _addReactiveValues _computeEncumbrance _detectHealthChange _finalizeBooks _finalizeData _finalizeTraits _generateSpellbookCache _initializeBaseValues _onItemReady _prepareBooks _prepareHealth _prepareNaturalReach _prepareOverlandSpeeds _prepareSenses _prepareSkills _prepareTraits _refreshDerivedData _setSkillFlags _updateResources displayDefenseCard getCarryCapacity getChangeTargets getCoinWeight getCR getDefenses getTotalCurrency hasArmorProficiency hasWeaponProficiency onRestUpdate prepareCMB rollSave pruneData

    Document

    _updateResource

    Extension API

    _prepareChangeFlags _prepareChanges _prepareDependentData _preparePostChanges getInitiativeOptions getLabels getTokenSize

    General

    _rollData

    _rollData: any
    abilities: Record<AbilityId, AbilityData>
    ac:
        | {
            natural: { base: number; enh: number; misc: number; total: number };
            normal: { base: number; enh: number; misc: number; total: number };
            shield: { base: number; enh: number; misc: number; total: number };
        }
        | undefined
    altCurrency: Record<string, number>
    attributes: {
        ac: {
            flatFooted: { total: number };
            normal: { ability: string; total: number };
            touch: { ability: string; total: number };
        };
        acNotes: FreeText;
        attack: {
            meleeAbility: ""
            | "str"
            | "dex"
            | "con"
            | "int"
            | "wis"
            | "cha";
            rangedAbility: "" | "str" | "dex" | "con" | "int" | "wis" | "cha";
        };
        bab: { total: number };
        cmbAbility: string;
        cmd: {
            dexAbility: string;
            flatFootedTotal: number;
            strAbility: string;
            total: number;
        };
        cmdNotes: FreeText;
        encumbrance: {
            carriedWeight: number;
            level: number;
            levels: {
                carry: number;
                drag: number;
                heavy: number;
                light: number;
                medium: number;
                overhead: number;
            };
        };
        energyDrain: number;
        hp: {
            max: number;
            nonlethal: number;
            offset: number;
            temp: number;
            value: number;
        };
        hpAbility: string;
        init: {
            ability: ""
            | "str"
            | "dex"
            | "con"
            | "int"
            | "wis"
            | "cha";
            total: number;
            value: number;
        };
        naturalAC: number;
        quadruped: boolean;
        saveNotes: FreeText;
        savingThrows: Record<string, SaveData>;
        speed: {
            burrow: { base: number };
            climb: { base: number };
            fly: {
                base: number;
                maneuverability: "good" | "average" | "clumsy" | "poor" | "perfect";
            };
            land: { base: number };
            swim: { base: number };
        };
        sr: { formula: Formula };
        srNotes: FreeText;
        vigor: { max: number; offset: number; temp: number; value: number };
        wounds: { max: number; offset: number; value: number };
    } & {
        ac: {
            flatFooted: { total: number };
            normal: { ability: string; total: number };
            touch: { ability: string; total: number };
        } & {
            normal: { ability: string; total: number } & { value: number | null };
        };
        bab: { value: number
        | null };
        cmd: {
            dexAbility: string;
            flatFootedTotal: number;
            strAbility: string;
            total: number;
        } & { value: number
        | null };
    }
    config: { noManeuvers: boolean }
    currency: Record<string, number>
    details: {
        age: FreeText;
        alignment: "tn" | "lg" | "ng" | "cg" | "ln" | "cn" | "le" | "ne" | "ce";
        biography: { value: HTML };
        bonusFeatFormula: Formula;
        bonusSkillRankFormula: Formula;
        carryCapacity: {
            bonus: { user: number };
            multiplier: { base: number; user: number };
        };
        deity: FreeText;
        gender: FreeText;
        height: FreeText;
        notes: { value: HTML };
        weight: FreeText;
        xp: { value: number };
    } & { cr: { base: number; offset: number } }
    parent: ActorPF
    resources: any
    skills: Record<string, SkillModel>
    spells: Record<string, SpellbookModel>
    traits: {
        ageCategory: "adult" | "young" | "middleAge" | "old" | "venerable";
        armorProf: Set<"medium" | "heavy" | "none" | "light">;
        aura: { custom: FreeText };
        ci: Set<string>;
        cres: FreeText;
        di: Set<string>;
        dr: ParsedResistanceEntry[];
        dv: Set<string>;
        eres: ParsedResistanceEntry[];
        fastHealing: FreeText;
        hardness: number;
        languages: Set<
            | "aboleth"
            | "abyssal"
            | "aklo"
            | "ancientosiriani"
            | "androffan"
            | "aquan"
            | "auran"
            | "azlanti"
            | "boggard"
            | "brethedan"
            | "canto"
            | "catfolk"
            | "celestial"
            | "common"
            | "cyclops"
            | "dark"
            | "draconic"
            | "drowsign"
            | "druidic"
            | "dtang"
            | "dwarven"
            | "dziriak"
            | "ekekeh"
            | "elderthing"
            | "elven"
            | "erutaki"
            | "firstspeech"
            | "gholgan"
            | "giant"
            | "gnoll"
            | "gnome"
            | "goblin"
            | "grippli"
            | "grioth"
            | "gug"
            | "halfling"
            | "hallit"
            | "honla"
            | "hwan"
            | "ib"
            | "ignan"
            | "infernal"
            | "iobaran"
            | "jandelayan"
            | "jistka"
            | "kasatha"
            | "kelish"
            | "kuru"
            | "lashunta"
            | "migo"
            | "minatan"
            | "minkaian"
            | "munavri"
            | "nagaji"
            | "necril"
            | "orc"
            | "orvian"
            | "osiriani"
            | "polyglot"
            | "protean"
            | "reptoid"
            | "rougarou"
            | "sakvroth"
            | "samsaran"
            | "sasquatch"
            | "senzar"
            | "shadowtongue"
            | "shae"
            | "shoanti"
            | "shobhad"
            | "skald"
            | "sphinx"
            | "strix"
            | "sylvan"
            | "syrinx"
            | "taldane"
            | "tekritanin"
            | "tengu"
            | "terran"
            | "thassilonian"
            | "tien"
            | "treant"
            | "triaxian"
            | "undercommon"
            | "urdefhan"
            | "vanaran"
            | "varisian"
            | "varki"
            | "vegepygmy"
            | "vishkanya"
            | "vudrani"
            | "wayang"
            | "yaddithian"
            | "yithian",
        >;
        regen: FreeText;
        senses: {
            bs: { value: number };
            bse: { value: number };
            custom: FreeText;
            dv: { value: number };
            ll: { enabled: boolean; multiplier: { bright: number; dim: number } };
            ls: { value: number };
            lv: { value: number };
            sc: { value: number };
            si: boolean;
            sid: boolean;
            ths: { value: number };
            tr: { value: number };
            ts: { value: number };
        };
        size: | "med"
        | "fine"
        | "dim"
        | "tiny"
        | "sm"
        | "lg"
        | "huge"
        | "grg"
        | "col";
        stature: "long"
        | "tall";
        weaponProf: Set<
            | "misc"
            | "simple"
            | "siege"
            | "martial"
            | "exotic"
            | "firearm"
            | "heavy",
        >;
    }

    _skillTargets

    • get _skillTargets(): string[]
      Internal

      Retrieve valid skill change targets for this actor.

      Returns string[]

      • Skill target array
    • get sourceInfo(): Record<string, SourceInfoGroup>

      Returns Record<string, SourceInfoGroup>

      • This is for conversion compatibility and is not meant to work.
      • Remove before next release
    • get system(): this

      Returns this

      REMOVE BEFORE RELEASE

    _addReactiveValues

    • _addReactiveValues(): void

      Add getters for values that are fine calculating themselves

      Returns void

    _computeEncumbrance

    • _computeEncumbrance(): MobilityPenaltyResult
      Internal

      Computes encumbrance values for this actor.

      Returns MobilityPenaltyResult

      The resulting penalties from encumbrance.

    _detectHealthChange

    • _detectHealthChange(changed: any, context: any): void

      Parameters

      • changed: any
      • context: any

      Returns void

    _finalizeBooks

    • _finalizeBooks(): void
      Internal

      Finalize data in spellbooks

      Returns void

    _finalizeData

    • _finalizeData(): void

      Called at end of ActorPF.prepareDerivedData()

      Returns void

    Protected_finalizeTraits

    • _finalizeTraits(): void
      Protected

      Finalize preparing armor, weapon, and language proficiencies and other traits.

      Returns void

    _generateSpellbookCache

    • _generateSpellbookCache(): {
          books: Record<string, Spellbook>;
          spells: ItemSpellPF[];
      }
      Internal

      Collect some basic spellbook info so it doesn't need to be gathered again for each spellbook.

      Returns { books: Record<string, Spellbook>; spells: ItemSpellPF[] }

      Spellbook cache

    _initializeBaseValues

    Abstract_onItemReady

    • _onItemReady(item: ItemPF): void
      Experimental

      Callback for when the system thinks the item is fully ready.

      Parameters

      Returns void

    _prepareBooks

    • _prepareBooks(): void
      Internal

      Prepare spellbook data

      Returns void

    _prepareHealth

    Protected_prepareNaturalReach

    • _prepareNaturalReach(): void
      Protected

      Prepare natural reach for melee range and for reach weapons.

      Returns void

    Protected_prepareOverlandSpeeds

    _prepareSenses

    _prepareSkills

    _prepareTraits

    _refreshDerivedData

    • _refreshDerivedData(): void

      Actor Document

      Provides baseline support for system datamodels and module added subtypes.

      Returns void

    Protected_setSkillFlags

    • _setSkillFlags(): void
      Protected

      Reset class skills & background skills.

      Returns void

    _updateResources

    • _updateResources(error: boolean): void
      Internal

      Parameters

      • error: boolean

      Returns void

    • Show defenses in chat

      Parameters

      • Optionaloptions: { rollMode?: string | null; token?: any } = {}

        Additional options

        • OptionalrollMode?: string | null

          The roll mode to use for the roll; defaults to the user's current preference when null.

        • Optionaltoken?: any

          Relevant token if any.

      Returns Promise<any>

      • Created message

    • Calculate current carry capacity limits.

      Returns { heavy: number; light: number; medium: number }

      • Capacity info
    • Protected

      Change target paths for spellbooks on the actor.

      Returns string[]

    • Internal

      Returns number

      • Total coin weight in lbs

    • Get challenge rating. Applies CR offset modifications from templates.

      Returns number

      • CR

    • Total coinage in both weighted and weightless.

      Parameters

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

        Additional options

        • OptionalinLowestDenomination?: boolean

          Use copper for calculations, otherwise standard denomination is used.

      Returns number

      • The total amount of currency, in copper pieces.

    • Checks if there's any matching proficiency

      Parameters

      • item: any

        The item to check for.

      Returns boolean

      Whether the actor is proficient with that item.

    • Test if actor is proficient with specified weapon.

      Parameters

      • item: any

        Item to test

      • options: {} = {}

        Additional options

      Returns boolean

      • Proficiency state
    • Protected

      Prepare total CMB value.

      Returns void

      Move all the logic here to the Change system.

    • Roll a specific saving throw

      Parameters

      • saveId: "fort" | "ref" | "will"

        Identifier for saving throw type.

      • Optionaloptions: ActorRollOptions = {}

        Roll options.

      Returns Promise<any>

      • The chat message if one was created, or its data if not. void if the roll was cancelled.
      await actor.rollSavingThrow("ref", { skipDialog: true, dice: "2d20kh", bonus: "4" });

    • Parameters

      • source: any

      Returns void

    Document

    _updateResource

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

      Update Item Resource

      Parameters

      • item: ItemPF

        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

    _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

    _prepareDependentData

    • _prepareDependentData(): void

      Prepare data post embedded documents have been prepared.

      This is before changes and before prepareDerivedData()

      Returns void

    _preparePostChanges

    • _preparePostChanges(): void

      Prepare data post change application.

      This is called inside prepareDerivedData()

      Returns void

    • Generate generic labels.

      Returns { speed: {} }

    Settings

    Member Visibility

    On This Page

    General
    Document
    Extension API