Class ActorSheetPF

Extend the basic ActorSheet class to do all the PF things! This sheet is an Abstract layer which is not used.

Hierarchy (View Summary)

Constructors

constructor

Properties

_commitItemUsesBound _filters effectiveSearch searchCompositioning searchDelay searchDelayEvent searchRefresh

Accessors

currentPrimaryTab currentSpellbookKey defaultOptions

Methods

_adjustActorPropertyBySpan _adjustNewItem _alterDropItemData _applySectionFilter _canDragStart _canShowRange _commitItemUses _convertCurrency _disableFields _duplicateItem _editSkill _filterSection _focusTabByItem _hideShowElement _itemActivationControl _itemPreparedToggle _mouseWheelAdd _onArbitrarySkillCreate _onControlAlignment _onDragMiscStart _onDragSaveStart _onDragSkillStart _onDragStart _onDropCurrency _onDropItem _onDropItemCreate _onEditCondition _onItemGive _onItemSplit _onLevelUp _onPointBuyCalculator _onRest _onRollAbilityTest _onRollAttack _onRollBAB _onRollCL _onRollConcentration _onRollInitiative _onRollSavingThrow _onSensesSelector _onSkillCreate _onSkillDelete _onSkillEdit _onSpanTextInput _onSubmit _onToggleCondition _onToggleSkillLock _prepareDuplicateItem _prepareHiddenElements _prepareItem _prepareSenseLabels _prepareSkills _prepareSkillsets _prepareSpellbook _prepareTraits _quickAction _quickCarryItem _quickChangeItemQuantity _quickEquipItem _quickIdentifyItem _renderInner _searchFilterChange _searchFilterCommit _searchFilterCompositioning _selectOnClick _setBuffLevel _setItemActive _setItemUses _setMaxSpellUses _setSpellUses _updateItems _updateObject activateListeners calculateSellItemValue calculateTotalItemValue getData openItemSummary setItemUpdate

Constructors

constructor

  • new ActorSheetPF(object: ActorPF, options?: Partial<Options>): ActorSheetPF

  • Parameters

    • object: ActorPF

      Some object or entity which is the target to be updated.

    • Optionaloptions: Partial<Options>

      Additional options which modify the rendering of the sheet. (default: {})

    Returns ActorSheetPF

    Remarks

    Foundry allows passing no value to the constructor at all.

  • new ActorSheetPF(...args: [ActorPF, Partial<Options>?]): ActorSheetPF

  • Parameters

    • ...args: [ActorPF, Partial<Options>?]

    Returns ActorSheetPF

Properties

_commitItemUsesBound

_commitItemUsesBound: (event: Event) => Promise<any> = ...

Type declaration

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

      Commit changes from _setItemUses

      Parameters

      • event: Event

      Returns Promise<any>

Protected Internal_filters

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

Track the set of item filters which are applied

effectiveSearch

effectiveSearch: {} = {}

searchCompositioning

searchCompositioning: boolean = false

Item search

searchDelay

searchDelay: number = 250

searchDelayEvent

searchDelayEvent: null

searchRefresh

searchRefresh: boolean = true

Accessors

currentPrimaryTab

currentSpellbookKey

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;
        }[];
    }

Methods

_adjustActorPropertyBySpan

_adjustNewItem

_alterDropItemData

_applySectionFilter

_canDragStart

  • _canDragStart(selector: string): boolean

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

    Parameters

    • selector: string

      Selector string

    Returns boolean

Protected_canShowRange

_commitItemUses

_convertCurrency

_disableFields

_duplicateItem

_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: object, filters: Set<string>): void
  • Internal

    Filter inventory section

    Called in _prepareItems()

    Parameters

    • category: object

      Category data

    • section: object

      Section data

    • filters: Set<string>

      Active filters

    Returns void

_focusTabByItem

_hideShowElement

_itemActivationControl

_itemPreparedToggle

_mouseWheelAdd

_onArbitrarySkillCreate

_onControlAlignment

_onDragMiscStart

  • _onDragMiscStart(
        event: DragEvent,
        type:
            | "attack"
            | "bab"
            | "cmb"
            | "concentration"
            | "cl"
            | "defenses"
            | "initiative"
            | "abilityScore",
        subType?: string,
    ): void

  • Parameters

    • event: DragEvent

      Drag start event

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

      Type specific subtype

    Returns void

_onDragSaveStart

_onDragSkillStart

_onDragStart

_onDropCurrency

_onDropItem

  • _onDropItem(
        event: any,
        data: any,
    ): 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: any,
    ): 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

_onItemGive

_onItemSplit

_onLevelUp

_onPointBuyCalculator

_onRest

Protected_onRollAbilityTest

  • _onRollAbilityTest(event: Event): void
  • Protected

    Handle rolling an Ability check, either a test or a saving throw

    Parameters

    • event: Event

      The originating click event

    Returns void

Protected_onRollAttack

Protected_onRollBAB

_onRollCL

_onRollConcentration

Protected_onRollInitiative

Protected_onRollSavingThrow

_onSensesSelector

_onSkillCreate

_onSkillDelete

_onSkillEdit

Protected_onSpanTextInput

_onSubmit

  • _onSubmit(
        event: any,
        __namedParameters?: {
            preventClose?: boolean;
            preventRender?: boolean;
            updateData?: null;
        },
    ): Promise<void>

  • Handle standard form submission steps

    Parameters

    • event: any

      The submit event which triggered this handler

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

    Returns Promise<void>

    A promise which resolves to the validated update data

_onToggleCondition

_onToggleSkillLock

_prepareDuplicateItem

  • _prepareDuplicateItem(
        itemData: any,
        __namedParameters?: { rename?: boolean },
    ): void

  • Parameters

    • itemData: any
    • __namedParameters: { rename?: boolean } = {}

    Returns void

_prepareHiddenElements

Protected_prepareItem

_prepareSenseLabels

_prepareSkills

_prepareSkillsets

_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

_prepareTraits

_quickAction

_quickCarryItem

_quickChangeItemQuantity

_quickEquipItem

_quickIdentifyItem

_renderInner

_searchFilterChange

_searchFilterCommit

_searchFilterCompositioning

_selectOnClick

_setBuffLevel

_setItemActive

_setItemUses

_setMaxSpellUses

_setSpellUses

_updateItems

_updateObject

activateListeners

  • activateListeners(html: JQuery<HTMLElement>): 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?: {
            inLowestDenomination?: boolean;
            recursive?: boolean;
        },
    ): number

  • Parameters

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

    Returns number

calculateTotalItemValue

  • calculateTotalItemValue(
        __namedParameters?: {
            inLowestDenomination?: boolean;
            recursive?: boolean;
        },
    ): number

  • Parameters

    • __namedParameters: { inLowestDenomination?: boolean; recursive?: 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: JQuery<HTMLElement>, instant?: boolean): 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

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
_adjustActorPropertyBySpan_adjustNewItem_alterDropItemData_applySectionFilter_canDragStart_canShowRange_commitItemUses_convertCurrency_disableFields_duplicateItem_editSkill_filterSection_focusTabByItem_hideShowElement_itemActivationControl_itemPreparedToggle_mouseWheelAdd_onArbitrarySkillCreate_onControlAlignment_onDragMiscStart_onDragSaveStart_onDragSkillStart_onDragStart_onDropCurrency_onDropItem_onDropItemCreate_onEditCondition_onItemGive_onItemSplit_onLevelUp_onPointBuyCalculator_onRest_onRollAbilityTest_onRollAttack_onRollBAB_onRollCL_onRollConcentration_onRollInitiative_onRollSavingThrow_onSensesSelector_onSkillCreate_onSkillDelete_onSkillEdit_onSpanTextInput_onSubmit_onToggleCondition_onToggleSkillLock_prepareDuplicateItem_prepareHiddenElements_prepareItem_prepareSenseLabels_prepareSkills_prepareSkillsets_prepareSpellbook_prepareTraits_quickAction_quickCarryItem_quickChangeItemQuantity_quickEquipItem_quickIdentifyItem_renderInner_searchFilterChange_searchFilterCommit_searchFilterCompositioning_selectOnClick_setBuffLevel_setItemActive_setItemUses_setMaxSpellUses_setSpellUses_updateItems_updateObjectactivateListenerscalculateSellItemValuecalculateTotalItemValuegetDataopenItemSummarysetItemUpdate