Class ItemSheetPF_Container

Override and extend the core ItemSheet implementation to handle game system specific item types

Hierarchy (View Summary)

ItemSheetPF
- ItemSheetPF_Container

Index

Constructors

Constructors

constructor

new ItemSheetPF_Container(...args: any[]): ItemSheetPF_Container
Parameters
- ...args: any[]
Returns ItemSheetPF_Container
Overrides ItemSheetPF.constructor
- Defined in module/applications/item/container-sheet.mjs:6

Properties

`Internal`_activeEdits

_activeEdits: Record<string, string> = {}

_filters

_filters: Set<any>

Track the set of item filters which are applied

_itemUpdates

_itemUpdates: object[]

Track item updates from the actor sheet.

effectiveSearch

effectiveSearch: string

item

item: ItemContainerPF

searchCompositioning

searchCompositioning: boolean

Item search

searchDelay

searchDelay: number

searchDelayEvent

searchDelayEvent: null | Timeout

searchRefresh

searchRefresh: boolean

`Static` `Internal`EDIT_TRACKING

EDIT_TRACKING: string[] = ...

Which fields to track edits for

Accessors

template

get template(): string
Return a dynamic reference to the HTML template path used to render this Item Sheet

Returns string
Overrides ItemSheetPF.template
- Defined in module/applications/item/container-sheet.mjs:67

title

get title(): string
Returns string
Inherited from ItemSheetPF.title
- Defined in module/applications/item/item-sheet.mjs:115

`Static`defaultOptions

get defaultOptions(): InsertKeys<
    {},
    OmitByValue<
        {
            classes: string[];
            dragDrop: (
                | { dragSelector: string; dropSelector: string }
                | { dragSelector: string; dropSelector?: undefined }
            )[];
            scrollY: string[];
            width: number;
        },
        never,
    >,
>
Returns InsertKeys<
    {},
    OmitByValue<
        {
            classes: string[];
            dragDrop: (
                | { dragSelector: string; dropSelector: string }
                | { dragSelector: string; dropSelector?: undefined }
            )[];
            scrollY: string[];
            width: number;
        },
        never,
    >,
>
Default Value
```
foundry.utils.mergeObject(super.defaultOptions, {
  template: "templates/sheets/item-sheet.html",
  width: 500,
  closeOnSubmit: false,
  submitOnClose: true,
  submitOnChange: true,
  resizable: true,
  baseApplication: "ItemSheet",
  id: "item"
})
```
Overrides ItemSheetPF.defaultOptions
- Defined in module/applications/item/container-sheet.mjs:48

Methods

_applySectionFilter

_applySectionFilter(item: Item, section: object): boolean
Internal
Filters item by sheet section config.
Parameters
- item: Item
  Item to filter
- section: object
  Section to filter by
Returns boolean
- Defined in module/applications/item/container-sheet.mjs:136

`Protected`_canDragDrop

_canDragDrop(): boolean
Protected
Allow non-GM to drag&drop actions and items (for containers) to this sheet.

Returns boolean
Inherited from ItemSheetPF._canDragDrop
- Defined in module/applications/item/item-sheet.mjs:1867

_canDragStart

_canDragStart(selector: any): boolean
By default, returns true only for GM
Parameters
- selector: any
Returns boolean
Inherited from ItemSheetPF._canDragStart
- Defined in module/applications/item/item-sheet.mjs:1815

_convertCurrency

_convertCurrency(event: any): void
Parameters
- event: any
Returns void
- Defined in module/applications/item/container-sheet.mjs:692

_createAttack

_createAttack(event: any): Promise<void>
Parameters
- event: any
Returns Promise<void>
Inherited from ItemSheetPF._createAttack
- Defined in module/applications/item/item-sheet.mjs:2488

_createSpellbook

_createSpellbook(event: any): Promise<void>
Parameters
- event: any
Returns Promise<void>
Inherited from ItemSheetPF._createSpellbook
- Defined in module/applications/item/item-sheet.mjs:2514

_duplicateItem

_duplicateItem(event: any): Promise<ItemContainerPF>
Parameters
- event: any
Returns Promise<ItemContainerPF>
- Defined in module/applications/item/container-sheet.mjs:586

_getContentSources

_getContentSources(): any
Returns any
Inherited from ItemSheetPF._getContentSources
- Defined in module/applications/item/item-sheet.mjs:945

_mouseWheelAdd

_mouseWheelAdd(event: any, el: any): void
Parameters
- event: any
- el: any
Returns void
Overrides ItemSheetPF._mouseWheelAdd
- Defined in module/applications/item/container-sheet.mjs:681

_onActionControl

_onActionControl(event: any): Promise<void>
Parameters
- event: any
Returns Promise<void>
Inherited from ItemSheetPF._onActionControl
- Defined in module/applications/item/item-sheet.mjs:2202

_onActionEdit

_onActionEdit(event: any): Promise<void>
Parameters
- event: any
Returns Promise<void>
Inherited from ItemSheetPF._onActionEdit
- Defined in module/applications/item/item-sheet.mjs:2272

`Protected`_onActionSummary

_onActionSummary(event: ClickEvent<HTMLElement, any, any, any>): Promise<void>
Protected
Toggle inline display of an item's summary/description by expanding or hiding info div
Parameters
- event: ClickEvent<HTMLElement, any, any, any>
  The click event on the item
Returns Promise<void>
Inherited from ItemSheetPF._onActionSummary
- Defined in module/applications/item/item-sheet.mjs:2156

_onCardNoteControl

_onCardNoteControl(event: Event): Promise<void>
Internal
Control effect notes and footnotes
Parameters
- event: Event
Returns Promise<void>
Inherited from ItemSheetPF._onCardNoteControl
- Defined in module/applications/item/item-sheet.mjs:2599

_onChangeDrop

_onChangeDrop(event: DragEvent, data: object): Promise<void>
Internal
Handle pf1.components.ItemChange drop events.
Parameters
- event: DragEvent
  The originating drop event
- data: object
  The data extracted from the drop event
Returns Promise<void>
Inherited from ItemSheetPF._onChangeDrop
- Defined in module/applications/item/item-sheet.mjs:2018

_onCreateChange

_onCreateChange(event: any): Promise<void>
Parameters
- event: any
Returns Promise<void>
Inherited from ItemSheetPF._onCreateChange
- Defined in module/applications/item/item-sheet.mjs:2359

_onDeleteChange

_onDeleteChange(event: any): void
Parameters
- event: any
Returns void
Inherited from ItemSheetPF._onDeleteChange
- Defined in module/applications/item/item-sheet.mjs:2351

_onDragStart

_onDragStart(event: any): void
Internal
Parameters
- event: any
Returns void
Overrides ItemSheetPF._onDragStart
- Defined in module/applications/item/container-sheet.mjs:450

_onDrop

_onDrop(event: any): undefined | Promise<unknown>
Internal
Parameters
- event: any
Returns undefined | Promise<unknown>
Overrides ItemSheetPF._onDrop
- Defined in module/applications/item/container-sheet.mjs:482

_onDropCurrency

_onDropCurrency(event: any, data: any): Promise<unknown>
Parameters
- event: any
- data: any
Returns Promise<unknown>
- Defined in module/applications/item/container-sheet.mjs:508

_onDropItem

_onDropItem(event: any, data: any): Promise<false | void | ItemContainerPF>
Parameters
- event: any
- data: any
Returns Promise<false | void | ItemContainerPF>
- Defined in module/applications/item/container-sheet.mjs:521

_onDuplicateChange

_onDuplicateChange(event: any): undefined | Promise<ItemChange[]>
Parameters
- event: any
Returns undefined | Promise<ItemChange[]>
Inherited from ItemSheetPF._onDuplicateChange
- Defined in module/applications/item/item-sheet.mjs:2337

_onEditChange

_onEditChange(event: Event, tooltip?: boolean): undefined
Internal
Parameters
- event: Event
  Click event
- Optionaltooltip: boolean = false
  Is this event from locked tooltip?
Returns undefined
Inherited from ItemSheetPF._onEditChange
- Defined in module/applications/item/item-sheet.mjs:2326

