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

    Class BaseCharacterModelAbstract

    Base data model for character-type actors (Character & NPC)

    Hierarchy (View Summary)

    Index

    General

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

    Document

    _updateResource

    Advanced

    getSourceDetails

    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>
    asf: { base: number } | undefined
    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 };
    }
    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 };
    }
    parent: ActorPF
    resources: any
    skills: Record<string, SkillModel>
    spells: Record<string, SpellbookModel>
    traits: {
        ageCategory: "adult" | "young" | "middleAge" | "old" | "venerable";
        armorProf: Trait<"medium" | "heavy" | "none" | "light">;
        aura: { custom: FreeText };
        ci: Trait<
            | "fly"
            | "swim"
            | "climb"
            | "burrow"
            | "dying"
            | "staggered"
            | "helpless"
            | "unconscious"
            | "disabled"
            | "stunned"
            | "petrified"
            | "paralyzed"
            | "prone"
            | "bleed"
            | "blind"
            | "burning"
            | "confused"
            | "cowering"
            | "dazed"
            | "dazzled"
            | "dead"
            | "deaf"
            | "entangled"
            | "exhausted"
            | "fatigued"
            | "flatFooted"
            | "frightened"
            | "grappled"
            | "incorporeal"
            | "invisible"
            | "nauseated"
            | "panicked"
            | "pinned"
            | "shaken"
            | "sickened"
            | "sleep"
            | "squeezing"
            | "stable"
            | "hover",
        >;
        creatureSubtypes: Trait<
            | "evil"
            | "good"
            | "lawful"
            | "chaotic"
            | "div"
            | "mythic"
            | "fire"
            | "cold"
            | "incorporeal"
            | "catfolk"
            | "giant"
            | "gnome"
            | "grippli"
            | "halfling"
            | "kasatha"
            | "munavri"
            | "orc"
            | "protean"
            | "samsaran"
            | "sasquatch"
            | "vishkanya"
            | "wayang"
            | "adlet"
            | "aeon"
            | "aether"
            | "agathion"
            | "air"
            | "android"
            | "angel"
            | "aquatic"
            | "archon"
            | "astomoi"
            | "asura"
            | "augmented"
            | "azata"
            | "behemoth"
            | "blight"
            | "changeling"
            | "clockwork"
            | "colossus"
            | "daemon"
            | "darkFolk"
            | "deepOne"
            | "demodand"
            | "demon"
            | "derro"
            | "devil"
            | "dwarf"
            | "earth"
            | "elemental"
            | "elf"
            | "extraplanar"
            | "goblinoid"
            | "gray"
            | "greatOldOne"
            | "hive"
            | "herald"
            | "human"
            | "inevitable"
            | "kaiju"
            | "kami"
            | "kitsune"
            | "kyton"
            | "leshy"
            | "manasaputra"
            | "mortic"
            | "native"
            | "nightshade"
            | "oni"
            | "phantom"
            | "psychopomp"
            | "qlippoth"
            | "rakshasa"
            | "ratfolk"
            | "reptilian"
            | "robot"
            | "sahkil"
            | "shapechanger"
            | "skinwalker"
            | "spawnOfRovagug"
            | "swarm"
            | "troop"
            | "vanara"
            | "water"
            | "wildHunt",
        >;
        creatureTypes: Trait<
            | "animal"
            | "aberration"
            | "construct"
            | "dragon"
            | "fey"
            | "humanoid"
            | "magicalBeast"
            | "monstrousHumanoid"
            | "ooze"
            | "outsider"
            | "plant"
            | "undead"
            | "vermin",
        >;
        cres: FreeText;
        di: Trait<
            | "untyped"
            | "fire"
            | "acid"
            | "force"
            | "nonlethal"
            | "positive"
            | "slashing"
            | "piercing"
            | "bludgeoning"
            | "cold"
            | "electric"
            | "sonic"
            | "negative"
            | "precision"
            | "areaOfEffect",
        >;
        dr: ParsedResistanceEntry[];
        dv: Trait<
            | "untyped"
            | "fire"
            | "acid"
            | "force"
            | "nonlethal"
            | "positive"
            | "slashing"
            | "piercing"
            | "bludgeoning"
            | "cold"
            | "electric"
            | "sonic"
            | "negative"
            | "precision"
            | "areaOfEffect",
        >;
        eres: ParsedResistanceEntry[];
        fastHealing: FreeText;
        hardness: number;
        languages: Trait<
            | "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: Trait<
            | "misc"
            | "simple"
            | "siege"
            | "martial"
            | "exotic"
            | "firearm"
            | "heavy",
        >;
    }
    BASE_10_VALUES: Set<
        | "system.attributes.ac.normal.total"
        | "system.attributes.ac.flatFooted.total"
        | "system.attributes.ac.touch.total"
        | "system.attributes.cmd.total"
        | "system.attributes.cmd.flatFootedTotal",
    > = ...

    _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

    _applyConditionImmunities

    • _applyConditionImmunities(): void
      Internal Experimental

      Apply Condition Immunities

      Must be called before _prepareChanges() to avoid condition effects from being applied.

      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

    • _initializeBaseValues(): void

      Returns void

    _onCreateDescendantItems

    • _onCreateDescendantItems(items: Item[]): Promise<void>
      Internal Experimental

      Parameters

      • items: Item[]

      Returns Promise<void>

    _onDeltaUpdates

    • _onDeltaUpdates(deltas: Promise<object>): Promise<void>

      Handle Deltas in update context

      Produces scrolling text for health changes.

      Parameters

      • deltas: Promise<object>

      Returns Promise<void>

    Abstract_onItemReady

    _prepareBooks

    • _prepareBooks(): void
      Internal

      Prepare spellbook data

      Returns void

    _prepareHealth

    • _prepareHealth(allClasses: any, changes: ItemChange[]): void
      Internal

      Calculate maximum health

      Parameters

      Returns void

      _prepareChanges

    Protected_prepareNaturalReach

    • _prepareNaturalReach(): void
      Protected

      Prepare natural reach for melee range and for reach weapons.

      Returns void

    Protected_prepareOverlandSpeeds

    • _prepareOverlandSpeeds(): void
      Protected

      Calculate overland speeds.

      Returns void

    _prepareSenses

    • _prepareSenses(): void

      Returns void

    _prepareSkills

    • _prepareSkills(): void

      Prepare Skills

      Returns void

    _prepareTraits

    • _prepareTraits(): void
      Internal

      Returns void

    _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

    • Returns {
          ci: Set<
              | "fly"
              | "swim"
              | "climb"
              | "burrow"
              | "dying"
              | "staggered"
              | "helpless"
              | "unconscious"
              | "disabled"
              | "stunned"
              | "petrified"
              | "paralyzed"
              | "prone"
              | "bleed"
              | "blind"
              | "burning"
              | "confused"
              | "cowering"
              | "dazed"
              | "dazzled"
              | "dead"
              | "deaf"
              | "entangled"
              | "exhausted"
              | "fatigued"
              | "flatFooted"
              | "frightened"
              | "grappled"
              | "incorporeal"
              | "invisible"
              | "nauseated"
              | "panicked"
              | "pinned"
              | "shaken"
              | "sickened"
              | "sleep"
              | "squeezing"
              | "stable"
              | "hover",
          >;
          di: Trait<
              | "untyped"
              | "fire"
              | "acid"
              | "force"
              | "nonlethal"
              | "positive"
              | "slashing"
              | "piercing"
              | "bludgeoning"
              | "cold"
              | "electric"
              | "sonic"
              | "negative"
              | "precision"
              | "areaOfEffect",
              string,
          >;
          dr: ParsedResistanceEntry[];
          dv: Trait<
              | "untyped"
              | "fire"
              | "acid"
              | "force"
              | "nonlethal"
              | "positive"
              | "slashing"
              | "piercing"
              | "bludgeoning"
              | "cold"
              | "electric"
              | "sonic"
              | "negative"
              | "precision"
              | "areaOfEffect",
              string,
          >;
          er: ParsedResistanceEntry[];
          h: number;
      }

    • 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: ItemEquipmentPF

        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: ItemPF<BaseItemModel>

        Item to test

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

        Additional options

        • Optionaloverride?: boolean

          Allow item's proficiency override to influence the result.

      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<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

    Advanced

    • Retrieve source details regarding a change target.

      Parameters

      • path: string

        Change target path

      Returns SourceInfo[]

      actor.system.getSourceDetails("system.attributes.hp.max");
      • Merge sourceInfo into the change system to reduce underlying system complexity

    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

    • Initiative rolling options

      Returns object

    • Generate generic labels.

      Returns { speed: {} }

    Settings

    Member Visibility

    On This Page

    General
    Document
    Advanced
    Extension API