Class: UserSettingSaveManager
Defined in: src/sdk/settings/UserSettingSaveManager.ts:52
A manager for user settings that are saved and persistent across flight sessions. The manager facilitates saving and loading setting values to and from multiple keyed save slots and also supports auto-saving. Uses Data Store to store saved setting values.
Constructors
Constructor
new UserSettingSaveManager(
settings,bus):UserSettingSaveManager
Defined in: src/sdk/settings/UserSettingSaveManager.ts:65
Creates a new instance of UserSettingSaveManager.
Parameters
| Parameter | Type | Description |
|---|---|---|
settings | readonly (UserSetting<UserSettingValue> | UserSettingSaveManagerSettingDef<UserSettingValue>)[] | This manager's managed settings. |
bus | EventBus | The event bus. |
Returns
UserSettingSaveManager
Methods
destroy()
destroy():
void
Defined in: src/sdk/settings/UserSettingSaveManager.ts:191
Destroys this manager. Once this manager is destroyed, all active autosaves will be stopped, and attempting to save, load, or start another autosave from this manager will cause an error to be thrown.
Returns
void
load()
load(
key):void
Defined in: src/sdk/settings/UserSettingSaveManager.ts:109
Loads the saved values of this manager's settings.
Parameters
| Parameter | Type | Description |
|---|---|---|
key | string | The key from which to load the values. |
Returns
void
Throws
Error if this manager has been destroyed.
save()
save(
key):void
Defined in: src/sdk/settings/UserSettingSaveManager.ts:129
Saves the current values of this manager's settings.
Parameters
| Parameter | Type | Description |
|---|---|---|
key | string | The key to which to save the values. |
Returns
void
Throws
Error if this manager has been destroyed.
startAutoSave()
startAutoSave(
key):void
Defined in: src/sdk/settings/UserSettingSaveManager.ts:146
Starts automatically saving this manager's settings when their values change.
Parameters
| Parameter | Type | Description |
|---|---|---|
key | string | The key to which to save the values. |
Returns
void
Throws
Error if this manager has been destroyed.
stopAutoSave()
stopAutoSave(
key):void
Defined in: src/sdk/settings/UserSettingSaveManager.ts:169
Stops automatically saving this manager's settings when their values change.
Parameters
| Parameter | Type | Description |
|---|---|---|
key | string | The key to which to stop saving the values. |
Returns
void
Throws
Error if this manager has been destroyed.