FLIGHTPLANS

IMPORTANT! GPS variables are deprecated in Microsoft Flight Simulator 2024. For more information, please see the GPS Vars In MSFS 2024 section.

The tables below indicate the requirements for the GPS Variables that can be used to get and set the different GPS properties associated with Flightplans. You can find a complete index of all available GPS Vars here: GPSVar Index

 

 

General

 

GPS Variable Units Settable
FlightPlanTitle String
FlightPlanDescription String
FlightPlanIsActiveFlightPlan Boolean
FlightPlanIsLoadedApproach Boolean
FlightPlanIsActiveApproach Boolean
FlightPlanIsActiveWaypoint Boolean
FlightPlanIsDirectTo Boolean
FlightPlanDirectToWaypoint Number
FlightPlanActiveWaypoint Number
FlightPlanActiveApproachWaypoint Number
FlightPlanIsActiveWaypointLocked Boolean
FlightPlanWaypointsNumber Number
FlightPlanRouteType

Enum:

  1. DIRECT (0)
  2. VOR (1)
  3. LOWALT (2)
  4. HIGHALT (3)
FlightPlanFlightPlanType

Enum:

  1. NONE (0)
  2. VFR (1)
  3. IFR (2)
FlightPlanCruisingAltitude Meters
FlightPlanDirectToDestination Boolean
FlightPlanCancelDirectTo Boolean

 

 

Departure

 

GPS Variable Units Settable
FlightPlanDepartureAirportIdent String
FlightPlanDepartureName String
FlightPlanDepartureLatitude Degrees
FlightPlanDepartureLongitude Degrees
FlightPlanDepartureAltitude Meters

 

 

Destination

 

GPS Variable Units Settable
FlightPlanDestinationAirportident String
FlightPlanDestinationName String
FlightPlanDestinationLatitude Degrees
FlightPlanDestinationLongitude Degrees
FlightPlanDestinationAltitude Meters

 

 

Alternate

 

GPS Variable Units Settable
FlightPlanAlternateAirportIdent String
FlightPlanAlternateName String
FlightPlanAlternateLatitude Degrees
FlightPlanAlternateLongitude Degrees
FlightPlanAlternateAltitude Meters

 

 

Approach

 

GPS Variable Units Settable
FlightPlanNewApproachAirport String
FlightPlanNewApproachApproach Number
FlightPlanNewApproachTransition Number
FlightPlanNewApproachMissed Boolean
FlightPlanNewApproachAddInitialLeg

Enum:

  1. GPS_APPROACH_LOAD_ONLY (1)
  2. GPS_APPROACH_LOAD_ACTIVATE (2)
  3. GPS_APPROACH_ACTIVATE_VECTORS (3)
FlightPlanLoadApproach Boolean
FlightPlanApproachWaypointType

Enum:

  1. NONE (0)
  2. FIX (1)
  3. PROC_TURN_LEFT (2)
  4. PROC_TURN_RIGHT (3)
  5. DME_ARC_LEFT (4)
  6. DME_ARC_RIGHT (5)
  7. HOLDING_LEFT (6)
  8. HOLDING_RIGHT (7)
  9. DISTANCE (8)
  10. ALTITUDE (9)
  11. MANUAL_SEQ (10)
  12. VECTORS_TO_FINAL (11)
FlightPlanApproachMode

Enum:

  1. NONE (0)
  2. TRANSITION (1)
  3. FINAL (2)
  4. MISSED (3)
FlightPlanApproachSegmentType

Enum:

  1. SEGMENT_LINE (0)
  2. SEGMENT_ARC_CW (1)
  3. SEGMENT_ARC_CCW (2)
FlightPlanApproachSegmentDistance Meters
FlightPlanApproachSegmentLength Meters
FlightPlanApproachIsWaypointRunway Boolean
FlightPlanApproachAirportIdent Runway
FlightPlanApproachIndex Number
FlightPlanApproachName String
FlightPlanApproachTransitionIndex Number
FlightPlanApproachTransitionName String
FlightPlanIsApproachFinal Boolean
FlightPlanIsApproachMissed Boolean
FlightPlanActiveApproachWaypoint Number
FlightPlanApproachWaypointsNumber Number
FlightPlanApproachType

Enum:

  1. UNKNOWN (0)
  2. VFR (1)
  3. HEL (2)
  4. TACAN (3)
  5. NDB (4)
  6. LORAN (5)
  7. RNAV (6)
  8. VOR (7)
  9. GPS (8)
  10. SDF (9)
  11. LDA (10)
  12. LOC (11)
  13. MLS (12)
  14. ILS (13)

 

 

Waypoint

 

GPS Variable Units Settable
FlightPlanAddWaypoint Number
FlightPlanDeleteWaypoint Number
FlightPlanWaypointIndex Number
FlightPlanWaypointLatitude Degrees
FlightPlanWaypointLongitude Degrees
FlightPlanWaypointAltitude Meters
FlightPlanWaypointICAO String
FlightPlanWaypointIdent String
FlightPlanWaypointAirwayIdent String
FlightPlanWaypointType

Enum:

  1. NONE (0)
  2. AIRPORT (1)
  3. INTERSECTION (2)
  4. VOR (3)
  5. NDB (4)
  6. USER (5)
  7. ATC (6)
FlightPlanWaypointMinAltitude Meters
FlightPlanWaypointFrequency Hz
FlightPlanWaypointMagneticHeading Degrees
FlightPlanWaypointSpeedEstimate Meters per Second
FlightPlanWaypointDistance Meters
FlightPlanWaypointDistanceTotal Meters
FlightPlanWaypointDistanceRemaining Meters
FlightPlanWaypointRemainingDistance Meters
FlightPlanWaypointRemainingTotalDistance Meters
FlightPlanWaypointTimeZoneDeviation Seconds
FlightPlanWaypointETE Seconds
FlightPlanWaypointET Seconds
FlightPlanWaypointATE Seconds
FlightPlanWaypointAT Seconds
FlightPlanWaypointEstimatedTimeRemaining Seconds
FlightPlanWaypointETA Seconds
FlightPlanWaypointFuelRemainedAtArrival Gallons
FlightPlanWaypointEstimatedFuelConsumption Gallons
FlightPlanWaypointActualFuelConsumption Gallons

 

 

Waypoint Approach

 

GPS Variable Units Settable
FlightPlanWaypointApproachIndex Number
FlightPlanWaypointApproachType

Enum:

  1. NONE (0)
  2. FIX (1)
  3. PROC_TURN_LEFT (2)
  4. PROC_TURN_RIGHT (3)
  5. DME_ARC_LEFT (4)
  6. DME_ARC_RIGHT (5)
  7. HOLDING_LEFT (6)
  8. HOLDING_RIGHT (7)
  9. DISTANCE (8)
  10. ALTITUDE (9)
  11. MANUAL_SEQ (10)
  12. VECTORS_TO_FINAL (11)
FlightPlanWaypointApproachMode

Enum:

  1. NONE (0)
  2. TRANSITION (1)
  3. FINAL (2)
  4. MISSED (3)
FlightPlanWaypointApproachName String
FlightPlanWaypointApproachICAO String
FlightPlanWaypointApproachLatitude Degrees
FlightPlanWaypointApproachLongitude Degrees
FlightPlanWaypointApproachAltitude Meters
FlightPlanWaypointApproachTarget Meters
FlightPlanWaypointApproachLegDistance Meters
FlightPlanWaypointApproachLegTotalDistance Meters
FlightPlanWaypointApproachLegFromDistance Meters
FlightPlanWaypointApproachRemainingDistance Meters
FlightPlanWaypointApproachRemainingTotalDistance Meters
FlightPlanWaypointApproachCourse Degrees

 

New Waypoint

 

GPS Variable Units Settable
FlightPlanNewWaypointLatitude Degrees
FlightPlanNewWaypointLongitude Degrees
FlightPlanNewWaypointIdent String
FlightPlanNewWaypointICAO String

 

Related Topics

  1. GPS Variables
  2. JavaScript
  3. Simvar.js
  4. Reverse Polish Notation