Class ItemSheetPF

constructor

• new ItemSheetPF(...args): ItemSheetPF

• Parameters

  • Rest ...args: any[]

  Returns ItemSheetPF

items

template

• get template(): string

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

  Returns string

title

• get title(): string

• Returns string

Static defaultOptions

• get defaultOptions(): InsertKeys<{
      baseApplication: null | string;
      classes: string[];
      closeOnSubmit: boolean;
      dragDrop: {
          dragSelector: string;
          dropSelector: string;
      }[];
      editable: boolean;
      filters: Omit<SearchFilterConfiguration, "callback">[];
      height: null | number | "auto";
      id: string;
      left: null | number;
      minimizable: boolean;
      popOut: boolean;
      resizable: boolean;
      scale: null | number;
      scrollY: string[];
      sheetConfig: boolean;
      submitOnChange: boolean;
      submitOnClose: boolean;
      tabs: {
          contentSelector: string;
          group: string;
          initial: string;
          navSelector: string;
      }[];
      template: null | string;
      title: string;
      top: null | number;
      viewPermission: 0 | 1 | 2 | 3;
      width: number;
  }, OmitByValue<{
      classes: string[];
      dragDrop: {
          dragSelector: string;
          dropSelector: string;
      }[];
      scrollY: string[];
      tabs: {
          contentSelector: string;
          group: string;
          initial: string;
          navSelector: string;
      }[];
      width: number;
  }, never>>

• Returns InsertKeys<{
      baseApplication: null | string;
      classes: string[];
      closeOnSubmit: boolean;
      dragDrop: {
          dragSelector: string;
          dropSelector: string;
      }[];
      editable: boolean;
      filters: Omit<SearchFilterConfiguration, "callback">[];
      height: null | number | "auto";
      id: string;
      left: null | number;
      minimizable: boolean;
      popOut: boolean;
      resizable: boolean;
      scale: null | number;
      scrollY: string[];
      sheetConfig: boolean;
      submitOnChange: boolean;
      submitOnClose: boolean;
      tabs: {
          contentSelector: string;
          group: string;
          initial: string;
          navSelector: string;
      }[];
      template: null | string;
      title: string;
      top: null | number;
      viewPermission: 0 | 1 | 2 | 3;
      width: number;
  }, OmitByValue<{
      classes: string[];
      dragDrop: {
          dragSelector: string;
          dropSelector: string;
      }[];
      scrollY: string[];
      tabs: {
          contentSelector: string;
          group: string;
          initial: string;
          navSelector: string;
      }[];
      width: number;
  }, never>>

_canDragStart

• _canDragStart(selector): boolean

• By default, returns true only for GM

  Parameters

  • selector: any

  Returns boolean

_createAttack

• _createAttack(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_createSpellbook

• _createSpellbook(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_mouseWheelAdd

• _mouseWheelAdd(event, el): void

• Parameters

  • event: any

  • el: any

  Returns void

_moveTooltips

• _moveTooltips(event): void

• Parameters

  • event: any

  Returns void

_onActionControl

• _onActionControl(event): Promise<void | Partial<Record<string, unknown>> | (undefined | ItemAction)[]>

• Parameters

  • event: any

  Returns Promise<void | Partial<Record<string, unknown>> | (undefined | ItemAction)[]>

_onActionEdit

• _onActionEdit(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onBuffControl

• _onBuffControl(event): Promise<undefined | any[] | Partial<Record<string, unknown>>>

• Parameters

  • event: any

  Returns Promise<undefined | any[] | Partial<Record<string, unknown>>>

_onChangeTargetControl

• _onChangeTargetControl(event): void

• Parameters

  • event: any

  Returns void

_onDragStart

• _onDragStart(event): void

• Parameters

  • event: any

  Returns void

_onDrop

• _onDrop(event): Promise<undefined | false>

• Parameters

  • event: any

  Returns Promise<undefined | false>

_onEditChangeScriptContents

• _onEditChangeScriptContents(event): Promise<any>

• Parameters

  • event: any

  Returns Promise<any>

_onEntryControl

• _onEntryControl(event): undefined | Promise<Partial<Record<string, unknown>>>

• Parameters

  • event: any

  Returns undefined | Promise<Partial<Record<string, unknown>>>

_onEntrySelector

• _onEntrySelector(event): void

• Parameters

  • event: any

  Returns void

_onFilePickerAlt

• _onFilePickerAlt(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onLinkControl

• _onLinkControl(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onLinksDrop

• _onLinksDrop(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onNoteControl

• _onNoteControl(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onNoteTargetControl

• _onNoteTargetControl(event): void

• Parameters

  • event: any

  Returns void

_onOpenCompendium

• _onOpenCompendium(event): void

• Parameters

  • event: any

  Returns void

_onScriptCallControl

• _onScriptCallControl(event): Promise<undefined | any[] | Partial<Record<string, unknown>>>

• Parameters

  • event: any

  Returns Promise<undefined | any[] | Partial<Record<string, unknown>>>

_onScriptCallDrop

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

• Parameters

  • event: any

  Returns Promise<undefined | any[]>

_onScriptCallEdit

• _onScriptCallEdit(event): void

• Parameters

  • event: any

  Returns void

_onSpanTextInput

• _onSpanTextInput(event, callback?): void

• Parameters

  • event: any

  • callback: null = null

  Returns void

_onTextAreaDrop

• _onTextAreaDrop(event): Promise<undefined | Partial<Record<string, unknown>>>

• Parameters

  • event: any

  Returns Promise<undefined | Partial<Record<string, unknown>>>

_openHelpBrowser

• _openHelpBrowser(event): void

• Parameters

  • event: any

  Returns void

_openLinkedItem

• _openLinkedItem(event): Promise<void>

• Open linked item sheet.

  Parameters

  • event: Event

  Returns Promise<void>

_prepareActions

• _prepareActions(data): undefined | never[]

• Parameters

  • data: any

  Returns undefined | never[]

_prepareItemFlags

• _prepareItemFlags(data): void

• Parameters

  • data: any

  Returns void

_prepareLinks

• _prepareLinks(data): void

• Parameters

  • data: any

  Returns void

_prepareScriptCalls

• _prepareScriptCalls(data): Promise<void>

• Parameters

  • data: any

  Returns Promise<void>

_selectOnClick

• _selectOnClick(event): void

• Parameters

  • event: any

  Returns void

_setActionUses

• _setActionUses(event): void

• Parameters

  • event: any

  Returns void

_updateActions

• _updateActions(): Promise<void>

• Returns Promise<void>

activateListeners

• activateListeners(html): void

• Activate listeners for interactive item sheet events

  Parameters

  • html: any

  Returns void

getData

• getData(): Promise<Data<DocumentSheetOptions>>

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

  Returns Promise<Data<DocumentSheetOptions>>

setActionUpdate

• setActionUpdate(id, key, value): void

• Parameters

  • id: any

  • key: any

  • value: any

  Returns void