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
`FlightPlanIsActiveWaypointLocked`	Boolean
`FlightPlanWaypointsNumber`	Number
`FlightPlanRouteType`	Enum:`DIRECT` (0)`VOR` (1)`LOWALT` (2)`HIGHALT` (3)
`FlightPlanFlightPlanType`	Enum:`NONE` (0)`VFR` (1)`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:`GPS_APPROACH_LOAD_ONLY` (1)`GPS_APPROACH_LOAD_ACTIVATE` (2)`GPS_APPROACH_ACTIVATE_VECTORS` (3)
`FlightPlanLoadApproach`	Boolean
`FlightPlanApproachWaypointType`	Enum:`NONE` (0)`FIX` (1)`PROC_TURN_LEFT` (2)`PROC_TURN_RIGHT` (3)`DME_ARC_LEFT` (4)`DME_ARC_RIGHT` (5)`HOLDING_LEFT` (6)`HOLDING_RIGHT` (7)`DISTANCE` (8)`ALTITUDE` (9)`MANUAL_SEQ` (10)`VECTORS_TO_FINAL` (11)
`FlightPlanApproachMode`	Enum:`NONE` (0)`TRANSITION` (1)`FINAL` (2)`MISSED` (3)
`FlightPlanApproachSegmentType`	Enum:`SEGMENT_LINE` (0)`SEGMENT_ARC_CW` (1)`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:`UNKNOWN` (0)`VFR` (1)`HEL` (2)`TACAN` (3)`NDB` (4)`LORAN` (5)`RNAV` (6)`VOR` (7)`GPS` (8)`SDF` (9)`LDA` (10)`LOC` (11)`MLS` (12)`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:`NONE` (0)`AIRPORT` (1)`INTERSECTION` (2)`VOR` (3)`NDB` (4)`USER` (5)`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:`NONE` (0)`FIX` (1)`PROC_TURN_LEFT` (2)`PROC_TURN_RIGHT` (3)`DME_ARC_LEFT` (4)`DME_ARC_RIGHT` (5)`HOLDING_LEFT` (6)`HOLDING_RIGHT` (7)`DISTANCE` (8)`ALTITUDE` (9)`MANUAL_SEQ` (10)`VECTORS_TO_FINAL` (11)
`FlightPlanWaypointApproachMode`	Enum:`NONE` (0)`TRANSITION` (1)`FINAL` (2)`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

Airports

Intersections

Flighting

SDK Documentation

Flightplans

General

Departure

Destination

Alternate

Approach

Waypoint

Waypoint Approach

New Waypoint

Flightplans

General#

Departure#

Destination#

Alternate#

Approach#

Waypoint#

Waypoint Approach#

New Waypoint#

General

Departure

Destination

Alternate

Approach

Waypoint

Waypoint Approach

New Waypoint