Class ActorSheetPF

_commitItemUsesBound

effectiveSearch

searchCompositioning

searchDelay

searchDelayEvent

searchRefresh

currentPrimaryTab

• get currentPrimaryTab(): null | string

• Returns null | string

currentSpellbookKey

• get currentSpellbookKey(): string

• Returns string

StaticdefaultOptions

• get defaultOptions(): {
      classes: string[];
      dragDrop: {
          dragSelector: string;
      }[];
      scrollY: string[];
      tabs: {
          contentSelector: string;
          group: string;
          initial: string;
          navSelector: string;
      }[];
  }

• Returns {
      classes: string[];
      dragDrop: {
          dragSelector: string;
      }[];
      scrollY: string[];
      tabs: {
          contentSelector: string;
          group: string;
          initial: string;
          navSelector: string;
      }[];
  }

  • classes: string[]

  • dragDrop: {
        dragSelector: string;
    }[]

  • scrollY: string[]

  • tabs: {
        contentSelector: string;
        group: string;
        initial: string;
        navSelector: string;
    }[]

_adjustActorPropertyBySpan

• _adjustActorPropertyBySpan(event, oldEl): Promise<void>

• Parameters

  • event: any
  • oldEl: any

  Returns Promise<void>

_adjustNewItem

• _adjustNewItem(item, data): void
• Internal

  Adjust item before addition, overriding data

  Parameters

  • item: ItemPF

    Temporary item document before creation
  • data: any

  Returns void

_alterDropItemData

• _alterDropItemData(data, source): void
• Internal

  Parameters

  • data: object

    Item data
  • source: ItemPF

    Source item

  Returns void

_applySectionFilter

• _applySectionFilter(item, section): boolean
• Internal

  Filters item by sheet section config.

  Parameters

  • item: Item

    Item to filter
  • section: object

    Section to filter by

  Returns boolean

_canDragStart

• _canDragStart(selector): boolean

• Allow drag start always. Foundry blocks this if sheet is not editable, which blocks copying items.

  Parameters

  • selector: string

    Selector string

  Returns boolean

_commitItemUses

• _commitItemUses(event): Promise<any>
• Internal

  Commit changes from _setItemUses

  Parameters

  • event: Event

  Returns Promise<any>

_convertCurrency

• _convertCurrency(event): void

• Parameters

  • event: any

  Returns void

_createPlaceholders

• _createPlaceholders(html): void

• Parameters

  • html: any

  Returns void

_disableFields

• _disableFields(form): void

• Parameters

  • form: HTMLElement

  Returns void

_duplicateItem

