Class: Epic2UserSettingSaveManager
Defined in: workingtitle-instruments-epic2/shared/Settings/PersistentSettings/Epic2UserSettingsSaveManager.ts:12
A manager for Epic2 user settings that are saved and persistent across flight sessions.
Extends
Constructors
Constructor
new Epic2UserSettingSaveManager(
bus,mfdUserSettings,navComUserSettings,pfdUserSettings):Epic2UserSettingSaveManager
Defined in: workingtitle-instruments-epic2/shared/Settings/PersistentSettings/Epic2UserSettingsSaveManager.ts:60
Constructor.
Parameters
| Parameter | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
mfdUserSettings | UserSettingManager<MfdAliasedUserSettingTypes> | The mfd user settings |
navComUserSettings | NavComUserSettingManager | The nav/com user settings |
pfdUserSettings | PfdUserSettingManager | The PFD user settings |
Returns
Epic2UserSettingSaveManager
Overrides
UserSettingSaveManager.constructor
Methods
destroy()
destroy():
void
Defined in: sdk/settings/UserSettingSaveManager.ts:192
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
Inherited from
UserSettingSaveManager.destroy
load()
load(
key):void
Defined in: sdk/settings/UserSettingSaveManager.ts:108
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.
Inherited from
save()
save(
key):void
Defined in: sdk/settings/UserSettingSaveManager.ts:128
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.
Inherited from
startAutoSave()
startAutoSave(
key):void
Defined in: sdk/settings/UserSettingSaveManager.ts:145
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.
Inherited from
UserSettingSaveManager.startAutoSave
stopAutoSave()
stopAutoSave(
key):void
Defined in: sdk/settings/UserSettingSaveManager.ts:170
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.