Class ItemSheetPF

constructor

• new ItemSheetPF(...args: any[]): ItemSheetPF

• Parameters

  • ...args: any[]

  Returns ItemSheetPF

Internal_activeEdits

Static InternalEDIT_TRACKING

template

• get template(): string

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

  Returns string

  • Template path

title

• get title(): string

• Returns string

StaticdefaultOptions

• get defaultOptions(): InsertKeys<
      {},
      OmitByValue<
          {
              classes: string[];
              dragDrop: (
                  | { dragSelector: string; dropSelector: string }
                  | { dragSelector: string; dropSelector: null }
              )[];
              scrollY: string[];
              tabs: {
                  contentSelector: string;
                  group: string;
                  initial: string;
                  navSelector: string;
              }[];
              width: number;
          },
          never,
      >,
  >

• Returns InsertKeys<
      {},
      OmitByValue<
          {
              classes: string[];
              dragDrop: (
                  | { dragSelector: string; dropSelector: string }
                  | { dragSelector: string; dropSelector: null }
              )[];
              scrollY: string[];
              tabs: {
                  contentSelector: string;
                  group: string;
                  initial: string;
                  navSelector: 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"
  })
  Copy

_canDragStart

• _canDragStart(selector: any): boolean

• By default, returns true only for GM

  Parameters

  • selector: any

  Returns boolean

_createAttack

• _createAttack(event: any): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_createSpellbook

• _createSpellbook(event: any): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_getContentSources

• _getContentSources(): any

• Returns any

_mouseWheelAdd

• _mouseWheelAdd(event: any, el: any): void

• Parameters

  • event: any
  • el: any

  Returns void

_onActionControl

• _onActionControl(event: any): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onActionEdit

• _onActionEdit(event: any): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onCardNoteControl

• _onCardNoteControl(event: Event): Promise<unknown>
• Internal

  Control effect notes and footnotes

  Parameters

  • event: Event

  Returns Promise<unknown>

_onCreateChange

• _onCreateChange(event: any): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onDeleteChange

• _onDeleteChange(event: any): void

• Parameters

  • event: any

  Returns void

_onDragStart

• _onDragStart(event: DragEvent): void
• Internal

  Parameters

  • event: DragEvent

  Returns void

_onDrop

• _onDrop(
      event: DragEvent,
  ): Promise<undefined | ItemChange[] | Item | ItemAction[]>
• Internal

  Parameters

  • event: DragEvent

  Returns Promise<undefined | ItemChange[] | Item | ItemAction[]>

_onDuplicateChange

• _onDuplicateChange(event: any): undefined | ItemChange[]

• Parameters

  • event: any

  Returns undefined | ItemChange[]

_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

• _onEntrySelector(event: any): void

• Parameters

  • event: any

  Returns void

_onHoverPriceTooltip

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

• Parameters

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

  Returns void

_onHoverTooltip

• _onHoverTooltip(event: any): string

• Parameters

  • event: any

  Returns string

_onHoverWeightTooltip

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

• Parameters

  • event: any
  • content: any

  Returns void

_onItemSelector

• _onItemSelector(event: any): Promise<undefined>

• Parameters

  • event: any

  Returns Promise<undefined>

_onLinkControl

• _onLinkControl(event: any): Promise<unknown>

• Parameters

  • event: any

  Returns Promise<unknown>

_onLinksDrop

• _onLinksDrop(event: any, data: any): Promise<void>

• Parameters

  • event: any
  • data: any

  Returns Promise<void>

_onNoteControl

• _onNoteControl(event: any): Promise<unknown>

• Parameters

  • event: any

  Returns Promise<unknown>

_onNoteTargetControl

• _onNoteTargetControl(event: any): void

• Parameters

  • event: any

  Returns void

_onOpenChangeMenu

• _onOpenChangeMenu(event: any): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onOpenCompendiumBrowser

• _onOpenCompendiumBrowser(event: any): void

• Parameters

  • event: any

  Returns void

_onOpenTextEditor

• _onOpenTextEditor(event: Event): Promise<void>
• Internal

  Parameters

  • event: Event

  Returns Promise<void>

_onScriptCallControl

• _onScriptCallControl(event: any): Promise<unknown>

• Parameters

  • event: any

  Returns Promise<unknown>

_onScriptCallDrop

• _onScriptCallDrop(event: any): Promise<undefined | ItemScriptCall[]>

• Parameters

  • event: any

  Returns Promise<undefined | ItemScriptCall[]>

_onScriptCallEdit

• _onScriptCallEdit(event: any): void

• Parameters

  • event: any

  Returns void

_onSpanTextInput

• _onSpanTextInput(event: any, callback?: null): void

• Parameters

  • event: any
  • callback: null = null

  Returns void

_onSpeedEdit

• _onSpeedEdit(event: any): void

• Parameters

  • event: any

  Returns void

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

_openHelpBrowser

• _openHelpBrowser(event: any): void

• Parameters

  • event: any

  Returns void

_openLinkedItem

• _openLinkedItem(event: Event): Promise<void>

• Open linked item sheet.

  Parameters

  • event: Event

  Returns Promise<void>

_prepareAlignments

• _prepareAlignments(alignments: any): { choices: {}; values: any }

• Parameters

  • alignments: any

  Returns { choices: {}; values: any }

_prepareContentSource

• _prepareContentSource(context: any): void

• Parameters

  • context: any

  Returns void

_prepareItemFlags

• _prepareItemFlags(context: any): void

• Parameters

  • context: any

  Returns void

_prepareLinks

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

• Parameters

  • context: any

  Returns Promise<void>

_prepareMaterialsAndAddons

• _prepareMaterialsAndAddons(
      item: any,
  ): { addons: { key: string; name: string }[]; basics: {}; materials: {} }

• Parameters

  • item: any

  Returns { addons: { key: string; name: string }[]; basics: {}; materials: {} }

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

_selectContentSource

• _selectContentSource(sources: any): any

• Parameters

  • sources: any

  Returns any

_selectOnClick

• _selectOnClick(event: any): void

• Parameters

  • event: any

  Returns void

_setActionUses

• _setActionUses(event: any): void

• Parameters

  • event: any

  Returns void

_updateActions

• _updateActions(): Promise<void>

• Returns Promise<void>

_validateFormula

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

  Validate input formula for basic errors.

  Parameters

  • el: HTMLElement

  Returns Promise<void>

activateListeners

• activateListeners(html: JQuery<HTMLElement>): void

• Activate listeners for interactive item sheet events

  Parameters

  • html: JQuery<HTMLElement>

  Returns void

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;
      },
  >

setActionUpdate

• setActionUpdate(id: any, key: any, value: any): void

• Parameters

  • id: any
  • key: any
  • value: any

  Returns void