Class ChangeEditor

Change Editor

Since

PF1 v10

Hierarchy

HandlebarsApplication<this> & DocumentSheetV2<
    any,
    RenderContext<any>,
    Configuration<any>,
    RenderOptions,
    this,
>
- ChangeEditor

Index

Constructors

constructor

new ChangeEditor(options?: {}): ChangeEditor
Parameters
- Optionaloptions: {}
Returns ChangeEditor
Inherited from HandlebarsApplicationMixin(DocumentSheetV2).constructor
- Defined in node_modules/fvtt-types/src/foundry/client/applications/api/document-sheet.d.mts:90

Properties

`Static`DEFAULT_OPTIONS

DEFAULT_OPTIONS: {
    actions: {
        copyUuid: {
            buttons: number[];
            handler: (...this: any, event: PointerEvent) => void;
        };
        help: (
            ...this: any,
            event: PointerEvent,
            target: HTMLElement,
        ) => Promise<void>;
        selectTarget: (
            ...this: any,
            event: PointerEvent,
            button: HTMLElement,
        ) => Promise<void>;
    };
    classes: string[];
    form: { closeOnSubmit: boolean; handler: Object; submitOnChange: boolean };
    id: string;
    position: { width: number };
    sheetConfig: boolean;
    tag: string;
    window: { minimizable: boolean; resizable: boolean };
} = ...

`Static`PARTS

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

Accessors

actor

get actor(): ActorPF
Returns ActorPF
- Defined in module/applications/change-editor.mjs:68

change

get change(): ItemChange
Returns ItemChange
- Defined in module/applications/change-editor.mjs:45

inParent

get inParent(): boolean
Test if this Change is in its declared parent.

Returns boolean
- Defined in module/applications/change-editor.mjs:283

item

get item(): ItemPF
Returns ItemPF
- Defined in module/applications/change-editor.mjs:77

promise

get promise(): Promise<any>
Returns Promise<any>
- Defined in module/applications/change-editor.mjs:10

title

get title(): string
Returns string
Overrides HandlebarsApplicationMixin(DocumentSheetV2).title
- Defined in module/applications/change-editor.mjs:87

Methods

_canRender

_canRender(options: any): false | void
Parameters
- options: any
Returns false | void
Overrides HandlebarsApplicationMixin(DocumentSheetV2)._canRender
- Defined in module/applications/change-editor.mjs:304

_initializeApplicationOptions

_initializeApplicationOptions(options: object): object
Override to fix DocumentSheet ignoring get id
Parameters
- options: object
  App options
Returns object
Overrides HandlebarsApplicationMixin(DocumentSheetV2)._initializeApplicationOptions
- Defined in module/applications/change-editor.mjs:55

_onClose

_onClose(options: any): void
Parameters
- options: any
Returns void
Overrides HandlebarsApplicationMixin(DocumentSheetV2)._onClose
- Defined in module/applications/change-editor.mjs:338

`Protected`_onRender

_onRender(context: ApplicationRenderContext, options: RenderOptions): void
Protected
Attach event listeners to the rendered application form.
Parameters
- context: ApplicationRenderContext
  Prepared context data
- options: RenderOptions
  Provided render options
Returns void
Overrides HandlebarsApplicationMixin(DocumentSheetV2)._onRender
- Defined in module/applications/change-editor.mjs:319

`Protected`_prepareContext

_prepareContext(): Promise<
    {
        actor: ActorPF;
        change: ItemChange;
        config: config;
        cssClass: string;
        editable: boolean;
        hasType: boolean;
        isAdd: boolean;
        isCustom: boolean;
        isDeferred: boolean;
        isSet: boolean;
        isSimple: boolean;
        isValid: boolean;
        isValidOp: boolean;
        isValidType: boolean;
        item: ItemPF;
        label: string;
        priority: { early: boolean; late: boolean; normal: boolean };
        types: {
            [k: string]: {
                disabled: boolean;
                label:
                    | "PF1.ModifierType.untyped"
                    | "PF1.ModifierType.untypedPerm"
                    | "PF1.ModifierType.base"
                    | "PF1.ModifierType.enhancement"
                    | "PF1.ModifierType.dodge"
                    | "PF1.ModifierType.haste"
                    | "PF1.ModifierType.inherent"
                    | "PF1.ModifierType.deflection"
                    | "PF1.ModifierType.morale"
                    | "PF1.ModifierType.luck"
                    | "PF1.ModifierType.sacred"
                    | "PF1.ModifierType.insight"
                    | "PF1.ModifierType.resistance"
                    | "PF1.ModifierType.profane"
                    | "PF1.ModifierType.trait"
                    | "PF1.ModifierType.racial"
                    | "PF1.ModifierType.size"
                    | "PF1.ModifierType.competence"
                    | "PF1.ModifierType.circumstance"
                    | "PF1.ModifierType.alchemical";
            };
        };
        values: {
            priority: { early: undefined
            | number; late: undefined | number };
        };
    },
