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

    Class ItemSheetPF_Container

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

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _activeEdits item _warnedAppV1 ACTIONS BASE_APPLICATION EDIT_TRACKING WHEEL_UPDATE_SCOPES

    Accessors

    abortSignal template title defaultOptions

    Methods

    _applySectionFilter _canDragDrop _canDragStart _commitSpanTextInputValue _getContentSources _getSidebarTooltipContent _getUniqueActionName _initializeActions _onChange _onChangeDrop _onClick _onClickAction _onContext _onContextAction _onDisplaySidebarTooltip _onDragStart _onDrop _onDropCurrency _onDropGeneric _onDropItem _onFinishWheelUpdate _onHoverPriceTooltip _onHoverWeightTooltip _onItemDrop _onLinksDrop _onOpenChangeMenu _onPointerEnter _onPointerLeave _onPostRender _onSortItem _onSpanTextInput _onTextDrop _prepareAlignments _prepareContents _prepareContentSource _prepareItem _prepareItemFlags _prepareItemForSection _prepareLinks _prepareScriptCalls _render _renderInner _selectContentSource _toggleItemSummary _updateObject _validateFormula activateListeners close getData _onConvertCurrency _onDeleteCardNote _onDeleteResource _onDuplicateChange _onEditChange inheritanceChain

    Constructors

    Properties

    Internal_activeEdits

    _activeEdits: Record<string, string> = {}
    item: ItemContainerPF

    Static_warnedAppV1

    _warnedAppV1: boolean = true
    ACTIONS: {
        __proto__: null;
        adjustQuantity: Object;
        convertCurrency: (
            ...this: any,
            event: PointerEvent,
            target: HTMLElement,
        ) => Promise<void>;
        createItem: Object;
        deleteItem: Object;
        displayItemCard: Object;
        dupeItem: Object;
        editItem: Object;
        takeItem: Object;
        toggleIdentified: Object;
        toggleItemSummary: Object;
        useItem: Object;
    } = ...

    Temporary action mapping until AppV2 conversion.

    Type Declaration

    • __proto__: null
    • adjustQuantity: Object
    • convertCurrency: (...this: any, event: PointerEvent, target: HTMLElement) => Promise<void>
    • createItem: Object
    • deleteItem: Object
    • displayItemCard: Object
    • dupeItem: Object
    • editItem: Object
    • takeItem: Object
    • toggleIdentified: Object
    • toggleItemSummary: Object
    • useItem: Object
    BASE_APPLICATION: typeof ItemSheetPF = ...

    Remove with AppV2 conversion

    EDIT_TRACKING: string[] = ...

    Which fields to track edits for

    WHEEL_UPDATE_SCOPES: string[] = ...

    Accessors

    • get abortSignal(): any

      Returns any

    • get template(): string

      Return a dynamic reference to the HTML template path used to render this Item Sheet

      Returns string

    • get title(): string

      Returns string

    • get defaultOptions(): InsertKeys<
          {},
          {
              classes: readonly ["pf1", "sheet", "item"];
              dragDrop: readonly [
                  {
                      dragSelector: "li.item[data-item-id]";
                      dropSelector: ".tab[data-tab=\"contents\"]";
                  },
                  { dragSelector: ".tab.changes li.change" },
                  { dragSelector: "label.denomination" },
              ];
              scrollY: readonly [
                  ".tab",
                  ".buff-flags",
                  ".editor-content",
                  ".inventory-body",
              ];
              width: 800;
          },
      >

      Returns InsertKeys<
          {},
          {
              classes: readonly ["pf1", "sheet", "item"];
              dragDrop: readonly [
                  {
                      dragSelector: "li.item[data-item-id]";
                      dropSelector: ".tab[data-tab=\"contents\"]";
                  },
                  { dragSelector: ".tab.changes li.change" },
                  { dragSelector: "label.denomination" },
              ];
              scrollY: readonly [
                  ".tab",
                  ".buff-flags",
                  ".editor-content",
                  ".inventory-body",
              ];
              width: 800;
          },
      >

      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",
        secrets: [{parentSelector: ".editor"}]
      })

    Methods

    _applySectionFilter

    • _applySectionFilter(
          item: Item<"base" | ModuleSubType>,
          section: object,
      ): boolean
      Internal

      Filters item by sheet section config.

      Parameters

      • item: Item<"base" | ModuleSubType>

        Item to filter

      • section: object

        Section to filter by

      Returns boolean

    Protected_canDragDrop

    • _canDragDrop(): boolean
      Protected

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

      Returns boolean

    _canDragStart

    • _canDragStart(selector: any): boolean

      By default, returns true only for GM

      Parameters

      • selector: any

      Returns boolean

    _commitSpanTextInputValue

    • _commitSpanTextInputValue(event: Event, target: HTMLElement): Promise<void>
      Internal

      Submit input value

      Parameters

      • event: Event
      • target: HTMLElement

      Returns Promise<void>

    _getContentSources

    • _getContentSources(): object[]

      Returns object[]

    _getSidebarTooltipContent

    • _getSidebarTooltipContent(event: PointerEvent, target: HTMLElement): string
      Internal

      Get Sidebar Tooltip Content

      Parameters

      • event: PointerEvent
      • target: HTMLElement

      Returns string

    _getUniqueActionName

    • _getUniqueActionName(base: string): string
      Internal

      Get Unique Action Name

      Parameters

      • base: string

      Returns string

    _initializeActions

    • _initializeActions(): void
      Internal

      Returns void

      Remove with AppV2 conversion

    _onChange

    • _onChange(event: any, target: any): boolean

      Nameless Change Event

      Handler for any change event that did not target an element with name.

      Parameters

      • event: any
      • target: any

      Returns boolean

      • True if the change was handled, false otherwise.

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

    Protected_onClick

    • _onClick(event: PointerEvent, target: HTMLElement): boolean
      Protected

      Non-action button clicks

      Parameters

      • event: PointerEvent

        Triggering event

      • target: HTMLElement

        Click target

      Returns boolean

      • True if this click was handled, false otherwise

    Protected_onClickAction

    • _onClickAction(event: PointerEvent, target: HTMLElement): boolean
      Protected

      Handle action button clicks

      Parameters

      • event: PointerEvent

        Triggering event

      • target: HTMLElement

        Action element

      Returns boolean

      • true if handler was found, false otherwise.

    Protected_onContext

    • _onContext(event: PointerEvent, target: HTMLElement): boolean
      Protected

      Non-action context clicks

      Parameters

      • event: PointerEvent

        Triggering event

      • target: HTMLElement

        Click target

      Returns boolean

      • True if this click was handled, false otherwise

    Protected_onContextAction

    • _onContextAction(event: PointerEvent, target: HTMLElement): boolean
      Protected

      Handle right-click actions

      Parameters

      • event: PointerEvent
      • target: HTMLElement

      Returns boolean

      • True if click was handled, false otherwise.

    _onDisplaySidebarTooltip

    • _onDisplaySidebarTooltip(
          event: PointerEvent,
          target: HTMLElement,
      ): Promise<void>
      Internal

      Open sidebar tooltip

      Parameters

      • event: PointerEvent
      • target: HTMLElement

      Returns Promise<void>

    _onDragStart

    • _onDragStart(event: DragEvent): void

      Parameters

      • event: DragEvent

      Returns void

    _onDrop

    • _onDrop(event: DragEvent): void | Promise<false | void | ItemContainerPF>

      Parameters

      • event: DragEvent

      Returns void | Promise<false | void | ItemContainerPF>

    _onDropCurrency

    • _onDropCurrency(event: DragEvent, data: object): void
      Internal

      Parameters

      • event: DragEvent
      • data: object

      Returns void

    Protected_onDropGeneric

    • _onDropGeneric(event: DragEvent, data: object): void
      Protected

      On drop of unrecognized data

      Parameters

      • event: DragEvent
      • data: object

      Returns void

    _onDropItem

    • _onDropItem(
          event: DragEvent,
          data: object,
      ): Promise<false | void | ItemContainerPF>
      Internal

      Parameters

      • event: DragEvent
      • data: object

      Returns Promise<false | void | ItemContainerPF>

    _onFinishWheelUpdate

    • _onFinishWheelUpdate(target: any): undefined | object

      Finalize Wheel Update

      Parameters

      • target: any

      Returns undefined | object

      • object with wheel element info, undefined if this is not valid element

    _onHoverPriceTooltip

    • _onHoverPriceTooltip(event: any, content: any, identified?: boolean): void

      Parameters

      • event: any
      • content: any
      • identified: boolean = true

      Returns void

    _onHoverWeightTooltip

    • _onHoverWeightTooltip(event: any, content: any): void

      Parameters

      • event: any
      • content: any

      Returns void

    _onItemDrop

    • _onItemDrop(event: Event, srcDoc: ItemPF, dropData: object): Promise<void>

      Handle item drop events

      Parameters

      • event: Event

        The originating drop event

      • srcDoc: ItemPF

        The dropped item document

      • dropData: object

        The drop data

      Returns Promise<void>

    _onLinksDrop

    • _onLinksDrop(event: DragEvent, data: object): Promise<void>
      Internal

      Handle drop into links

      Parameters

      • event: DragEvent
      • data: object

      Returns Promise<void>

    _onOpenChangeMenu

    • _onOpenChangeMenu(event: PointerEvent): Promise<void>
      Internal

      Open static tooltip for a Change

      Parameters

      • event: PointerEvent

      Returns Promise<void>

    _onPointerEnter

    • _onPointerEnter(event: PointerEvent): void
      Internal

      Pointer Enter event handler delegate

      Parameters

      • event: PointerEvent

      Returns void

    _onPointerLeave

    • _onPointerLeave(event: PointerEvent): void
      Internal

      Pointer Leave event handler delegate

      Parameters

      • event: PointerEvent

      Returns void

    _onPostRender

    • _onPostRender(html: HTMLElement): Promise<void>
      Internal

      Post-Render handling

      Sheet handling that is not needed for rendering

      Parameters

      • html: HTMLElement

      Returns Promise<void>

    _onSortItem

    • _onSortItem(event: any, itemData: any): undefined | Promise<void>

      Parameters

      • event: any
      • itemData: any

      Returns undefined | Promise<void>

    _onSpanTextInput

    • _onSpanTextInput(
          event: PointerEvent,
          target: HTMLElement,
          callback: Function,
      ): void
      Internal

      Edit input

      Parameters

      • event: PointerEvent
      • target: HTMLElement
      • callback: Function

      Returns void

    _onTextDrop

    • _onTextDrop(
          event: DragEvent,
          dropData: object,
      ): Promise<undefined | Partial<AnyObject>>
      Internal

      Handle dropping content-linkable data to <textarea> or text <input>

      Parameters

      • event: DragEvent
      • dropData: object

      Returns Promise<undefined | Partial<AnyObject>>

    _prepareAlignments

    Protected_prepareContents

    • _prepareContents(context: object): void
      Protected

      Parameters

      • context: object

        Render context

      Returns void

    _prepareContentSource

    • _prepareContentSource(context: any): void

      Parameters

      • context: any

      Returns void

    Protected_prepareItem

    • _prepareItem(item: ItemPhysicalPF, context: object): object
      Protected

      Parameters

      Returns object

      • Item render data

    _prepareItemFlags

    • _prepareItemFlags(context: any): void

      Parameters

      • context: any

      Returns void

    _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

    _prepareLinks

    • _prepareLinks(context: any): Promise<void>

      Parameters

      • context: any

      Returns Promise<void>

    _prepareScriptCalls

    • _prepareScriptCalls(context: any): Promise<void>

      Parameters

      • context: any

      Returns Promise<void>

    _render

    • _render(force: any, options: any): Promise<void>

      Parameters

      • force: any
      • options: any

      Returns Promise<void>

    _renderInner

    • _renderInner(...args: any[]): Promise<JQuery>

      Parameters

      • ...args: any[]

      Returns Promise<JQuery>

    _selectContentSource

    • _selectContentSource(sources: any): any

      Parameters

      • sources: any

      Returns any

    _toggleItemSummary

    • _toggleItemSummary(
          elem: HTMLElement,
          options?: { animation?: boolean; rollData?: object },
      ): Promise<void>
      Internal

      Toggle Item Summary

      Parameters

      • elem: HTMLElement
      • Optionaloptions: { animation?: boolean; rollData?: object } = {}

        Additional options

      Returns Promise<void>

    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>

    _validateFormula

    • _validateFormula(el: HTMLElement): Promise<void>
      Internal

      Validate input formula for basic errors.

      Parameters

      • el: HTMLElement

      Returns Promise<void>

    • Activate listeners for interactive item sheet events

      Parameters

      • html: any

      Returns void

    • Parameters

      • options: any

      Returns Promise<void>

    • Prepare item sheet data Start with the base item data and extending with additional properties for rendering.

      Returns Promise<
          {
              actor: null
              | ActorPF;
              canClassLink: boolean;
              config: config;
              cssClass: string;
              data: any;
              document: ItemPF;
              editable: boolean;
              embedded: boolean;
              inContainer: boolean;
              isGM: any;
              item: ItemPF;
              itemType: any;
              labels: Record<string, string>;
              name: string;
              owned: boolean;
              owner: boolean;
              rollData: object;
              system: SystemOfType<"base" | ModuleSubType>;
              tag: any;
          },
      >

    Static_onConvertCurrency

    • _onConvertCurrency(
          ...this: any,
          event: PointerEvent,
          target: HTMLElement,
      ): Promise<void>
      Internal

      Convert Currency

      Parameters

      • ...this: any
      • event: PointerEvent
      • target: HTMLElement

      Returns Promise<void>

    Static_onDeleteCardNote

    • _onDeleteCardNote(
          ...this: any,
          event: PointerEvent,
          target: HTMLElement,
      ): Promise<void>
      Internal

      Control effect notes and footnotes

      Parameters

      • ...this: any
      • event: PointerEvent
      • target: HTMLElement

      Returns Promise<void>

    Static_onDeleteResource

    • _onDeleteResource(event: any, _target: any): Promise<any>

      Parameters

      • event: any
      • _target: any

      Returns Promise<any>

    Static_onDuplicateChange

    • _onDuplicateChange(...this: any, event: PointerEvent, target: HTMLElement): void

      Duplicate Change

      Parameters

      • ...this: any
      • event: PointerEvent
      • target: HTMLElement

      Returns void

    Static_onEditChange

    • _onEditChange(...this: any, event: PointerEvent, target: HTMLElement): void
      Internal

      Edit Change

      Parameters

      • ...this: any
      • event: PointerEvent

        Click event

      • target: HTMLElement

      Returns void

    • Copy of AppV2 function

      Returns Generator<typeof ItemSheetPF, void, unknown>

      Remove with AppV2 conversion

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    _applySectionFilter_canDragDrop_canDragStart_commitSpanTextInputValue_getContentSources_getSidebarTooltipContent_getUniqueActionName_initializeActions_onChange_onChangeDrop_onClick_onClickAction_onContext_onContextAction_onDisplaySidebarTooltip_onDragStart_onDrop_onDropCurrency_onDropGeneric_onDropItem_onFinishWheelUpdate_onHoverPriceTooltip_onHoverWeightTooltip_onItemDrop_onLinksDrop_onOpenChangeMenu_onPointerEnter_onPointerLeave_onPostRender_onSortItem_onSpanTextInput_onTextDrop_prepareAlignments_prepareContents_prepareContentSource_prepareItem_prepareItemFlags_prepareItemForSection_prepareLinks_prepareScriptCalls_render_renderInner_selectContentSource_toggleItemSummary_updateObject_validateFormulaactivateListenersclosegetData_onConvertCurrency_onDeleteCardNote_onDeleteResource_onDuplicateChange_onEditChangeinheritanceChain