Interface: APConfig

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

An autopilot configuration.

Properties

altitudeHoldDefaultAltitude?

optional altitudeHoldDefaultAltitude: number

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

The default altitude hold value set during init, defaults to 0

---

altitudeHoldSlotIndex?

optional altitudeHoldSlotIndex: 2 | 1 | 3

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

The altitude hold slot index to use. Defaults to 1

---

autoEngageFd?

optional autoEngageFd: boolean

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

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

Options for the Autopilot Driver

---

cdiId?

readonly optional cdiId: string

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

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

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

---

defaultLateralMode

defaultLateralMode: APLateralModes | () => APLateralModes

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

The autopilot's default lateral mode.

---

defaultMaxBankAngle?

optional defaultMaxBankAngle: number

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

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

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

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: APVerticalModes | () => APVerticalModes

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

The autopilot's default vertical mode.

---

headingHoldSlotIndex?

optional headingHoldSlotIndex: 2 | 1 | 3

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

The heading hold slot index to use. Defaults to 1

---

independentFds?

optional independentFds: boolean

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

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

---

initializeStateManagerOnFirstFlightPlanSync?

readonly optional initializeStateManagerOnFirstFlightPlanSync: boolean

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

When true, will initialize the state manager when the flight plan is next synced. This is a work around to delay initialization of autopilot, and you may not need it if you handle initialization of the ap state manager in your code. Defaults to true.

---

onlyDisarmLnavOnOffEvent?

optional onlyDisarmLnavOnOffEvent: boolean

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

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

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

Methods

createAltCapDirector()?

optional createAltCapDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's altitude capture mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's altitude capture mode director.

---

createAltHoldDirector()?

optional createAltHoldDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's altitude hold mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's altitude hold mode director.

---

createBcDirector()?

optional createBcDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's back-course mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's back-course mode director.

---

createFlareDirector()?

optional createFlareDirector(): undefined | PlaneDirector

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

Creates the auto land FLARE mode director.

Returns

undefined | PlaneDirector

The autopilot's FLARE mode director.

---

createFlcDirector()?

optional createFlcDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's flight level change mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's flight level change mode director.

---

createFmsLocLateralDirector()?

optional createFmsLocLateralDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's FMC LOC-style mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's FMS LOC mode director.

---

createFpaDirector()?

optional createFpaDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's flight path angle mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's flight path angle mode director.

---

createGaLateralDirector()?

optional createGaLateralDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's lateral go-around mode director.

Parameters

Parameter	Type
apValues	APValues

Returns

undefined | PlaneDirector

The autopilot's lateral go-around mode director.

---

createGaVerticalDirector()?

optional createGaVerticalDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's vertical go-around mode director.

Parameters

Parameter	Type
apValues	APValues

Returns

undefined | PlaneDirector

The autopilot's vertical go-around mode director.

---

createGpDirector()?

optional createGpDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's GPS glidepath mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's GPS glidepath mode director.

---

createGpssDirector()?

optional createGpssDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's GPS LNAV mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's GPS LNAV mode director.

---

createGsDirector()?

optional createGsDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's ILS glideslope mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's ILS glideslope mode director.

---

createHeadingDirector()?

optional createHeadingDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's heading mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's heading mode director.

---

createHeadingHoldDirector()?

optional createHeadingHoldDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's heading hold (level off and then capture heading)

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's heading hold director.

---

createLocDirector()?

optional createLocDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's LOC mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's LOC mode director.

---

createNavToNavManager()?

optional createNavToNavManager(apValues): undefined | NavToNavManager | NavToNavManager2

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

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

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | NavToNavManager | NavToNavManager2

The autopilot's nav-to-nav manager.

---

createPitchDirector()?

optional createPitchDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's pitch mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's pitch mode director.

---

createPitchLevelerDirector()?

optional createPitchLevelerDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's pitch level mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's pitch level mode director.

---

createRollDirector()?

optional createRollDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's roll mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's heading mode director.

---

createRolloutDirector()?

optional createRolloutDirector(): undefined | PlaneDirector

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

Creates the autopilot's ROLLOUT mode director.

Returns

undefined | PlaneDirector

The autopilot's ROLLOUT mode director.

---

createTakeoffLocLateralDirector()?

optional createTakeoffLocLateralDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's takeoff LOC mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's takeoff LOC mode director.

---

createToLateralDirector()?

optional createToLateralDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's lateral takeoff mode director (or combined lateral takeoff/go-around mode director).

Parameters

Parameter	Type
apValues	APValues

Returns

undefined | PlaneDirector

The autopilot's lateral takeoff mode director.

---

createToVerticalDirector()?

optional createToVerticalDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's vertical takeoff mode director (or combined vertical takeoff/go-around mode director).

Parameters

Parameter	Type
apValues	APValues

Returns

undefined | PlaneDirector

The autopilot's vertical takeoff mode director.

---

createTrackDirector()?

optional createTrackDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's track mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's heading mode director.

---

createTrackHoldDirector()?

optional createTrackHoldDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's track hold (level off and then capture track)

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's heading hold director.

---

createVariableBankManager()?

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

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

Creates the autopilot's variable bank manager.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | Record<any, any>

The autopilot's variable bank manager.

---

createVNavManager()?

optional createVNavManager(apValues): undefined | VNavManager

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

Creates the autopilot's VNAV Manager.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | VNavManager

The autopilot's VNAV Manager.

---

createVNavPathDirector()?

optional createVNavPathDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's VNAV Path mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's VNAV Path mode director.

---

createVorDirector()?

optional createVorDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's VOR mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's VOR mode director.

---

createVsDirector()?

optional createVsDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's vertical speed mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's vertical speed mode director.

---

createWingLevelerDirector()?

optional createWingLevelerDirector(apValues): undefined | PlaneDirector

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

Creates the autopilot's wings level mode director.

Parameters

Parameter	Type	Description
apValues	APValues	The autopilot's state values.

Returns

undefined | PlaneDirector

The autopilot's wings level mode director.