Type Alias Data

type Data = {
    allSettings: TJSGameSettingsWithUI.UISetting.Data[];
    destroy?: () => void;
    folders: Folder[];
    resetCurrent?: (options: { confirm?: boolean }) => Promise<boolean>;
    resetDefault?: (options: { confirm?: boolean }) => Promise<boolean>;
    sections: Section[];
    storeScrollbar: Writable<number>;
    topLevel: TJSGameSettingsWithUI.UISetting.Data[];
}
Index
allSettings destroy? folders resetCurrent? resetDefault? sections storeScrollbar topLevel
allSettings: TJSGameSettingsWithUI.UISetting.Data[]

All settings regardless of top level or in folders.

destroy?: () => void

The bound destroy callback function for received of TJSGameSettingsWithUI.Data instance.

folders: Folder[]

Sorted folders with associated settings and label.

resetCurrent?: (options: { confirm?: boolean }) => Promise<boolean>

Resets any current changes made to settings since the UIControl data has been initialized.

Type Declaration

    • (options: { confirm?: boolean }): Promise<boolean>

    • Parameters

      • options: { confirm?: boolean }

        Options.

        • Optionalconfirm?: boolean

          When true show a confirmation dialog.

      Returns Promise<boolean>

      Whether settings were reset.

resetDefault?: (options: { confirm?: boolean }) => Promise<boolean>

Resets all settings to initial default values.

Type Declaration

    • (options: { confirm?: boolean }): Promise<boolean>

    • Parameters

      • options: { confirm?: boolean }

        Options.

        • Optionalconfirm?: boolean

          When true show a confirmation dialog.

      Returns Promise<boolean>

      Whether settings were reset.

sections: Section[]

Custom sections.

storeScrollbar: Writable<number>

The store for applyScroll.

topLevel: TJSGameSettingsWithUI.UISetting.Data[]

Top level settings data.

Settings
Member Visibility

On This Page
Properties