Class ItemSheetPF

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

Hierarchy (View Summary)

Constructors

constructor

Accessors

template title defaultOptions

Methods

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

Constructors

constructor

Accessors

template

  • get template(): string

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

    Returns string

    • Template path

title

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"
    })

Methods

Protected_canDragDrop

_canDragStart

_createAttack

_createSpellbook

_getContentSources

_mouseWheelAdd

_onActionControl

_onActionEdit

_onCardNoteControl

_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

_onNoteControl

_onNoteTargetControl

_onOpenChangeMenu

_onOpenCompendiumBrowser

_onOpenTextEditor

_onScriptCallControl

_onScriptCallDrop

_onScriptCallEdit

_onSpanTextInput

_onSpeedEdit

_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

_openLinkedItem

_prepareAlignments

_prepareContentSource

_prepareItemFlags

_prepareLinks

_prepareMaterialsAndAddons

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

  • Parameters

    • item: any

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

_prepareScriptCalls

_selectContentSource

_selectOnClick

_setActionUses

_updateActions

_validateFormula

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

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods