Skip to content

Commit e54868d

Browse files
committed
Update VSE docs
1 parent ea63c1c commit e54868d

File tree

1 file changed

+100
-66
lines changed

1 file changed

+100
-66
lines changed

docs/acars/vse.md

Lines changed: 100 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@ Might not always be set or available
1313
- [`Aircraft`](#aircraft)
1414
- **airline** - The airline the pilot is a part of
1515
- [`Airline`](#airline)
16-
- **approachTime** - A DateTime object, the time in the sim. See:
17-
https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties
16+
- **approachTime** - A DateTime object, the time in the sim
17+
<a href="https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties">See DateTime
18+
properties</a>
1819
- `System.DateTime`
19-
- **approachTimeActual** - A DateTime object, system time. See:
20-
https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties
20+
- **approachTimeActual** - A DateTime object, system time
21+
<a href="https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties">See DateTime
22+
properties</a>
2123
- `System.DateTime`
2224
- **arrivalAirport** - The arrival airport, null if they haven't landed yet
2325
- [`Airport`](#airport)
@@ -27,23 +29,29 @@ Might be null if it wasn't detected
2729
- **arrivalRunway** - The runway that they landed on.
2830
Might be null if it wasn't detected
2931
- [`Runway`](#runway)
30-
- **blocksOffTime** - DateTime object, the time in the sim. See:
31-
https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties
32+
- **blocksOffTime** - DateTime object, the time in the sim
33+
<a href="https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties">See DateTime
34+
properties</a>
3235
- `System.DateTime`
33-
- **blocksOffTimeActual** - A DateTime object. Real time. See:
34-
https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties
36+
- **blocksOffTimeActual** - A DateTime object. Real time
37+
<a href="https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties">See DateTime
38+
properties</a>
3539
- `System.DateTime`
36-
- **blocksOnTime** - A DateTime object, the time in the sim. See:
37-
https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties
40+
- **blocksOnTime** - A DateTime object, the time in the sim
41+
<a href="https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties">See DateTime
42+
properties</a>
3843
- `System.DateTime`
39-
- **blocksOnTimeActual** - A DateTime object, system time. See:
40-
https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties
44+
- **blocksOnTimeActual** - A DateTime object, system time
45+
<a href="https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties">See DateTime
46+
properties</a>
4147
- `System.DateTime`
42-
- **boardingTime** - Unix timestamp, the time in the sim. See:
43-
https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties
48+
- **boardingTime** - Unix timestamp, the time in the sim
49+
<a href="https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties">See DateTime
50+
properties</a>
4451
- `System.DateTime`
45-
- **boardingTimeActual** - A DateTime object, sim time. See:
46-
https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties
52+
- **boardingTimeActual** - A DateTime object, sim time
53+
<a href="https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties">See DateTime
54+
properties</a>
4755
- `System.DateTime`
4856
- **crossingRunway** - This will have a value, with the runway information,
4957
if they're currently on a runway
@@ -64,8 +72,8 @@ Might be null if it wasn't detected
6472
Might not always be set or available
6573
- `UnitsNet.Length`
6674
- **elapsedTime** - Get the time elapsed, subtract the current sim time from the blocks off time
67-
Timespan object. See:
68-
https://learn.microsoft.com/en-us/dotnet/api/system.timespan?view=net-8.0#properties
75+
<a href="https://learn.microsoft.com/en-us/dotnet/api/system.timespan?view=net-8.0#properties">See TimeSpan
76+
properties</a>
6977
- `System.TimeSpan`
7078
- **elapsedTimeHumanReadable**
7179
- `string`
@@ -86,23 +94,28 @@ a bid, or loaded on the screen
8694
- [`FlightPlan`](#flightplan)
8795
- **flightType**
8896
- `string`
89-
- **fuelAtApproach** - The fuel. See:
90-
https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.json
97+
- **fuelAtApproach** - The fuel
98+
<a href="https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.json">See unit
99+
conversion properties</a>
91100
- `UnitsNet.Mass`
92-
- **fuelAtLanding** - The fuel. See:
93-
https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.json
101+
- **fuelAtLanding** - The fuel
102+
<a href="https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.json">See unit
103+
conversion properties</a>
94104
- `UnitsNet.Mass`
95-
- **fuelAtTakeOff** - The fuel. See:
96-
https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.json
105+
- **fuelAtTakeOff** - The fuel
106+
<a href="https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.json">See unit
107+
conversion properties</a>
97108
- `UnitsNet.Mass`
98-
- **fuelBlocksOff** - Weight. See:
99-
https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.json
109+
- **fuelBlocksOff** - Weight <a href="https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.json">See unit
110+
conversion properties</a>
100111
- `UnitsNet.Mass`
101-
- **fuelBlocksOn** - The fuel. See:
102-
https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.json
112+
- **fuelBlocksOn** - The fuel
113+
<a href="https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.json">See unit
114+
conversion properties</a>
103115
- `UnitsNet.Mass`
104-
- **fuelUsed** - The fuel. See:
105-
https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.json
116+
- **fuelUsed** - The fuel
117+
<a href="https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.json">See unit
118+
conversion properties</a>
106119
- `UnitsNet.Mass`
107120
- **id** - The phpVMS PIREP ID
108121
- `string`
@@ -114,11 +127,13 @@ https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.j
114127
- `boolean`
115128
- **isResuming** - If this PIREP is being resumed
116129
- `boolean`
117-
- **landedTime** - A DateTime object, the time in the sim. See:
118-
https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties
130+
- **landedTime** - A DateTime object, the time in the sim
131+
<a href="https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties">See DateTime
132+
properties</a>
119133
- `System.DateTime`
120-
- **landedTimeActual** - A DateTime object, system time. See:
121-
https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties
134+
- **landedTimeActual** - A DateTime object, system time
135+
<a href="https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties">See DateTime
136+
properties</a>
122137
- `System.DateTime`
123138
- **landingRate**
124139
- `UnitsNet.Speed`
@@ -169,8 +184,8 @@ Might not always be set or available
169184
- **startedWithBrakes** - Did they start the flight with the brakes on? Use this to determine the criterea on
170185
moving out of the Boarding phase
171186
- `boolean`
172-
- **startTime** - DateTime object, the time in the sim. See:
173-
https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties
187+
- **startTime** - DateTime object, the time in the sim
188+
<a href="https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties">See DateTime properties</a>
174189
- `System.DateTime`
175190
- **state** - The PIREP states - these match the phase
176191
- `string`
@@ -190,38 +205,46 @@ https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#proper
190205
- Cancelled
191206
- Filed
192207
- Paused
193-
- **takeoffTime** - A DateTime object, sim time. See:
194-
https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties
208+
- **takeoffTime** - A DateTime object, sim time
209+
<a href="https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties">See DateTime
210+
properties</a>
195211
- `System.DateTime`
196-
- **takeoffTimeActual** - A DateTime object, system time. See:
197-
https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties
212+
- **takeoffTimeActual** - A DateTime object, system time
213+
<a href="https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties">See DateTime
214+
properties</a>
198215
- `System.DateTime`
199-
- **taxiFuelOut** - The fuel. See:
200-
https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.json
216+
- **taxiFuelOut** - The fuel. <a href="https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.json">See unit
217+
conversion properties</a>
201218
- `UnitsNet.Mass`
202-
- **taxiInDuration** - Timespan object. See:
203-
https://learn.microsoft.com/en-us/dotnet/api/system.timespan?view=net-8.0#properties
219+
- **taxiInDuration** - Timespan object
220+
<a href="https://learn.microsoft.com/en-us/dotnet/api/system.timespan?view=net-8.0#properties">See TimeSpan
221+
properties</a>
204222
- `System.TimeSpan`
205-
- **taxiOutDuration** - Timespan object. See:
206-
https://learn.microsoft.com/en-us/dotnet/api/system.timespan?view=net-8.0#properties
223+
- **taxiOutDuration** - Timespan object
224+
<a href="https://learn.microsoft.com/en-us/dotnet/api/system.timespan?view=net-8.0#properties">See TimeSpan
225+
properties</a>
207226
- `System.TimeSpan`
208-
- **taxiOutTime** - A DateTime object, sim time. See:
209-
https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties
227+
- **taxiOutTime** - A DateTime object, sim time
228+
<a href="https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties">See DateTime
229+
properties</a>
210230
- `System.DateTime`
211-
- **taxiOutTimeActual** - A DateTime object, system time. See:
212-
https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties
231+
- **taxiOutTimeActual** - A DateTime object, system time
232+
<a href="https://learn.microsoft.com/en-us/dotnet/api/system.datetime?view=net-8.0#properties">See DateTime
233+
properties</a>
213234
- `System.DateTime`
214-
- **thresholdDistance** - Distance from the threshold. See:
215-
https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Length.json
235+
- **thresholdDistance** - Distance from the threshold
236+
<a href="https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Length.json">See
237+
unit conversion properties</a>
216238
- `UnitsNet.Length`
217239
- **todPauseCompleted** - Save whether we've already paused or not for the TOD
218240
- `boolean`
219241
- **todPauseDistance** - Or pause the given distance before
220242
- `number`
221243
- **todPauseOn** - Whether we should pause at TOD or not
222244
- `boolean`
223-
- **totalPauseTime** - Timespan object. See:
224-
https://learn.microsoft.com/en-us/dotnet/api/system.timespan?view=net-8.0#properties
245+
- **totalPauseTime** - Timespan object
246+
<a href="https://learn.microsoft.com/en-us/dotnet/api/system.timespan?view=net-8.0#properties">See TimeSpan
247+
properties</a>
225248
- `System.TimeSpan`
226249

227250
---
@@ -248,7 +271,9 @@ https://learn.microsoft.com/en-us/dotnet/api/system.timespan?view=net-8.0#proper
248271
- The number of engines
249272
- **engineFuelFlow**
250273
- `UnitsNet.MassFlow[]`
251-
- **engineMaxRpm** - Has units. See https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/RotationalSpeed.json
274+
- **engineMaxRpm** - Has units.
275+
<a href="https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/RotationalSpeed.json">See
276+
for details about unit properties</a>
252277
- `UnitsNet.RotationalSpeed`
253278
- The total N1 percent
254279
- **engineN2Average** - Get the current engine N2 value (as an average)
@@ -273,6 +298,8 @@ https://learn.microsoft.com/en-us/dotnet/api/system.timespan?view=net-8.0#proper
273298
- **fuelQuantity**
274299
- `UnitsNet.Mass`
275300
- The current fuel quantity (weight)
301+
<a href="https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.json">See
302+
for details about unit properties</a>
276303
- **gearUp**
277304
- `boolean`
278305
- True if the gear is up
@@ -283,21 +310,23 @@ https://learn.microsoft.com/en-us/dotnet/api/system.timespan?view=net-8.0#proper
283310
- `number`
284311
- The g-force at touchdown
285312
- **groundAltitude** - Altitude of plane above the ground. Has units, like .Feet/.Meters
286-
See https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Length.json
313+
<a href="https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Length.json">See
314+
for details about unit properties</a>
287315
- `UnitsNet.Length`
288316
- The ground altitude (AGL)
289-
- **groundSpeed**
317+
- **groundSpeed** - <a href="https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Speed.json">See
318+
for details about unit properties</a>
290319
- `UnitsNet.Speed`
291320
- If all of the engines are running. Has units, like .Knots
292-
See https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Speed.json
293321
- **heading**
294322
- `number`
295323
- The true heading
296324
- **headingMagnetic**
297325
- `number`
298326
- The magnetic heading
299327
- **indicatedAirspeed** - The indicated airspeed
300-
See https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Speed.json
328+
<a href="https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Speed.json">See
329+
for details about unit properties</a>
301330
- `UnitsNet.Speed`
302331
- Indicated airspeed. Has units, like .Knots
303332
- **landingLights**
@@ -331,13 +360,15 @@ See https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Sp
331360
- `boolean`
332361
- Is the sim paused? inherited
333362
- **payloadWeight** - Weight of the payload
334-
See https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.json
363+
/// <a href="https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.json">See
364+
for details about unit properties</a>
335365
- `UnitsNet.Mass`
336366
- **pitch**
337367
- `number`
338368
- Aircraft pitch, +/-
339369
- **planeAltitude** - Altitude of plane above MSL. Has units, like .Feet/.Meters
340-
See https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Length.json
370+
<a href="https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Length.json">See
371+
for details about unit properties</a>
341372
- `UnitsNet.Length`
342373
- The indicated altitude
343374
- **replay**
@@ -368,26 +399,29 @@ track of if we're crossing a runway or something
368399
- **throttles**
369400
- `array`
370401
- **totalWeight** - Total weight of the aircraft
371-
See https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.json
402+
<a href="https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.json">See
403+
for details about unit properties</a>
372404
- `UnitsNet.Mass`
373405
- **transponderCode** - The transponder code
374406
- `System.UInt32`
375407
- Transponder code
376408
- **unlimitedFuel**
377409
- `boolean`
378410
- If unlimited fuel is enabled
379-
- **verticalSpeed**
411+
- **verticalSpeed** - <a href="https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Speed.json">See
412+
for details about unit properties</a>
380413
- `UnitsNet.Speed`
381414
Their vertical speed (+/-). Has units - FeetPerMinute
382-
See https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Speed.json
383-
- **verticalSpeedTouchdown**
415+
- **verticalSpeedTouchdown** - <a href="https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Speed.json">See
416+
for details about unit properties</a>
384417
- `UnitsNet.Speed`
385418
- The vertical speed at touchdown
386419
- **wingLights**
387420
- `boolean`
388421
- Boolean for lights
389422
- **zeroFuelWeight** - The zero fuel weight
390-
See https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.json
423+
<a href="https://github.com/angularsen/UnitsNet/blob/master/Common/UnitDefinitions/Mass.json">See
424+
for details about unit properties</a>
391425
- `UnitsNet.Mass`
392426

393427
---

0 commit comments

Comments
 (0)