Add new MSFS 2024 APIs

EvenAR · EvenAR · commit 6d67341303e6 · 2025-09-12T21:05:43.000+02:00
diff --git a/src/SimConnectConnection.ts b/src/SimConnectConnection.ts
@@ -61,6 +61,8 @@ import {
     ObjectId,
 } from './Types';
 import Timeout = NodeJS.Timeout;
+import { RecvEnumerateSimobjectAndLiveryList } from './recv/RecvEnumerateSimobjectAndLiveryList';
+import { RecvFlowEvent } from './recv/RecvFlowEvent';
 
 type OpenPacketData = {
     major: number;
@@ -99,6 +101,13 @@ const openPacketData: { [key in Protocol]: OpenPacketData } = {
         buildMinor: 3,
         alias: 'HK', // "Hawk" + "Kitty"?
     },
+    [Protocol.SunRise]: {
+        major: 12,
+        minor: 2,
+        buildMajor: 282174,
+        buildMinor: 999,
+        alias: 'SR', // Unverified
+    },
 };
 
 interface SimConnectRecvEvents {
@@ -143,6 +152,10 @@ interface SimConnectRecvEvents {
     enumerateInputEventParams: (
         recvEnumerateInputEventParams: RecvEnumerateInputEventParams
     ) => void;
+    enumerateSimobjectAndLiveryList: (
+        recvEnumerateSimobjectAndLiveryList: RecvEnumerateSimobjectAndLiveryList
+    ) => void;
+    flowEvent: (recvFlowEvent: RecvFlowEvent) => void;
 }
 
 type ConnectionOptions =
@@ -1687,6 +1700,149 @@ class SimConnectConnection extends EventEmitter {
         return this._buildAndSend(this._beginPacket(0x56).putInt32(dataDefinitionId));
     }
 
+    /**
+     *
+     * @returns sendId of packet (can be used to identify packet when exception event occurs)
+     */
+    aICreateParkedATCAircraftEx1(
+        containerTitle: string,
+        livery: string,
+        tailNumber: string,
+        airportID: string,
+        dataRequestId: DataRequestId
+    ): number {
+        if (this._ourProtocol < Protocol.SunRise) throw Error(SimConnectError.BadVersion);
+
+        return this._buildAndSend(
+            this._beginPacket(0x57)
+                .putString256(containerTitle)
+                .putString256(livery)
+                .putString(tailNumber, 12)
+                .putString(airportID, 5)
+                .putInt32(dataRequestId)
+        );
+    }
+
+    /**
+     *
+     * @returns sendId of packet (can be used to identify packet when exception event occurs)
+     */
+    aICreateEnrouteATCAircraftEx1(
+        containerTitle: string,
+        livery: string,
+        tailNumber: string,
+        flightNumber: number,
+        flightPlanPath: string,
+        flightPlanPosition: number,
+        touchAndGo: boolean,
+        dataRequestId: DataRequestId
+    ): number {
+        if (this._ourProtocol < Protocol.SunRise) throw Error(SimConnectError.BadVersion);
+
+        return this._buildAndSend(
+            this._beginPacket(0x58)
+                .putString256(containerTitle)
+                .putString256(livery)
+                .putString(tailNumber, 12)
+                .putInt32(flightNumber)
+                .putString(flightPlanPath, 260)
+                .putFloat64(flightPlanPosition)
+                .putInt32(touchAndGo ? 1 : 0)
+                .putInt32(dataRequestId)
+        );
+    }
+
+    /**
+     *
+     * @returns sendId of packet (can be used to identify packet when exception event occurs)
+     */
+    aICreateNonATCAircraftEx1(
+        containerTitle: string,
+        livery: string,
+        tailNumber: string,
+        initPos: InitPosition,
+        dataRequestId: DataRequestId
+    ): number {
+        if (this._ourProtocol < Protocol.SunRise) throw Error(SimConnectError.BadVersion);
+
+        const packet = this._beginPacket(0x59)
+            .putString256(containerTitle)
+            .putString256(livery)
+            .putString(tailNumber, 12);
+
+        initPos.writeTo(packet);
+        packet.putInt32(dataRequestId);
+
+        return this._buildAndSend(packet);
+    }
+
+    /**
+     *
+     * @returns sendId of packet (can be used to identify packet when exception event occurs)
+     */
+    aICreateSimulatedObjectEx1(
+        containerTitle: string,
+        livery: string,
+        initPos: InitPosition,
+        dataRequestId: DataRequestId
+    ): number {
+        if (this._ourProtocol < Protocol.SunRise) throw Error(SimConnectError.BadVersion);
+
+        const packet = this._beginPacket(0x5a);
+
+        packet.putString256(containerTitle);
+        packet.putString256(livery);
+        initPos.writeTo(packet);
+        packet.putInt32(dataRequestId);
+
+        return this._buildAndSend(packet);
+    }
+
+    /**
+     *
+     * @returns sendId of packet (can be used to identify packet when exception event occurs)
+     */
+    enumerateSimObjectsAndLiveries(dataRequestId: DataRequestId, type: SimObjectType): number {
+        if (this._ourProtocol < Protocol.SunRise) throw Error(SimConnectError.BadVersion);
+
+        const packet = this._beginPacket(0x5b).putInt32(dataRequestId).putInt32(type);
+
+        return this._buildAndSend(packet);
+    }
+
+    /**
+     *
+     * @returns sendId of packet (can be used to identify packet when exception event occurs)
+     */
+    subscribeToFlowEvent(): number {
+        if (this._ourProtocol < Protocol.SunRise) throw Error(SimConnectError.BadVersion);
+
+        const packet = this._beginPacket(0x5c);
+        return this._buildAndSend(packet);
+    }
+
+    /**
+     *
+     * @returns sendId of packet (can be used to identify packet when exception event occurs)
+     */
+    unsubscribeToFlowEvent(): number {
+        if (this._ourProtocol < Protocol.SunRise) throw Error(SimConnectError.BadVersion);
+
+        const packet = this._beginPacket(0x5d);
+        return this._buildAndSend(packet);
+    }
+
+    /**
+     *
+     * @returns sendId of packet (can be used to identify packet when exception event occurs)
+     */
+    requestAllFacilities(dataRequestId: DataRequestId, type: FacilityListType): number {
+        if (this._ourProtocol < Protocol.SunRise) throw Error(SimConnectError.BadVersion);
+
+        const packet = this._beginPacket(0x5e).putInt32(dataRequestId).putInt32(type);
+        return this._buildAndSend(packet);
+    }
+
     close() {
         if (this._openTimeout !== null) {
             clearTimeout(this._openTimeout);
@@ -1833,6 +1989,15 @@ class SimConnectConnection extends EventEmitter {
             case RecvID.ID_ENUMERATE_INPUT_EVENT_PARAMS:
                 this.emit('enumerateInputEventParams', new RecvEnumerateInputEventParams(data));
                 break;
+            case RecvID.ID_ENUMERATE_SIMOBJECT_AND_LIVERY_LIST:
+                this.emit(
+                    'enumerateSimobjectAndLiveryList',
+                    new RecvEnumerateSimobjectAndLiveryList(data)
+                );
+                break;
+            case RecvID.ID_FLOW_EVENT:
+                this.emit('flowEvent', new RecvFlowEvent(data));
+                break;
         }
     }
 
diff --git a/src/SimConnectSocket.ts b/src/SimConnectSocket.ts
@@ -45,6 +45,8 @@ enum RecvID {
     ID_GET_INPUT_EVENT,
     ID_SUBSCRIBE_INPUT_EVENT,
     ID_ENUMERATE_INPUT_EVENT_PARAMS,
+    ID_ENUMERATE_SIMOBJECT_AND_LIVERY_LIST,
+    ID_FLOW_EVENT,
 }
 
 interface SimConnectMessage {
diff --git a/src/datastructures/EnumerateSimobjectLivery.ts b/src/datastructures/EnumerateSimobjectLivery.ts
@@ -0,0 +1,12 @@
+import { RawBuffer } from '../RawBuffer';
+
+export class EnumerateSimobjectLivery {
+    aircraftTitle: string;
+
+    liveryName: string;
+
+    constructor(data: RawBuffer) {
+        this.aircraftTitle = data.readString256();
+        this.liveryName = data.readString256();
+    }
+}
diff --git a/src/enums/FacilityDataType.ts b/src/enums/FacilityDataType.ts
@@ -25,6 +25,9 @@ export enum FacilityDataType {
     PAVEMENT,
     APPROACHLIGHTS,
     VASI,
+    VDGS,
+    HOLDING_PATTERN,
+    TAXI_PARKING_AIRLINE,
 }
 
 module.exports = {
diff --git a/src/enums/FlowEvent.ts b/src/enums/FlowEvent.ts
@@ -0,0 +1,23 @@
+export enum FlowEvent {
+    NONE,
+    FLT_LOAD,
+    FLT_LOADED,
+    TELEPORT_START,
+    TELEPORT_DONE,
+    BACK_ON_TRACK_START,
+    BACK_ON_TRACK_DONE,
+    SKIP_START,
+    SKIP_DONE,
+    BACK_TO_MAIN_MENU,
+    RTC_START,
+    RTC_END,
+    REPLAY_START,
+    REPLAY_END,
+    FLIGHT_START,
+    FLIGHT_END,
+    PLANE_CRASH,
+}
+
+module.exports = {
+    FlowEvent,
+};
diff --git a/src/enums/Protocol.ts b/src/enums/Protocol.ts
@@ -15,6 +15,10 @@ export enum Protocol {
      * MSFS / Asobo
      */
     KittyHawk = 0x5,
+    /**
+     * MSFS / Asobo, 2024
+     */
+    SunRise = 0x6,
 }
 
 module.exports = {
diff --git a/src/enums/SimObjectType.ts b/src/enums/SimObjectType.ts
@@ -11,9 +11,11 @@ export enum SimObjectType {
     BOAT,
     /** Specifies all AI controlled ground vehicles */
     GROUND,
-
-    /** for invalid values */
-    INVALID,
+    /** MSFS 2024 onwards */
+    HOT_AIR_BALLOON,
+    ANIMAL,
+    USER_AVATAR,
+    USER_CURRENT,
 }
 
 module.exports = {
diff --git a/src/recv/RecvEnumerateSimobjectAndLiveryList.ts b/src/recv/RecvEnumerateSimobjectAndLiveryList.ts
@@ -0,0 +1,16 @@
+import { RecvListTemplate } from './RecvListTemplate';
+import { RawBuffer } from '../RawBuffer';
+import { EnumerateSimobjectLivery } from '../datastructures/EnumerateSimobjectLivery';
+
+export class RecvEnumerateSimobjectAndLiveryList extends RecvListTemplate {
+    simobjectLiveries: EnumerateSimobjectLivery[] = [];
+
+    constructor(data: RawBuffer) {
+        super(data);
+
+        this.simobjectLiveries = [];
+        for (let i = 0; i < this.arraySize; i++) {
+            this.simobjectLiveries.push(new EnumerateSimobjectLivery(data));
+        }
+    }
+}
diff --git a/src/recv/RecvFlowEvent.ts b/src/recv/RecvFlowEvent.ts
@@ -0,0 +1,14 @@
+import { RawBuffer } from '../RawBuffer';
+import { RecvEvent } from './RecvEvent';
+
+export class RecvFlowEvent extends RecvEvent {
+    flowEventID: number;
+
+    fltPath: string;
+
+    constructor(data: RawBuffer) {
+        super(data);
+        this.flowEventID = data.readInt32();
+        this.fltPath = data.readString256();
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,8 @@ enum RecvID {`
`45`	`45`	`ID_GET_INPUT_EVENT,`
`46`	`46`	`ID_SUBSCRIBE_INPUT_EVENT,`
`47`	`47`	`ID_ENUMERATE_INPUT_EVENT_PARAMS,`
	`48`	`+ ID_ENUMERATE_SIMOBJECT_AND_LIVERY_LIST,`
	`49`	`+ ID_FLOW_EVENT,`
`48`	`50`	`}`
`49`	`51`
`50`	`52`	`interface SimConnectMessage {`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,9 @@ export enum FacilityDataType {`
`25`	`25`	`PAVEMENT,`
`26`	`26`	`APPROACHLIGHTS,`
`27`	`27`	`VASI,`
	`28`	`+ VDGS,`
	`29`	`+ HOLDING_PATTERN,`
	`30`	`+ TAXI_PARKING_AIRLINE,`
`28`	`31`	`}`
`29`	`32`
`30`	`33`	`module.exports = {`