Pathfinder 1e for Foundry VTT
    Preparing search index...

    Class ScriptEditor

    Hierarchy

    • HandlebarsApplication<this> & ApplicationV2<
          RenderContext,
          Configuration,
          RenderOptions,
          this,
      >
      • ScriptEditor
    Index

    Constructors

    constructor

    Properties

    DEFAULT_OPTIONS PARTS

    Accessors

    category isEditable item promise scriptCall title validCategories

    Methods

    _initializeApplicationOptions _onChangeForm _onClose _onRender _prepareContext _prepareMainContext _preparePartContext _renderFrame _toggleDisabled awaitResult _onOpenMacro wait

    Constructors

    • Applications are constructed by providing an object of configuration options.

      Parameters

      • Optionaloptions: {}

        Options used to configure the Application instance (default: {})

      Returns ScriptEditor

    Properties

    DEFAULT_OPTIONS: {
        actions: {
            copyUuid: {
                buttons: number[];
                handler: (...this: any, event: PointerEvent, target: HTMLElement) => void;
            };
            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 };
    } = ...
    PARTS: { footer: { template: string }; form: { template: string } } = ...

    Accessors

    • get category(): ScriptCallCategory

      Returns ScriptCallCategory

      • The category of this script
    • get isEditable(): boolean

      Is this script editable by the current User? This is governed by the editPermission threshold configured for the class.

      Returns boolean

    • get item(): ItemPF

      Returns ItemPF

      • The item the scriptCall belongs to
    • get promise(): Promise<any>

      Returns Promise<any>

    • get title(): string

      Returns string

    • get validCategories(): ScriptCallCategory[]

      Returns ScriptCallCategory[]

      • A list of valid categories for this script

    Methods

    _initializeApplicationOptions

    • _initializeApplicationOptions(options: any): any

      Parameters

      • options: any

      Returns any

    _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

    _onClose

    • _onClose(...args: any[]): void

      Parameters

      • ...args: any[]

      Returns void

    _onRender

    • _onRender(context: any, options: any): Promise<void>

      Parameters

      • context: any
      • options: any

      Returns Promise<void>

    Protected_prepareContext

    • _prepareContext(): Promise<{ editable: boolean; id: string; isGM: any }>
      Protected

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

    _prepareMainContext

    • _prepareMainContext(context: any): Promise<void>

      Parameters

      • context: any

      Returns Promise<void>

    _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

    _renderFrame

    • _renderFrame(options: any): Promise<HTMLElement>

      Partial copy of DocumentSheetV2#_renderFrame contents

      Synced with Foundry v13.348

      Parameters

      • options: any

      Returns Promise<HTMLElement>

    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

    • Returns Promise<unknown>

    Static_onOpenMacro

    • _onOpenMacro(event: any, button: any): Promise<void>

      Parameters

      • event: any
      • button: any

      Returns Promise<void>

    • Parameters

      • options: any

      Returns Promise<any>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods