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

    Class ActorSheetPF

    Abstract actor sheet for all actor types.

    Hierarchy (View Summary)

    Index

    General

    _activeEdits _filters _hiddenElems _itemUpdates actor constructor document INPUT_LOCKOUT PARTS isEdit isLocked isPlay isView itemValueDenomination mode _addItemsValue _adjustNewItem _adjustReplacementItem _alterDropItemData _applySectionFilter _configureRenderOptions _editSkill _filterSection _focusTabByItem _getItemRemovalConsequences _getTooltipContext _interactionBlock _onActivateSimpleTooltip _onChange _onChangeInput _onCommitSpanTextInput _onFinishWheelUpdate _onSpanTextInput _onWeightTooltip _preCommitSpanTextValue _prepareDuplicateItem _prepareHiddenElements _prepareItemForSection _prepareItems _prepareSection _prepareSenseLabels _replaceItem _toggleItemSummary calculateSellItemValue calculateTotalItemValue _convertCurrency _onToggleMode _prepareItem

    Containers

    _onContainerDrop

    General

    Internal_activeEdits

    _activeEdits: Record<string, string> = {}

    Internal_filters

    _filters: Record<string, Record<string, Set<string>>> = ...

    Track the set of item filters which are applied

    Internal_hiddenElems

    _hiddenElems: Record<string, boolean> = {}

    Track hidden elements of the sheet.

    Internal_itemUpdates

    _itemUpdates: object[] = []

    Track item updates from the actor sheet.

    actor: ActorPF
    constructor: typeof ActorSheetPF
    document: ActorPF
    INPUT_LOCKOUT: number = 150

    Small delay to prevent click-through, such as from opening the sheet from a token with triple click (e.g. faulty mouse or user)

    PARTS: {
        form: {
            root: boolean;
            scrollable: string[];
            template: null;
            templates: string[];
        };
    } = ...
    • get isEdit(): boolean

      Returns boolean

    • get isLocked(): boolean

      Returns boolean

    • get isPlay(): boolean

      Returns boolean

    • get isView(): boolean

      Returns boolean

    • get itemValueDenomination(): "gp" | "cp" | "pp" | "sp"

      Which currency denomination to use for items

      Returns "gp" | "cp" | "pp" | "sp"

    • get mode(): SheetMode

      Sheet Mode

      Returns SheetMode

    _addItemsValue

    • _addItemsValue(context: any, valueAdjust?: number): void

      Parameters

      • context: any
      • valueAdjust: number = 0

      Returns void

    _adjustNewItem

    • _adjustNewItem(item: ItemPF<BaseItemModel>, data: any): void
      Internal

      Adjust item before addition, overriding data

      Parameters

      Returns void

    Protected_adjustReplacementItem

    • _adjustReplacementItem(
          itemData: object,
          sourceItem: ItemPF<BaseItemModel>,
      ): void
      Protected

      Given an object that will later update the item to create and a existent item in the actor, this function will make sure some relevant properties are kept the same by inheriting the current state from source item.

      Parameters

      • itemData: object

        The data that will later update the item to create.

      • sourceItem: ItemPF<BaseItemModel>

        The existent item in the actor.

      Returns void

      ActorSheetPF#_onDropItem.

    _alterDropItemData

    • _alterDropItemData(data: object, source: ItemPF<BaseItemModel>): void
      Internal

      Parameters

      Returns void

    _applySectionFilter

    • _applySectionFilter(item: any, section: object): boolean
      Internal

      Filters item by sheet section config.

      Parameters

      • item: any

        Item to filter

      • section: object

        Section to filter by

      Returns boolean

    _configureRenderOptions

    • _configureRenderOptions(options: any): void

      Parameters

      • options: any

      Returns void

    _editSkill

    • _editSkill(skillId: string, subSkillId?: string): Promise<void>

      Opens a dialog to edit a skill.

      Parameters

      • skillId: string

        The id of the skill in question.

      • OptionalsubSkillId: string

        The id of the subskill, if appropriate.

      Returns Promise<void>

    _filterSection

    • _filterSection(
          category: object,
          section: SectionData,
          filters: Set<string>,
      ): void
      Internal

      Filter inventory section

      Called in ()

      Parameters

      • category: object

        Category data

      • section: SectionData

        Section data

      • filters: Set<string>

        Active filters

      Returns void

    Protected Abstract_focusTabByItem

    • _focusTabByItem(item: any): void
      Protected

      Focuses certain tab based on provided item.

      Parameters

      • item: any

        Item document or raw data for such

      Returns void

    Protected_getItemRemovalConsequences

    • _getItemRemovalConsequences(
          item: ItemPF<BaseItemModel>,
      ): { name: string; type: string; uuid: string }[]
      Protected

      Given an item, it returns a list of items that will be removed alongside.

      Parameters

      Returns { name: string; type: string; uuid: string }[]

      List of items that will be also removed.

    Protected_getTooltipContext

    • _getTooltipContext(fullId: string, context: SourceTooltipContext): Promise<void>
      Protected

      Parameters

      Returns Promise<void>

      • If provided ID is invalid.

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

    _onActivateSimpleTooltip

    • _onActivateSimpleTooltip(event: PointerEvent, target: HTMLElement): boolean
      Experimental

      Dynamic Tooltips

      Parameters

      • event: PointerEvent
      • target: HTMLElement

      Returns boolean

    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.

    _onChangeInput

    • _onChangeInput(event: any): void

      Parameters

      • event: any

      Returns void

    _onCommitSpanTextInput

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

      Submit input value

      Parameters

      • event: Event
      • target: HTMLElement
      • OptionalnewValue: any

      Returns Promise<void>

    Protected_onFinishWheelUpdate

    • _onFinishWheelUpdate(target: HTMLElement): object | undefined
      Protected

      Finalize Wheel Update

      Parameters

      • target: HTMLElement

      Returns object | undefined

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

    Protected_onSpanTextInput

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

      Handle input

      Parameters

      • event: PointerEvent

        Triggering event

      • target: HTMLElement

      Returns void

    _onWeightTooltip

    • _onWeightTooltip(event: PointerEvent, target: HTMLElement): Promise<void>
      Experimental

      Weight Tooltips

      Parameters

      • event: PointerEvent
      • target: HTMLElement

      Returns Promise<void>

      Convert into extended tooltip?

    Protected_preCommitSpanTextValue

    • _preCommitSpanTextValue(
          name: string,
          value: number,
          str: string,
          el: HTMLElement,
      ): any
      Protected

      Alter span text value before committing.

      Parameters

      • name: string

        Update path

      • value: number

        Numeric value

      • str: string

        Original string from input

      • el: HTMLElement

        Input element

      Returns any

    _prepareDuplicateItem

    • _prepareDuplicateItem(
          itemData: object,
          options?: { original?: ItemPF<BaseItemModel>; rename?: boolean },
      ): void

      Prepare duplicate item data

      Parameters

      Returns void

    _prepareHiddenElements

    • _prepareHiddenElements(): void

      Returns void

    Protected_prepareItemForSection

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

      Parameters

      • item: object

        Item render data

      • section: object

        Item section

      • context: object

        Render context

      Returns void

    Protected_prepareItems

    • _prepareItems(context: object): void
      Protected

      Organize and classify Owned Items

      Parameters

      • context: object

        Render context

      Returns void

    Protected_prepareSection

    • _prepareSection(section: object): void
      Protected

      Prepare item section

      Parameters

      • section: object

      Returns void

    _prepareSenseLabels

    • _prepareSenseLabels(): {}

      Returns {}

    _replaceItem

    • _replaceItem(itemData: object, sourceItem: ItemPF<BaseItemModel>): boolean

      Replace Item Handling

      Parameters

      Returns boolean

      • True if this function handled the item, false otherwise.

    Protected_toggleItemSummary

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

      Toggle inline display of an item's summary/description by expanding or hiding info div

      Parameters

      • event: any
      • elem: HTMLElement

        The element to open. Likely will have the item class in CSS.

      • root0: { animation?: boolean } = {}

      Returns Promise<void>

    • Parameters

      • __namedParameters: { inLowestDenomination?: boolean; recursive?: boolean } = {}

      Returns number

    • Parameters

      • __namedParameters: { inLowestDenomination?: boolean; recursive?: boolean } = {}

      Returns any

    Static_convertCurrency

    • _convertCurrency(
          category?: "currency" | "altCurrency",
          type?: "gp" | "cp" | "pp" | "sp",
      ): Promise<any> | undefined
      Internal

      Converts currencies of the given category to the given currency type

      Parameters

      • Optionalcategory: "currency" | "altCurrency" = "currency"

        Currency category, altCurrency is for weightless

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

        Target currency.

      Returns Promise<any> | undefined

      Updated document or undefined if no update occurred.

      pf1.utils.currency.convert

    Static_onToggleMode

    • _onToggleMode(
          this: ActorSheetPF,
          event: PointerEvent,
          target: HTMLElement,
      ): void

      Parameters

      Returns void

    Protected Static_prepareItem

    • _prepareItem(item: ItemPF<BaseItemModel>): object
      Protected

      Prepare item data for display.

      Parameters

      Returns object

      • Data fed to the sheet

    Containers

    _onContainerDrop

    • _onContainerDrop(event: Event, item: ItemPF<ContainerModel>): Promise<void>
      Internal

      Handle container drop

      Parameters

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    General
    Containers