_onEntrySelector

_onEntrySelector(event: any): void
Parameters
- event: any
Returns void
Inherited from ItemSheetPF._onEntrySelector
- Defined in module/applications/item/item-sheet.mjs:2525

_onHoverPriceTooltip

_onHoverPriceTooltip(event: any, content: any, identified?: boolean): void
Parameters
- event: any
- content: any
- identified: boolean = true
Returns void
Inherited from ItemSheetPF._onHoverPriceTooltip
- Defined in module/applications/item/item-sheet.mjs:1314

_onHoverTooltip

_onHoverTooltip(event: any): string
Parameters
- event: any
Returns string
Inherited from ItemSheetPF._onHoverTooltip
- Defined in module/applications/item/item-sheet.mjs:1288

_onHoverWeightTooltip

_onHoverWeightTooltip(event: any, content: any): void
Parameters
- event: any
- content: any
Returns void
Inherited from ItemSheetPF._onHoverWeightTooltip
- Defined in module/applications/item/item-sheet.mjs:1305

_onItemCreate

_onItemCreate(event: any): Promise<ItemContainerPF>
Parameters
- event: any
Returns Promise<ItemContainerPF>
- Defined in module/applications/item/container-sheet.mjs:320

_onItemDelete

_onItemDelete(event: any): Promise<void>
Parameters
- event: any
Returns Promise<void>
- Defined in module/applications/item/container-sheet.mjs:408

_onItemEdit

_onItemEdit(event: any): void
Parameters
- event: any
Returns void
- Defined in module/applications/item/container-sheet.mjs:357

_onItemSelector

_onItemSelector(event: any): Promise<undefined>
Parameters
- event: any
Returns Promise<undefined>
Inherited from ItemSheetPF._onItemSelector
- Defined in module/applications/item/item-sheet.mjs:2556

_onItemSummary

_onItemSummary(event: any): void
Parameters
- event: any
Returns void
- Defined in module/applications/item/container-sheet.mjs:365

_onItemTake

_onItemTake(event: any): Promise<void>
Parameters
- event: any
Returns Promise<void>
- Defined in module/applications/item/container-sheet.mjs:436

_onLinkControl

_onLinkControl(event: any): Promise<unknown>
Parameters
- event: any
Returns Promise<unknown>
Inherited from ItemSheetPF._onLinkControl
- Defined in module/applications/item/item-sheet.mjs:2427

_onLinksDrop

_onLinksDrop(event: any, data: any): Promise<void>
Parameters
- event: any
- data: any
Returns Promise<void>
Inherited from ItemSheetPF._onLinksDrop
- Defined in module/applications/item/item-sheet.mjs:1986

_onNoteControl

_onNoteControl(event: any): Promise<unknown>
Parameters
- event: any
Returns Promise<unknown>
Inherited from ItemSheetPF._onNoteControl
- Defined in module/applications/item/item-sheet.mjs:2366

_onNoteTargetControl

_onNoteTargetControl(event: any): void
Parameters
- event: any
Returns void
Inherited from ItemSheetPF._onNoteTargetControl
- Defined in module/applications/item/item-sheet.mjs:2387

_onOpenChangeMenu

_onOpenChangeMenu(event: any): Promise<void>
Parameters
- event: any
Returns Promise<void>
Inherited from ItemSheetPF._onOpenChangeMenu
- Defined in module/applications/item/item-sheet.mjs:2298

_onOpenCompendiumBrowser

_onOpenCompendiumBrowser(event: any): void
Parameters
- event: any
Returns void
Inherited from ItemSheetPF._onOpenCompendiumBrowser
- Defined in module/applications/item/item-sheet.mjs:1705

_onOpenTextEditor

_onOpenTextEditor(event: Event): Promise<void>
Internal
Parameters
- event: Event
Returns Promise<void>
Inherited from ItemSheetPF._onOpenTextEditor
- Defined in module/applications/item/item-sheet.mjs:2284

_onScriptCallControl

_onScriptCallControl(event: any): Promise<unknown>
Parameters
- event: any
Returns Promise<unknown>
Inherited from ItemSheetPF._onScriptCallControl
- Defined in module/applications/item/item-sheet.mjs:1713

_onScriptCallDrop

_onScriptCallDrop(event: any): Promise<undefined | ItemScriptCall[]>
Parameters
- event: any
Returns Promise<undefined | ItemScriptCall[]>
Inherited from ItemSheetPF._onScriptCallDrop
- Defined in module/applications/item/item-sheet.mjs:1781

_onScriptCallEdit

_onScriptCallEdit(event: any): void
Parameters
- event: any
Returns void
Inherited from ItemSheetPF._onScriptCallEdit
- Defined in module/applications/item/item-sheet.mjs:1746

_onSortItem

_onSortItem(event: any, itemData: any): undefined | Promise<void>
Parameters
- event: any
- itemData: any
Returns undefined | Promise<void>
- Defined in module/applications/item/container-sheet.mjs:703

_onSpanTextInput

_onSpanTextInput(event: any, callback?: null): void
Parameters
- event: any
- callback: null = null
Returns void
Inherited from ItemSheetPF._onSpanTextInput
- Defined in module/applications/item/item-sheet.mjs:1556

_onSpeedEdit

_onSpeedEdit(event: any): void
Parameters
- event: any
Returns void
Inherited from ItemSheetPF._onSpeedEdit
- Defined in module/applications/item/item-sheet.mjs:2138

_onTextAreaDrop

_onTextAreaDrop(
event: DragEvent,
): Promise<undefined | Partial<Record<string, unknown>>>
Internal
Handle dropping content-linkable data to <textarea> or text <input>
Parameters
- event: DragEvent
Returns Promise<undefined | Partial<Record<string, unknown>>>
Inherited from ItemSheetPF._onTextAreaDrop
- Defined in module/applications/item/item-sheet.mjs:1761

_openHelpBrowser

_openHelpBrowser(event: any): void
Parameters
- event: any
Returns void
Inherited from ItemSheetPF._openHelpBrowser
- Defined in module/applications/item/item-sheet.mjs:1803

_openItemSummary

_openItemSummary(
elem: Element,
options?: { animation?: boolean; rollData?: object },
): Promise<void>
Internal
Parameters
- elem: Element
- Optionaloptions: { animation?: boolean; rollData?: object } = {}
  Additional options
Returns Promise<void>
- Defined in module/applications/item/container-sheet.mjs:378

_openLinkedItem

_openLinkedItem(event: Event): Promise<void>
Open linked item sheet.
Parameters
- event: Event
Returns Promise<void>
Inherited from ItemSheetPF._openLinkedItem
- Defined in module/applications/item/item-sheet.mjs:2193

_prepareAlignments

_prepareAlignments(alignments: any): { choices: {}; values: any }
Parameters
- alignments: any
Returns { choices: {}; values: any }
Inherited from ItemSheetPF._prepareAlignments
- Defined in module/applications/item/item-sheet.mjs:994

`Protected`_prepareContents

_prepareContents(context: object): void
Protected
Parameters
- context: object
  Render context
Returns void
- Defined in module/applications/item/container-sheet.mjs:212

_prepareContentSource

_prepareContentSource(context: any): void
Parameters
- context: any
Returns void
Inherited from ItemSheetPF._prepareContentSource
- Defined in module/applications/item/item-sheet.mjs:921

`Protected`_prepareItem

_prepareItem(item: ItemPhysicalPF, context: object): object
Protected
Parameters
- item: ItemPhysicalPF
  Item document
- context: object
  Render context
Returns object
- Item render data
- Defined in module/applications/item/container-sheet.mjs:167

_prepareItemFlags

_prepareItemFlags(context: any): void
Parameters
- context: any
Returns void
Inherited from ItemSheetPF._prepareItemFlags
- Defined in module/applications/item/item-sheet.mjs:1084

_prepareItemForSection

_prepareItemForSection(item: object, section: object, context: object): void
Internal
Parameters
- item: object
  Item render data
- section: object
  Section configuration
- context: object
  Render context
Returns void
- Defined in module/applications/item/container-sheet.mjs:152

_prepareLinks

_prepareLinks(context: any): Promise<void>
Parameters
- context: any
Returns Promise<void>
Inherited from ItemSheetPF._prepareLinks
- Defined in module/applications/item/item-sheet.mjs:1007

_prepareMaterialsAndAddons

_prepareMaterialsAndAddons(
item: any,
): { addons: { key: string; name: string }[]; basics: {}; materials: {} }
Parameters
- item: any
Returns { addons: { key: string; name: string }[]; basics: {}; materials: {} }
Inherited from ItemSheetPF._prepareMaterialsAndAddons
- Defined in module/applications/item/item-sheet.mjs:966

_prepareScriptCalls

_prepareScriptCalls(context: any): Promise<void>
Parameters
- context: any
Returns Promise<void>
Inherited from ItemSheetPF._prepareScriptCalls
- Defined in module/applications/item/item-sheet.mjs:1091

_quickChangeItemQuantity

_quickChangeItemQuantity(event: any, add?: number): Promise<Item>
Parameters
- event: any
- add: number = 1
Returns Promise<Item>
- Defined in module/applications/item/container-sheet.mjs:610

_quickIdentifyItem

_quickIdentifyItem(event: any): Promise<undefined | Item>
Parameters
- event: any
Returns Promise<undefined | Item>
- Defined in module/applications/item/container-sheet.mjs:572

`Protected`_quickItemActionControl

_quickItemActionControl(event: MouseEvent): void
Protected
Handles click events to trigger the use of an item.
Parameters
- event: MouseEvent
  The originating click event
Returns void
- Defined in module/applications/item/container-sheet.mjs:630

_render

_render(force: any, options: any): Promise<void>
Parameters
- force: any
- options: any
Returns Promise<void>
Inherited from ItemSheetPF._render
- Defined in module/applications/item/item-sheet.mjs:124

_renderInner

_renderInner(...args: any[]): Promise<JQuery<HTMLElement>>
Parameters
- ...args: any[]
Returns Promise<JQuery<HTMLElement>>
Overrides ItemSheetPF._renderInner
- Defined in module/applications/item/container-sheet.mjs:238

_searchFilterChange

_searchFilterChange(event: any): void
Parameters
- event: any
Returns void
- Defined in module/applications/item/container-sheet.mjs:791

_searchFilterCommit

_searchFilterCommit(event: any): void
Item Search
Parameters
- event: any
Returns void
- Defined in module/applications/item/container-sheet.mjs:761

_searchFilterCompositioning

_searchFilterCompositioning(event: any): void
Parameters
- event: any
Returns void
- Defined in module/applications/item/container-sheet.mjs:787

_selectContentSource

_selectContentSource(sources: any): any
Parameters
- sources: any
Returns any
Inherited from ItemSheetPF._selectContentSource
- Defined in module/applications/item/item-sheet.mjs:937

_selectOnClick

_selectOnClick(event: any): void
Parameters
- event: any
Returns void
Inherited from ItemSheetPF._selectOnClick
- Defined in module/applications/item/item-sheet.mjs:2621

_setActionUses

_setActionUses(event: any): void
Parameters
- event: any
Returns void
Inherited from ItemSheetPF._setActionUses
- Defined in module/applications/item/item-sheet.mjs:1661

_setItemUses

_setItemUses(event: any): Promise<void>
Parameters
- event: any
Returns Promise<void>
- Defined in module/applications/item/container-sheet.mjs:637

_updateActions

_updateActions(): Promise<void>
Returns Promise<void>
Inherited from ItemSheetPF._updateActions
- Defined in module/applications/item/item-sheet.mjs:1688

_updateItems

_updateItems(): Promise<Item[]>
Returns Promise<Item[]>
- Defined in module/applications/item/container-sheet.mjs:654

`Protected`_updateObject

_updateObject(event: any, formData: any): Promise<unknown>
Protected
Extend the parent class _updateObject method to ensure that damage ends up in an Array
Parameters
- event: any
- formData: any
Returns Promise<unknown>
Inherited from ItemSheetPF._updateObject
- Defined in module/applications/item/item-sheet.mjs:1130

