Pathfinder 1e for Foundry VTT
    Preparing search index...

    Class ItemSheetPF

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

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _activeEdits item _warnedAppV1 ACTIONS BASE_APPLICATION EDIT_TRACKING WHEEL_UPDATE_SCOPES

    Accessors

    abortSignal

    Methods

    _commitSpanTextInputValue _getContentSources _getSidebarTooltipContent _getUniqueActionName _initializeActions _onChange _onChangeDrop _onClick _onContext _onContextAction _onDisplaySidebarTooltip _onDragStart _onFinishWheelUpdate _onHoverPriceTooltip _onHoverWeightTooltip _onItemDrop _onLinksDrop _onOpenChangeMenu _onPointerEnter _onPointerLeave _onPostRender _onSpanTextInput _onTextDrop _prepareAlignments _prepareContentSource _prepareItemFlags _prepareLinks _prepareScriptCalls _selectContentSource _validateFormula _onDeleteCardNote _onDeleteResource _onDuplicateChange _onEditChange inheritanceChain

    Constructors

    • Parameters

      • ...args: any[]

      Returns ItemSheetPF

    Properties

    Internal_activeEdits

    _activeEdits: Record<string, string> = {}
    item: ItemPF

    Static_warnedAppV1

    _warnedAppV1: boolean = true
    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;
        deleteResource: (event: any, _target: any) => Promise<any>;
        deleteScriptCall: Object;
        dupeAction: Object;
        dupeChange: (
            ...this: any,
            event: PointerEvent,
            target: HTMLElement,
        ) => void;
        editAction: Object;
        editChange: (
            ...this: any,
            event: PointerEvent,
            target: HTMLElement,
        ) => void;
        editEntries: 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
    • deleteResource: (event: any, _target: any) => Promise<any>
    • deleteScriptCall: Object
    • dupeAction: Object
    • dupeChange: (...this: any, event: PointerEvent, target: HTMLElement) => void
    • editAction: Object
    • editChange: (...this: any, event: PointerEvent, target: HTMLElement) => void
    • editEntries: 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
    BASE_APPLICATION: typeof ItemSheetPF = ...

    Remove with AppV2 conversion

    EDIT_TRACKING: string[] = ...

    Which fields to track edits for

    WHEEL_UPDATE_SCOPES: string[] = ...

    Accessors

    • get abortSignal(): any

      Returns any

    Methods

    _commitSpanTextInputValue

    • _commitSpanTextInputValue(event: Event, target: HTMLElement): Promise<void>
      Internal

      Submit input value

      Parameters

      • event: Event
      • target: HTMLElement

      Returns Promise<void>

    _getContentSources

    • _getContentSources(): object[]

      Returns object[]

    _getSidebarTooltipContent

    • _getSidebarTooltipContent(event: PointerEvent, target: HTMLElement): string
      Internal

      Get Sidebar Tooltip Content

      Parameters

      • event: PointerEvent
      • target: HTMLElement

      Returns string

    _getUniqueActionName

    • _getUniqueActionName(base: string): string
      Internal

      Get Unique Action Name

      Parameters

      • base: string

      Returns string

    _initializeActions

    • _initializeActions(): void
      Internal

      Returns void

      Remove with AppV2 conversion

    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.

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

    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

    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

    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.

    _onDisplaySidebarTooltip

    • _onDisplaySidebarTooltip(
          event: PointerEvent,
          target: HTMLElement,
      ): Promise<void>
      Internal

      Open sidebar tooltip

      Parameters

      • event: PointerEvent
      • target: HTMLElement

      Returns Promise<void>

    _onDragStart

    • _onDragStart(event: DragEvent): void
      Internal

      Override of drag start event handler

      Parameters

      • event: DragEvent

      Returns void

    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

    _onHoverPriceTooltip

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

      Parameters

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

      Returns void

    _onHoverWeightTooltip

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

      Parameters

      • event: any
      • content: any

      Returns void

    _onItemDrop

    • _onItemDrop(event: Event, srcDoc: ItemPF, dropData: object): Promise<void>

      Handle item drop events

      Parameters

      • event: Event

        The originating drop event

      • srcDoc: ItemPF

        The dropped item document

      • dropData: object

        The drop data

      Returns Promise<void>

    _onLinksDrop

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

      Handle drop into links

      Parameters

      • event: DragEvent
      • data: object

      Returns Promise<void>

    _onOpenChangeMenu

    • _onOpenChangeMenu(event: PointerEvent): Promise<void>
      Internal

      Open static tooltip for a Change

      Parameters

      • event: PointerEvent

      Returns Promise<void>

    _onPointerEnter

    • _onPointerEnter(event: PointerEvent): void
      Internal

      Pointer Enter event handler delegate

      Parameters

      • event: PointerEvent

      Returns void

    _onPointerLeave

    • _onPointerLeave(event: PointerEvent): void
      Internal

      Pointer Leave event handler delegate

      Parameters

      • event: PointerEvent

      Returns void

    _onPostRender

    • _onPostRender(html: HTMLElement): Promise<void>
      Internal

      Post-Render handling

      Sheet handling that is not needed for rendering

      Parameters

      • html: HTMLElement

      Returns Promise<void>

    _onSpanTextInput

    • _onSpanTextInput(
          event: PointerEvent,
          target: HTMLElement,
          callback: Function,
      ): void
      Internal

      Edit input

      Parameters

      • event: PointerEvent
      • target: HTMLElement
      • callback: Function

      Returns void

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

    _prepareAlignments

    • _prepareAlignments(): {}

      Returns {}

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

    _prepareScriptCalls

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

      Parameters

      • context: any

      Returns Promise<void>

    _selectContentSource

    • _selectContentSource(sources: any): any

      Parameters

      • sources: any

      Returns any

    _validateFormula

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

      Validate input formula for basic errors.

      Parameters

      • el: HTMLElement

      Returns Promise<void>

    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>

    Static_onDeleteResource

    • _onDeleteResource(event: any, _target: any): Promise<any>

      Parameters

      • event: any
      • _target: any

      Returns Promise<any>

    Static_onDuplicateChange

    • _onDuplicateChange(...this: any, event: PointerEvent, target: HTMLElement): void

      Duplicate Change

      Parameters

      • ...this: any
      • event: PointerEvent
      • target: HTMLElement

      Returns void

    Static_onEditChange

    • _onEditChange(...this: any, event: PointerEvent, target: HTMLElement): void
      Internal

      Edit Change

      Parameters

      • ...this: any
      • event: PointerEvent

        Click event

      • target: HTMLElement

      Returns void

    • Copy of AppV2 function

      Returns Generator<typeof ItemSheetPF, void, unknown>

      Remove with AppV2 conversion

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods