A Collection of ItemActions.
An object containing links to other items.
Static Internal systemA static object holding system-specific metadata applicable to all instances of this Document class.
Whether this item has actions.
Whether this item has changes and change flags.
Whether this item receives an identifier.
Whether this item is a physical one, possessing properties like quantity or weight.
An array containing all action types from this item's actions.
The item's material addons.
Private adjustsPrivate Determine whether this item adjusts actor size
Private adjustsPrivate Determine whether this item adjusts senses
The item's alignment attributes, or null if the item has no alignment attributes
Generic damage source retrieval for default action, includes default conditionals and other item specific modifiers.
All relevant changes, or undefined if action was not found.
Return attack sources for default action.
Array of value and label pairs for attack bonus sources on the main attack.
Is this item usable at base level, disregarding per-action details.
Linked ammunition item if any.
An active effect associated with this item.
{@inheritDoc ItemPF.hasActions:getter}
Returns true if any of this item's actions have an attack, see ItemAction#hasAttack.
Returns true if any of this item's actions have a damage roll, see ItemAction#hasDamage.
Is the item is fully functional.
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.
PF1 v10
The keys of data variables to memorize between updates, for e.g. determining the difference in update.
The item's material.
Internal Should the item show unidentified data
The item's subtype, or null if the item has no subtype
Static hasStatic hasStatic isPrivate _chargePrepare data potentially dependent on other items.
This should be run at in Item.prepareDerivedData() if no actor is present, or in actor's prepareDerivedData after document preparation is done.
Is this final call to this?
Internal Recharges item's uses, if any.
Options
Internal Transform given data so it becomes valid update data within parent item.
This can, for example, be used to generate batched update to the real item.
Update data
Optional options: { Additional options
Create data recursively, meant for the real item document.
_transformContainerUpdateData({ name: "new name" })
// => { system: { items: { [itemID]: { name: "new name" } } } }
Creates a link to another item.
The type of link.
The target item to link into this.
Optional extraData: objectAdditional data to store int he link
Display the chat card for an Item as a message in chat
Optional altChatData: object = {}Optional data that will be merged into the chat data object.
Optional options: { Additional options.
Relevant token if any.
Chat message instance if one was created.
Executes all script calls on this item of a specified category.
The category of script calls to call.
Optional extraParams: {} = {}A dictionary of extra parameters to pass as variables for use in the script.
Optional shared: object = {}Shared data object
The shared object between calls which may have been given data.
Attack sources for a specific action.
Action ID
Optional options: { Additional options
Roll data instance
Array of value and label pairs for attack bonus sources on the main attack, or undefined if the action is missing.
Finds, filters and alters changes relevant to a context, and returns the result (as an array)
The given context.
Private getGet full description.
Item type dependant options for rendering the description.
Include main description body if such exists.
Instruct template to render chat card in mind.
Template data for rendering
Include header if such exists.
Passed to getDescriptionData
Roll data for transforming description
Description Data
Additional options
Include extra data to reflect it not being so easily available in context.
Roll data instance
Returns labels for this item
Optional options: { Additional options
ID of one of this item's actions to get labels for; defaults to first action
Roll data to use.
This item's labels
Get item links of type
Link type
Include link data, return value changes from item array to object array
Optional options: { Additional options
Internal use only.
Retrieved linked items recursively.
Retrieve list of linked items for a type, synchronously. Intended mainly for fetching child or charge links quickly.
Link type, e.g. "children", "charges", or "classAssociations"
Optional options: { Additional options
Internal use only
Retrieve links recursively.
Linked items or their compendium index data
const childItems = item.getLinkedItemsSync("children");
Determines the starting data for an ActiveEffect based off this item.
Internal Fetches all this item's script calls of a specified category
Per item type chat data.
A partial of a chat data object that can be modified to add per item type data.
The labels for this item.
Additional property strings
A rollData object to be used for checks
Optional options: { Additional options
Action this pertains to, if any.
Is this for a chat card?
Recharges item's uses, if any.
Options
Commit update directly. If false, returns the update data instead.
Update context
Use exact time period. Otherwise "week" for example will also recharge items with "day" period.
Recharge to full regardless of recharge formula.
Recharge period. Use "any" to ignore item's configuration.
Roll data instance to use for formulas.
Recharge to specific value, respecting maximum and minimum bounds.
Removes all link references to an item.
The UUID of the item to remove links to.
Optional options: { Additional options
Commit changes to database. If false, resulting update data is returned instead.
Sets a dictionary flag value on this item.
The name/key of the flag to set.
The flag's new value.
Update context
Whether something was changed.
Use an attack, using SharedActionData
Optional __namedParameters: string = {}Static _addStatic Protected _adjustProtected Adjust temporary item before creation
Optional item: ItemPFTemporary document
Optional data: objectCreation data
Optional override: boolean = falseOverride values even if defined
Static _collectStatic _hasStatic _hasStatic _onStatic _onStatic Private _onStatic chatStatic createItem create dialog.
Initial form data
Optional context: { Additional options.
Dialog context options.
Pack ID parameter passed to Item.create() options
Parent parameter passed to Item.create() options
Synchronized with Foundry VTT v11.315
Static createStatic getGenerated using TypeDoc
Override and extend the basic :class:
Itemimplementation