Class ScriptEditor

Hierarchy

HandlebarsApplication<this> & ApplicationV2<
    RenderContext,
    Configuration,
    RenderOptions,
    this,
>
- ScriptEditor

Index

Constructors

constructor

new ScriptEditor(options: any): ScriptEditor
Parameters
- options: any
Returns ScriptEditor
Overrides HandlebarsApplicationMixin(NoAutocomplete(ApplicationV2)).constructor
- Defined in module/applications/script-editor.mjs:51

Properties

`Static`DEFAULT_OPTIONS

DEFAULT_OPTIONS: {
    actions: {
        help: Object;
        openMacro: (event: any, button: any) => Promise<void>;
    };
    classes: string[];
    form: { closeOnSubmit: boolean; handler: Object };
    id: string;
    position: { height: number; width: number };
    sheetConfig: boolean;
    tag: string;
    window: { icon: string; minimizable: boolean; resizable: boolean };
} = ...

`Static`PARTS

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

Accessors

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:116

item

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

promise

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

scriptCall

get scriptCall(): ItemScriptCall
Returns ItemScriptCall
- Defined in module/applications/script-editor.mjs:14

title

get title(): string
Returns string
Inherit Doc
Overrides HandlebarsApplicationMixin(NoAutocomplete(ApplicationV2)).title
- Defined in module/applications/script-editor.mjs:101

validCategories

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

Methods

_initializeApplicationOptions

_initializeApplicationOptions(options: any): any
Parameters
- options: any
Returns any
Overrides HandlebarsApplicationMixin(NoAutocomplete(ApplicationV2))._initializeApplicationOptions
- Defined in module/applications/script-editor.mjs:61

_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
Overrides HandlebarsApplicationMixin(NoAutocomplete(ApplicationV2))._onChangeForm
- Defined in module/applications/script-editor.mjs:323

_onClose

_onClose(...args: any[]): void
Parameters
- ...args: any[]
Returns void
Overrides HandlebarsApplicationMixin(NoAutocomplete(ApplicationV2))._onClose
- Defined in module/applications/script-editor.mjs:353

_onRender

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

`Protected`_prepareContext

_prepareContext(): Promise<{ editable: boolean; id: string; isGM: boolean }>
Protected
Returns Promise<{ editable: boolean; id: string; isGM: boolean }>
Inherit Doc
Overrides HandlebarsApplicationMixin(NoAutocomplete(ApplicationV2))._prepareContext
- Defined in module/applications/script-editor.mjs:244

_prepareMainContext

_prepareMainContext(context: any): Promise<void>
Parameters
- context: any
Returns Promise<void>
- Defined in module/applications/script-editor.mjs:272

_preparePartContext

_preparePartContext(partId: any, context: any, options: any): Promise<any>
Prepare context that is specific to only a single rendered part.

It is recommended to augment or mutate the shared context so that downstream methods like _onRender have visibility into the data that was used for rendering. It is acceptable to return a different context object rather than mutating the shared context at the expense of this transparency.
Parameters
- partId: any
  The part being rendered
- context: any
  Shared context provided by _prepareContext
- options: any
  Options which configure application rendering behavior
Returns Promise<any>
Context data for a specific part
Overrides HandlebarsApplicationMixin(NoAutocomplete(ApplicationV2))._preparePartContext
- Defined in module/applications/script-editor.mjs:252

`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:141

awaitResult

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

`Static`_onOpenMacro

_onOpenMacro(event: any, button: any): Promise<void>
Parameters
- event: any
- button: any
Returns Promise<void>
- Defined in module/applications/script-editor.mjs:345

`Static`wait

wait(options: any): Promise<any>
Parameters
- options: any
Returns Promise<any>
- Defined in module/applications/script-editor.mjs:359

Class ScriptEditor

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ScriptEditor

Properties

StaticDEFAULT_OPTIONS

StaticPARTS

Accessors

category

Returns ScriptCallCategory

isEditable

Returns boolean

item

Returns ItemPF

promise

Returns Promise<any>

scriptCall

Returns ItemScriptCall

title

Returns string

Inherit Doc

validCategories

Returns ScriptCallCategory[]

Methods

_initializeApplicationOptions

Parameters

Returns any

_onChangeForm

Parameters

Returns void

_onClose

Parameters

Returns void

_onRender

Parameters

Returns Promise<void>

Inherit Doc

Protected_prepareContext

Returns Promise<{ editable: boolean; id: string; isGM: boolean }>

Inherit Doc

_prepareMainContext

Parameters

Returns Promise<void>

_preparePartContext

Parameters

Returns Promise<any>

Protected_toggleDisabled

Parameters

Returns void

awaitResult

Returns Promise<unknown>

Deprecated

Static_onOpenMacro

Parameters

Returns Promise<void>

Staticwait

Parameters

Returns Promise<any>

Settings

On This Page

`Static`DEFAULT_OPTIONS

`Static`PARTS

`Protected`_prepareContext

`Protected`_toggleDisabled

`Static`_onOpenMacro

`Static`wait