Class SettingsManager

Manages game settings

Index

Constructors

Properties

_settings lsKey

Accessors

audio display expSpritesEnabled gamepad general isLegacyTheme isPlayerFemale meta musicPreferenceAllGens

Methods

loadFromLocalStorage saveToLocalStorage update updateAndReload

Constructors

constructor

new SettingsManager(
localStorageKey: string,
initSettings: UserFacingSettings,
): SettingsManager
Parameters
- localStorageKey: string
- initSettings: UserFacingSettings
Returns SettingsManager
- Defined in src/system/settings/settings-manager.ts:19

Properties

`Private` `Readonly`_settings

_settings: Settings

Internal buffer for current settings.

`Readonly`lsKey

lsKey: string

Local storage key for persisting settings.

Accessors

audio

get audio(): AudioSettings
Getter for audio settings

Returns AudioSettings
- Defined in src/system/settings/settings-manager.ts:47

display

get display(): DisplaySettings
Getter for display settings

Returns DisplaySettings
- Defined in src/system/settings/settings-manager.ts:42

expSpritesEnabled

get expSpritesEnabled(): boolean
Getter for checking if experimental sprites are enabled

Returns boolean
- Defined in src/system/settings/settings-manager.ts:57

gamepad

get gamepad(): GamepadSettings
Getter for gamepad settings

Returns GamepadSettings
- Defined in src/system/settings/settings-manager.ts:52

general

get general(): GeneralSettings
Getter for general settings

Returns GeneralSettings
- Defined in src/system/settings/settings-manager.ts:37

isLegacyTheme

get isLegacyTheme(): boolean
Getter for checking if the current UI theme is the legacy theme

Returns boolean
- Defined in src/system/settings/settings-manager.ts:67

isPlayerFemale

get isPlayerFemale(): boolean
Getter for checking if the player's gender is female

Returns boolean
- Defined in src/system/settings/settings-manager.ts:62

meta

get meta(): MetaSettings
Getter for meta settings

Returns MetaSettings
- Defined in src/system/settings/settings-manager.ts:32

musicPreferenceAllGens

get musicPreferenceAllGens(): boolean
Getter for checking if the music from all gens should be used

Returns boolean
- Defined in src/system/settings/settings-manager.ts:72

Methods

`Private`loadFromLocalStorage

loadFromLocalStorage(): void
Loads and populates settings from local storage at lsKey

Returns void
- Defined in src/system/settings/settings-manager.ts:119

`Private`saveToLocalStorage

saveToLocalStorage(): void
Saves settings to local storage at lsKey

Returns void
- Defined in src/system/settings/settings-manager.ts:113

update

update<C extends keyof UserFacingSettings>(
    category: C,
    key: keyof UserFacingSettings[C],
    value: any,
): void
Updates a setting. Takes care of dispatching events and saving to local storage.
Type Parameters
- C extends keyof UserFacingSettings
Parameters
- category: C
  The category of the setting
- key: keyof UserFacingSettings[C]
  The key of the setting
- value: any
  The updated value
Returns void

Throws
An error if an invalid category or key is encountered
- Defined in src/system/settings/settings-manager.ts:83

updateAndReload

updateAndReload<C extends keyof UserFacingSettings>(
    category: C,
    key: keyof UserFacingSettings[C],
    value: any,
): void
Exectues a window reload after updating the setting.
Type Parameters
- C extends keyof UserFacingSettings
Parameters
- category: C
  The category of the setting
- key: keyof UserFacingSettings[C]
  The key of the setting
- value: any
  The updated value
Returns void

See
update
- Defined in src/system/settings/settings-manager.ts:107