Skip to main content

Type Alias: AltitudeSelectManagerOptions

AltitudeSelectManagerOptions = object

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:53

Configuration options for AltitudeSelectManager.

Properties​

accelFilter?​

optional accelFilter: number

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:140

Bitflags to use to filter input events for input acceleration. Only events that pass the filter are eligible to trigger input acceleration. Defaults to AltitudeSelectManagerAccelFilter.All.

accelInputCountThreshold?​

optional accelInputCountThreshold: number

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:131

The required number of consecutive small-increment inputs received to trigger input acceleration. While acceleration is active, small-increment inputs will be converted to large increments. A threshold less than or equal to zero effectively disables input acceleration. Defaults to 0.

accelResetOnDirectionChange?​

optional accelResetOnDirectionChange: boolean

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:134

Whether to reset input acceleration if the direction of increment changes. Defaults to false.

altitudeHoldSlotIndex?​

optional altitudeHoldSlotIndex: 1 | 2 | 3

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:55

The altitude hold slot index to use. Defaults to 1.

incrLarge​

incrLarge: NumberUnitInterface<Distance>

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:88

The value to increase/decrease the selected altitude setting on a large increment.

incrLargeMetric?​

optional incrLargeMetric: NumberUnitInterface<Distance>

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:100

The value to increase/decrease the selected altitude setting on a large increment in metric mode. If undefined, it will be set equal to the large increment value in non-metric mode.

incrSmall​

incrSmall: NumberUnitInterface<Distance>

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:85

The value to increase/decrease the selected altitude setting on a small increment.

incrSmallMetric?​

optional incrSmallMetric: NumberUnitInterface<Distance>

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:94

The value to increase/decrease the selected altitude setting on a small increment in metric mode. If undefined, it will be set equal to the small increment value in non-metric mode.

initOnInput?​

optional initOnInput: boolean

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:146

Whether to initialize the selected altitude setting only on the first detected input. If false, the selected altitude will be initialized as soon as the manager is fully initialized. Defaults to false.

initToIndicatedAlt?​

optional initToIndicatedAlt: boolean

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:152

Whether to initialize the selected altitude setting to the indicated altitude. If false, the selected altitude will be initialized to 0. Defaults to false.

inputIncrLargeThreshold​

inputIncrLargeThreshold: number

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:82

The threshold for an altitude select change key input value above which the input is interpreted as a large increment.

lockAltToStepOnIncr?​

optional lockAltToStepOnIncr: boolean

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:106

Whether to lock the selected altitude setting to multiples of the appropriate increment value on a small or large increment. Defaults to true.

lockAltToStepOnIncrMetric?​

optional lockAltToStepOnIncrMetric: boolean

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:112

Whether to lock the selected altitude setting to multiples of the appropriate increment value on a small or large increment in metric mode. If undefined, it will be set equal to the lock flag in non-metric mode.

lockAltToStepOnSet?​

optional lockAltToStepOnSet: boolean

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:118

Whether to lock the selected altitude setting to multiples of the small increment on a SET event. Defaults to false.

lockAltToStepOnSetMetric?​

optional lockAltToStepOnSetMetric: boolean

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:124

Whether to lock the selected altitude setting to multiples of the small increment in metric mode on a SET event. If undefined, it will be set equal to the lock flag in non-metric mode.

maxValue​

maxValue: NumberUnitInterface<Distance>

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:64

The maximum value of the selected altitude setting.

maxValueMetric?​

optional maxValueMetric: NumberUnitInterface<Distance>

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:76

The maximum value of the selected altitude setting in metric mode. If undefined, it will be set equal to the maximum value in non-metric mode.

minValue​

minValue: NumberUnitInterface<Distance>

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:61

The minimum value of the selected altitude setting.

minValueMetric?​

optional minValueMetric: NumberUnitInterface<Distance>

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:70

The minimum value of the selected altitude setting in metric mode. If undefined, it will be set equal to the minimum value in non-metric mode.

supportMetric​

supportMetric: boolean

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:58

Whether to support metric mode.

transformSetToIncDec?​

optional transformSetToIncDec: boolean

Defined in: src/sdk/autopilot/managers/AltitudeSelectManager.ts:157

Whether to treat all intercepted SET key events as if they were INC or DEC events. Defaults to true.