Skip to main content

Class: WT21SettingSaveManager

Defined in: workingtitle-instruments-wt21/shared/Profiles/WT21SettingSaveManager.ts:17

A manager for WT21 settings which are saved to pilot profiles.

Extends

  • UserSettingSaveManager

Constructors

Constructor

new WT21SettingSaveManager(bus): WT21SettingSaveManager

Defined in: workingtitle-instruments-wt21/shared/Profiles/WT21SettingSaveManager.ts:28

Parameters

ParameterType
busEventBus

Returns

WT21SettingSaveManager

Inherit Doc

Overrides

UserSettingSaveManager.constructor

Methods

destroy()

destroy(): void

Defined in: 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

Inherited from

UserSettingSaveManager.destroy


load()

load(key): void

Defined in: sdk/settings/UserSettingSaveManager.ts:109

Loads the saved values of this manager's settings.

Parameters

ParameterTypeDescription
keystringThe key from which to load the values.

Returns

void

Throws

Error if this manager has been destroyed.

Inherited from

UserSettingSaveManager.load


save()

save(key): void

Defined in: sdk/settings/UserSettingSaveManager.ts:129

Saves the current values of this manager's settings.

Parameters

ParameterTypeDescription
keystringThe key to which to save the values.

Returns

void

Throws

Error if this manager has been destroyed.

Inherited from

UserSettingSaveManager.save


startAutoSave()

startAutoSave(key): void

Defined in: sdk/settings/UserSettingSaveManager.ts:146

Starts automatically saving this manager's settings when their values change.

Parameters

ParameterTypeDescription
keystringThe 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:169

Stops automatically saving this manager's settings when their values change.

Parameters

ParameterTypeDescription
keystringThe key to which to stop saving the values.

Returns

void

Throws

Error if this manager has been destroyed.

Inherited from

UserSettingSaveManager.stopAutoSave