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

    Class ClassModel

    Hierarchy (View Summary)

    Index

    General

    alignment armorProf? bab babBase babFormula casting changeFlags? changes? classSkills contextNotes? customHD description fc flags hd hitDice hp languages? level links? mythicTier parent? progression savingThrows scriptCalls skillsPerLevel sources subType tag? tags wealth weaponProf? activeState autoDeductCharges canUse charges hasFiniteCharges isActive isCharged isPhysical isSingleUse maxCharges isPhysical _activeStateChange _chargePreUpdate _onLevelChange _prepareTraits _rechargeActions _rechargeUses _registerOnActor _updateChargeLinking _updateInheritedCharges getDefaultChargeCost getDefaultChargeFormula getLabels getName getRollData prepareBaseData prepareDependentData prepareDerivedData recharge setActive _adjustNewItem migrateParentData pruneData

    Document

    metadata

    General

    alignment: FreeText
    armorProf?: Trait<"med" | "lgt" | "hvy" | "shl" | "twr">
    bab: "high" | "med" | "low" | "custom"
    babBase: number | undefined
    babFormula: Formula
    casting: {
        ability: "str" | "dex" | "con" | "int" | "wis" | "cha";
        cantrips: boolean;
        domain: number;
        offset: number;
        progression: "high" | "med" | "low";
        spells: "arcane" | "divine" | "psychic" | "alchemy";
        type: "prestige" | "prepared" | "spontaneous" | "hybrid";
    }
    changeFlags?: Set<
        | "haste"
        | "lowLightVision"
        | "seeInDarkness"
        | "seeInvisibility"
        | "immuneToMorale"
        | "loseDexToAC"
        | "noMediumEncumbrance"
        | "noHeavyEncumbrance"
        | "mediumArmorFullSpeed"
        | "heavyArmorFullSpeed"
        | "noAblScore.str"
        | "noAblScore.dex"
        | "noAblScore.con"
        | "noAblScore.int"
        | "noAblScore.wis"
        | "noAblScore.cha"
        | "pointBlankShot"
        | "rapidShot"
        | "manyshot",
    >
    changes?: Record<string, ItemChange>
    classSkills: Set<
        | "int"
        | "crf"
        | "acr"
        | "swm"
        | "clm"
        | "fly"
        | "lor"
        | "art"
        | "per"
        | "apr"
        | "blf"
        | "dip"
        | "dev"
        | "dis"
        | "esc"
        | "han"
        | "hea"
        | "kar"
        | "kdu"
        | "ken"
        | "kge"
        | "khi"
        | "klo"
        | "kna"
        | "kno"
        | "kpl"
        | "kre"
        | "lin"
        | "prf"
        | "pro"
        | "rid"
        | "sen"
        | "slt"
        | "spl"
        | "ste"
        | "sur"
        | "umd",
    >
    contextNotes?: Record<string, ContextNote>
    customHD: Formula
    description: { instructions: HTML; summary: FreeText; value: HTML }
    fc: {
        alt: { notes: FreeText; value: number };
        hp: { value: number };
        skill: { value: number };
    }
    flags: { boolean: Set<Slug>; dictionary: Record<Slug, FreeText | number> }
    hd: number
    hitDice: number | undefined
    hp: number
    languages?: Set<
        | "dark"
        | "aboleth"
        | "abyssal"
        | "aklo"
        | "ancientosiriani"
        | "androffan"
        | "aquan"
        | "auran"
        | "azlanti"
        | "boggard"
        | "brethedan"
        | "canto"
        | "catfolk"
        | "celestial"
        | "common"
        | "cyclops"
        | "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",
    >
    level: number
    links?: { children?: LinkModel[]; supplements?: LinkModel[] }
    mythicTier: number | undefined
    parent?: ItemPF
    progression: "" | "animal" | "eidolon"
    savingThrows: {
        fort: { custom: Formula; value: "high" | "low" | "custom" };
        ref: { custom: Formula; value: "high" | "low" | "custom" };
        will: { custom: Formula; value: "high" | "low" | "custom" };
    }
    scriptCalls: Record<string, ItemScriptCall>
    skillsPerLevel: number
    sources: SourceModel[]
    subType: "base" | "racial" | "prestige" | "npc" | "mythic"
    tag?: Slug
    tags: Set<FreeText>
    wealth: Formula
    weaponProf?: Trait<"simple" | "siege" | "martial" | "firearm" | "heavy">
    • get activeState(): boolean

      Active state as per what setActive would correspond with.

      Returns boolean

    • get autoDeductCharges(): boolean

      Consumes are adds charges by default.

      Returns boolean

    • get canUse(): boolean

      Is this item usable at base level, disregarding per-action details.

      Returns boolean

    • get charges(): number

      Remaining charges

      Returns number

    • get hasFiniteCharges(): boolean

      Finite charges

      Returns boolean

    • get isActive(): boolean

      Is Active

      This returns composite result of if the item is equipped, has quantity, is not disabled, is not out of charges, etc. and is not representative if the item can be set active or not via setActive.

      Returns boolean

      activeState

    • get isCharged(): boolean

      Returns boolean

    • get isPhysical(): boolean

      Is this a physical item?

      Returns boolean

    • get isSingleUse(): boolean

      Returns boolean

    • get maxCharges(): number

      Maximum possible charges this item can have.

      Returns number

      • Can return zero. Usually signifying something has reduced the potential uses below usability.
      • Can return infinity, signifying lack of limits.
    • get isPhysical(): boolean

      {@inheritDoc BaseItemModel#isPhysical}

      Returns boolean

    Abstract_activeStateChange

    • _activeStateChange(changed: object): boolean
      Internal Experimental

      Return active state change from data if present

      This is a hack to allow item-type agnostic active state change detection.

      Parameters

      • changed: object

      Returns boolean

    _chargePreUpdate

    • _chargePreUpdate(changed: object, context: object): Promise<void>
      Internal

      Handle charge update sanity checking, constraining them to reasonable values, and propagating to parent items if charges are shared.

      Parameters

      • changed: object

        Changed data

      • context: object

        Context

      Returns Promise<void>

    _onLevelChange

    • _onLevelChange(
          curLevel?: number,
          newLevel?: number,
          options?: { event?: "create" | "update" | "delete" },
      ): Promise<void>

      Add or remove class associations on level change.

      Called from ItemBasePF._onXOperation functions

      Parameters

      • curLevel: number = 0

        Current level, before the change.

      • newLevel: number = 0

        New level, after the change.

      • Optionaloptions: { event?: "create" | "update" | "delete" } = {}

        Additional options

        • Optionalevent?: "create" | "update" | "delete"

          Relevant event

      Returns Promise<void>

    _prepareTraits

    • _prepareTraits(): void
      Internal

      Returns void

    Protected_rechargeActions

    • _rechargeActions(
          options?: { exact: boolean; period?: string; rollData?: object },
      ): object | undefined
      Protected

      Update action limited uses

      {@inheritDoc ItemPF.recharge}

      TODO: Move this to the action itself.

      Parameters

      • options: { exact: boolean; period?: string; rollData?: object } = {}

        Options

        • exact: boolean

          Exact time period only

        • Optionalperiod?: string

          Recharge only if matching this time period

        • OptionalrollData?: object

          Roll data

      Returns object | undefined

      • Update data or undefined if no update is needed.

    Protected_rechargeUses

    • _rechargeUses(
          options?: {
              exact?: boolean;
              maximize?: boolean;
              period?: string;
              rollData?: object;
              value?: number;
          },
      ): Promise<object | undefined>
      Protected

      Recharges item's uses, if any.

      Parameters

      • options: {
            exact?: boolean;
            maximize?: boolean;
            period?: string;
            rollData?: object;
            value?: number;
        } = {}

        Options

        • Optionalexact?: boolean

          Match only exact time period

        • Optionalmaximize?: boolean

          Maximize instead of using recharge formula

        • Optionalperiod?: string

          Recharge only if it matches this time period

        • OptionalrollData?: object

          Roll data instance

        • Optionalvalue?: number

          Set charges to specific value

      Returns Promise<object | undefined>

      • Promise for the update, update data object, or undefined (no update needed).

    _registerOnActor

    • _registerOnActor(): void
      Internal

      Register this item on actor in relevant places.

      Returns void

    _updateChargeLinking

    • _updateChargeLinking(): void
      Internal

      Update Charge Linking

      Returns void

    _updateInheritedCharges

    • _updateInheritedCharges(source: Item<"base" | ModuleSubType>): void
      Internal

      Update this item's charges based on provided item.

      Parameters

      • source: Item<"base" | ModuleSubType>

        Charge source

      Returns void

    • Get default charge cost for all actions.

      Parameters

      • Optionaloptions: { rollData?: object } = {}

        Additional options

        • OptionalrollData?: object

          Roll data instance

      Returns number

      Number for default cost.

    • Default charge formula.

      Returns string

      • Charge formula

    • Called by ()

      Parameters

      • labels: any
      • __namedParameters: {} = {}

      Returns any

    • Visible item name

      Parameters

      • OptionalasPlayer: boolean = false

        If true, return value players see.

      Returns string

      • Item name

    • DataModel specific roll data

      Parameters

      • result: object

        Roll data

      Returns void

    • Prepare data dependent on other items

      Called in actor.prepareDerivedData() when all items are guaranteed to be prepared.

      Returns void

    • Recharges item's uses, if any.

      Parameters

      • options: {
            commit?: boolean;
            context?: object;
            exact?: boolean;
            maximize?: boolean;
            period?: "round" | "minute" | "hour" | "day" | "week" | "any";
            rollData?: object;
            value?: number;
        } = {}

        Options

        • Optionalcommit?: boolean

          Commit update directly. If false, returns the update data instead.

        • Optionalcontext?: object

          Update context

        • Optionalexact?: boolean

          Use exact time period. Otherwise "week" for example will also recharge items with "day" period.

        • Optionalmaximize?: boolean

          Recharge to full regardless of recharge formula.

        • Optionalperiod?: "round" | "minute" | "hour" | "day" | "week" | "any"

          Recharge period. Use "any" to ignore item's configuration.

        • OptionalrollData?: object

          Roll data instance to use for formulas.

        • Optionalvalue?: number

          Recharge to specific value, respecting maximum and minimum bounds.

      Returns Promise<object | ClassModel | undefined>

      • Promise for the update, update data object, or undefined (no update needed).

    • Set item's active state.

      Parameters

      • active: boolean

        Active state

      • Optionalcontext: object

        Optional update context

      Returns Promise<ClassModel>

      • Update promise if item type supports the operation.
      • If item does not support the operation.

    Protected Static Abstract_adjustNewItem

    • _adjustNewItem(item?: ItemPF, data?: object, override?: boolean): void
      Protected

      Adjust temporary item before creation

      Parameters

      • Optionalitem: ItemPF

        Temporary document

      • Optionaldata: object

        Creation data

      • Optionaloverride: boolean = false

        Override values even if defined

      Returns void

    • Parent datamodel (item document) migration

      AVOID USING THIS

      Parameters

      • source: any

      Returns void

    • Parameters

      • source: any

      Returns void

    Document

    metadata: Readonly<
        {
            classAssociation: false;
            isPhysical: false;
            label: "CONFIG.Item.typeLabels.class";
            supplementLevel: true;
            type: "class";
        },
    > = ...

    Settings

    Member Visibility

    On This Page

    General
    Document