Type Alias: APRollSteerDirectorOptions

APRollSteerDirectorOptions = object

Defined in: src/sdk/autopilot/directors/APRollSteerDirector.ts:28

Options for APRollSteerDirector.

Properties

bankRate?

optional bankRate: number | () => number

Defined in: src/sdk/autopilot/directors/APRollSteerDirector.ts:40

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.

---

canActivate()?

optional canActivate: (apValues, state) => boolean

Defined in: src/sdk/autopilot/directors/APRollSteerDirector.ts:85

A function that determines whether the director can activate from an armed state.

Parameters

Parameter	Type	Description
apValues	APValues	Autopilot values from the director's parent autopilot.
state	Readonly<APRollSteerDirectorState>	Data describing the state of the director.

Returns

boolean

Whether the director can remain active once it has already been activated.

---

canArm()?

optional canArm: (apValues, state) => boolean

Defined in: src/sdk/autopilot/directors/APRollSteerDirector.ts:69

A function that determines whether the director can remain active once it has already been activated.

Parameters

Parameter	Type	Description
apValues	APValues	Autopilot values from the director's parent autopilot.
state	Readonly<APRollSteerDirectorState>	Data describing the state of the director.

Returns

boolean

Whether the director can remain active once it has already been activated.

---

canRemainActive()?

optional canRemainActive: (apValues, state) => boolean

Defined in: src/sdk/autopilot/directors/APRollSteerDirector.ts:93

A function that determines whether the director can remain active once it has already been activated.

Parameters

Parameter	Type	Description
apValues	APValues	Autopilot values from the director's parent autopilot.
state	Readonly<APRollSteerDirectorState>	Data describing the state of the director.

Returns

boolean

Whether the director can remain active once it has already been activated.

---

canRemainArmed()?

optional canRemainArmed: (apValues, state) => boolean

Defined in: src/sdk/autopilot/directors/APRollSteerDirector.ts:77

A function that determines whether the director can remain active once it has already been activated.

Parameters

Parameter	Type	Description
apValues	APValues	Autopilot values from the director's parent autopilot.
state	Readonly<APRollSteerDirectorState>	Data describing the state of the director.

Returns

boolean

Whether the director can remain active once it has already been activated.

---

maxBankAngle?

optional maxBankAngle: number | () => number

Defined in: src/sdk/autopilot/directors/APRollSteerDirector.ts:34

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.

---

onActivate()?

optional onActivate: (apValues, state) => void

Defined in: src/sdk/autopilot/directors/APRollSteerDirector.ts:54

A function that is called when the director is activated.

Parameters

Parameter	Type	Description
apValues	APValues	Autopilot values from the director's parent autopilot.
state	Readonly<APRollSteerDirectorState>	Data describing the state of the director.

Returns

void

---

onArm()?

optional onArm: (apValues, state) => void

Defined in: src/sdk/autopilot/directors/APRollSteerDirector.ts:47

A function that is called when the director is armed.

Parameters

Parameter	Type	Description
apValues	APValues	Autopilot values from the director's parent autopilot.
state	Readonly<APRollSteerDirectorState>	Data describing the state of the director.

Returns

void

---

onDeactivate()?

optional onDeactivate: (apValues, state) => void

Defined in: src/sdk/autopilot/directors/APRollSteerDirector.ts:61

A function that is called when the director is deactivated.

Parameters

Parameter	Type	Description
apValues	APValues	Autopilot values from the director's parent autopilot.
state	Readonly<APRollSteerDirectorState>	Data describing the state of the director.

Returns

void