>
Protected
Returns Promise<
    {
        actor: ActorPF;
        change: ItemChange;
        config: config;
        cssClass: string;
        editable: boolean;
        hasType: boolean;
        isAdd: boolean;
        isCustom: boolean;
        isDeferred: boolean;
        isSet: boolean;
        isSimple: boolean;
        isValid: boolean;
        isValidOp: boolean;
        isValidType: boolean;
        item: ItemPF;
        label: string;
        priority: { early: boolean; late: boolean; normal: boolean };
        types: {
            [k: string]: {
                disabled: boolean;
                label:
                    | "PF1.ModifierType.untyped"
                    | "PF1.ModifierType.untypedPerm"
                    | "PF1.ModifierType.base"
                    | "PF1.ModifierType.enhancement"
                    | "PF1.ModifierType.dodge"
                    | "PF1.ModifierType.haste"
                    | "PF1.ModifierType.inherent"
                    | "PF1.ModifierType.deflection"
                    | "PF1.ModifierType.morale"
                    | "PF1.ModifierType.luck"
                    | "PF1.ModifierType.sacred"
                    | "PF1.ModifierType.insight"
                    | "PF1.ModifierType.resistance"
                    | "PF1.ModifierType.profane"
                    | "PF1.ModifierType.trait"
                    | "PF1.ModifierType.racial"
                    | "PF1.ModifierType.size"
                    | "PF1.ModifierType.competence"
                    | "PF1.ModifierType.circumstance"
                    | "PF1.ModifierType.alchemical";
            };
        };
        values: {
            priority: { early: undefined
            | number; late: undefined | number };
        };
    },
>
Inherit Doc
Overrides HandlebarsApplicationMixin(DocumentSheetV2)._prepareContext
- Defined in module/applications/change-editor.mjs:100

_validateFormula

_validateFormula(el: HTMLElement): Promise<void>
Internal
Validate input formula for basic errors.
Parameters
- el: HTMLElement
Returns Promise<void>
- Defined in module/applications/change-editor.mjs:246

render

render(options: object, _options: object): Promise<ChangeEditor>
HACK: Override to force close the dialog when the Change is deleted
Parameters
- options: object
  Options
- _options: object
  Legacy options
Returns Promise<ChangeEditor>
Overrides HandlebarsApplicationMixin(DocumentSheetV2).render
- Defined in module/applications/change-editor.mjs:294

`Static`_onChangeTarget

_onChangeTarget(
    ...this: any,
    event: PointerEvent,
    button: HTMLElement,
): Promise<void>
Internal
Open Target Selector
Parameters
- ...this: any
- event: PointerEvent
- button: HTMLElement
Returns Promise<void>
- Defined in module/applications/change-editor.mjs:185

`Static`_onOpenHelp

_onOpenHelp(
    ...this: any,
    event: PointerEvent,
    target: HTMLElement,
): Promise<void>
Open Documentation
Parameters
- ...this: any
- event: PointerEvent
- target: HTMLElement
Returns Promise<void>
- Defined in module/applications/change-editor.mjs:173

`Static`wait

wait(options: { change: ItemChange }): Promise<void>
Parameters
- options: { change: ItemChange }
  Application options
  - change: ItemChange
    Change to modify
Returns Promise<void>
- Promise that resolves when the app is closed.
- Defined in module/applications/change-editor.mjs:371

Class ChangeEditor

Since

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ChangeEditor

Properties

StaticDEFAULT_OPTIONS

StaticPARTS

Accessors

actor

Returns ActorPF

change

Returns ItemChange

inParent

Returns boolean

item

Returns ItemPF

promise

Returns Promise<any>

title

Returns string

Methods

_canRender

Parameters

Returns false | void

_initializeApplicationOptions

Parameters

Returns object

_onClose

Parameters

Returns void

Protected_onRender

Parameters

Returns void

Protected_prepareContext

Inherit Doc

_validateFormula

Parameters

Returns Promise<void>

render

Parameters

Returns Promise<ChangeEditor>

Static_onChangeTarget

Parameters

Returns Promise<void>

Static_onOpenHelp

Parameters

Returns Promise<void>

Staticwait

Parameters

change: ItemChange

Returns Promise<void>

Settings

On This Page

`Static`DEFAULT_OPTIONS

`Static`PARTS

`Protected`_onRender

`Protected`_prepareContext

`Static`_onChangeTarget

`Static`_onOpenHelp

`Static`wait