Class: WT21SettingSaveManager
A manager for WT21 settings which are saved to pilot profiles.
Hierarchy
UserSettingSaveManager↳
WT21SettingSaveManager
Constructors
constructor
• new WT21SettingSaveManager(bus): WT21SettingSaveManager
Parameters
| Name | Type |
|---|---|
bus | EventBus |
Returns
Inherit Doc
Overrides
UserSettingSaveManager.constructor
Defined in
workingtitle-instruments-wt21/shared/Profiles/WT21SettingSaveManager.ts:28
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
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
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
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
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
sdk/settings/UserSettingSaveManager.ts:128