@skyvexsoftware/stratos-sdk 0.16.5 → 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -46,7 +46,30 @@ export type FlightData = {
46
46
  indicatedAirspeed: number;
47
47
  trueAirspeed: number;
48
48
  verticalSpeed: number;
49
+ /**
50
+ * Heading against **true** north, in degrees. This is what every simulator
51
+ * reports natively, and what the client's geometry depends on: runway
52
+ * matching compares it against a runway's true bearing, and the tracking map
53
+ * is true-north-up. It is *not* what a pilot sees on the ND, so use
54
+ * `headingMagnetic` for anything displayed alongside cockpit instruments.
55
+ */
49
56
  heading: number;
57
+ /**
58
+ * Heading against **magnetic** north, in degrees. That is the reference the
59
+ * ND, the compass and the runway number all use, so this is the one to show
60
+ * a pilot. Derived from `heading` and `magVar`, and equal to `heading` when
61
+ * the sim has not reported a variation yet. Optional until every sim client
62
+ * populates it.
63
+ */
64
+ headingMagnetic?: number;
65
+ /**
66
+ * Magnetic variation at the aircraft's position, in degrees, east-positive
67
+ * (`magnetic = true - magVar`). Zero when the sim has not reported one yet.
68
+ * MSFS: the MAGVAR SimVar. X-Plane: recovered from the gap between the true
69
+ * and magnetic heading datarefs. Optional until every sim client populates
70
+ * it.
71
+ */
72
+ magVar?: number;
50
73
  pitch: number;
51
74
  bank: number;
52
75
  gearControl: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyvexsoftware/stratos-sdk",
3
- "version": "0.16.5",
3
+ "version": "0.17.0",
4
4
  "description": "Plugin SDK for Stratos — types, hooks, and UI components",
5
5
  "author": {
6
6
  "name": "Skyvex Software Pty Ltd",