Skip to main content

Type Alias: AltitudeSelectManagerOptions

AltitudeSelectManagerOptions = object

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

Configuration options for AltitudeSelectManager.

Properties​

accelFilter?​

optional accelFilter: number

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

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:155

The required number of consecutive small-increment inputs received to trigger input acceleration. Only applies to the AltitudeSelectManagerAccelType.SmallToLarge acceleration type. A threshold less than or equal to zero disables input acceleration. Defaults to 0.

accelInputCountWindow?​

optional accelInputCountWindow: number

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

The maximum amount of time, in milliseconds, between input events that are counted as consecutive for triggering input acceleration. Only applies to the AltitudeSelectManagerAccelType.SmallToLarge acceleration type. Defaults to 300.

accelInputRateThreshold?​

optional accelInputRateThreshold: number

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

The required average rate of inputs received to trigger input acceleration. Only applies to the AltitudeSelectManagerAccelType.DynamicSmall acceleration type. A threshold less than or equal to zero enables input acceleration for every eligible input. Defaults to 0.

accelInputRateTransformer()?​

optional accelInputRateTransformer: (inputRate) => number

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

A function that transforms an observed input rate to an accelerated input rate when input acceleration is active. The amount by which each input increments the selected altitude setting will be adjusted such that the setting's rate of change approximately equals that which would be effected by unaccelerated inputs at the transformed rate.

Parameters​

ParameterTypeDescription
inputRatenumberThe observed input rate to transform, in inputs per second.

Returns​

number

The accelerated input rate for the specified observed input rate, in inputs per second.

accelInputRateWindow?​

optional accelInputRateWindow: number

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

The window of time, in milliseconds, over which input rate is averaged when calculating input acceleration. Only applies to the AltitudeSelectManagerAccelType.DynamicSmall acceleration type. A window less than or equal to zero disables input acceleration. Defaults to 0.

accelResetOnDirectionChange?​

optional accelResetOnDirectionChange: boolean

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

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

accelType?​

optional accelType: AltitudeSelectManagerAccelType

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

The type of input acceleration to use when handling increment/decrement events. Defaults to AltitudeSelectManagerAccelType.None.

altitudeHoldSlotIndex?​

optional altitudeHoldSlotIndex: 1 | 2 | 3

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

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

incrLarge​

incrLarge: NumberUnitInterface<Distance>

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

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:118

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:103

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:112

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:200

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:206

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:100

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:124

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:130

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:136

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:142

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:82

The maximum value of the selected altitude setting.

maxValueMetric?​

optional maxValueMetric: NumberUnitInterface<Distance>

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

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:79

The minimum value of the selected altitude setting.

minValueMetric?​

optional minValueMetric: NumberUnitInterface<Distance>

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

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:76

Whether to support metric mode.

transformSetToIncDec?​

optional transformSetToIncDec: boolean

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

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