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

    Class AbstractSettingsApplicationAbstract

    A generic application to render a settings modal.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    fields settings DEFAULT_OPTIONS settings

    Accessors

    title

    Methods

    _initializeApplicationOptions _onChangeForm _prepareContext _preparePartContext _onFormReset _save

    Constructors

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

      Parameters

      • Optionaloptions: {}

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

      Returns AbstractSettingsApplication

    Properties

    fields: any
    settings: any
    DEFAULT_OPTIONS: {
        actions: { resetForm: (event: Event) => Promise<void> };
        classes: string[];
        form: {
            closeOnSubmit: boolean;
            handler: (
                ...this: any,
                event: SubmitEvent,
                form: HTMLFormElement,
                formData: FormDataExtended,
            ) => Promise<void>;
            submitOnChange: boolean;
            submitOnClose: boolean;
        };
        position: { width: number };
        sheetConfig: boolean;
        tag: string;
        window: { minimizable: boolean; resizable: boolean };
    } = ...
    settings: any

    Accessors

    Methods

    _initializeApplicationOptions

    • _initializeApplicationOptions(
          options: ApplicationConfiguration,
      ): ApplicationConfiguration

      Initialize the configuration for this application. Override the default ID to be unique to this settings app instance and tack on extra class.

      Parameters

      • options: ApplicationConfiguration

        The provided configuration options for the Application

      Returns ApplicationConfiguration

      The final configuration values for the application

    _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

    _prepareContext

    Protected_preparePartContext

    • _preparePartContext(
          partId: string,
          context: ApplicationRenderContext,
      ): Promise<ApplicationRenderContext>
      Protected

      Parameters

      • partId: string

        Part ID

      • context: ApplicationRenderContext

        Context

      Returns Promise<ApplicationRenderContext>

    Static_onFormReset

    Static_save

    • _save(
          ...this: any,
          event: SubmitEvent,
          form: HTMLFormElement,
          formData: FormDataExtended,
      ): Promise<void>
      Internal

      Update the game settings with the new configuration

      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 form data in object form

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods