Class: AiPilotPublisher

A publisher for events related to the sim's AI piloting feature.

Hierarchy

• SimVarPublisher<AiPilotEvents>

  ↳ AiPilotPublisher

Constructors

constructor

• new AiPilotPublisher(bus): AiPilotPublisher

Creates a new instance of AiPilotPublisher.

Parameters

Name	Type	Description
bus	EventBus	The event bus to which to publish.

Returns

AiPilotPublisher

Overrides

SimVarPublisher.constructor

Defined in

src/sdk/instruments/AiPilotPublisher.ts:30

Properties

bus

• Protected Readonly bus: EventBus

Inherited from

SimVarPublisher.bus

Defined in

src/sdk/instruments/BasePublishers.ts:10

---

indexedSimVars

• Protected Readonly indexedSimVars: Map<"ai_delegate_controls_active" | "ai_auto_rudder_active", IndexedSimVarPublisherEntry<any>>

Inherited from

SimVarPublisher.indexedSimVars

Defined in

src/sdk/instruments/BasePublishers.ts:149

---

pacer

• Protected Readonly pacer: undefined | PublishPacer<AiPilotEvents>

Inherited from

SimVarPublisher.pacer

Defined in

src/sdk/instruments/BasePublishers.ts:13

---

publishActive

• Protected publishActive: boolean

Inherited from

SimVarPublisher.publishActive

Defined in

src/sdk/instruments/BasePublishers.ts:12

---

publisher

• Protected Readonly publisher: Publisher<AiPilotEvents>

Inherited from

SimVarPublisher.publisher

Defined in

src/sdk/instruments/BasePublishers.ts:11

---

resolvedSimVars

• Protected Readonly resolvedSimVars: Map<"ai_delegate_controls_active" | "ai_auto_rudder_active", ResolvedSimVarPublisherEntry<any>>

Inherited from

SimVarPublisher.resolvedSimVars

Defined in

src/sdk/instruments/BasePublishers.ts:147

---

subscribed

• Protected Readonly subscribed: Set<"ai_delegate_controls_active" | "ai_auto_rudder_active">

Inherited from

SimVarPublisher.subscribed

Defined in

src/sdk/instruments/BasePublishers.ts:151

---

INDEXED_REGEX

▪ Static Protected Readonly INDEXED_REGEX: RegExp

Inherited from

SimVarPublisher.INDEXED_REGEX

Defined in

src/sdk/instruments/BasePublishers.ts:145

Methods

getValue

▸ getValue<K>(topic): undefined | AiPilotEvents[K]

Gets the current value for a topic.

Type parameters

Name	Type
K	extends "ai_delegate_controls_active" | "ai_auto_rudder_active"

Parameters

Name	Type	Description
topic	K	A topic.

Returns

undefined | AiPilotEvents[K]

The current value for the specified topic.

Inherited from

SimVarPublisher.getValue

Defined in

src/sdk/instruments/BasePublishers.ts:343

---

getValueFromEntry

▸ getValueFromEntry<T>(entry): T

Gets the current value for a resolved topic entry.

Type parameters

Name
T

Parameters

Name	Type	Description
entry	ResolvedSimVarPublisherEntry<T>	An entry for a resolved topic.

Returns

T

The current value for the specified entry.

Inherited from

SimVarPublisher.getValueFromEntry

Defined in

src/sdk/instruments/BasePublishers.ts:357

---

handleSubscribedTopic

▸ handleSubscribedTopic(topic): void

Handles when an event bus topic is subscribed to for the first time.

Parameters

Name	Type	Description
topic	string	The subscribed topic.

Returns

void

Inherited from

SimVarPublisher.handleSubscribedTopic

Defined in

src/sdk/instruments/BasePublishers.ts:193

---

isPublishing

▸ isPublishing(): boolean

Tells whether or not the publisher is currently active.

Returns

boolean

True if the publisher is active, false otherwise.

Inherited from

SimVarPublisher.isPublishing

Defined in

src/sdk/instruments/BasePublishers.ts:45

---

onTopicSubscribed

▸ onTopicSubscribed(topic): void

Responds to when one of this publisher's topics is subscribed to for the first time.

Parameters

Name	Type	Description
topic	"ai_delegate_controls_active" | "ai_auto_rudder_active"	The topic that was subscribed to.

Returns

void

Inherited from

SimVarPublisher.onTopicSubscribed

Defined in

src/sdk/instruments/BasePublishers.ts:279

---

onUpdate

▸ onUpdate(): void

Publish all subscribed data points to the bus.

Returns

void

Inherited from

SimVarPublisher.onUpdate

Defined in

src/sdk/instruments/BasePublishers.ts:315

---

publish

▸ publish<K>(topic, data, sync?, isCached?): void

Publish a message if publishing is acpive

Type parameters

Name	Type
K	extends keyof AiPilotEvents

Parameters

Name	Type	Default value	Description
topic	K	undefined	The topic key to publish to.
data	AiPilotEvents[K]	undefined	The data type for chosen topic.
sync	boolean	false	Whether or not the event should be synced to other instruments. Defaults to false.
isCached	boolean	true	Whether or not the event should be cached. Defaults to true.

Returns

void

Inherited from

SimVarPublisher.publish

Defined in

src/sdk/instruments/BasePublishers.ts:63

---

publishTopic

▸ publishTopic(topic): void

Publishes data to the event bus for a topic.

Parameters

Name	Type	Description
topic	"ai_delegate_controls_active" | "ai_auto_rudder_active"	The topic to publish.

Returns

void

Inherited from

SimVarPublisher.publishTopic

Defined in

src/sdk/instruments/BasePublishers.ts:325

---

resolveIndexedSimVar

▸ resolveIndexedSimVar(topic, entry, index): undefined | string

Attempts to resolve an indexed topic with an index, generating a version of the topic which is mapped to an indexed simvar. The resolved indexed topic can then be published.

Parameters

Name	Type	Description
topic	"ai_delegate_controls_active" | "ai_auto_rudder_active"	The topic to resolve.
entry	IndexedSimVarPublisherEntry<any>	The entry of the topic to resolve.
index	number	The index with which to resolve the topic. If not defined, the topic will resolve to itself (without a suffix) and will be mapped the index-1 version of its simvar.

Returns

undefined | string

The resolved indexed topic, or undefined if the topic could not be resolved with the specified index.

Inherited from

SimVarPublisher.resolveIndexedSimVar

Defined in

src/sdk/instruments/BasePublishers.ts:250

---

startPublish

▸ startPublish(): void

Start publishing.

Returns

void

Inherited from

SimVarPublisher.startPublish

Defined in

src/sdk/instruments/BasePublishers.ts:30

---

stopPublish

▸ stopPublish(): void

Stop publishing.

Returns

void

Inherited from

SimVarPublisher.stopPublish

Defined in

src/sdk/instruments/BasePublishers.ts:37

---

subscribe

▸ subscribe(data): void

NOOP - For backwards compatibility.

Parameters

Name	Type	Description
data	keyof AiPilotEvents	Key of the event type in the simVarMap

Returns

void

Deprecated

Inherited from

SimVarPublisher.subscribe

Defined in

src/sdk/instruments/BasePublishers.ts:298

---

tryMatchIndexedSubscribedTopic

▸ tryMatchIndexedSubscribedTopic(topic): void

Checks if a subscribed topic matches one of this publisher's indexed topics, and if so resolves and starts publishing the indexed topic.

Parameters

Name	Type	Description
topic	string	The subscribed topic to check.

Returns

void

Inherited from

SimVarPublisher.tryMatchIndexedSubscribedTopic

Defined in

src/sdk/instruments/BasePublishers.ts:208

---

unsubscribe

▸ unsubscribe(data): void

NOOP - For backwards compatibility.

Parameters

Name	Type	Description
data	keyof AiPilotEvents	Key of the event type in the simVarMap

Returns

void

Deprecated

Inherited from

SimVarPublisher.unsubscribe

Defined in

src/sdk/instruments/BasePublishers.ts:308