OptionalactionsOptionalarmorOptionalattackOptionalauraOptionalchangeOptionalchangesCaster Level
OptionalclassOptionalcontextOptionaldescriptionOptionaleffectOptionalflagsOptionalhardnessOptionalimplantImplantation cost
OptionalimplantedIs this implanted?
OptionalinstallInstall DC
OptionallanguagesOptionallinksOptionalparentOptionalpriceOptionalscriptOptionalshowShow item in combat tab.
OptionalshowDisplay item and its actions in quick actions and token HUD.
OptionalslotSlot
OptionalsubOptionaltagOptionalunidentifiedOptionalweaponStaticmetadataActive state as per what setActive would correspond with.
The item's material addons.
Consumes are adds charges by default.
Base material
Can equip currently?
Is this item usable at base level, disregarding per-action details.
Remaining charges
The default spell school of this items aura, if any
Effective caster level of this item.
Finite charges
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.
Broken state
Tests both explicit broken override and current health.
AbstractisThe item's actual material.
Should current user see identified info
Internal ExperimentalReturn active state change from data if present
This is a hack to allow item-type agnostic active state change detection.
InternalHandle charge update sanity checking, constraining them to reasonable values, and propagating to parent items if charges are shared.
Changed data
Context
InternalFinalize weight calculation effects
InternalContext
Triggering user ID
Changed data
Context
Triggering user ID
InternalChanged data
Context
Triggering user
Protected_ProtectedUpdate action limited uses
{@inheritDoc ItemPF.recharge}
Options
Exact time period only
Optionalperiod?: stringRecharge only if matching this time period
OptionalrollData?: objectRoll data
Protected_ProtectedRecharges item's uses, if any.
Options
Optionalexact?: booleanMatch only exact time period
Optionalmaximize?: booleanMaximize instead of using recharge formula
Optionalperiod?: stringRecharge only if it matches this time period
OptionalrollData?: objectRoll data instance
Optionalvalue?: numberSet charges to specific value
Reset charges when quantity is changed to simulate a stack.
Changed data
InternalAdjust HP value by item size.
In reference to rules established at Table 7-12 of CRB p. 175
InternalUpdate Charge Linking
InternalUpdate this item's charges based on provided item.
Charge source
Return cost multiplier affecting this item.
Such as item size dictating how costly an armor is.
Get default charge cost for all actions.
Optionaloptions: { rollData?: object } = {}Additional options
OptionalrollData?: objectRoll data instance
Number for default cost.
Default charge formula.
Protected AbstractgetProtectedCalled by ()
Optionaloptions: { isolated?: boolean; rollData?: object } = {}Visible item name
If true, return value players see.
AbstractgetDataModel specific roll data
Roll data
Returns the displayed value of an item according to multiple options
Optionaloptions: {Various optional parameters affecting value calculations
OptionalforceUnidentified?: booleanOverride whether the value should use the unidentified price
Optionalidentical?: booleanTreat all items in stack as identical (same number of charges).
OptionalinLowestDenomination?: booleanWhether the value should be returned in the lowest denomination
Optionalmaximized?: booleanPretend as if the items were fresh (full charges)
Optionalrecursive?: booleanWhether the value of contained items should be included
OptionalsellValue?: numberThe sell value multiplier
Optionalsingle?: booleanReturn value of singular item instead of the actual stack. Disables recursive option.
The item's value
Return weight multiplier affecting this item.
Such as item size dictating how heavy an armor is.
Prepare data dependent on other items
Called in actor.prepareDerivedData() when all items are guaranteed to be prepared.
InternalPrepare hardness and hit points
Prepare this item's WeightData
Recharges item's uses, if any.
Options
Optionalcommit?: booleanCommit update directly. If false, returns the update data instead.
Optionalcontext?: objectUpdate context
Optionalexact?: booleanUse exact time period. Otherwise "week" for example will also recharge items with "day" period.
Optionalmaximize?: booleanRecharge to full regardless of recharge formula.
Optionalperiod?: "round" | "minute" | "hour" | "day" | "week" | "any"Recharge period. Use "any" to ignore item's configuration.
OptionalrollData?: objectRoll data instance to use for formulas.
Optionalvalue?: numberRecharge to specific value, respecting maximum and minimum bounds.
Protected Static Abstract_ProtectedAdjust temporary item before creation
Optionalitem: ItemPFTemporary document
Optionaldata: objectCreation data
Optionaloverride: boolean = falseOverride values even if defined
StaticdefaultStaticdefineStaticmigrateStatic AbstractmigrateParent datamodel (item document) migration
AVOID USING THIS
Document source data
Staticprune
Basic Item model with actions and related data