Class ActorSheetPFNPC

An Actor sheet for NPC type characters in the game system. Extends the base ActorSheetPF class.

Hierarchy

ActorSheetPF
- ActorSheetPFNPC
  - ActorSheetPFNPCLite
  - ActorSheetPFNPCLoot

Index

Constructors

constructor

new ActorSheetPFNPC(...args): ActorSheetPFNPC
Parameters
- Rest ...args: any[]
Returns ActorSheetPFNPC
Inherited from ActorSheetPF.constructor
- Defined in module/applications/actor/actor-sheet.mjs:22

Properties

_filters

_filters: Set<any>

Track the set of item filters which are applied

_hiddenElems

_hiddenElems: {}

Track hidden elements of the sheet.

Type declaration

effectiveSearch

effectiveSearch: {}

Type declaration

searchCompositioning

searchCompositioning: boolean

Item search

searchDelay

searchDelay: number

searchDelayEvent

searchDelayEvent: null | Timeout

searchRefresh

searchRefresh: boolean

Accessors

currentPrimaryTab

get currentPrimaryTab(): undefined | null | string
Returns undefined | null | string
Inherited from ActorSheetPF.currentPrimaryTab
- Defined in module/applications/actor/actor-sheet.mjs:152

currentSpellbookKey

get currentSpellbookKey(): undefined | string
Returns undefined | string
Inherited from ActorSheetPF.currentSpellbookKey
- Defined in module/applications/actor/actor-sheet.mjs:158

`Private` inCharacterGeneration

get inCharacterGeneration(): boolean
Private
Determine if this actor is in character generation state.

Returns boolean
True if character generation guides are desirable.
Inherited from ActorSheetPF.inCharacterGeneration
- Defined in module/applications/actor/actor-sheet.mjs:592

template

get template(): string
Get the correct HTML template path to use for rendering this particular sheet

Returns string
Overrides ActorSheetPF.template
- Defined in module/applications/actor/npc-sheet.mjs:31

`Static` defaultOptions

get defaultOptions(): object
Define default rendering options for the NPC sheet

Returns object
Overrides ActorSheetPF.defaultOptions
- Defined in module/applications/actor/npc-sheet.mjs:17

`Static` featTypeData

get featTypeData(): {}
Returns an object containing feature type specific data relevant to feature organization.

Returns {}
Static
Inherited from ActorSheetPF.featTypeData
- Defined in module/applications/actor/actor-sheet.mjs:144

Methods

_adjustActorPropertyBySpan

_adjustActorPropertyBySpan(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._adjustActorPropertyBySpan
- Defined in module/applications/actor/actor-sheet.mjs:1658

_adjustCR

_adjustCR(event): void
Parameters
- event: any
Returns void
- Defined in module/applications/actor/npc-sheet.mjs:83

_alterDropItemData

_alterDropItemData(data, source): void
Internal
Parameters
- data: object
  Item data
- source: ItemPF
  Source item
Returns void
Inherited from ActorSheetPF._alterDropItemData
- Defined in module/applications/actor/actor-sheet.mjs:3048

_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
Inherited from ActorSheetPF._canDragStart
- Defined in module/applications/actor/actor-sheet.mjs:3243

`Protected` _canShowRange

_canShowRange(item): boolean
Protected
Determine if the item can have its range shown on this sheet.
Parameters
- item: Item
Returns boolean
Inherited from ActorSheetPF._canShowRange
- Defined in module/applications/actor/actor-sheet.mjs:580

_clearSearch

_clearSearch(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._clearSearch
- Defined in module/applications/actor/actor-sheet.mjs:2841

_convertCurrency

_convertCurrency(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._convertCurrency
- Defined in module/applications/actor/actor-sheet.mjs:2183

_createPlaceholders

_createPlaceholders(html): void
Parameters
- html: any
Returns void
Inherited from ActorSheetPF._createPlaceholders
- Defined in module/applications/actor/actor-sheet.mjs:3336

_duplicateItem

_duplicateItem(event): Promise<void>
Parameters
- event: any
Returns Promise<void>
Inherited from ActorSheetPF._duplicateItem
- Defined in module/applications/actor/actor-sheet.mjs:2141

_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>
Inherited from ActorSheetPF._editSkill
- Defined in module/applications/actor/actor-sheet.mjs:1981

_focusTabByItem

_focusTabByItem(item): void
Internal
Focuses certain tab based on provided item.
Parameters
- item: any
Returns void
Inherited from ActorSheetPF._focusTabByItem
- Defined in module/applications/actor/actor-sheet.mjs:3205

_hideShowElement

_hideShowElement(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._hideShowElement
- Defined in module/applications/actor/actor-sheet.mjs:1704

_itemActivationControl

_itemActivationControl(event): void
Activate an item from item control button.
Parameters
- event: MouseEvent
  Click event
Returns void
Inherited from ActorSheetPF._itemActivationControl
- Defined in module/applications/actor/actor-sheet.mjs:2072

_itemPreparedToggle

_itemPreparedToggle(event): Promise<void>
Parameters
- event: any
Returns Promise<void>
Inherited from ActorSheetPF._itemPreparedToggle
- Defined in module/applications/actor/actor-sheet.mjs:2127

_mouseWheelAdd

_mouseWheelAdd(event, el): void
Parameters
- event: any
- el: any
Returns void
Inherited from ActorSheetPF._mouseWheelAdd
- Defined in module/applications/actor/actor-sheet.mjs:1575

`Protected` _moveTooltips

_moveTooltips(event): void
Protected
Parameters
- event: Event
Returns void
Inherited from ActorSheetPF._moveTooltips
- Defined in module/applications/actor/actor-sheet.mjs:1441

_onArbitrarySkillCreate

_onArbitrarySkillCreate(event): Promise<void>
Parameters
- event: any
Returns Promise<void>
Inherited from ActorSheetPF._onArbitrarySkillCreate
- Defined in module/applications/actor/actor-sheet.mjs:1915

_onControlAlignment

_onControlAlignment(event): Promise<void>
Parameters
- event: any
Returns Promise<void>
Inherited from ActorSheetPF._onControlAlignment
- Defined in module/applications/actor/actor-sheet.mjs:2050

_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
Inherited from ActorSheetPF._onDragMiscStart
- Defined in module/applications/actor/actor-sheet.mjs:1474

_onDragSaveStart

_onDragSaveStart(event, type): void
Parameters
- event: any
- type: any
Returns void
Inherited from ActorSheetPF._onDragSaveStart
- Defined in module/applications/actor/actor-sheet.mjs:1506

_onDragSkillStart

_onDragSkillStart(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._onDragSkillStart
- Defined in module/applications/actor/actor-sheet.mjs:1454

_onDragStart

_onDragStart(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._onDragStart
- Defined in module/applications/actor/actor-sheet.mjs:3249

_onDropCurrency

_onDropCurrency(event, data): Promise<unknown>
Parameters
- event: any
- data: any
Returns Promise<unknown>
Inherited from ActorSheetPF._onDropCurrency
- Defined in module/applications/actor/actor-sheet.mjs:3004

_onDropItem

_onDropItem(event, data): Promise<undefined | false | ItemPF[] | StoredDocument<Document<any, ActorPF, Metadata<any>>>[]>
Parameters
- event: any
- data: any
Returns Promise<undefined | false | ItemPF[] | StoredDocument<Document<any, ActorPF, Metadata<any>>>[]>
Inherited from ActorSheetPF._onDropItem
- Defined in module/applications/actor/actor-sheet.mjs:3018

_onDropItemCreate

_onDropItemCreate(itemData): Promise<StoredDocument<Document<any, ActorPF, Metadata<any>>>[]>
Parameters
- itemData: any
Returns Promise<StoredDocument<Document<any, ActorPF, Metadata<any>>>[]>
Inherited from ActorSheetPF._onDropItemCreate
- Defined in module/applications/actor/actor-sheet.mjs:3119

_onItemGive

_onItemGive(event): Promise<void>
Parameters
- event: any
Returns Promise<void>
Inherited from ActorSheetPF._onItemGive
- Defined in module/applications/actor/actor-sheet.mjs:2298

_onItemSplit

_onItemSplit(event): Promise<void>
Parameters
- event: any
Returns Promise<void>
Inherited from ActorSheetPF._onItemSplit
- Defined in module/applications/actor/actor-sheet.mjs:2346

_onLevelUp

_onLevelUp(event): Promise<undefined | null | Item>
Parameters
- event: any
Returns Promise<undefined | null | Item>
Inherited from ActorSheetPF._onLevelUp
- Defined in module/applications/actor/actor-sheet.mjs:1787

_onOpenCompendium

_onOpenCompendium(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._onOpenCompendium
- Defined in module/applications/actor/actor-sheet.mjs:1756

_onPointBuyCalculator

_onPointBuyCalculator(event): Promise<void>
Parameters
- event: any
Returns Promise<void>
Inherited from ActorSheetPF._onPointBuyCalculator
- Defined in module/applications/actor/actor-sheet.mjs:2030

_onRest

_onRest(event): Promise<void>
Parameters
- event: any
Returns Promise<void>
Inherited from ActorSheetPF._onRest
- Defined in module/applications/actor/actor-sheet.mjs:1535

_onRollAttack

_onRollAttack(event): void
Internal
Parameters
- event: Event
Returns void
Inherited from ActorSheetPF._onRollAttack
- Defined in module/applications/actor/actor-sheet.mjs:2401

_onRollBAB

_onRollBAB(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._onRollBAB
- Defined in module/applications/actor/actor-sheet.mjs:2392

_onRollCL

_onRollCL(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._onRollCL
- Defined in module/applications/actor/actor-sheet.mjs:1771

_onRollConcentration

_onRollConcentration(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._onRollConcentration
- Defined in module/applications/actor/actor-sheet.mjs:1764

_onRollInitiative

_onRollInitiative(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._onRollInitiative
- Defined in module/applications/actor/actor-sheet.mjs:2413

_onRollSavingThrow

_onRollSavingThrow(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._onRollSavingThrow
- Defined in module/applications/actor/actor-sheet.mjs:2422

_onSensesSelector

_onSensesSelector(event): Promise<void>
Parameters
- event: any
Returns Promise<void>
Inherited from ActorSheetPF._onSensesSelector
- Defined in module/applications/actor/actor-sheet.mjs:2040

_onSkillCreate

_onSkillCreate(event): Promise<void>
Parameters
- event: any
Returns Promise<void>
Inherited from ActorSheetPF._onSkillCreate
- Defined in module/applications/actor/actor-sheet.mjs:1943

_onSkillDelete

_onSkillDelete(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._onSkillDelete
- Defined in module/applications/actor/actor-sheet.mjs:1998

_onSkillEdit

_onSkillEdit(event): Promise<void>
Parameters
- event: any
Returns Promise<void>
Inherited from ActorSheetPF._onSkillEdit
- Defined in module/applications/actor/actor-sheet.mjs:1989

`Protected` _onSpanTextInput

_onSpanTextInput(event, callback): void
Protected
Parameters
- event: Event
  Triggering event
- callback: Function
  Submission handler
Returns void
Inherited from ActorSheetPF._onSpanTextInput
- Defined in module/applications/actor/actor-sheet.mjs:1342

_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>
Inherited from ActorSheetPF._onSubmit
- Defined in module/applications/actor/actor-sheet.mjs:2975

_onToggleCondition

_onToggleCondition(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._onToggleCondition
- Defined in module/applications/actor/actor-sheet.mjs:1724

_onToggleSkillLock

_onToggleSkillLock(event): void
Toggle skill lock.
Parameters
- event: MouseEvent
Returns void
Inherited from ActorSheetPF._onToggleSkillLock
- Defined in module/applications/actor/actor-sheet.mjs:1737

_prepareHiddenElements

_prepareHiddenElements(): void
Returns void
Inherited from ActorSheetPF._prepareHiddenElements
- Defined in module/applications/actor/actor-sheet.mjs:599

`Protected` _prepareItem

_prepareItem(item): object
Protected
Prepare item data for display.
Parameters
- item: ItemPF
  Original document
Returns object
- Data fed to the sheet
Inherited from ActorSheetPF._prepareItem
- Defined in module/applications/actor/actor-sheet.mjs:518

_prepareSenseLabels

_prepareSenseLabels(): {}
Returns {}
Inherited from ActorSheetPF._prepareSenseLabels
- Defined in module/applications/actor/actor-sheet.mjs:645

_prepareSkills

_prepareSkills(context, rollData): void
Internal
Parameters
- context: object
- rollData: object
Returns void
Inherited from ActorSheetPF._prepareSkills
- Defined in module/applications/actor/actor-sheet.mjs:789

_prepareSkillsets

_prepareSkillsets(context): void
Internal
Prepare adventure/background skill distinction if needed.
Parameters
- context: object
Returns void
Inherited from ActorSheetPF._prepareSkillsets
- Defined in module/applications/actor/actor-sheet.mjs:757

_prepareTraits

_prepareTraits(traits): void
Parameters
- traits: any
Returns void
Inherited from ActorSheetPF._prepareTraits
- Defined in module/applications/actor/actor-sheet.mjs:608

_quickAction

_quickAction(event): undefined | Promise<void | ChatMessage | SharedActionData>
Parameters
- event: any
Returns undefined | Promise<void | ChatMessage | SharedActionData>
Inherited from ActorSheetPF._quickAction
- Defined in module/applications/actor/actor-sheet.mjs:2173

_quickCarryItem

_quickCarryItem(event): Promise<void>
Parameters
- event: any
Returns Promise<void>
Inherited from ActorSheetPF._quickCarryItem
- Defined in module/applications/actor/actor-sheet.mjs:2104

_quickChangeItemQuantity

_quickChangeItemQuantity(event, add?): Promise<void>
Parameters
- event: any
- add: number = 1
Returns Promise<void>
Inherited from ActorSheetPF._quickChangeItemQuantity
- Defined in module/applications/actor/actor-sheet.mjs:2081

_quickEquipItem

_quickEquipItem(event): Promise<void>
Parameters
- event: any
Returns Promise<void>
Inherited from ActorSheetPF._quickEquipItem
- Defined in module/applications/actor/actor-sheet.mjs:2094

_quickIdentifyItem

_quickIdentifyItem(event): Promise<undefined>
Parameters
- event: any
Returns Promise<undefined>
Inherited from ActorSheetPF._quickIdentifyItem
- Defined in module/applications/actor/actor-sheet.mjs:2114

_render

_render(...args): Promise<void>
Parameters
- Rest ...args: any[]
Returns Promise<void>
Inherited from ActorSheetPF._render
- Defined in module/applications/actor/actor-sheet.mjs:2940

_renderInner

_renderInner(...args): Promise<JQuery<HTMLElement>>
Parameters
- Rest ...args: any[]
Returns Promise<JQuery<HTMLElement>>
Inherited from ActorSheetPF._renderInner
- Defined in module/applications/actor/actor-sheet.mjs:2957

_searchFilterChange

_searchFilterChange(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._searchFilterChange
- Defined in module/applications/actor/actor-sheet.mjs:2852

_searchFilterCommit

_searchFilterCommit(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._searchFilterCommit
- Defined in module/applications/actor/actor-sheet.mjs:2816

_searchFilterCompositioning

_searchFilterCompositioning(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._searchFilterCompositioning
- Defined in module/applications/actor/actor-sheet.mjs:2848

_selectOnClick

_selectOnClick(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._selectOnClick
- Defined in module/applications/actor/actor-sheet.mjs:3280

_setBuffLevel

_setBuffLevel(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._setBuffLevel
- Defined in module/applications/actor/actor-sheet.mjs:1688

_setFeatUses

_setFeatUses(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._setFeatUses
- Defined in module/applications/actor/actor-sheet.mjs:1595

_setItemActive

_setItemActive(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._setItemActive
- Defined in module/applications/actor/actor-sheet.mjs:1778

_setMaxSpellUses

_setMaxSpellUses(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._setMaxSpellUses
- Defined in module/applications/actor/actor-sheet.mjs:1633

_setSpellUses

_setSpellUses(event): void
Parameters
- event: any
Returns void
Inherited from ActorSheetPF._setSpellUses
- Defined in module/applications/actor/actor-sheet.mjs:1612

_updateItems

_updateItems(): Promise<void>
Returns Promise<void>
Inherited from ActorSheetPF._updateItems
- Defined in module/applications/actor/actor-sheet.mjs:2986

_updateObject

_updateObject(event, formData): Promise<unknown>
Parameters
- event: any
- formData: any
Returns Promise<unknown>
Inherited from ActorSheetPF._updateObject
- Defined in module/applications/actor/actor-sheet.mjs:3286

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
Overrides ActorSheetPF.activateListeners
- Defined in module/applications/actor/npc-sheet.mjs:72

calculateSellItemValue

calculateSellItemValue(__namedParameters?): number
Parameters
- __namedParameters: {
  inLowestDenomination: undefined | boolean;
  recursive: undefined | boolean;
  } = {}
  - inLowestDenomination: undefined | boolean
  - recursive: undefined | boolean
Returns number
Inherited from ActorSheetPF.calculateSellItemValue
- Defined in module/applications/actor/actor-sheet.mjs:3327

calculateTotalItemValue

calculateTotalItemValue(__namedParameters?): number
Parameters
- __namedParameters: {
  inLowestDenomination: undefined | boolean;
  recursive: undefined | boolean;
  } = {}
  - inLowestDenomination: undefined | boolean
  - recursive: undefined | boolean
Returns number
Inherited from ActorSheetPF.calculateTotalItemValue
- Defined in module/applications/actor/actor-sheet.mjs:3319

getData

getData(): Promise<{
    actor: ActorPF;
    conditions: Conditions;
    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: string;
            tactical: string;
        };
        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;
    conditions: Conditions;
    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: string;
            tactical: string;
        };
        weight: string;
    };
    usesAnySpellbook: boolean;
}>
Overrides ActorSheetPF.getData
- Defined in module/applications/actor/npc-sheet.mjs:45

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.
- Optional instant: boolean = {}
  Whether to instantly show the expansion (true), or animate it (false)
Returns Promise<void>
Inherited from ActorSheetPF.openItemSummary
- Defined in module/applications/actor/actor-sheet.mjs:1813

setItemUpdate

setItemUpdate(id, key, value): void
Parameters
- id: any
- key: any
- value: any
Returns void
Inherited from ActorSheetPF.setItemUpdate
- Defined in module/applications/actor/actor-sheet.mjs:2930

Class ActorSheetPFNPC

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Rest ...args: any[]

Returns ActorSheetPFNPC

Properties

_filters

_hiddenElems

Type declaration

effectiveSearch

Type declaration

searchCompositioning

searchDelay

searchDelayEvent

searchRefresh

Accessors

currentPrimaryTab

Returns undefined | null | string

currentSpellbookKey

Returns undefined | string

Private inCharacterGeneration

Returns boolean

template

Returns string

Static defaultOptions

Returns object

Static featTypeData

Returns {}

Static

Methods

_adjustActorPropertyBySpan

Parameters

event: any

Returns void

_adjustCR

Parameters

event: any

Returns void

_alterDropItemData

Parameters

data: object

source: ItemPF

Returns void

_canDragStart

Parameters

selector: string

Returns boolean

Protected _canShowRange

Parameters

item: Item

Returns boolean

_clearSearch

Parameters

event: any

Returns void

_convertCurrency

Parameters

event: any

Returns void

_createPlaceholders

Parameters

html: any

Returns void

_duplicateItem

Parameters

event: any

Returns Promise<void>

_editSkill

Parameters

skillId: string

Optional subSkillId: string

Returns Promise<void>

_focusTabByItem

`Rest` ...args: any[]

`Private` inCharacterGeneration

`Static` defaultOptions

`Static` featTypeData

`Protected` _canShowRange

`Optional` subSkillId: string

`Protected` _moveTooltips

`Optional` subType: string