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

    Class ContainerSheetPF

    Sheet for container type items.

    Hierarchy (View Summary)

    Index

    Properties

    item PRELOAD_TEMPLATES SHEET_CONFIG WHEEL_UPDATE_SCOPES

    Accessors

    abortSignal canShowSource showIdentified

    Methods

    _addSidebarFields _applySectionFilter _convertCurrency _getContentSources _getSidebarTooltipContent _getUniqueActionName _interactionBlock _onChange _onCommitSpanTextInput _onDisplaySidebarTooltip _onDragStart _onDropChange _onDropLink _onDropText _onFinishWheelUpdate _onHoverPriceTooltip _onHoverWeightTooltip _onOpenChangeMenu _onPostRender _onSortItem _onSpanTextInput _prepareAlignments _prepareContents _prepareContentSource _prepareItemFlags _prepareItemForSection _prepareLinks _prepareScriptCalls _relativeInput _selectContentSource _toggleItemSummary _validateFormula _onConvertCurrency _onDeleteCardNote _onDeleteResource _onDuplicateChange _onEditChange

    Properties

    item: ItemPF
    PRELOAD_TEMPLATES: string[] = ...
    SHEET_CONFIG: { makeDefault: boolean; types: string[] } = ...
    WHEEL_UPDATE_SCOPES: string[] = ...

    Accessors

    • get abortSignal(): any

      Returns any

    • get canShowSource(): boolean

      Returns boolean

    • get showIdentified(): any

      Returns any

    Methods

    _addSidebarFields

    • _addSidebarFields(context: any): void

      Populate sidebar fields.

      Parameters

      • context: any

      Returns void

    _applySectionFilter

    • _applySectionFilter(
          item: Item<"base" | ModuleSubType>,
          section: object,
      ): boolean
      Internal

      Filters item by sheet section config.

      Parameters

      • item: Item<"base" | ModuleSubType>

        Item to filter

      • section: object

        Section to filter by

      Returns boolean

    _convertCurrency

    • _convertCurrency(
          type?: "gp" | "cp" | "pp" | "sp",
          options?: { interactive?: boolean },
      ): Promise<ContainerSheetPF>
      Internal

      Converts currencies to the given currency type

      Parameters

      • type: "gp" | "cp" | "pp" | "sp" = "pp"

        Converts as much currency as possible to this type.

      • Optionaloptions: { interactive?: boolean } = {}

        Additional options

        • Optionalinteractive?: boolean

          Was this from user interaction?

      Returns Promise<ContainerSheetPF>

      The updated item

    _getContentSources

    _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

    _interactionBlock

    • _interactionBlock(event: PointerEvent): boolean
      Internal

      Test if interaction should be blocked to eliminate doubleclicks or similar.

      Parameters

      • event: PointerEvent

      Returns boolean

      • True if should lock, false otherwise.

    _onChange

    • _onChange(event: any, target: any): boolean

      Nameless Change Event

      Handler for any change event that did not target an element with name.

      Parameters

      • event: any
      • target: any

      Returns boolean

      • True if the change was handled, false otherwise.

    _onCommitSpanTextInput

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

      Submit input value

      Parameters

      • event: Event
      • target: HTMLElement

      Returns Promise<void>

    _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

      Parameters

      • event: DragEvent

      Returns void

    _onDropChange

    • _onDropChange(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>

    _onDropLink

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

      Handle drop into links

      Parameters

      • event: DragEvent
      • data: object

      Returns Promise<void>

    _onDropText

    • _onDropText(event: DragEvent, dropData: object): Promise<undefined>
      Internal

      Handle dropping content-linkable data to <textarea> or text <input>

      Parameters

      • event: DragEvent
      • dropData: object

      Returns Promise<undefined>

    _onFinishWheelUpdate

    • _onFinishWheelUpdate(target: any): object | undefined

      Finalize Wheel Update

      Parameters

      • target: any

      Returns object | undefined

      • object with wheel element info, undefined if this is not valid element

    _onHoverPriceTooltip

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

      Parameters

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

      Returns Promise<void>

    _onHoverWeightTooltip

    • _onHoverWeightTooltip(event: any, content: any): Promise<void>

      Parameters

      • event: any
      • content: any

      Returns Promise<void>

    _onOpenChangeMenu

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

      Open static tooltip for a Change

      Parameters

      • event: PointerEvent

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

    _onSortItem

    • _onSortItem(event: any, itemData: any): any

      Parameters

      • event: any
      • itemData: any

      Returns any

    _onSpanTextInput

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

      Edit input

      Parameters

      • event: PointerEvent
      • target: HTMLElement

      Returns void

    _prepareAlignments

    Protected_prepareContents

    • _prepareContents(context: object): void
      Protected

      Parameters

      • context: object

        Render context

      Returns void

    _prepareContentSource

    _prepareItemFlags

    • _prepareItemFlags(context: any): void

      Parameters

      • context: any

      Returns void

    _prepareItemForSection

    • _prepareItemForSection(item: object, section: object, context: object): void
      Internal

      Parameters

      • item: object

        Item render data

      • section: object

        Section configuration

      • context: object

        Render context

      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>

    Protected_relativeInput

    • _relativeInput(
          name: string,
          key: string,
          updateData: object,
          options?: {
              current?: any;
              decimals?: number;
              fallback?: number | null;
              max?: number;
              min?: number;
          },
      ): void
      Protected

      Handle relative input

      Parameters

      • name: string

        Input name property

      • key: string

        Path

      • updateData: object

        Update data

      • Optionaloptions: {
            current?: any;
            decimals?: number;
            fallback?: number | null;
            max?: number;
            min?: number;
        } = {}

        Additional options

        • Optionalcurrent?: any

          Current value

        • Optionaldecimals?: number

          Allowed decimal precision

        • Optionalfallback?: number | null

          Fallback value for odd values

        • Optionalmax?: number

          Maximum allowed value

        • Optionalmin?: number

          Minimum allowed value

      Returns void

    _selectContentSource

    _toggleItemSummary

    • _toggleItemSummary(
          event: any,
          elem: HTMLElement,
          options?: { animation?: boolean },
      ): Promise<void>
      Internal

      Toggle Item Summary

      Parameters

      • event: any
      • elem: HTMLElement
      • Optionaloptions: { animation?: boolean } = {}

        Additional options

      Returns Promise<void>

    _validateFormula

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

      Validate input formula for basic errors.

      Parameters

      • el: HTMLElement

      Returns Promise<void>

    Static_onConvertCurrency

    • _onConvertCurrency(
          this: ContainerSheetPF,
          event: PointerEvent,
          target: HTMLElement,
      ): Promise<void>
      Internal

      Convert Currency

      Parameters

      Returns Promise<void>

    Static_onDeleteCardNote

    • _onDeleteCardNote(
          this: ItemSheetPF,
          event: PointerEvent,
          target: HTMLElement,
      ): Promise<unknown>
      Internal

      Control effect notes and footnotes

      Parameters

      • this: ItemSheetPF
      • event: PointerEvent
      • target: HTMLElement

      Returns Promise<unknown>

    Static_onDeleteResource

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

      Parameters

      • event: any
      • _target: any

      Returns Promise<void>

    Static_onDuplicateChange

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

      Duplicate Change

      Parameters

      • this: ItemSheetPF
      • event: PointerEvent
      • target: HTMLElement

      Returns void

    Static_onEditChange

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

      Edit Change

      Parameters

      • this: ItemSheetPF
      • event: PointerEvent

        Click event

      • target: HTMLElement

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods