Class ItemSheetPF

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

Hierarchy (View Summary)

ItemSheet
- ItemSheetPF
  - ItemSheetPF_Container

Index

Constructors

constructor

new ItemSheetPF(...args: any[]): ItemSheetPF
Parameters
- ...args: any[]
Returns ItemSheetPF
Overrides foundry.appv1.sheets.ItemSheet.constructor
- Defined in module/applications/item/item-sheet.mjs:41

Properties

`Internal`_activeEdits

_activeEdits: Record<string, string> = {}

`Static`_warnedAppV1

_warnedAppV1: boolean = true

`Static` `Internal` `Experimental`ACTIONS

ACTIONS: {
    addCardNote: Object;
    browse: Object;
    createAction: Object;
    createChange: Object;
    createContextNote: Object;
    createLinkedAttack: Object;
    createScriptCall: Object;
    createSpellbook: Object;
    deleteAction: Object;
    deleteCardNote: (
        ...this: any,
        event: PointerEvent,
        target: HTMLElement,
    ) => Promise<void>;
    deleteChange: Object;
    deleteContextNote: Object;
    deleteLink: Object;
    deleteScriptCall: Object;
    dupeAction: Object;
    dupeChange: (
        ...this: any,
        event: PointerEvent,
        target: HTMLElement,
    ) => void;
    editAction: Object;
    editChange: (
        ...this: any,
        event: PointerEvent,
        target: HTMLElement,
    ) => void;
    editEntries: Object;
    editFlags: Object;
    editInstructions: Object;
    editMaterial: Object;
    editResistances: Object;
    editScriptCall: Object;
    editSources: Object;
    editSpeeds: Object;
    editTraits: Object;
    help: Object;
    hideScriptCall: Object;
    openDocument: Object;
    protectedInput: Object;
    selectContextNoteTarget: Object;
    selectItem: Object;
    toggleActionSummary: Object;
} = ...

Temporary action mapping until AppV2 conversion.

Type Declaration

addCardNote: Object
browse: Object
createAction: Object
createChange: Object
createContextNote: Object
createLinkedAttack: Object
createScriptCall: Object
createSpellbook: Object
deleteAction: Object
deleteCardNote: (...this: any, event: PointerEvent, target: HTMLElement) => Promise<void>
deleteChange: Object
deleteContextNote: Object
deleteLink: Object
deleteScriptCall: Object
dupeAction: Object
dupeChange: (...this: any, event: PointerEvent, target: HTMLElement) => void
editAction: Object
editChange: (...this: any, event: PointerEvent, target: HTMLElement) => void
editEntries: Object
editFlags: Object
editInstructions: Object
editMaterial: Object
editResistances: Object
editScriptCall: Object
editSources: Object
editSpeeds: Object
editTraits: Object
help: Object
hideScriptCall: Object
openDocument: Object
protectedInput: Object
selectContextNoteTarget: Object
selectItem: Object
toggleActionSummary: Object

`Static`BASE_APPLICATION

BASE_APPLICATION: typeof ItemSheetPF = ...

Todo

Remove with AppV2 conversion

`Static` `Internal`EDIT_TRACKING

EDIT_TRACKING: string[] = ...

Which fields to track edits for

`Static`WHEEL_UPDATE_SCOPES

WHEEL_UPDATE_SCOPES: string[] = ...

Accessors

abortSignal

get abortSignal(): any
Returns any
- Defined in module/applications/item/item-sheet.mjs:17

template

get template(): string
Return a dynamic reference to the HTML template path used to render this Item Sheet

Returns string
- Template path
Overrides foundry.appv1.sheets.ItemSheet.template
- Defined in module/applications/item/item-sheet.mjs:213

title

get title(): string
Returns string
Overrides foundry.appv1.sheets.ItemSheet.title
- Defined in module/applications/item/item-sheet.mjs:218

`Static`defaultOptions

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: ".description-container";
                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: ".description-container";
                group: "description";
                initial: "identified";
                navSelector: "nav.tabs[data-group='description']";
            },
        ];
        width: 800;
    },
>
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",
  secrets: [{parentSelector: ".editor"}]
})
```
Overrides foundry.appv1.sheets.ItemSheet.defaultOptions
- Defined in module/applications/item/item-sheet.mjs:100

Methods

`Protected`_canDragDrop

_canDragDrop(): boolean
Protected
Allow non-GM to drag&drop actions and items (for containers) to this sheet.

Returns boolean
Overrides foundry.appv1.sheets.ItemSheet._canDragDrop
- Defined in module/applications/item/item-sheet.mjs:2231

_canDragStart

_canDragStart(selector: any): boolean
By default, returns true only for GM
Parameters
- selector: any
Returns boolean
Overrides foundry.appv1.sheets.ItemSheet._canDragStart
- Defined in module/applications/item/item-sheet.mjs:2177

_commitSpanTextInputValue

_commitSpanTextInputValue(event: Event, target: HTMLElement): Promise<void>
Internal
Submit input value
Parameters
- event: Event
- target: HTMLElement
Returns Promise<void>
Throws
- Defined in module/applications/item/item-sheet.mjs:2011

_getContentSources

_getContentSources(): object[]
Returns object[]
- Defined in module/applications/item/item-sheet.mjs:1064

_getSidebarTooltipContent

_getSidebarTooltipContent(event: PointerEvent, target: HTMLElement): string
Internal
Get Sidebar Tooltip Content
Parameters
- event: PointerEvent
- target: HTMLElement
Returns string
- Defined in module/applications/item/item-sheet.mjs:1390

_getUniqueActionName

_getUniqueActionName(base: string): string
Internal
Get Unique Action Name
Parameters
- base: string
Returns string
- Defined in module/applications/item/item-sheet.mjs:2714

_initializeActions

_initializeActions(): void
Internal
Returns void
Todo
Remove with AppV2 conversion
- Defined in module/applications/item/item-sheet.mjs:63

`Abstract`_onChange

_onChange(event: Event, target: HTMLElement): boolean
Nameless Change Event

Handler for any change event that did not target an element with name.
Parameters
- event: Event
- target: HTMLElement
Returns boolean
- True if the change was handled, false otherwise.
- Defined in module/applications/item/item-sheet.mjs:1727

_onChangeDrop

_onChangeDrop(event: DragEvent, data: object): Promise<void>
Internal
Handle pf1.components.ItemChange drop events.
Parameters
- event: DragEvent
  The originating drop event
- data: object
  The data extracted from the drop event
Returns Promise<void>
- Defined in module/applications/item/item-sheet.mjs:2468

`Protected`_onClick

_onClick(event: PointerEvent, target: HTMLElement): boolean
Protected
Non-action button clicks
Parameters
- event: PointerEvent
  Triggering event
- target: HTMLElement
  Click target
Returns boolean
- True if this click was handled, false otherwise
- Defined in module/applications/item/item-sheet.mjs:1633

`Protected`_onClickAction

_onClickAction(event: PointerEvent, target: HTMLElement): boolean
Protected
Handle action button clicks
Parameters
- event: PointerEvent
  Triggering event
- target: HTMLElement
  Action element
Returns boolean
- true if handler was found, false otherwise.
- Defined in module/applications/item/item-sheet.mjs:1617

`Protected`_onContext

_onContext(event: PointerEvent, target: HTMLElement): boolean
Protected
Non-action context clicks
Parameters
- event: PointerEvent
  Triggering event
- target: HTMLElement
  Click target
Returns boolean
- True if this click was handled, false otherwise
- Defined in module/applications/item/item-sheet.mjs:1696

`Protected`_onContextAction

_onContextAction(event: PointerEvent, target: HTMLElement): boolean
Protected
Handle right-click actions
Parameters
- event: PointerEvent
- target: HTMLElement
Returns boolean
- True if click was handled, false otherwise.
- Defined in module/applications/item/item-sheet.mjs:1679

_onDisplaySidebarTooltip

_onDisplaySidebarTooltip(
event: PointerEvent,
target: HTMLElement,
): Promise<void>
Internal
Open sidebar tooltip
Parameters
- event: PointerEvent
- target: HTMLElement
Returns Promise<void>
- Defined in module/applications/item/item-sheet.mjs:2849

_onDragStart

_onDragStart(event: DragEvent): void
Internal
Override of drag start event handler
Parameters
- event: DragEvent
Returns void
Overrides foundry.appv1.sheets.ItemSheet._onDragStart
- Defined in module/applications/item/item-sheet.mjs:2188

_onDrop

_onDrop(event: DragEvent): Promise<void | ItemAction[] | Partial<AnyObject>>
Parameters
- event: DragEvent
Returns Promise<void | ItemAction[] | Partial<AnyObject>>
Overrides foundry.appv1.sheets.ItemSheet._onDrop
- Defined in module/applications/item/item-sheet.mjs:2239

`Protected`_onDropGeneric

_onDropGeneric(event: DragEvent, data: object): void
Protected
On drop of unrecognized data
Parameters
- event: DragEvent
- data: object
Returns void
- Defined in module/applications/item/item-sheet.mjs:2401

`Protected`_onFinishWheelUpdate

_onFinishWheelUpdate(target: HTMLElement): undefined | object
Protected
Finalize Wheel Update
Parameters
- target: HTMLElement
Returns undefined | object
- object with wheel element info, undefined if this is not valid element
- Defined in module/applications/item/item-sheet.mjs:1791

_onHoverPriceTooltip

_onHoverPriceTooltip(event: any, content: any, identified?: boolean): void
Parameters
- event: any
- content: any
- identified: boolean = true
Returns void
- Defined in module/applications/item/item-sheet.mjs:1416

_onHoverWeightTooltip

_onHoverWeightTooltip(event: any, content: any): void
Parameters
- event: any
- content: any
Returns void
- Defined in module/applications/item/item-sheet.mjs:1407

_onLinksDrop

_onLinksDrop(event: DragEvent, data: object): Promise<void>
Internal
Handle drop into links
Parameters
- event: DragEvent
- data: object
Returns Promise<void>
- Defined in module/applications/item/item-sheet.mjs:2436

_onOpenChangeMenu

_onOpenChangeMenu(event: PointerEvent): Promise<void>
Internal
Open static tooltip for a Change
Parameters
- event: PointerEvent
Returns Promise<void>
- Defined in module/applications/item/item-sheet.mjs:2869

_onPointerEnter

_onPointerEnter(event: PointerEvent): void
Internal
Pointer Enter event handler delegate
Parameters
- event: PointerEvent
Returns void
- Defined in module/applications/item/item-sheet.mjs:1827

_onPointerLeave

_onPointerLeave(event: PointerEvent): void
Internal
Pointer Leave event handler delegate
Parameters
- event: PointerEvent
Returns void
- Defined in module/applications/item/item-sheet.mjs:1846

_onPostRender

_onPostRender(html: HTMLElement): Promise<void>
Internal
Post-Render handling

Sheet handling that is not needed for rendering
Parameters
- html: HTMLElement
Returns Promise<void>
- Defined in module/applications/item/item-sheet.mjs:1584

_onSpanTextInput

_onSpanTextInput(
    event: PointerEvent,
    target: HTMLElement,
    callback: Function,
): void
Internal
Edit input
Parameters
- event: PointerEvent
- target: HTMLElement
- callback: Function
Returns void
- Defined in module/applications/item/item-sheet.mjs:1897

_onTextDrop

_onTextDrop(
event: DragEvent,
dropData: object,
): Promise<undefined | Partial<AnyObject>>
Internal
Handle dropping content-linkable data to <textarea> or text <input>
Parameters
- event: DragEvent
- dropData: object
Returns Promise<undefined | Partial<AnyObject>>
- Defined in module/applications/item/item-sheet.mjs:2410

_prepareAlignments

_prepareAlignments(): {}
Returns {}
- Defined in module/applications/item/item-sheet.mjs:1074

_prepareContentSource

_prepareContentSource(context: any): void
Parameters
- context: any
Returns void
- Defined in module/applications/item/item-sheet.mjs:1043

_prepareItemFlags

_prepareItemFlags(context: any): void
Parameters
- context: any
Returns void
- Defined in module/applications/item/item-sheet.mjs:1168

_prepareLinks

_prepareLinks(context: any): Promise<void>
Parameters
- context: any
Returns Promise<void>
- Defined in module/applications/item/item-sheet.mjs:1090

_prepareScriptCalls

_prepareScriptCalls(context: any): Promise<void>
Parameters
- context: any
Returns Promise<void>
- Defined in module/applications/item/item-sheet.mjs:1175

_render

_render(force: any, options: any): Promise<void>
Parameters
- force: any
- options: any
Returns Promise<void>
Overrides foundry.appv1.sheets.ItemSheet._render
- Defined in module/applications/item/item-sheet.mjs:227

_selectContentSource

_selectContentSource(sources: any): any
Parameters
- sources: any
Returns any
- Defined in module/applications/item/item-sheet.mjs:1056

`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>
Overrides foundry.appv1.sheets.ItemSheet._updateObject
- Defined in module/applications/item/item-sheet.mjs:1224

