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;
      } | {
          dragSelector: string;
          dropSelector: null;
      })[];
      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;
      } | {
          dragSelector: string;
          dropSelector: null;
      })[];
      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;
      } | {
          dragSelector: string;
          dropSelector: null;
      })[];
      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;
      } | {
          dragSelector: string;
          dropSelector: null;
      })[];
      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>

_getContentSources

• _getContentSources(): any

• Returns any

_isMaterialAllowed

• _isMaterialAllowed(itemType, itemSubtype, subType, material): boolean

• Check if a given material is okay to be added to our materials list for the item sheet.

  Parameters

  • itemType: string

    Whether we're checking weapons or equipment

  • itemSubtype: string

    Item-specific typing to filter with

  • subType: string

    Only relevant with shields, since "other" is used in both shield and general gear

  • material: MaterialType

    The Material object from the registry that has our needed metadata

  Returns boolean

_mouseWheelAdd

• _mouseWheelAdd(event, el): void

• Parameters

  • event: any

  • el: any

  Returns void

_onActionControl

• _onActionControl(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onActionEdit

• _onActionEdit(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onCardNoteControl

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

  Control effect notes and footnotes

  Parameters

  • event: Event

  Returns Promise<unknown>

_onCreateChange

• _onCreateChange(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onDeleteChange

• _onDeleteChange(event): void

• Parameters

  • event: any

  Returns void

_onDragStart

• _onDragStart(event): void
• Internal

  Parameters

  • event: DragEvent

  Returns void

_onDrop

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

  Parameters

  • event: DragEvent

  Returns Promise<undefined | Item | ItemChange[]>

_onDuplicateChange

• _onDuplicateChange(event): undefined | ItemChange[]

• Parameters

  • event: any

  Returns undefined | ItemChange[]

_onEditChange

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

  Parameters

  • event: Event

    Click event

  • Optional tooltip: boolean = false

    Is this event from locked tooltip?

  Returns undefined

_onEntrySelector

• _onEntrySelector(event): void

• Parameters

  • event: any

  Returns void

_onHoverPriceTooltip

• _onHoverPriceTooltip(event, content): void

• Parameters

  • event: any

  • content: any

  Returns void

_onHoverTooltip

• _onHoverTooltip(event): string

• Parameters

  • event: any

  Returns string

_onHoverWeightTooltip

• _onHoverWeightTooltip(event, content): void

• Parameters

  • event: any

  • content: any

  Returns void

_onItemSelector

• _onItemSelector(event): Promise<undefined>

• Parameters

  • event: any

  Returns Promise<undefined>

_onLinkControl

• _onLinkControl(event): Promise<unknown>

• Parameters

  • event: any

  Returns Promise<unknown>

_onLinksDrop

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

• Parameters

  • event: any

  • data: any

  Returns Promise<void>

_onNoteControl

• _onNoteControl(event): Promise<unknown>

• Parameters

  • event: any

  Returns Promise<unknown>

_onNoteTargetControl

• _onNoteTargetControl(event): void

• Parameters

  • event: any

  Returns void

_onOpenChangeMenu

• _onOpenChangeMenu(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onOpenCompendiumBrowser

• _onOpenCompendiumBrowser(event): void

• Parameters

  • event: any

  Returns void

_onScriptCallControl

• _onScriptCallControl(event): Promise<unknown>

• Parameters

  • event: any

  Returns Promise<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

_onSpeedEdit

• _onSpeedEdit(event): void

• Parameters

  • event: any

  Returns void

_onTextAreaDrop

• _onTextAreaDrop(event): 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): void

• Parameters

  • event: any

  Returns void

_openLinkedItem

• _openLinkedItem(event): Promise<void>

• Open linked item sheet.

  Parameters

  • event: Event

  Returns Promise<void>

_prepareAlignments

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

• Parameters

  • alignments: any

  Returns {
      choices: {};
      values: any;
  }

  • choices: {}

  • values: any

_prepareContentSource

• _prepareContentSource(context): void

• Parameters

  • context: any

  Returns void

_prepareItemFlags

• _prepareItemFlags(context): void

• Parameters

  • context: any

  Returns void

_prepareLinks

• _prepareLinks(context): void

• Parameters

  • context: any

  Returns void

_prepareMaterialsAndAddons

• _prepareMaterialsAndAddons(itemType, itemSubtype, subType, chosenMaterial?): {
      addons: any[];
      basics: {};
      materials: {};
  }

• Parameters

  • itemType: any

  • itemSubtype: any

  • subType: any

  • chosenMaterial: string = ""

  Returns {
      addons: any[];
      basics: {};
      materials: {};
  }

  • addons: any[]

  • basics: {}

  • materials: {}

_prepareScriptCalls

• _prepareScriptCalls(context): Promise<void>

• Parameters

  • context: any

  Returns Promise<void>

_selectContentSource

• _selectContentSource(sources): any

• Parameters

  • sources: any

  Returns any

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

_validateFormula

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

  Validate input formula for basic errors.

  Parameters

  • el: HTMLElement

  Returns Promise<void>

activateListeners

• activateListeners(html): void

• Activate listeners for interactive item sheet events

  Parameters

  • html: JQuery<HTMLElement>

  Returns void

getData

• getData(): Promise<{
      canClassLink: boolean;
      config: config;
      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;
      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, key, value): void

• Parameters

  • id: any

  • key: any

  • value: any

  Returns void