Skip to main content

Interface: APConfig

Defined in: src/sdk/autopilot/APConfig.ts:21

An autopilot configuration.

Extended by

Properties

altitudeHoldSlotIndex?

optional altitudeHoldSlotIndex: 2 | 1 | 3

Defined in: src/sdk/autopilot/APConfig.ts:83

The altitude hold slot index to use. Defaults to 1


autoEngageFd?

optional autoEngageFd: boolean

Defined in: src/sdk/autopilot/APConfig.ts:103

Whether to automatically engage the FD(s) with AP or mode button presses, defaults to true. Lateral/Vertical press events will be ignored if this is false and neither AP nor FDs are engaged.


autopilotDriverOptions?

readonly optional autopilotDriverOptions: Readonly<AutopilotDriverOptions>

Defined in: src/sdk/autopilot/APConfig.ts:113

Options for the Autopilot Driver


cdiId?

readonly optional cdiId: string

Defined in: src/sdk/autopilot/APConfig.ts:89

The ID of the CDI associated with the autopilot. Defaults to the empty string ''.


deactivateAutopilotOnGa?

readonly optional deactivateAutopilotOnGa: boolean

Defined in: src/sdk/autopilot/APConfig.ts:97

Whether to deactivate the autopilot when GA mode is armed in response to a TO/GA mode button press. Defaults to true.


defaultLateralMode

defaultLateralMode: number | () => number

Defined in: src/sdk/autopilot/APConfig.ts:59

The autopilot's default lateral mode.


defaultMaxBankAngle?

optional defaultMaxBankAngle: number

Defined in: src/sdk/autopilot/APConfig.ts:68

The default maximum bank angle the autopilot may command in degrees. If not defined, then the maximum bank angle will be sourced from the AUTOPILOT MAX BANK SimVar


defaultMaxNoseDownPitchAngle?

optional defaultMaxNoseDownPitchAngle: number

Defined in: src/sdk/autopilot/APConfig.ts:80

The default maximum nose down pitch angle the autopilot may command in degrees. If not defined, then the maximum angle will be 15 degrees.


defaultMaxNoseUpPitchAngle?

optional defaultMaxNoseUpPitchAngle: number

Defined in: src/sdk/autopilot/APConfig.ts:74

The default maximum nose up pitch angle the autopilot may command in degrees. If not defined, then the maximum angle will be 15 degrees.


defaultVerticalMode

defaultVerticalMode: number | () => number

Defined in: src/sdk/autopilot/APConfig.ts:62

The autopilot's default vertical mode.


headingHoldSlotIndex?

optional headingHoldSlotIndex: 2 | 1 | 3

Defined in: src/sdk/autopilot/APConfig.ts:86

The heading hold slot index to use. Defaults to 1


independentFds?

optional independentFds: boolean

Defined in: src/sdk/autopilot/APConfig.ts:108

Whether to have independent flight directors that can be switched on/off separately. Defaults to false.


onlyDisarmLnavOnOffEvent?

optional onlyDisarmLnavOnOffEvent: boolean

Defined in: src/sdk/autopilot/APConfig.ts:94

Whether to only allow disarming (not deactivating) LNAV when receiving the AP_NAV1_HOLD_OFF event


publishAutopilotModesAsLVars?

readonly optional publishAutopilotModesAsLVars: boolean

Defined in: src/sdk/autopilot/APConfig.ts:118

Whether to publish the active and armed autopilot modes as LVars. Defaults to false.

Methods

createLateralDirectors()?

optional createLateralDirectors(apValues): Iterable<Readonly<APConfigDirectorEntry>>

Defined in: src/sdk/autopilot/APConfig.ts:49

Creates the autopilot's lateral mode directors. Mode APLateralModes.NONE (0) is ignored.

Parameters

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns

Iterable<Readonly<APConfigDirectorEntry>>

An iterable of lateral mode directors to add to the autopilot.


createNavToNavManager()?

optional createNavToNavManager(apValues): undefined | NavToNavManager2

Defined in: src/sdk/autopilot/APConfig.ts:35

Creates the autopilot's nav-to-nav manager.

Parameters

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns

undefined | NavToNavManager2

The autopilot's nav-to-nav manager.


createVariableBankManager()?

optional createVariableBankManager(apValues): undefined | Record<any, any>

Defined in: src/sdk/autopilot/APConfig.ts:42

Creates the autopilot's variable bank manager.

Parameters

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns

undefined | Record<any, any>

The autopilot's variable bank manager.


createVerticalDirectors()?

optional createVerticalDirectors(apValues): Iterable<Readonly<APConfigDirectorEntry>>

Defined in: src/sdk/autopilot/APConfig.ts:56

Creates the autopilot's vertical mode directors. Mode APVerticalModes.NONE (0) is ignored.

Parameters

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns

Iterable<Readonly<APConfigDirectorEntry>>

An iterable of vertical mode directors to add to the autopilot.


createVNavManager()?

optional createVNavManager(apValues): undefined | VNavManager

Defined in: src/sdk/autopilot/APConfig.ts:28

Creates the autopilot's VNAV Manager.

Parameters

ParameterTypeDescription
apValuesAPValuesThe autopilot's state values.

Returns

undefined | VNavManager

The autopilot's VNAV Manager.