Class: PfdUserSettingManager
Defined in: workingtitle-instruments-epic2/shared/Settings/PfdUserSettings.ts:121
A manager for PFD user settings. The indexed settings are saved in crew profiles, while non-indexed settings are temporal.
Implements
UserSettingManager<PfdAllUserSettingTypes>
Constructors
Constructor
new PfdUserSettingManager(
bus,displayIndices):PfdUserSettingManager
Defined in: workingtitle-instruments-epic2/shared/Settings/PfdUserSettings.ts:140
Constructor.
Parameters
| Parameter | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
displayIndices | DisplayUnitIndices[] | The indices of the Displays for which to get a manager. |
Returns
PfdUserSettingManager
Properties
displayIndices
readonlydisplayIndices:DisplayUnitIndices[]
Defined in: workingtitle-instruments-epic2/shared/Settings/PfdUserSettings.ts:140
The indices of the Displays for which to get a manager.
Methods
getAliasedManager()
getAliasedManager(
displayIndex):UserSettingManager<PfdAliasedUserSettingTypes>
Defined in: workingtitle-instruments-epic2/shared/Settings/PfdUserSettings.ts:186
Gets a manager for aliased PFD user settings for an indexed GDU.
Parameters
| Parameter | Type | Description |
|---|---|---|
displayIndex | DisplayUnitIndices | The index of the GDU for which to get an aliased setting manager. |
Returns
UserSettingManager<PfdAliasedUserSettingTypes>
A manager for aliased PFD user settings for the specified GDU.
Throws
RangeError if index is less than 1 or greater than the number of GDUs supported by this manager.
getAllSettings()
getAllSettings():
UserSetting<UserSettingValue>[]
Defined in: workingtitle-instruments-epic2/shared/Settings/PfdUserSettings.ts:171
Returns
UserSetting<UserSettingValue>[]
Inherit Doc
Implementation of
UserSettingManager.getAllSettings
getSetting()
getSetting<
K>(name):UserSetting<NonNullable<PfdAllUserSettingTypes[K]>>
Defined in: workingtitle-instruments-epic2/shared/Settings/PfdUserSettings.ts:161
Type Parameters
| Type Parameter |
|---|
K extends "altMetric" | "baroCorrectionUnit" | "baroSynchEnabled" | "flightDirectorMode" | "fpsEnabled" | "thrustDirectorEnabled" | "windFormat" | "headingFormat" | "popupKeyboardEnabled" | "popupKeyboardLayout" | `hsiRange_${number}` | `hsiDisplayFormat_${number}` | `terrWxState_${number}` | `trafficEnabled_${number}` | `lightningEnabled_${number}` | `syntheticVisionEnabled_${number}` |
Parameters
| Parameter | Type |
|---|---|
name | K |
Returns
UserSetting<NonNullable<PfdAllUserSettingTypes[K]>>
Inherit Doc
Implementation of
UserSettingManager.getSetting
mapTo()
mapTo<
M>(map):UserSettingManager<M&PfdIndexedUserSettingTypes<number> &PfdNonIndexedUserSettingTypes>
Defined in: workingtitle-instruments-epic2/shared/Settings/PfdUserSettings.ts:176
Type Parameters
| Type Parameter |
|---|
M extends UserSettingRecord |
Parameters
| Parameter | Type |
|---|---|
map | UserSettingMap<M, PfdAllUserSettingTypes> |
Returns
UserSettingManager<M & PfdIndexedUserSettingTypes<number> & PfdNonIndexedUserSettingTypes>
Inherit Doc
Implementation of
UserSettingManager.mapTo
tryGetSetting()
tryGetSetting<
K>(name):Kextends"altMetric"|"baroCorrectionUnit"|"baroSynchEnabled"|"flightDirectorMode"|"fpsEnabled"|"thrustDirectorEnabled"|"windFormat"|"headingFormat"|"popupKeyboardEnabled"|"popupKeyboardLayout"|`hsiRange_${number}`|`hsiDisplayFormat_${number}`|`terrWxState_${number}`|`trafficEnabled_${number}`|`lightningEnabled_${number}`|`syntheticVisionEnabled_${number}`?UserSetting<PfdAllUserSettingTypes[K<K>]> :undefined
Defined in: workingtitle-instruments-epic2/shared/Settings/PfdUserSettings.ts:156
Type Parameters
| Type Parameter |
|---|
K extends string |
Parameters
| Parameter | Type |
|---|---|
name | K |
Returns
K extends "altMetric" | "baroCorrectionUnit" | "baroSynchEnabled" | "flightDirectorMode" | "fpsEnabled" | "thrustDirectorEnabled" | "windFormat" | "headingFormat" | "popupKeyboardEnabled" | "popupKeyboardLayout" | `hsiRange_${number}` | `hsiDisplayFormat_${number}` | `terrWxState_${number}` | `trafficEnabled_${number}` | `lightningEnabled_${number}` | `syntheticVisionEnabled_${number}` ? UserSetting<PfdAllUserSettingTypes[K<K>]> : undefined
Inherit Doc
Implementation of
UserSettingManager.tryGetSetting
whenSettingChanged()
whenSettingChanged<
K>(name):Consumer<NonNullable<PfdAllUserSettingTypes[K]>>
Defined in: workingtitle-instruments-epic2/shared/Settings/PfdUserSettings.ts:166
Type Parameters
| Type Parameter |
|---|
K extends "altMetric" | "baroCorrectionUnit" | "baroSynchEnabled" | "flightDirectorMode" | "fpsEnabled" | "thrustDirectorEnabled" | "windFormat" | "headingFormat" | "popupKeyboardEnabled" | "popupKeyboardLayout" | `hsiRange_${number}` | `hsiDisplayFormat_${number}` | `terrWxState_${number}` | `trafficEnabled_${number}` | `lightningEnabled_${number}` | `syntheticVisionEnabled_${number}` |
Parameters
| Parameter | Type |
|---|---|
name | K |
Returns
Consumer<NonNullable<PfdAllUserSettingTypes[K]>>
Inherit Doc
Implementation of
UserSettingManager.whenSettingChanged