Class ScriptEditor

Hierarchy

any
- ScriptEditor

Index

Constructors

constructor

new ScriptEditor(__namedParameters: { scriptCall: any }): ScriptEditor
Parameters
- __namedParameters: { scriptCall: any }
Returns ScriptEditor
Overrides HandlebarsApplicationMixin(NoAutocomplete(ApplicationV2)).constructor
- Defined in module/applications/script-editor.mjs:36

Properties

_promises

_promises: { submit: never[] }

scriptCall

scriptCall: any

`Static`DEFAULT_OPTIONS

DEFAULT_OPTIONS: {
    actions: { helpBrowser: Object };
    classes: string[];
    form: { closeOnSubmit: boolean; handler: Object };
    position: { height: number; width: number };
    sheetConfig: boolean;
    tag: string;
    window: { minimizable: boolean; resizable: boolean };
} = ...

`Static`PARTS

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

Accessors

id

get id(): string
Returns string
Inherit Doc
- Defined in module/applications/script-editor.mjs:91

isEditable

get isEditable(): boolean
Is this script editable by the current User? This is governed by the editPermission threshold configured for the class.

Returns boolean
- Defined in module/applications/script-editor.mjs:103

parent

get parent(): ItemPF
Returns ItemPF
- The item the scriptCall belongs to
- Defined in module/applications/script-editor.mjs:51

title

get title(): any
Returns any
Inherit Doc
- Defined in module/applications/script-editor.mjs:78

validCategories

get validCategories(): ScriptCallCategory[]
Returns ScriptCallCategory[]
- A list of valid categories for this script
- Defined in module/applications/script-editor.mjs:60

Methods

_onChangeForm

_onChangeForm(formConfig: ApplicationFormConfiguration, event: Event): void
Internal
The event handler for changes to form input elements
Parameters
- formConfig: ApplicationFormConfiguration
  The configuration of the form being changed
- event: Event
  The triggering event
Returns void
- Defined in module/applications/script-editor.mjs:231

_onRender

_onRender(context: any, options: any): Promise<void>
Parameters
- context: any
- options: any
Returns Promise<void>
Inherit Doc
- Defined in module/applications/script-editor.mjs:115

`Protected`_prepareContext

_prepareContext(): Promise<
    {
        buttons: {
            category: string;
            disabled: boolean;
            icon: string;
            label: string;
        }[];
        categories: ScriptCallCategory[];
        editable: boolean;
        id: string;
        isGM: boolean;
        scriptCall: any;
        selectedCategory: ScriptCallCategory;
    },
>
Protected
Returns Promise<
    {
        buttons: {
            category: string;
            disabled: boolean;
            icon: string;
            label: string;
        }[];
        categories: ScriptCallCategory[];
        editable: boolean;
        id: string;
        isGM: boolean;
        scriptCall: any;
        selectedCategory: ScriptCallCategory;
    },
>
Inherit Doc
- Defined in module/applications/script-editor.mjs:187

`Protected`_toggleDisabled

_toggleDisabled(disabled: boolean): void
Protected
Disable or reenable all form fields in this application.
Parameters
- disabled: boolean
  Should the fields be disabled?
Returns void
- Defined in module/applications/script-editor.mjs:128

awaitResult

awaitResult(): Promise<unknown>
Returns Promise<unknown>
- Defined in module/applications/script-editor.mjs:212

close

close(...args: any[]): Promise<void>
Close the application and resolve any pending submit promises.
Parameters
- ...args: any[]
Returns Promise<void>
- Defined in module/applications/script-editor.mjs:282

resolvePromises

resolvePromises(category: any, result: any): void
Resolve all promises of the given category with the given result.
Parameters
- category: any
- result: any
Returns void
- Defined in module/applications/script-editor.mjs:265

Class ScriptEditor

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ScriptEditor

Properties

_promises

scriptCall

StaticDEFAULT_OPTIONS

StaticPARTS

Accessors

category

Returns ScriptCallCategory

id

Returns string

Inherit Doc

isEditable

Returns boolean

parent

Returns ItemPF

title

Returns any

Inherit Doc

validCategories

Returns ScriptCallCategory[]

Methods

_onChangeForm

Parameters

Returns void

_onRender

Parameters

Returns Promise<void>

Inherit Doc

Protected_prepareContext

Returns Promise< { buttons: { category: string; disabled: boolean; icon: string; label: string; }[]; categories: ScriptCallCategory[]; editable: boolean; id: string; isGM: boolean; scriptCall: any; selectedCategory: ScriptCallCategory; },>

Inherit Doc

Protected_toggleDisabled

Parameters

Returns void

awaitResult

Returns Promise<unknown>

close

Parameters

Returns Promise<void>

resolvePromises

Parameters

Returns void

Settings

On This Page

`Static`DEFAULT_OPTIONS

`Static`PARTS

`Protected`_prepareContext

Returns Promise<
{
buttons: {
category: string;
disabled: boolean;
icon: string;
label: string;
}[];
categories: ScriptCallCategory[];
editable: boolean;
id: string;
isGM: boolean;
scriptCall: any;
selectedCategory: ScriptCallCategory;
},
>

`Protected`_toggleDisabled