Skip to main content

Type Alias: APHdgDirectorOptions

APHdgDirectorOptions = object

Defined in: src/sdk/autopilot/directors/APHdgDirector.ts:10

Options for APHdgDirector.

Properties​

bankRate?​

optional bankRate: number | () => number

Defined in: src/sdk/autopilot/directors/APHdgDirector.ts:22

The bank rate to enforce when the director commands changes in bank angle, in degrees per second, or a function which returns it. If not undefined, a default bank rate will be used. Defaults to undefined.

isToGaMode?​

optional isToGaMode: boolean

Defined in: src/sdk/autopilot/directors/APHdgDirector.ts:41

Whether the director is to be used as a TO/GA lateral mode. If false, then the director will hold the autopilot's selected heading and will control the state of the AUTOPILOT HEADING LOCK SimVar. If true, then the director will hold the airplane's current heading at the time of director activation or the transition from on-ground to in-air, whichever comes later, and will not control the state of the AUTOPILOT HEADING LOCK SimVar. Defaults to false.

maxBankAngle?​

optional maxBankAngle: number | () => number

Defined in: src/sdk/autopilot/directors/APHdgDirector.ts:16

The maximum bank angle, in degrees, supported by the director, or a function which returns it. If not defined, the director will use the maximum bank angle defined by its parent autopilot (via apValues). Defaults to undefined.

turnReversalThreshold?​

optional turnReversalThreshold: number

Defined in: src/sdk/autopilot/directors/APHdgDirector.ts:32

The threshold difference between selected heading and current heading, in degrees, at which the director unlocks its commanded turn direction and chooses a new optimal turn direction to establish on the selected heading, potentially resulting in a turn reversal. Any value less than or equal to 180 degrees effectively prevents the director from locking a commanded turn direction. Any value greater than or equal to 360 degrees will require the selected heading to traverse past the current heading in the desired turn direction in order for the director to issue a turn reversal. Defaults to 0.