Interface UIControl
interface UIControl {
get showSettings(): boolean;
set showSettings(showSettings: boolean): void;
get stores(): { showSettings: Readable<boolean> };
addSection(options: CustomSection): void;
create(
options?: TJSGameSettingsWithUI.Options.Create,
): TJSGameSettingsWithUI.Data;
swapShowSettings(): boolean;
}
get showSettings(): boolean;
set showSettings(showSettings: boolean): void;
get stores(): { showSettings: Readable<boolean> };
addSection(options: CustomSection): void;
create(
options?: TJSGameSettingsWithUI.Options.Create,
): TJSGameSettingsWithUI.Data;
swapShowSettings(): boolean;
}
Index
Accessors
Methods
Accessors
showSettings
- get showSettings(): boolean
Returns boolean
Current
showSettingsstate. - set showSettings(showSettings: boolean): void
Sets current
showSettingsstate.Parameters
- showSettings: boolean
New
showSettingsstate.
Returns void
- showSettings: boolean
stores
Returns { showSettings: Readable<boolean> }
Returns the managed stores.
Methods
addSection
Adds a custom section / folder defined by the provided TJSSettingsCustomSection options object.
Parameters
- options: CustomSection
The configuration object for the custom section.
Returns void
- options: CustomSection
create
Creates the UISettingsData object by parsing stored settings in
Parameters
Optionaloptions: TJSGameSettingsWithUI.Options.CreateOptional parameters.
Returns TJSGameSettingsWithUI.Data
Parsed UI settings data.
swapShowSettings
Convenience method to swap
showSettings.Returns boolean
New
showSettingsstate.
Controls preparation and processing of registered game settings w/ TJSGameSettings. Game settings are parsed for UI display by TJSSettingsEdit. The store
showSettingsis utilized in TJSSettingsSwap component to provide an easy way to flip between settings component or any main slotted component.