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

    Class ActorSheetPFCharacter

    An Actor sheet for player character type actors in the PF system. Extends the base ActorSheetPF class.

    Hierarchy (View Summary)

    Index

    Properties

    _activeEdits _filters _hiddenElems _itemUpdates _skillsLocked _skillsLocked

    Accessors

    currentPrimaryTab currentSpellbookKey itemValueDenomination template

    Methods

    _adjustNewItem _alterDropItemData _applySectionFilter _canShowRange _commitSpanTextInputValue _disableFields _editSkill _filterSection _focusTabByItem _getTooltipContext _onActivateSimpleTooltip _onChange _onChangeInput _onClick _onContext _onContextAction _onFinishWheelUpdate _onPointerEnter _onPointerLeave _onSpanTextInput _onWeightTooltip _preCommitSpanTextValue _prepareDuplicateItem _prepareEncumbrance _prepareHiddenElements _prepareItem _prepareItemForSection _prepareItems _prepareSection _prepareSenseLabels _prepareSkills _prepareSkillsets _prepareSpellbook _toggleItemSummary calculateSellItemValue calculateTotalItemValue

    Properties

    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.

    Internal_skillsLocked

    _skillsLocked: boolean = true

    Whether the skills are currently locked.

    Static_skillsLocked

    _skillsLocked: any

    Accessors

    • get currentPrimaryTab(): null | string

      Returns null | string

    • get currentSpellbookKey(): string

      Returns string

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

      Which currency denomination to use for items

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

    • get template(): string

      Get the correct HTML template path to use for rendering this particular sheet

      Returns string

    Methods

    _adjustNewItem

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

      Adjust item before addition, overriding data

      Parameters

      • item: ItemPF

        Temporary item document before creation

      • data: any

      Returns void

    _alterDropItemData

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

      Parameters

      • data: object

        Item data

      • source: ItemPF

        Source item

      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

    Protected_canShowRange

    • _canShowRange(item: Item<"base" | ModuleSubType>): boolean
      Protected

      Determine if the item can have its range shown on this sheet.

      Parameters

      • item: Item<"base" | ModuleSubType>

      Returns boolean

    _commitSpanTextInputValue

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

      Submit input value

      Parameters

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

      Returns Promise<void>

    _disableFields

    • _disableFields(form: HTMLElement): void

      Parameters

      • form: HTMLElement

      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

    _focusTabByItem

    • _focusTabByItem(item: object | Item<"base" | ModuleSubType>): void
      Internal

      Focuses certain tab based on provided item.

      Parameters

      • item: object | Item<"base" | ModuleSubType>

        Item document or raw data for such

      Returns void

    Protected_getTooltipContext

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

      Parameters

      • fullId: string

        Target ID

      • context: object

        Context object to store data into

      Returns Promise<void>

      • If provided ID is invalid.

    _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

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

    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

    _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

    Protected_onSpanTextInput

    • _onSpanTextInput(
          event: PointerEvent,
          target: HTMLElement,
          callback: Function,
      ): any
      Protected

      Handle input

      Parameters

      • event: PointerEvent

        Triggering event

      • target: HTMLElement
      • callback: Function

        Submission handler

      Returns any

    _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): any
      Protected

      Alter span text value before committing.

      Parameters

      • name: string

        Update path

      • value: number

        Numeric value

      • str: string

        Original string from input

      Returns any

    _prepareDuplicateItem

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

      Prepare duplicate item data

      Parameters

      • itemData: object
      • options: { original?: ItemPF; rename?: boolean } = {}

      Returns void

    Protected_prepareEncumbrance

    • _prepareEncumbrance(): object
      Protected

      Prepare encumbrance data for display

      Returns object

      • An object describing the character's encumbrance level

    _prepareHiddenElements

    Protected_prepareItem

    • _prepareItem(item: ItemPF): object
      Protected

      Prepare item data for display.

      Parameters

      • item: ItemPF

        Original document

      Returns object

      • Data fed to the sheet

    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

    _prepareSkills

    • _prepareSkills(context: object): void
      Internal

      Calculate used and available skill ranks.

      Parameters

      • context: object

        HBS context

      Returns void

    _prepareSkillsets

    • _prepareSkillsets(context: object): void
      Internal

      Prepare adventure/background skill distinction if needed.

      Parameters

      • context: object

      Returns void

    _prepareSpellbook

    • _prepareSpellbook(data: object, spells: any[], bookKey: string): object
      Internal

      Insert a spell into the spellbook object when rendering the character sheet

      Parameters

      • data: object

        The Actor data being prepared

      • spells: any[]

        The spell data being prepared

      • bookKey: string

        The key of the spellbook being prepared

      Returns object

      • Spellbook data

    Protected_toggleItemSummary

    • _toggleItemSummary(elem: HTMLElement, animation?: boolean): Promise<void>
      Protected

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

      Parameters

      • elem: HTMLElement

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

      • Optionalanimation: boolean = {}

        Whether to animate expansion and collapse or not.

      Returns Promise<void>

    • Parameters

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

      Returns number

    • Parameters

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

      Returns number

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods