Class ActorSheetPF

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

Hierarchy

Constructors

constructor

Properties

_filters _hiddenElems _renderedInner _submitQueued effectiveSearch searchCompositioning searchDelay searchDelayEvent searchRefresh

Accessors

currentPrimaryTab currentSpellbookKey inCharacterGeneration defaultOptions featTypeData

Methods

_adjustActorPropertyBySpan _alterDropItemData _canDragStart _clearSearch _computeEncumbrance _convertCurrency _createPlaceholders _duplicateItem _editSkill _filterItems _hideShowElement _initializeFilterItemList _isItemSameSubGroup _itemActivationControl _itemToggleData _mouseWheelAdd _moveTooltips _onArbitrarySkillCreate _onArbitrarySkillDelete _onConfigControl _onControlAlignment _onDragMiscStart _onDragSaveStart _onDragSkillStart _onDragStart _onDropCurrency _onDropItem _onDropItemCreate _onInputText _onItemCreate _onItemDelete _onItemEdit _onItemGive _onItemRoll _onItemSplit _onItemSummary _onLevelUp _onOpenCompendium _onOpenCompendiumEntry _onPointBuyCalculator _onRaceControl _onResistanceSelector _onRest _onRollAbilityTest _onRollBAB _onRollCL _onRollCMB _onRollConcentration _onRollInitiative _onRollMelee _onRollRanged _onRollSavingThrow _onRollSkillCheck _onRollSubSkillCheck _onSensesSelector _onSkillCreate _onSkillDelete _onSkillEdit _onSpanTextInput _onSubmit _onSubmitElement _onToggleCondition _onToggleFilter _onToggleSkillLock _onTraitSelector _prepareHiddenElements _prepareItems _prepareResistance _prepareSenses _prepareSkillsets _prepareSpellbook _prepareTraits _quickAction _quickCarryItem _quickChangeItemQuantity _quickEquipItem _quickIdentifyItem _render _renderInner _searchFilterChange _searchFilterCommit _searchFilterCompositioning _selectOnClick _setBuffLevel _setFeatUses _setItemActive _setMaxSpellUses _setSpellUses _sortNewItem _typeFilterCount _updateItems _updateObject activateListeners calculateSellItemValue calculateTotalItemValue getData openItemSummary setItemUpdate

Constructors

constructor

Properties

_filters

_filters: Set<any>

Track the set of item filters which are applied

_hiddenElems

_hiddenElems: {}

Track hidden elements of the sheet.

Type declaration

    _renderedInner

    _renderedInner: boolean

    Whether inner part of this sheet has been rendered already.

    _submitQueued

    _submitQueued: boolean

    Whether a submit has been queued in any way.

    effectiveSearch

    effectiveSearch: {}

    Type declaration

      searchCompositioning

      searchCompositioning: boolean

      Item search

      searchDelay

      searchDelay: number

      searchDelayEvent

      searchDelayEvent: null | Timeout

      searchRefresh

      searchRefresh: boolean

      Accessors

      currentPrimaryTab

      currentSpellbookKey

      Private inCharacterGeneration

      • get inCharacterGeneration(): boolean
      • Private

        Determine if this actor is in character generation state.

        Returns boolean

        True if character generation guides are desirable.

      Static defaultOptions

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

      Static featTypeData

      Methods

      _adjustActorPropertyBySpan

      _alterDropItemData

      _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

      Private _computeEncumbrance

      • _computeEncumbrance(actorData): object
      • Private

        Compute the level and percentage of encumbrance for an Actor.

        Parameters

        • actorData: object

          The data object for the Actor being rendered

        Returns object

        An object describing the character's encumbrance level

      _convertCurrency

      _createPlaceholders

      _duplicateItem

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

      Private _filterItems

      • _filterItems(items, filters): boolean
      • Private

        Determine whether an Item will be shown based on the current set of filters

        Parameters

        • items: object[]

          Raw data objects of items

        • filters: any

        Returns boolean

      _hideShowElement

      Private _initializeFilterItemList

      • _initializeFilterItemList(i, ul): void
      • Private

        Initialize Item list filters by activating the set of filters which are currently applied

        Parameters

        • i: any
        • ul: any

        Returns void

      Private _isItemSameSubGroup

      _itemActivationControl

      _itemToggleData

      _mouseWheelAdd

      _moveTooltips

      _onArbitrarySkillCreate

      _onArbitrarySkillDelete

      _onConfigControl

      _onControlAlignment

      _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

      _onDragSkillStart

      _onDragStart

      _onDropCurrency

      _onDropItem

      _onDropItemCreate

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

      • Parameters

        • itemData: any

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

      Private _onInputText

      Private _onItemCreate

      • _onItemCreate(event): Promise<StoredDocument<Document<any, ActorPF, Metadata<any>>>[]>
      • Private

        Handle creating a new Owned Item for the actor using initial data defined in the HTML dataset

        Parameters

        • event: any

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

      Private _onItemDelete

      Private _onItemEdit

      _onItemGive

      Private _onItemRoll

      • _onItemRoll(event): undefined | Promise<void | ChatMessage>
      • Private

        Handle rolling of an item from the Actor sheet, obtaining the Item instance and dispatching to it's roll method

        Parameters

        • event: any

        Returns undefined | Promise<void | ChatMessage>

      _onItemSplit

      Private _onItemSummary

      _onLevelUp

      _onOpenCompendium

      Private _onOpenCompendiumEntry

      _onPointBuyCalculator

      _onRaceControl

      Private _onResistanceSelector

      • _onResistanceSelector(event): void
      • Private

        Handle spawning the ActorResistanceSelector application which allows a number entry of multiple trait options

        Parameters

        • event: Event

          The click event which originated the selection

        Returns void

      _onRest

      Private _onRollAbilityTest

      _onRollBAB

      _onRollCL

      _onRollCMB

      _onRollConcentration

      _onRollInitiative

      _onRollMelee

      _onRollRanged

      _onRollSavingThrow

      Private _onRollSkillCheck

      _onRollSubSkillCheck

      _onSensesSelector

      _onSkillCreate

      _onSkillDelete

      _onSkillEdit

      _onSpanTextInput

      _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

      _onToggleCondition

      Private _onToggleFilter

      • _onToggleFilter(event): void
      • Private

        Handle toggling of filters to display a different set of owned items

        Parameters

        • event: Event

          The click event which triggered the toggle

        Returns void

      _onToggleSkillLock

      Private _onTraitSelector

      • _onTraitSelector(event): void
      • Private

        Handle spawning the ActorTraitSelector application which allows a checkbox of multiple trait options

        Parameters

        • event: Event

          The click event which originated the selection

        Returns void

      _prepareHiddenElements

      Private _prepareItems

      _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

      _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: {}

            Private _prepareSpellbook

            • _prepareSpellbook(data, spells, bookKey): {}
            • Private

              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 {}

              _prepareTraits

              _quickAction

              _quickCarryItem

              _quickChangeItemQuantity

              _quickEquipItem

              _quickIdentifyItem

              _render

              _renderInner

              _searchFilterChange

              _searchFilterCommit

              _searchFilterCompositioning

              _selectOnClick

              _setBuffLevel

              _setFeatUses

              _setItemActive

              _setMaxSpellUses

              _setSpellUses

              Private _sortNewItem

              Private _typeFilterCount

              _updateItems

              _updateObject

              activateListeners

              • 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

              • Parameters

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

                Returns number

              calculateTotalItemValue

              • Parameters

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

                Returns number

              getData

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

                Parameters

                • options: any

                Returns Promise<InsertKeys<{
                    actor: ActorPF;
                    cssClass: string;
                    data: {
                        _id: null | string;
                        data: object;
                        effects: ({ _id: string | null; changes: EffectChangeData[]; disabled: boolean; duration: { startTime: number | null; seconds: number | undefined; combat: string | undefined; rounds: number | undefined; turns: number | undefined; startRound: number | undefined; startTurn: number | undefined; }; ... 5 more ...; flags: Record<....)[];
                        flags: Record<string, unknown>;
                        folder: null | string;
                        img: null | string;
                        items: ({ _id: string | null; name: string; type: string; img: string | null; data: object; effects: { _id: string | null; changes: EffectChangeData[]; disabled: boolean; duration: { ...; }; ... 5 more ...; flags: Record<...> & CoreFlags; }[]; folder: string | null; sort: number; permission: Partial<...>; flags: Record<...>...)[];
                        name: string;
                        permission: Partial<Record<string, 0 | 1 | 2 | 3>>;
                        sort: number;
                        token: {
                            img: null | string;
                            randomImg: boolean;
                        } & {};
                        type: string;
                    };
                    document: ActorPF;
                    editable: boolean;
                    effects: {
                        _id: null | string;
                        changes: EffectChangeData[];
                        disabled: boolean;
                        duration: { startTime: number | null; seconds: number | undefined; combat: string | undefined; rounds: number | undefined; turns: number | undefined; startRound: number | undefined; startTurn: number | undefined; };
                        flags: Record<string, unknown> & CoreFlags;
                        icon: undefined | null | string;
                        label: string;
                        origin: undefined | string;
                        tint: undefined | null | string;
                        transfer: boolean;
                    }[];
                    items: {
                        _id: null | string;
                        data: object;
                        effects: ({ _id: string | null; changes: EffectChangeData[]; disabled: boolean; duration: { startTime: number | null; seconds: number | undefined; combat: string | undefined; rounds: number | undefined; turns: number | undefined; startRound: number | undefined; startTurn: number | undefined; }; ... 5 more ...; flags: Record<....)[];
                        flags: Record<string, unknown>;
                        folder: null | string;
                        img: null | string;
                        name: string;
                        permission: Partial<Record<string, 0 | 1 | 2 | 3>>;
                        sort: number;
                        type: string;
                    }[];
                    limited: boolean;
                    options: Options;
                    owner: boolean;
                    title: string;
                }, OmitByValue<{
                    config: config;
                    cssClass: string;
                    editable: boolean;
                    hasRace: boolean;
                    isCharacter: boolean;
                    isGM: boolean;
                    limited: boolean;
                    owner: boolean;
                    race: null | PropertiesToSource<ItemDataBaseProperties>;
                    skillsLocked: boolean;
                    sourceData: {};
                    useBGSkills: unknown;
                    usesAnySpellbook: boolean;
                }, never>>>

              openItemSummary

              • 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

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc