Skip to main content

Type Alias: APAltCapDirectorOptions

APAltCapDirectorOptions = object

Defined in: src/sdk/autopilot/directors/APAltCapDirector.ts:11

Options for APAltCapDirector.

Properties​

captureAltitude​

captureAltitude: APAltCapDirectorCaptureFunc | undefined

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

An optional function that contains the logic for the capturing. Has to return the desired pitch as input for the pitch controller.

shouldActivate​

shouldActivate: APAltCapDirectorActivationFunc | undefined

Defined in: src/sdk/autopilot/directors/APAltCapDirector.ts:21

A function that returns true if the capturing shall start.

targetChangeInhibitTime​

targetChangeInhibitTime: number | null

Defined in: src/sdk/autopilot/directors/APAltCapDirector.ts:29

The time to inhibit altitude capture when the target altitude is changed, in ms. Setting the time to null disables inhibition. Defaults to 500 ms. Note that if alt capture is already active when the target is changed, this will have no effect.