Class SettingsService<T>

The addon's files are loaded and its saved data is available (ADDON_LOADED of this addon).

Type Parameters

T extends object

Implements

OnAddonLoaded

Index

Constructors

Methods

change get getDefault onAddonLoaded

Constructors

constructor

new SettingsService<T extends object>(
    savedVariables: SavedVariablesService,
    bus: EventBus,
    createDefaults: () => T,
    repair?: (values: T) => void,
): SettingsService<T>
Type Parameters
- T extends object
Parameters
- savedVariables: SavedVariablesService
- bus: EventBus
- createDefaults: () => T
  Makes the settings of a player who has none saved yet.
- Optionalrepair: (values: T) => void
  Puts right what a saved value got wrong (a choice that has gone from a list), once the values are loaded.
Returns SettingsService<T>
- Defined in settings.service.ts:19

Methods

change

change<K extends string | number | symbol>(key: K, value: T[K]): void
Changes a player choice and announces it. Nested tables are replaced as a whole: pass a new table.
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
- value: T[K]
Returns void
- Defined in settings.service.ts:54

get

get<K extends string | number | symbol>(key: K): T[K]
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
Returns T[K]
- Defined in settings.service.ts:42

getDefault

getDefault<K extends string | number | symbol>(key: K): T[K]
What the setting is for a player who never changed it.
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
Returns T[K]
- Defined in settings.service.ts:47

onAddonLoaded

onAddonLoaded(): void
The saved values replace the defaults, as soon as the data of the addon is there.

Returns void
Implementation of OnAddonLoaded.onAddonLoaded
- Defined in settings.service.ts:31