Class: G3000UserSettingSaveManager
A manager for G3000 user settings that are saved and persistent across flight sessions.
Hierarchy
UserSettingSaveManager
↳
G3000UserSettingSaveManager
Constructors
constructor
• new G3000UserSettingSaveManager(bus
, config
, pluginSettings
, fmsSpeedSettingManager
): G3000UserSettingSaveManager
Constructor.
Parameters
Name | 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. |
Returns
Overrides
UserSettingSaveManager.constructor
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Settings/G3000UserSettingSaveManager.ts:79
Methods
destroy
▸ destroy(): void
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
Defined in
src/sdk/settings/UserSettingSaveManager.ts:150
load
▸ load(key
): void
Loads the saved values of this manager's settings.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key from which to load the values. |
Returns
void
Throws
Error if this manager has been destroyed.
Inherited from
UserSettingSaveManager.load
Defined in
src/sdk/settings/UserSettingSaveManager.ts:68
save
▸ save(key
): void
Saves the current values of this manager's settings.
Parameters
Name | 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.save
Defined in
src/sdk/settings/UserSettingSaveManager.ts:88
startAutoSave
▸ startAutoSave(key
): void
Starts automatically saving this manager's settings when their values change.
Parameters
Name | 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
Defined in
src/sdk/settings/UserSettingSaveManager.ts:105
stopAutoSave
▸ stopAutoSave(key
): void
Stops automatically saving this manager's settings when their values change.
Parameters
Name | Type | Description |
---|---|---|
key | string | The key to which to stop saving the values. |
Returns
void
Throws
Error if this manager has been destroyed.
Inherited from
UserSettingSaveManager.stopAutoSave
Defined in
src/sdk/settings/UserSettingSaveManager.ts:128