• _duplicateItem(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_editSkill

• _editSkill(skillId, subSkillId?): 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>

_focusTabByItem

• _focusTabByItem(item): void
• Internal

  Focuses certain tab based on provided item.

  Parameters

  • item: any

  Returns void

_hideShowElement

• _hideShowElement(event): void

• Parameters

  • event: any

  Returns void

_itemActivationControl

• _itemActivationControl(event): void

• Activate an item from item control button.

  Parameters

  • event: MouseEvent

    Click event

  Returns void

_itemPreparedToggle

• _itemPreparedToggle(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_mouseWheelAdd

• _mouseWheelAdd(event, el): void

• Parameters

  • event: any
  • el: any

  Returns void

_onArbitrarySkillCreate

• _onArbitrarySkillCreate(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onControlAlignment

• _onControlAlignment(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onDragMiscStart

• _onDragMiscStart(event, type, subType?): void

• Parameters

  • event: DragEvent

    Drag start event
  • type:
        | "attack"
        | "bab"
        | "cmb"
        | "concentration"
        | "cl"
        | "defenses"
        | "initiative"
        | "abilityScore"
  • OptionalsubType: string

    Type specific subtype

  Returns void

_onDragSaveStart

• _onDragSaveStart(event, type): void

• Parameters

  • event: any
  • type: any

  Returns void

_onDragSkillStart

• _onDragSkillStart(event): void
• Internal

  Parameters

  • event: DragEvent

    Drag start event

  Returns void

_onDragStart

• _onDragStart(event): void

• Parameters

  • event: any

  Returns void

_onDropCurrency

• _onDropCurrency(event, data): Promise<unknown>

• Parameters

  • event: any
  • data: any

  Returns Promise<unknown>

_onDropItem

• _onDropItem(event, data): Promise<undefined | ItemPF[] | StoredDocument<Document<any, ActorPF, Metadata<any>>>[]>

• Parameters

  • event: any
  • data: any

  Returns Promise<undefined | ItemPF[] | StoredDocument<Document<any, ActorPF, Metadata<any>>>[]>

_onDropItemCreate

• _onDropItemCreate(itemData): Promise<StoredDocument<Document<any, ActorPF, Metadata<any>>>[]>

• Handle the final creation of dropped Item data on the Actor. This method is factored out to allow downstream classes the opportunity to override item creation behavior.

  Parameters

  • itemData: any

    The item data requested for creation

  Returns Promise<StoredDocument<Document<any, ActorPF, Metadata<any>>>[]>

_onEditCondition

• _onEditCondition(event): Promise<undefined>

• Parameters

  • event: any

  Returns Promise<undefined>

_onItemGive

• _onItemGive(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onItemSplit

• _onItemSplit(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onLevelUp

• _onLevelUp(event): Promise<undefined | null | Item>

• Parameters

  • event: any

  Returns Promise<undefined | null | Item>

_onPointBuyCalculator

• _onPointBuyCalculator(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onRest

• _onRest(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onRollAttack

• _onRollAttack(event): void
• Internal

  Parameters

  • event: Event

  Returns void

_onRollBAB

• _onRollBAB(event): void

• Parameters

  • event: any

  Returns void

_onRollCL

• _onRollCL(event): void

• Parameters

  • event: any

  Returns void

_onRollConcentration

• _onRollConcentration(event): void

• Parameters

  • event: any

  Returns void

_onRollInitiative

• _onRollInitiative(event): void

• Parameters

  • event: any

  Returns void

_onRollSavingThrow

• _onRollSavingThrow(event): void

• Parameters

  • event: any

  Returns void

_onSensesSelector

• _onSensesSelector(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onSkillCreate

• _onSkillCreate(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onSkillDelete

• _onSkillDelete(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onSkillEdit

• _onSkillEdit(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onSubmit

• _onSubmit(event, __namedParameters?): Promise<void>

• Handle standard form submission steps

  Parameters

  • event: any

    The submit event which triggered this handler
  • __namedParameters: {
        preventClose: undefined | boolean;
        preventRender: undefined | boolean;
        updateData: undefined | null;
    } = {}

    • preventClose: undefined | boolean

    • preventRender: undefined | boolean

    • updateData: undefined | null

  Returns Promise<void>

  A promise which resolves to the validated update data

_onToggleCondition

• _onToggleCondition(event): undefined

• Parameters

  • event: any

  Returns undefined

_onToggleSkillLock

• _onToggleSkillLock(event): void

• Toggle skill lock.

  Parameters

  • event: MouseEvent

  Returns void

_prepareDuplicateItem

• _prepareDuplicateItem(itemData, __namedParameters?): void

• Parameters

  • itemData: any
  • __namedParameters: {
        rename: undefined | boolean;
    } = {}

    • rename: undefined | boolean

  Returns void

_prepareHiddenElements

• _prepareHiddenElements(): void

• Returns void

_prepareSenseLabels

• _prepareSenseLabels(): {}

• Returns {}

_prepareSkills

• _prepareSkills(context): void
• Internal

  Calculate used and available skill ranks.

  Parameters

  • context: object

    HBS context

  Returns void

_prepareSkillsets

• _prepareSkillsets(context): void
• Internal

  Prepare adventure/background skill distinction if needed.

  Parameters

  • context: object

  Returns void

_prepareSpellbook

• _prepareSpellbook(data, spells, bookKey): 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

_prepareTraits

• _prepareTraits(traits): void

• Parameters

  • traits: any

  Returns void

_quickAction

• _quickAction(event): undefined | Promise<void | ActionUse | SharedActionData>

• Parameters

  • event: any

  Returns undefined | Promise<void | ActionUse | SharedActionData>

_quickCarryItem

• _quickCarryItem(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_quickChangeItemQuantity

• _quickChangeItemQuantity(event, add?): Promise<void>

• Parameters

  • event: any
  • add: number = 1

  Returns Promise<void>

_quickEquipItem

• _quickEquipItem(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_quickIdentifyItem

• _quickIdentifyItem(event): Promise<undefined>

• Parameters

  • event: any

  Returns Promise<undefined>

_render

• _render(...args): Promise<void>

• Parameters

  • Rest...args: any[]

  Returns Promise<void>

_renderInner

• _renderInner(...args): Promise<JQuery<HTMLElement>>

• Parameters

  • Rest...args: any[]

  Returns Promise<JQuery<HTMLElement>>

_searchFilterChange

• _searchFilterChange(event): void

• Parameters

  • event: any

  Returns void

_searchFilterCommit

• _searchFilterCommit(event): void

• Parameters

  • event: any

  Returns void

_searchFilterCompositioning

• _searchFilterCompositioning(event): void

• Parameters

  • event: any

  Returns void

_selectOnClick

• _selectOnClick(event): void

• Parameters

  • event: any

  Returns void

_setBuffLevel

• _setBuffLevel(event): void

• Parameters

  • event: any

  Returns void

_setItemActive

• _setItemActive(event): void

• Parameters

  • event: any

  Returns void

_setItemUses

• _setItemUses(event): void

• Parameters

  • event: any

  Returns void

_setMaxSpellUses

• _setMaxSpellUses(event): void

• Parameters

  • event: any

  Returns void

_setSpellUses

• _setSpellUses(event): void

• Parameters

  • event: any

  Returns void

_updateItems

• _updateItems(): Promise<void>

• Returns Promise<void>

_updateObject

• _updateObject(event, formData): Promise<unknown>

• Parameters

  • event: any
  • formData: any

  Returns Promise<unknown>

activateListeners

• activateListeners(html): void

• Activate event listeners using the prepared sheet HTML

  Parameters

  • html: JQuery<HTMLElement>

    The prepared HTML object ready to be rendered into the DOM

  Returns void

calculateSellItemValue

• calculateSellItemValue(__namedParameters?): number

• Parameters

  • __namedParameters: {
        inLowestDenomination: undefined | boolean;
        recursive: undefined | boolean;
    } = {}

    • inLowestDenomination: undefined | boolean

    • recursive: undefined | boolean

  Returns number

calculateTotalItemValue

• calculateTotalItemValue(__namedParameters?): number

• Parameters

  • __namedParameters: {
        inLowestDenomination: undefined | boolean;
        recursive: undefined | boolean;
    } = {}

    • inLowestDenomination: undefined | boolean

    • recursive: undefined | boolean

  Returns number

getData

• getData(): Promise<{
      actor: ActorPF;
      choices: {};
      config: config;
      cssClass: string;
      document: ActorPF;
      editable: boolean;
      effects: EmbeddedCollection<typeof ActiveEffect, ActorData>;
      hasHD: boolean;
      isCharacter: boolean;
      isGM: boolean;
      itemTypes: ItemTypesMap;
      limited: boolean;
      options: Options;
      owner: boolean;
      race: null | PropertiesToSource<ItemDataBaseProperties>;
      skillsLocked: boolean;
      sourceData: {};
      unchainedActions: unknown;
      units: {
          distance: {
              overland: "PF1.Distance.miShort" | "PF1.Distance.kmShort";
              tactical: "PF1.Distance.ftShort" | "PF1.Distance.mShort";
          };
          weight: string;
      };
      usesAnySpellbook: boolean;
  }>

• Add some extra data when rendering the sheet to reduce the amount of logic required within the template.

  Returns Promise<{
      actor: ActorPF;
      choices: {};
      config: config;
      cssClass: string;
      document: ActorPF;
      editable: boolean;
      effects: EmbeddedCollection<typeof ActiveEffect, ActorData>;
      hasHD: boolean;
      isCharacter: boolean;
      isGM: boolean;
      itemTypes: ItemTypesMap;
      limited: boolean;
      options: Options;
      owner: boolean;
      race: null | PropertiesToSource<ItemDataBaseProperties>;
      skillsLocked: boolean;
      sourceData: {};
      unchainedActions: unknown;
      units: {
          distance: {
              overland: "PF1.Distance.miShort" | "PF1.Distance.kmShort";
              tactical: "PF1.Distance.ftShort" | "PF1.Distance.mShort";
          };
          weight: string;
      };
      usesAnySpellbook: boolean;
  }>

openItemSummary

• openItemSummary(elem, instant?): Promise<void>

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

  Parameters

  • elem: JQuery<HTMLElement>

    The element to open. Likely will have the item class in CSS.
  • Optionalinstant: boolean = {}

    Whether to instantly show the expansion (true), or animate it (false)

  Returns Promise<void>

setItemUpdate

• setItemUpdate(id, key, value): void

• Parameters

  • id: any
  • key: any
  • value: any

  Returns void