Class: G3000UserSettingSaveManager
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/PersistentSettings/G3000UserSettingSaveManager.ts:27
A manager for G3000 user settings that are saved and persistent across flight sessions.
Extends
Constructors
Constructor
new G3000UserSettingSaveManager(
bus
,config
,pluginSettings
,fmsSpeedSettingManager
,weightBalanceSettingManager
):G3000UserSettingSaveManager
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/PersistentSettings/G3000UserSettingSaveManager.ts:102
Constructor.
Parameters
Parameter | Type | Description |
---|---|---|
bus | EventBus | The event bus. |
config | AvionicsConfig | A configuration object defining avionics options. |
pluginSettings | Iterable <UserSetting <any >> | Additional settings to manage defined by plugins. |
fmsSpeedSettingManager | undefined | FmsSpeedUserSettingManager | A setting manager for FMS speed user settings, or undefined if FMS speed is not supported. |
weightBalanceSettingManager | undefined | WeightBalanceUserSettingManager | A setting manager for weight and balance user setting, or undefined if weight and balance is not supported. |
Returns
G3000UserSettingSaveManager
Overrides
UserSettingSaveManager
.constructor
Methods
destroy()
destroy():
void
Defined in: src/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: src/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: src/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: src/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: src/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.