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

    Class SourcesConfig

    An application that lets the user select the sources that are allowed to be imported into the game.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    fields settings DEFAULT_OPTIONS PARTS settings

    Accessors

    title

    Methods

    _initializeApplicationOptions _onChangeForm _onRender _prepareContext _preparePartContext #onSearchFilter _onCommitChanges _onFormReset _onToggleAll

    Constructors

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

      Parameters

      • Optionaloptions: {}

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

      Returns SourcesConfig

    Properties

    fields: any
    settings: any
    DEFAULT_OPTIONS: {
        actions: {
            toggleAll: (event: PointerEvent, _target: HTMLElement) => void;
        };
        configKey: string;
        model: typeof SourcesConfigModel;
        phraseKey: string;
        window: { icon: string };
    } = ...
    PARTS: { footer: { template: string }; form: { template: string } } = ...

    Configure a registry of template parts which are supported for this application for partial rendering.

    {}

    settings: any

    Accessors

    • get title(): any

      Returns any

    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

    _onRender

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

      Parameters

      • context: any
      • options: any

      Returns Promise<void>

    _prepareContext

    • _prepareContext(options: any): Promise<RenderContext>

      Parameters

      • options: any

      Returns Promise<RenderContext>

    _preparePartContext

    • _preparePartContext(partId: any, context: any): Promise<any>

      Parameters

      • partId: any

        Part ID

      • context: any

        Context

      Returns Promise<any>

    • Protected

      Filter the list of sources based on the search query (name or ID).

      Parameters

      • event: Event

        The originating change event.

      • query: string

        The search query.

      • rgx: RegExp

        The search regex.

      • content: HTMLElement

        The content element.

      Returns void

    Static_onCommitChanges

    • _onCommitChanges(
          ...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>

    Static_onFormReset

    • _onFormReset(event: Event): Promise<void>
      Internal

      The event handler that is fired when the form is reset to its original values

      Parameters

      • event: Event

        The triggering event

      Returns Promise<void>

    Protected Static_onToggleAll

    • _onToggleAll(event: PointerEvent, _target: HTMLElement): void
      Protected

      Select / Unselect all sources.

      Parameters

      • event: PointerEvent

        The originating click event

      • _target: HTMLElement

        the capturing HTML element which defined a [data-action]

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods