Class DamageResistanceSelector

Extend the FormApplication to handle creating, removing, and editing and Actor's Damage Reduction and Energy Resistances.

Hierarchy (View Summary)

AbstractListSelector
- DamageResistanceSelector

Indexable

[key: string]: any

Constructors

constructor

new DamageResistanceSelector(options: any): DamageResistanceSelector
Parameters
- options: any
Returns DamageResistanceSelector
Overrides AbstractListSelector.constructor
- Defined in module/applications/damage-resistance-selector.mjs:25

Properties

custom

custom: string

Custom user input for damage sources

damages

damages: {}

A list of key-value pairs for dropdown damage types

dragDropHighlightTimeout

dragDropHighlightTimeout: null | Timeout

entries

entries: any

isDR

isDR: boolean

Basic properties for handling operations

operators

operators: any

A dropdown list of combination types for multiple damage types

originalEntries

originalEntries: {}

Original copy of the trait's entries

`Static`DEFAULT_OPTIONS

DEFAULT_OPTIONS: { classes: string[]; window: { icon: string } } = ...

`Static`PARTS

PARTS: { footer: { template: string }; form: { template: string } } = ...

Accessors

actor

get actor(): ActorPF
Alias the document property to actor

Returns ActorPF
- Defined in module/applications/damage-resistance-selector.mjs:171

attribute

get attribute(): string
Alias the name property

Returns string
Inherited from AbstractListSelector.attribute
- Defined in module/applications/abstract-list-selector.mjs:191

dataCount

get dataCount(): number
Get the data entry length

Returns number
Inherited from AbstractListSelector.dataCount
- Defined in module/applications/abstract-list-selector.mjs:224

dragDropType

get dragDropType(): string
Return the dragdrop element type for this application

Returns string
Inherited from AbstractListSelector.dragDropType
- Defined in module/applications/abstract-list-selector.mjs:49

dtypes

get dtypes(): string[]
Get the list of data types

Returns string[]
Inherited from AbstractListSelector.dtypes
- Defined in module/applications/abstract-list-selector.mjs:213

fields

get fields(): string[]
Get the list of fields

Returns string[]
Overrides AbstractListSelector.fields
- Defined in module/applications/damage-resistance-selector.mjs:158

title

get title(): string
Configure the title of the window to include the Actor name

Returns string
- Defined in module/applications/damage-resistance-selector.mjs:183

Methods

`Protected`_canDragDrop

_canDragDrop(selector: string): boolean
Protected
Define whether a user is able to conclude a drag-and-drop workflow for a given drop selector
Parameters
- selector: string
  The candidate HTML selector for the drop target
Returns boolean
Can the current user drop on this selector?
Inherited from AbstractListSelector._canDragDrop
- Defined in module/applications/mixins/drag-drop.mjs:75

`Protected`_canDragStart

_canDragStart(selector: string): boolean
Protected
Define whether a user is able to begin a dragstart workflow for a given drag selector
Parameters
- selector: string
  The candidate HTML selector for dragging
Returns boolean
Can the current user drag this selector?
Inherited from AbstractListSelector._canDragStart
- Defined in module/applications/mixins/drag-drop.mjs:62

`Protected`_getNewEntry

_getNewEntry(event: any): object
Protected
Provides default data for a new list entry
Parameters
- event: any
Returns object
Overrides AbstractListSelector._getNewEntry
- Defined in module/applications/damage-resistance-selector.mjs:199

`Protected`_getUpdateData

_getUpdateData(): object
Protected
Provides update data for saves

Returns object
Overrides AbstractListSelector._getUpdateData
- Defined in module/applications/damage-resistance-selector.mjs:291

_initializeApplicationOptions

_initializeApplicationOptions(
options: ApplicationConfiguration,
): ApplicationConfiguration
Initialize the configuration for this application. Override the default ID to be unique to this entry selector instance based on document and attribute that is being edited.
Parameters
- options: ApplicationConfiguration
  The provided configuration options for the Application
Returns ApplicationConfiguration
The final configuration values for the application
- Defined in module/applications/damage-resistance-selector.mjs:124

`Protected`_onChangeForm

_onChangeForm(...this: any, formConfig: any, event: any): Promise<void>
Protected
Update internal data snapshot on form change
Parameters
- ...this: any
- formConfig: any
- event: any
Returns Promise<void>
Overrides AbstractListSelector._onChangeForm
- Defined in module/applications/damage-resistance-selector.mjs:219

`Protected`_onDragOver

_onDragOver(event: DragEvent): void
Protected
Highlight position that the element will be inserted to on drop
Parameters
- event: DragEvent
  The originating DragEvent
Returns void
Inherited from AbstractListSelector._onDragOver
- Defined in module/applications/abstract-list-selector.mjs:95

`Protected`_onDragStart

_onDragStart(event: DragEvent): void
Protected
Prepare drag-drop data and highlight dragged element
Parameters
- event: DragEvent
  The originating DragEvent
Returns void
Inherited from AbstractListSelector._onDragStart
- Defined in module/applications/abstract-list-selector.mjs:61

`Protected`_onDrop

_onDrop(event: DragEvent): Promise<void>
Protected
Inject dragged element into its new position
Parameters
- event: DragEvent
  The originating DragEvent
Returns Promise<void>
Inherited from AbstractListSelector._onDrop
- Defined in module/applications/abstract-list-selector.mjs:119

_onRender

_onRender(context: any, options: any): void
Parameters
- context: any
- options: any
Returns void
Inherited from AbstractListSelector._onRender
- Defined in module/applications/abstract-list-selector.mjs:173

_onResistanceChange

_onResistanceChange(event: Event): Promise<void>
A triggered operation when any inputs or dropdowns are interacted with to save the data from UI
Parameters
- event: Event
Returns Promise<void>
- Defined in module/applications/damage-resistance-selector.mjs:239

_onResistanceCustomChange

_onResistanceCustomChange(event: Event): Promise<void>
A triggered operation when the user modifies the custom input section
Parameters
- event: Event
Returns Promise<void>
- Defined in module/applications/damage-resistance-selector.mjs:277

`Protected`_preparePartContext

_preparePartContext(
    partId: any,
    context: any,
    options: any,
): Promise<
    | {
        buttons?: undefined;
        cssClass: string;
        document: any;
        dtypes: string[];
        editable: any;
        entries: any;
        fields: string[];
        id: any;
    }
    | {
        buttons?: undefined;
        cssClass?: undefined;
        document?: undefined;
        dtypes?: undefined;
        editable?: undefined;
        entries?: undefined;
        fields?: undefined;
        id?: undefined;
    }
    | {
        buttons: { icon: string; label: string; type: string }[];
        cssClass?: undefined;
        document?: undefined;
        dtypes?: undefined;
        editable?: undefined;
        entries?: undefined;
        fields?: undefined;
        id?: undefined;
    },
>
Protected Internal
Parameters
- partId: any
- context: any
- options: any
Returns Promise<
    | {
        buttons?: undefined;
        cssClass: string;
        document: any;
        dtypes: string[];
        editable: any;
        entries: any;
        fields: string[];
        id: any;
    }
    | {
        buttons?: undefined;
        cssClass?: undefined;
        document?: undefined;
        dtypes?: undefined;
        editable?: undefined;
        entries?: undefined;
        fields?: undefined;
        id?: undefined;
    }
    | {
        buttons: { icon: string; label: string; type: string }[];
        cssClass?: undefined;
        document?: undefined;
        dtypes?: undefined;
        editable?: undefined;
        entries?: undefined;
        fields?: undefined;
        id?: undefined;
    },
>
Inherit Doc
Overrides AbstractListSelector._preparePartContext
- Defined in module/applications/damage-resistance-selector.mjs:139

clearDragHighlights

clearDragHighlights(): void
Returns void
Inherited from AbstractListSelector.clearDragHighlights
- Defined in module/applications/abstract-list-selector.mjs:107

`Static`_onAddEntry

_onAddEntry(...this: any, event: any): Promise<void>
Internal
Add a new entry to the list
Parameters
- ...this: any
- event: any
Returns Promise<void>
Inherited from AbstractListSelector._onAddEntry
- Defined in module/applications/abstract-list-selector.mjs:252

`Static`_onDeleteEntry

_onDeleteEntry(...this: any, event: any): Promise<void>
Internal
Delete an existing entry from the list
Parameters
- ...this: any
- event: any
Returns Promise<void>
Inherited from AbstractListSelector._onDeleteEntry
- Defined in module/applications/abstract-list-selector.mjs:268

`Static`_save

_save(
    ...this: any,
    event: SubmitEvent,
    form: HTMLFormElement,
    formData: FormDataExtended,
): Promise<void>
Internal
Save the new data back to the document.
Parameters
- ...this: any
- event: SubmitEvent
  The originating form submission event
- form: HTMLFormElement
  The form element that was submitted
- formData: FormDataExtended
  Processed data for the submitted form
  - object
    The object of the form
Returns Promise<void>
Inherited from AbstractListSelector._save
- Defined in module/applications/abstract-list-selector.mjs:318

Class DamageResistanceSelector

Hierarchy (View Summary)

Indexable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DamageResistanceSelector

Properties

custom

damages

dragDropHighlightTimeout

entries

isDR

operators

originalEntries

StaticDEFAULT_OPTIONS

StaticPARTS

Accessors

actor

Returns ActorPF

attribute

Returns string

dataCount

Returns number

dragDropType

Returns string

dtypes

Returns string[]

fields

Returns string[]

title

Returns string

Methods

Protected_canDragDrop

Parameters

Returns boolean

Protected_canDragStart

Parameters

Returns boolean

Protected_getNewEntry

Parameters

Returns object

Protected_getUpdateData

Returns object

_initializeApplicationOptions

Parameters

Returns ApplicationConfiguration

Protected_onChangeForm

Parameters

Returns Promise<void>

Protected_onDragOver

Parameters

Returns void

Protected_onDragStart

Parameters

Returns void

Protected_onDrop

Parameters

Returns Promise<void>

_onRender

Parameters

Returns void

_onResistanceChange

Parameters

Returns Promise<void>

_onResistanceCustomChange

Parameters

Returns Promise<void>

Protected_preparePartContext

Parameters

Inherit Doc

clearDragHighlights

Returns void

Static_onAddEntry

Parameters

`Static`DEFAULT_OPTIONS

`Static`PARTS

`Protected`_canDragDrop

`Protected`_canDragStart

`Protected`_getNewEntry

`Protected`_getUpdateData

`Protected`_onChangeForm

`Protected`_onDragOver

`Protected`_onDragStart

`Protected`_onDrop

`Protected`_preparePartContext

`Static`_onAddEntry

`Static`_onDeleteEntry

`Static`_save