Class ActorSheetPFTrap

constructor

• new ActorSheetPFTrap(...args): ActorSheetPFTrap

• Parameters

  • Rest ...args: any[]

  Returns ActorSheetPFTrap

_filters

_hiddenElems

_renderedInner

_submitQueued

effectiveSearch

searchCompositioning

searchDelay

searchDelayEvent

searchRefresh

currentPrimaryTab

• get currentPrimaryTab(): undefined | null | string

• Returns undefined | null | string

currentSpellbookKey

• get currentSpellbookKey(): undefined | string

• Returns undefined | string

Static featTypeData

• get featTypeData(): Object

• Returns an object containing feature type specific data relevant to feature organization.

  Returns Object

  Static

_adjustActorPropertyBySpan

• _adjustActorPropertyBySpan(event): void

• Parameters

  • event: any

  Returns void

_alterDropItemData

• _alterDropItemData(data): void

• Parameters

  • data: any

  Returns void

_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

_clearSearch

• _clearSearch(event): void

• Parameters

  • event: any

  Returns void

_convertCurrency

• _convertCurrency(event): void

• Parameters

  • event: any

  Returns void

_createPlaceholders

• _createPlaceholders(html): void

• Parameters

  • html: any

  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.

  • Optional subSkillId: string

    The id of the subskill, if appropriate.

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

_itemToggleData

• _itemToggleData(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_mouseWheelAdd

• _mouseWheelAdd(event, el): void

• Parameters

  • event: any

  • el: any

  Returns void

_moveTooltips

• _moveTooltips(event): void

• Parameters

  • event: any

  Returns void

_onArbitrarySkillCreate

• _onArbitrarySkillCreate(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onArbitrarySkillDelete

• _onArbitrarySkillDelete(event): void

• Parameters

  • event: any

  Returns void

_onConfigControl

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

  • type: "attack" | "bab" | "cmb" | "concentration" | "cl" | "defenses" | "initiative" | "abilityScore"

  • Optional subType: string

    Type specific subtype

  Returns void

_onDragSaveStart

• _onDragSaveStart(event, type): void

• Parameters

  • event: any

  • type: any

  Returns void

_onDragSkillStart

• _onDragSkillStart(event): void

• Parameters

  • event: any

  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 | false | StoredDocument<Document<any, ActorPF, Metadata<any>>>[] | ItemPF[]>

• Parameters

  • event: any

  • data: any

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

_onDropItemCreate

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

• Parameters

  • itemData: any

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

_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): void

• Parameters

  • event: any

  Returns void

_onOpenCompendium

• _onOpenCompendium(event): void

• Parameters

  • event: any

  Returns void

_onPointBuyCalculator

• _onPointBuyCalculator(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onRaceControl

• _onRaceControl(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onRest

• _onRest(event): void

• Parameters

  • event: any

  Returns void

_onRollBAB

• _onRollBAB(event): void

• Parameters

  • event: any

  Returns void

_onRollCL

• _onRollCL(event): void

• Parameters

  • event: any

  Returns void

_onRollCMB

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

_onRollMelee

• _onRollMelee(event): void

• Parameters

  • event: any

  Returns void

_onRollRanged

• _onRollRanged(event): void

• Parameters

  • event: any

  Returns void

_onRollSavingThrow

• _onRollSavingThrow(event): void

• Parameters

  • event: any

  Returns void

_onRollSubSkillCheck

• _onRollSubSkillCheck(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): void

• Parameters

  • event: any

  Returns void

_onSkillEdit

• _onSkillEdit(event): Promise<void>

• Parameters

  • event: any

  Returns Promise<void>

_onSpanTextInput

• _onSpanTextInput(event, callback?): void

• Parameters

  • event: any

  • callback: null = null

  Returns void

_onSubmit

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

• Parameters

  • event: any

  • __namedParameters: {
        preventClose: undefined | boolean;
        preventRender: undefined | boolean;
        updateData: undefined | null;
    } = {}

    • preventClose: undefined | boolean

    • preventRender: undefined | boolean

    • updateData: undefined | null

  Returns Promise<void>

_onSubmitElement

• _onSubmitElement(event): void

• Parameters

  • event: any

  Returns void

_onToggleCondition

• _onToggleCondition(event): void

• Parameters

  • event: any

  Returns void

_onToggleSkillLock

• _onToggleSkillLock(event): void

• Toggle skill lock.

  Parameters

  • event: MouseEvent

  Returns void

_prepareHiddenElements

• _prepareHiddenElements(): void

• Returns void

_prepareResistance

• _prepareResistance(damages, damageType): Object

• Parameters

  • damages: Object

    The traits object containing both custom text input and more structured resistances

  • damageType: string

    The type of resistance to check ("dr" or "eres" for damage reduction or energy resistance, respectively)

  Returns Object

  • An object of key-value pairs of string labels for the actor sheet

_prepareSenses

• _prepareSenses(senses): {}

• Parameters

  • senses: any

  Returns {}

_prepareSkillsets

• _prepareSkillsets(skillset): {
      adventure: {
          skills: {};
      };
      all: {
          skills: {};
      };
      background: {
          skills: {};
      };
  }

• Parameters

  • skillset: any

  Returns {
      adventure: {
          skills: {};
      };
      all: {
          skills: {};
      };
      background: {
          skills: {};
      };
  }

  • adventure: {
        skills: {};
    }

    • skills: {}

  • all: {
        skills: {};
    }

    • skills: {}

  • background: {
        skills: {};
    }

    • skills: {}

_prepareTraits

• _prepareTraits(traits): void

• Parameters

  • traits: any

  Returns void

_quickAction

• _quickAction(event): undefined | Promise<any>

• Parameters

  • event: any

  Returns undefined | Promise<any>

_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

_setFeatUses

• _setFeatUses(event): void

• Parameters

  • event: any

  Returns void

_setItemActive

• _setItemActive(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: HTML

    {HTML} The prepared HTML object ready to be rendered into the DOM

  Returns void

calculateSellItemValue

• calculateSellItemValue(__namedParameters?): number

• Parameters

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

    • inLowestDenomination: undefined | boolean

  Returns number

calculateTotalItemValue

• calculateTotalItemValue(__namedParameters?): number

• Parameters

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

    • inLowestDenomination: undefined | boolean

  Returns number

openItemSummary

• openItemSummary(elem, instant?): 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.

  • Optional instant: boolean = {}

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

  Returns void

setItemUpdate

• setItemUpdate(id, key, value): void

• Parameters

  • id: any

  • key: any

  • value: any

  Returns void