_validateFormula

_validateFormula(el: HTMLElement): Promise<void>
Internal
Validate input formula for basic errors.
Parameters
- el: HTMLElement
Returns Promise<void>
- Defined in module/applications/item/item-sheet.mjs:1460

activateListeners

activateListeners(jq: JQuery<HTMLElement>): void
Activate listeners for interactive item sheet events
Parameters
- jq: JQuery<HTMLElement>
Returns void
Overrides foundry.appv1.sheets.ItemSheet.activateListeners
- Defined in module/applications/item/item-sheet.mjs:1507

close

close(...args: any[]): Promise<void>
Parameters
- ...args: any[]
Returns Promise<void>
Overrides foundry.appv1.sheets.ItemSheet.close
- Defined in module/applications/item/item-sheet.mjs:1495

getData

getData(): Promise<
    {
        actor: null
        | ActorPF;
        canClassLink: boolean;
        config: ./config.mjs;
        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;
    },
>
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.mjs;
        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;
    },
>
Overrides foundry.appv1.sheets.ItemSheet.getData
- Defined in module/applications/item/item-sheet.mjs:237

`Static`_onDeleteCardNote

_onDeleteCardNote(
    ...this: any,
    event: PointerEvent,
    target: HTMLElement,
): Promise<void>
Internal
Control effect notes and footnotes
Parameters
- ...this: any
- event: PointerEvent
- target: HTMLElement
Returns Promise<void>
- Defined in module/applications/item/item-sheet.mjs:3294

`Static`_onDuplicateChange

_onDuplicateChange(...this: any, event: PointerEvent, target: HTMLElement): void
Duplicate Change
Parameters
- ...this: any
- event: PointerEvent
- target: HTMLElement
Returns void
- Defined in module/applications/item/item-sheet.mjs:2926

`Static`_onEditChange

_onEditChange(...this: any, event: PointerEvent, target: HTMLElement): void
Internal
Edit Change
Parameters
- ...this: any
- event: PointerEvent
  Click event
- target: HTMLElement
Returns void
- Defined in module/applications/item/item-sheet.mjs:2903

`Static`inheritanceChain

inheritanceChain(): Generator<typeof ItemSheetPF, void, unknown>
Copy of AppV2 function

Returns Generator<typeof ItemSheetPF, void, unknown>
Todo
Remove with AppV2 conversion
- Defined in module/applications/item/item-sheet.mjs:88

Class ItemSheetPF

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ItemSheetPF

Properties

Internal_activeEdits

Static_warnedAppV1

Static Internal ExperimentalACTIONS

Type Declaration

addCardNote: Object

browse: Object

createAction: Object

createChange: Object

createContextNote: Object

createLinkedAttack: Object

createScriptCall: Object

createSpellbook: Object

deleteAction: Object

deleteCardNote: (...this: any, event: PointerEvent, target: HTMLElement) => Promise<void>

deleteChange: Object

deleteContextNote: Object

deleteLink: Object

deleteScriptCall: Object

dupeAction: Object

dupeChange: (...this: any, event: PointerEvent, target: HTMLElement) => void

editAction: Object

editChange: (...this: any, event: PointerEvent, target: HTMLElement) => void

editEntries: Object

editFlags: Object

editInstructions: Object

editMaterial: Object

editResistances: Object

editScriptCall: Object

editSources: Object

editSpeeds: Object

editTraits: Object

help: Object

hideScriptCall: Object

openDocument: Object

protectedInput: Object

selectContextNoteTarget: Object

selectItem: Object

toggleActionSummary: Object

StaticBASE_APPLICATION

Todo

Static InternalEDIT_TRACKING

StaticWHEEL_UPDATE_SCOPES

Accessors

abortSignal

Returns any

template

Returns string

title

Returns string

StaticdefaultOptions

Default Value

Methods

Protected_canDragDrop

Returns boolean

_canDragStart

Parameters

Returns boolean

_commitSpanTextInputValue

Parameters

Returns Promise<void>

Throws

_getContentSources

Returns object[]

_getSidebarTooltipContent

Parameters

Returns string

_getUniqueActionName

Parameters

`Internal`_activeEdits

`Static`_warnedAppV1

`Static` `Internal` `Experimental`ACTIONS

`Static`BASE_APPLICATION

`Static` `Internal`EDIT_TRACKING

`Static`WHEEL_UPDATE_SCOPES

`Static`defaultOptions

`Protected`_canDragDrop

`Abstract`_onChange

`Protected`_onClick

`Protected`_onClickAction

`Protected`_onContext

`Protected`_onContextAction

`Protected`_onDropGeneric

`Protected`_onFinishWheelUpdate