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

    Class ItemSheetPF

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

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _activeEdits _warnedAppV1 EDIT_TRACKING

    Accessors

    template title defaultOptions

    Methods

    _canDragDrop _canDragStart _createAttack _createSpellbook _getContentSources _mouseWheelAdd _onActionControl _onActionEdit _onActionSummary _onCardNoteControl _onChangeDrop _onCreateChange _onDeleteChange _onDragStart _onDrop _onDuplicateChange _onEditChange _onEntrySelector _onHoverPriceTooltip _onHoverTooltip _onHoverWeightTooltip _onItemSelector _onLinkControl _onLinksDrop _onMaterialSelector _onNoteControl _onNoteTargetControl _onOpenChangeMenu _onOpenCompendiumBrowser _onOpenTextEditor _onScriptCallControl _onScriptCallCreate _onScriptCallEdit _onSpanTextInput _onSpeedEdit _onTextAreaDrop _openHelpBrowser _openLinkedItem _prepareAlignments _prepareContentSource _prepareItemFlags _prepareLinks _prepareScriptCalls _render _selectContentSource _selectOnClick _setActionUses _updateActions _updateObject _validateFormula activateListeners getData setActionUpdate

    Constructors

    Properties

    Internal_activeEdits

    _activeEdits: Record<string, string> = {}

    Static_warnedAppV1

    _warnedAppV1: boolean = true
    EDIT_TRACKING: string[] = ...

    Which fields to track edits for

    Accessors

    • get template(): string

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

      Returns string

      • Template path
    • get defaultOptions(): InsertKeys<
          {},
          {
              classes: readonly ["pf1", "sheet", "item"];
              dragDrop: readonly [
                  { dragSelector: "li.action-part"; dropSelector: ".tab.details" },
                  { dragSelector: ".tab.changes li.change"; dropSelector: null },
                  {
                      dragSelector: ".tab.links .item-name";
                      dropSelector: ".tab.links .tab[data-group='links']";
                  },
              ];
              scrollY: readonly [".tab", ".buff-flags", ".editor-content"];
              tabs: readonly [
                  {
                      contentSelector: "section.primary-body";
                      group: "primary";
                      initial: "description";
                      navSelector: "nav.tabs[data-group='primary']";
                  },
                  {
                      contentSelector: "section.links-body";
                      group: "links";
                      initial: "children";
                      navSelector: "nav.tabs[data-group='links']";
                  },
                  {
                      contentSelector: "section.description-body";
                      group: "description";
                      initial: "identified";
                      navSelector: "nav.tabs[data-group='description']";
                  },
              ];
              width: 800;
          },
      >

      Returns InsertKeys<
          {},
          {
              classes: readonly ["pf1", "sheet", "item"];
              dragDrop: readonly [
                  { dragSelector: "li.action-part"; dropSelector: ".tab.details" },
                  { dragSelector: ".tab.changes li.change"; dropSelector: null },
                  {
                      dragSelector: ".tab.links .item-name";
                      dropSelector: ".tab.links .tab[data-group='links']";
                  },
              ];
              scrollY: readonly [".tab", ".buff-flags", ".editor-content"];
              tabs: readonly [
                  {
                      contentSelector: "section.primary-body";
                      group: "primary";
                      initial: "description";
                      navSelector: "nav.tabs[data-group='primary']";
                  },
                  {
                      contentSelector: "section.links-body";
                      group: "links";
                      initial: "children";
                      navSelector: "nav.tabs[data-group='links']";
                  },
                  {
                      contentSelector: "section.description-body";
                      group: "description";
                      initial: "identified";
                      navSelector: "nav.tabs[data-group='description']";
                  },
              ];
              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

    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

    _createAttack

    _createSpellbook

    _getContentSources

    _mouseWheelAdd

    _onActionControl

    _onActionEdit

    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>

    _onCardNoteControl

    _onChangeDrop

    _onCreateChange

    _onDeleteChange

    _onDragStart

    _onDrop

    _onDuplicateChange

    _onEditChange

    • _onEditChange(event: Event, tooltip?: boolean): undefined
      Internal

      Parameters

      • event: Event

        Click event

      • Optionaltooltip: boolean = false

        Is this event from locked tooltip?

      Returns undefined

    _onEntrySelector

    _onHoverPriceTooltip

    _onHoverTooltip

    _onHoverWeightTooltip

    _onItemSelector

    _onLinkControl

    _onLinksDrop

    _onMaterialSelector

    _onNoteControl

    _onNoteTargetControl

    _onOpenChangeMenu

    _onOpenCompendiumBrowser

    _onOpenTextEditor

    _onScriptCallControl

    _onScriptCallCreate

    _onScriptCallEdit

    _onSpanTextInput

    _onSpeedEdit

    _onTextAreaDrop

    • _onTextAreaDrop(event: DragEvent): Promise<undefined | Partial<AnyObject>>
      Internal

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

      Parameters

      • event: DragEvent

      Returns Promise<undefined | Partial<AnyObject>>

    _openHelpBrowser

    _openLinkedItem

    _prepareAlignments

    _prepareContentSource

    _prepareItemFlags

    _prepareLinks

    _prepareScriptCalls

    _render

    _selectContentSource

    _selectOnClick

    _setActionUses

    _updateActions

    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

    • Activate listeners for interactive item sheet events

      Parameters

      • jq: JQuery<HTMLElement>

      Returns 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: boolean;
              item: ItemPF;
              itemType: string;
              labels: Record<string, string>;
              name: string;
              owned: boolean;
              owner: boolean;
              rollData: object;
              system: SystemOfType<"base" | ModuleSubType>;
              tag: any;
          },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    _canDragDrop_canDragStart_createAttack_createSpellbook_getContentSources_mouseWheelAdd_onActionControl_onActionEdit_onActionSummary_onCardNoteControl_onChangeDrop_onCreateChange_onDeleteChange_onDragStart_onDrop_onDuplicateChange_onEditChange_onEntrySelector_onHoverPriceTooltip_onHoverTooltip_onHoverWeightTooltip_onItemSelector_onLinkControl_onLinksDrop_onMaterialSelector_onNoteControl_onNoteTargetControl_onOpenChangeMenu_onOpenCompendiumBrowser_onOpenTextEditor_onScriptCallControl_onScriptCallCreate_onScriptCallEdit_onSpanTextInput_onSpeedEdit_onTextAreaDrop_openHelpBrowser_openLinkedItem_prepareAlignments_prepareContentSource_prepareItemFlags_prepareLinks_prepareScriptCalls_render_selectContentSource_selectOnClick_setActionUses_updateActions_updateObject_validateFormulaactivateListenersgetDatasetActionUpdate