_validateFormula

_validateFormula(el: HTMLElement): Promise<void>
Internal
Validate input formula for basic errors.
Parameters
- el: HTMLElement
Returns Promise<void>
Inherited from ItemSheetPF._validateFormula
- Defined in module/applications/item/item-sheet.mjs:1347

activateListeners

activateListeners(html: any): void
Activate listeners for interactive item sheet events
Parameters
- html: any
Returns void
Overrides ItemSheetPF.activateListeners
- Defined in module/applications/item/container-sheet.mjs:256

getData

getData(): Promise<
    {
        canClassLink: boolean;
        config: config;
        cssClass: string;
        document: ItemPF;
        editable: boolean;
        inContainer: boolean;
        isGM: boolean;
        item: ItemPF;
        itemType: string;
        labels: Record<string, string>;
        name: null | string;
        owned: boolean;
        owner: boolean;
        rollData: object;
        system: any;
        tag: any;
    },
>
Prepare item sheet data Start with the base item data and extending with additional properties for rendering.

Returns Promise<
    {
        canClassLink: boolean;
        config: config;
        cssClass: string;
        document: ItemPF;
        editable: boolean;
        inContainer: boolean;
        isGM: boolean;
        item: ItemPF;
        itemType: string;
        labels: Record<string, string>;
        name: null | string;
        owned: boolean;
        owner: boolean;
        rollData: object;
        system: any;
        tag: any;
    },
>
Overrides ItemSheetPF.getData
- Defined in module/applications/item/container-sheet.mjs:77

setActionUpdate

setActionUpdate(id: any, key: any, value: any): void
Parameters
- id: any
- key: any
- value: any
Returns void
Inherited from ItemSheetPF.setActionUpdate
- Defined in module/applications/item/item-sheet.mjs:1678

setItemUpdate

setItemUpdate(id: any, key: any, value: any): void
Parameters
- id: any
- key: any
- value: any
Returns void
- Defined in module/applications/item/container-sheet.mjs:671

Class ItemSheetPF_Container

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ItemSheetPF_Container

Properties

Internal_activeEdits

_filters

_itemUpdates

effectiveSearch

item

searchCompositioning

searchDelay

searchDelayEvent

searchRefresh

Static InternalEDIT_TRACKING

Accessors

template

Returns string

title

Returns string

StaticdefaultOptions

Returns InsertKeys< {}, OmitByValue< { classes: string[]; dragDrop: ( | { dragSelector: string; dropSelector: string } | { dragSelector: string; dropSelector?: undefined } )[]; scrollY: string[]; width: number; }, never, >,>

Default Value

Methods

_applySectionFilter

Parameters

Returns boolean

Protected_canDragDrop

Returns boolean

_canDragStart

Parameters

Returns boolean

_convertCurrency

Parameters

Returns void

_createAttack

Parameters

Returns Promise<void>

_createSpellbook

Parameters

Returns Promise<void>

_duplicateItem

Parameters

Returns Promise<ItemContainerPF>

_getContentSources

Returns any

_mouseWheelAdd

Parameters

Returns void

_onActionControl

Parameters

Returns Promise<void>

_onActionEdit

Parameters

Returns Promise<void>

Protected_onActionSummary

Parameters

Returns Promise<void>

_onCardNoteControl

Parameters

Returns Promise<void>

_onChangeDrop

Parameters

Returns Promise<void>

_onCreateChange

Parameters

Returns Promise<void>

_onDeleteChange

Parameters

Returns void

_onDragStart

Parameters

Returns void

`Internal`_activeEdits

`Static` `Internal`EDIT_TRACKING

`Static`defaultOptions

Returns InsertKeys<
{},
OmitByValue<
{
classes: string[];
dragDrop: (
| { dragSelector: string; dropSelector: string }
| { dragSelector: string; dropSelector?: undefined }
)[];
scrollY: string[];
width: number;
},
never,
>,
>

`Protected`_canDragDrop

`Protected`_onActionSummary