FLT FILE PROPERTIES
The <mission_name>.flt
file goes in the main mission folder beside the other files and is formatted like CFG Files and can be edited by using any text editor. This file is responsible for what happens when the mission is launched, and tells the simulation which files to use and which not, as well as setting basic parameters like plane selection. It's also in charge of all the information displayed in the simulation briefing screen.
IMPORTANT! This is a complex file with a lot of parameters. A single error will make the whole mission misbehave - or potentially not even work at all - and you wont get any information on what is failing. So edit this file slowly and test every change.
Below you can find information on the different sections used in the <mission_name>.flt
file as well as what parameters and values are expected within them. Note that all file paths in the <mission_name>.flt
are relative to the directory the FLT
file resides in, and some of the sections listed will only be used on certain types of flights - such as missions - and the exact number of sections will depend on the type of aircraft being flown.
You can find an overview of how to create and edit FLT files on the following page:
You can find an example of this kind of file on the following page:
[Main]
This section is used for defining certain items of meta-data related to the flight or mission that the files is defining. The available parameters are:
[Briefing]
In this section you can setup how the mission briefing should look. The available parameters are:
[Options]
In this section you can set some miscellaneous options for the flight. The available parameters are:
[Assistance]
This section of the FLT
file is used to override the different assistance options and show notifications. Certain missions - for example, Landing Challenges - will require that the user performs actions unassisted and so you can use the parameters in this section to disable specific assistance options that would normally be available in the simulation options menu. Note that if this section is not used, the activity will use the assistance's set by the user.
The available parameters are:
For more information on Event Triggers see the following page:
[AutoPilot.N]
There will be one autopilot entry for each aircraft. The available parameters are:
[EFIS]
The EFIS (electronic flight information system) entry corresponds to the Visual Flight Path dialog. This is simply the visual aid given to identify the route the pilot should be following. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
Active |
This should be set to True if the EFIS is active or False otherwise. |
Boolean | Yes |
NavAid |
The linked radio. These entries correspond to NAV1 and NAV2, which will provide the VOR or ILS signal that will be used to place the visual guides. |
String:
|
Yes |
Type |
The type of visuals to use. |
String:
|
Yes |
Density |
The visual density. |
String:
|
Yes |
Range |
The distance between the visuals. |
String:
|
Yes |
Altitude |
Altitude (above MSL) below which the visual guides should be drawn. | Float | Yes |
Flags |
Flags for the EFIS. 0 indicates no flags. | Integer | Yes |
[ObjectFile]
This entry will be present when a mission is saved off, or it can be added to define the files used by a mission (when multiple XML files are used). The available parameters are:
[FreeFlight]
Set the freeflight state. The available parameters are:
[Weather]
This section controls the way the weather will be created for the flight. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
UseWeatherFile |
Set to true to use the WPR file within the mission folder. Set to false otherwise. |
Boolean | No |
UseLiveWeather |
Set to true to enable live weather, or false to disable it. |
Boolean | No |
WeatherPresetFile |
Here you can select one of the pre-defined weather presets included as part of the default Microsoft Flight Simulator 2024 installation. The available files are:
The string to access these files should be formatted like this: .\WeatherPresets\[PRESET_NAME] For example: WeatherPresetFile=.\WeatherPresets\ClearSky.WPR |
String | No |
WeatherCanBeLive |
Set to true to permit the user to set the weather to "live" from the Weather Panel (if available) during the mission. Set to false to not let the change this setting. |
Boolean | No |
CloudmapPosOverride |
Set to true to override the cloudmap position using the CloudmapInitialPosX /Y parameters, or false otherwise. |
Boolean | No |
CloudmapInitialPosX |
This is an arbitrary offset value that can be used to reposition the cloudmap along the X axis (in meters). This can be useful to move clouds away from the initial position of the aircraft or purely for aesthetic reasons. The value will be ignored if the CloudmapPosOverride parameter is set to false. |
Float | No |
CloudmapInitialPosY |
This is an arbitrary offset value that can be used to reposition the cloudmap along the Y axis (in meters). This can be useful to move clouds away from the initial position of the aircraft or purely for aesthetic reasons. The value will be ignored if the CloudmapPosOverride parameter is set to false. |
No | |
FixedClouds |
Set to true to fix the cloud map so it doesn't change over time, or set to false to permit it to change. |
Boolean | No |
[BingMap]
This section controls certain online interactions between the simulation and BingMaps. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
MinWeight |
This parameter is used to filter the display of Bing POI. The input must be a value between 0 and 1500, where 0 means that all Bing POI are displayed in the world, while 1500 means that none of them will be displayed. | Integer | No |
[Departure]
Set the departure airport. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
ICAO |
The ICAO code of the departure airport. | String | Yes |
RunwayNumber |
The runway number. | String | Yes |
RunwayDesignator |
The runway designator. | String | Yes |
GateNumber |
The gate number (only used if the mission starts on a Parking spot). | Integer | No |
GateName |
The gate name (only used if the mission starts on a Parking spot). | String | No |
GateSuffix |
The gate suffix (only used if the mission starts on a Parking spot). | String | No |
[Arrival]
Set the arrival airport. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
ICAO |
The ICAO code of the arrival airport. | String | Yes |
RunwayNumber |
The runway number. | String | Yes |
RunwayDesignator |
The runway designator. | String | Yes |
GateNumber |
The gate number (only used if the mission ends on a Parking spot). | Integer | No |
GateName |
The gate name (only used if the mission ends on a Parking spot). |
String, only one of the following:
|
No |
GateSuffix |
The gate suffix (only used if the mission ends on a Parking spot). | String | No |
[Loading]
Set one or more images for loading the flight along with one or more accompanying tips text. The available parameters are:
[TrafficManager]
This section controls the offline traffic manager. The available parameter is:
Parameter | Description | Type | Required |
---|---|---|---|
disable |
When set to 1 (TRUE) the traffic manager is disabled and there will be no offline traffic. Default value is 0 (FALSE). |
Bool | No |
[LivingWorld]
This section controls the offline traffic manager. The available parameters are:
[User Tip Window]
This section controls the window for user tips. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
Undocked |
Set to True if the window has been undocked, in which case the window will be located at UndocCoords . |
Bool | No |
ScreenUniCoords |
The current screen co-ordinates of the panel window. See the note on Universal Screen Co-ordinates. | 4 Floats | Yes |
UndocCoords |
The co-ordinates of the window if it has been undocked. See the note on Universal Screen Co-ordinates. | 4 Floats | Yes |
[Atc_Menu]
This section is related to the ATC menu window. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
Visible |
Set to True if the window is visible, or false otherwise. | Boolean | Yes |
ScreenUniCoords |
The current screen co-ordinates of the ATC window. See the note on Universal Screen Co-ordinates. The data for this parameter should be in a 4 value comma separated list, eg: ScreenUniCoords=2968, 811, 4304, 3702 |
4 Floats | No |
UndocCoords |
The co-ordinates of the window if it has been undocked. See the note on Universal Screen Co-ordinates. The data for this parameter should be in a 4 value comma separated list, eg: UndocCoords=0, 0, 0, 0 |
4 Floats | No |
Undocked |
Set to True if the window has been undocked or False otherwise. When set to True , the window will be located at UndocCoords and undocked windows will have a border and title. |
Boolean | No |
[ATC_AgentManager]
This section is for defining the number of ATC agents within the simulation. The available parameter is:
Parameter | Description | Type | Required |
---|---|---|---|
NumberofAgents |
Number of current ATC agents. If this number is 0, there will be no [ATC_Aircraft.N] or [ATC_Agent.n] entries. There will be an ATC agent if an aircraft is flying with a flight plan. |
Integer | Yes |
[ATC_AircraftManager]
This defines the number of aircraft in the ATC manager. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
NumberofAircraft |
The number of aircraft. Usually 1. | Integer | Yes |
[ATC_MessageSystem]
Sets up the ATC message system. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
FrequencyNodes |
Usually this value is 0. It will be non-zero if the flight has been saved mid-message. In this case there should be an [ATC_FrequencyNode.N] entry and usually an [ATC_MessageNode.N.i] entry. |
Integer | Yes |
[ATC_Agent.n]
There will be an [ATC_Agent]
entry for each agent, which can be none in free flight.
[ATC_Aircraft.N]
This section is for defining properties to specific aircraft involved int he flight. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
ActiveFlightPlan |
This will be True if the user aircraft has a flight plan, or False otherwise. The ATC will follow the flightplan and markers will be placed in the simulation - if the assistances allows it - when True . |
Boolean | Yes |
RequestedFlightPlan |
This will be True if the user aircraft has requested a new flight plan, and that request has not yet been answered, otherwise it will be False . Contrary to the ActiveFlightPlan field, ATC and in-simulation markers will not be active. |
Boolean | Yes |
AcState |
The current aircraft status. |
Enum:
// IFR Clearance
// Departure ground operations
// Class D departure operations
// VFR enroute operations
// Flight Following and Airspace Transitions
// Popup IFR States
// Handoffs
// IFR Enroute state
// States that loop back to ARRIVAL after aircraft responds
// Class D arrival operations
// CTAF Operations
// Arrival ground operations
|
Yes |
TaxiRouteAirport |
The ICAO for the airport taxi route. | String | No |
TaxiRoute.N |
This entry will only exist if the aircraft is currently following a cleared taxi route, and holds the taxiway route being followed. Each entry takes five numbers: the index of the TaxiwayPath, the TaxiwayPoint to head for, the direction along the path -- which will depend on the order in which the points were defined (1 = forward, 2 = backward), an unused number (always 0), and the runway index number if the route is along a runway. For example:TaxiRoute.0=27,11,2,0,2
|
String | No |
NumTaxiRoute |
The number of TaxiRoute entries. | Integer | No |
NumberofWaypoints |
The number of waypoints in the route (not taxiway points). This can be zero if the aircraft has not cleared a flight plan, is often two for a VFR or direct IFR route, but can be many more for a more complex IFR route. The waypoints will match exactly those in the ActiveFlightPlan, if there is such a flight plan. | Integer | Yes |
ClearanceFlags |
Hex number containing Boolean flags:
ClearanceFlags=2F
|
Hex | Yes |
CtCur |
Current clearance. |
String:
|
Yes |
WaypointNext |
The waypoint the aircraft is currently heading for. Note that waypoints are indexed from zero. | Integer | Yes |
AltCleared |
The altitude the aircraft has been instructed to fly at, in ft. | Float | Yes |
HdgAssigned |
The assigned heading, in radians, or -1 if no heading has been assigned. | Float | Yes |
SquawkAssigned |
The assigned squawk number. The saved value is a decimal number, that when converted to hexadecimal the last four digits will be the squawk number in octal. The example below gives the assigned number of 543650387. When converted to hex this gives 20677253, the last four digits -- 7253 -- are the squawk number in octal. Note that this number matches the code for the transponder in the [Avionics.N] section. The remaining digits are irrelevant and are ignored (this is a known issue). Example:SquawkAssigned=543650387
|
Integer | Yes |
LandingSequence |
The landing sequence identifier. |
String:
|
Yes |
DepartureRequest |
The departure request type. |
String:
|
Yes |
ParkingRequest |
The parking request. |
String:
|
Yes |
ParkingTypeequest |
The parking request type. |
String:
|
Yes |
PatternLeg |
String:
|
Yes | |
ApproachIndex |
The index number of the approach for the destination airport, or -1 if no approach has cleared. | Integer | Yes |
ApproachTransitionIndex |
The index number of the approach transition for the destination airport, of -1 if no approach transition has been cleared. | Integer | Yes |
ApproachRequestIndex |
The index number of the approach that has been requested by the pilot, but has not yet been cleared. | Integer | Yes |
ApproachTransitionRequestIndex |
The index number of the approach transition that has been requested by the pilot, but has not yet been cleared. | Integer | Yes |
RunwayIndex |
The index number of the destination airport runway, or -1 if no runway has been assigned. | Integer | Yes |
RunwayRequestIndex |
The index number of the destination airport runway requested by the pilot, but has not yet been assigned. | Integer | Yes |
ParkingIndex |
The index number of the parking spot assigned to the aircraft at the destination airport, or -1 if no parking spot has been assigned. | Integer | Yes |
FlightFollowing |
String:
|
Yes | |
AirspaceTransition |
String:
|
Yes | |
BvAirspaceTransition |
String:
|
Yes | |
BvAirspaceTransitionReq |
Yes | ||
TakeOffSequence |
String:
|
Yes | |
LandingsSquenceNumber |
If the aircraft is to land following other aircraft, this number is the aircraft's landing sequence number. For example, if this value is 3, then the aircraft is to follow two other aircraft. If this is not the case, then this property should be -1. | Integer | Yes |
TaxiRouteCurrent |
The index number of the taxiroute entry the aircraft is currently on, or -1 if the aircraft is not on a taxiway route (so there are no TaxiRoute, or NumTaxiRoute entries). | Integer | Yes |
CruisingAltitude |
The current cruising altitude. | Float | Yes |
RequestedCruisingAltitude |
The requested cruising altitude, if an altitude change has been requested, or -1 if there is no such request. | Float | Yes |
ExpectedAltitude |
The altitude the user aircraft pilot is told to expect, in feet, or -1 if this does not apply. | Float | Yes |
AircraftSignature |
The aircraft signature. This will be 1,0 for the user aircraft. | 2 value list | Yes |
AgentTracking |
The signature of the ATC agent (refer to ATC Agent Signatures). | 4 float values | Yes |
Waypoint.N |
The list of waypoints making up the IFR or VFR flight plan. Refer to the notes on Waypoint Format. | Comma separated list | Yes |
AgentHandoff |
The signature of the ATC agent the aircraft will be handed off to (refer to ATC Agent Signatures). | 4 float values | Yes |
ActiveVfrAirport |
The active VFR airport. This will be present even if the aircraft is flying under IFR rules. | String | Yes |
[ATC_AircraftData.N]
There will be an [ATC_AircraftData.N]
entry for each aircraft flying with a flight plan, which can be none in free flight. When adding this entry, each one should be given a unique number, starting at 0. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
AircraftSignature |
The aircraft signature. 1,0 for the user aircraft. | Float | Yes |
Contacted |
This will be True if the ATC agent has made contact with the aircraft or False otherwise. |
Boolean | Yes |
SecLastDing |
Time of the last ding (correcting message), or 0 if there was none. | Integer | Yes |
NumDings |
The number of times the pilot has been dinged. After three dings the pilot is removed from ATC control. After a forgiveness period the number of dings is reduced to zero. | Integer | Yes |
LastDing |
The ATC Message ID of the last ding, or 0 if there was no last ding. | Integer | Yes |
LastMessage |
The last transmitted ATC Message ID. | Integer | Yes |
HandedOff |
This will be True if the aircraft has been handed off to another ATC agent or False otherwise. |
Boolean | Yes |
TimeStampOnRunway |
The number of seconds an aircraft has been on the runway, after landing, or 0 if the aircraft has not just landed. | ||
BVAirspaceTransitionPrev |
The previous transition value. |
String:
|
Yes |
HasReachedClassD |
This value will be True if the aircraft has reached Class D airspace, or False otherwise. |
Boolean | Yes |
[ATC_ActiveFlightPlan.N]
This entry will exist if the user aircraft is flying with a current flight plan, either IFR or VFR. Note that This section is only necessary if your mission has an active flightplan, and the parameter ActiveFlightPlan
of the section [ATC_Aircraft.N]
must be set to True
. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
title |
The title of the flight plan, taken from the Title entry in the PLN file. | String | Yes |
description |
The Description entry from the PLN file. | String | Yes |
type |
The flight plan type. |
String:
|
Yes |
routetype |
This entry will be 0 if type is VFR. For IFR it will be one of the integer values shown. |
Integer:
|
Yes |
cruising_altitude |
The assigned cruising altitude in the current flight plan. | Float | Yes |
departure_id |
The ICAO of the departure airport, and its lat/lon/alt, in the DepartureLLA element of the PLN file. For example:departure_id=KSEA, N47° 25.89', W122° 18.48', +000433.00
|
Comma separated list | Yes |
departure_position |
The runway number and optional designator of the departure. For example: departure_position=34R
Note that this must be identical to that which is set in the |
String | Yes |
destination_id |
The ICAO of the destination airport, and its lat/lon/alt, in the DestinationLLA element of the PLN file. For example:destination_id=KLAX, N33° 56.16', W118° 25.13', +000126.00
|
Comma separated list | Yes |
departure_name |
The name of the departure airport. | String | Yes |
destination_name |
The name of the destination airport. | String | Yes |
waypoint.N |
The list of waypoints making up the route. Often this is only two waypoints, the departure and destination airports. Refer to the notes on Waypoint Format. Note that you should have as many waypoints defined as already listed in the [ATC_Aircraft.N] section. |
Comma separated list | Yes |
[ATC_RequestedFlightPlan.N]
This entry will only be present if the user aircraft has requested a new flight plan, and has yet to receive confirmation that this flight plan has been cleared. In some cases a flight file will have both an [atc_activeflightplan.N]
and an [atc_requestedflightplan.N]
(when a change from one flight plan to another has been requested), and in others just either one of these entries. The property list is identical to that of [ATC_ActiveFlightPlan.N]
.
[ATC_FrequencyNode.N]
Defines an ATC frequency node to be used with the ATC message system. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
Frequency |
Com frequency (120.1 in the example). | Float | yes |
CurrMessage |
True if the current message is saved, in which case an [ATC_MessageNode.N.i] entry should exist for the message. |
Boolean | Yes |
TotalMessageCount |
The number of messages. Usually 1. | Integer | Yes |
[ATC_MessageNode.N.i]
A message node for the ATC message system. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
Seconds |
The time it will take to read the message, in seconds. | Float | Yes |
MessageID |
The ATC Message ID of the message. | Integer | Yes |
TimeStamp |
Simtime of the message. | Float | Yes |
CommUnitFrom |
The agent the message is from (refer to ATC Agent Signatures). | Comma separated list | Yes |
CommUnitTo |
The signature of the aircraft the message is to. Usually 1,0 for the user aircraft. | 2 value list | Yes |
[GPS_Engine]
A [GPS_Engine]
entry will be present if the user aircraft is flying under ATC rules - IFR or VFR - and has an active flightplan. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
Filename |
The name the flight plan file, without the file extension. | String | Yes |
position |
The lat/lon/alt position of the aircraft. Note that the minutes section is recorded as a decimal, and not as minutes and seconds. There can be a small discrepancy between this position, and that recorded in the [SimVars.N] section, which is due to the slower frequency that this position is recorded by the GPS system. |
Comma separated list | Yes |
Time |
Current Zulu time. | Integer | Yes |
TimeWP |
Zulu Time (in seconds) when the aircraft passed the last waypoint. | Integer | Yes |
ArriveTime |
Estimated time en route, in seconds. | Integer | Yes |
CountWP |
The number of waypoints listed in this section. You must have as many waypoints as already created in the [ATC_Aircraft.N] section. |
Integer | Yes |
NextWP |
The next waypoint the aircraft is heading for. Note the waypoints are numbered from 0, so 1 for this value, with two waypoints, indicates the aircraft is heading for the second and last waypoint. | Integer | Yes |
PlaneStarted |
True when the aircraft takes off, False otherwise. |
Boolean | Yes |
WpInfoN |
Waypoint information in the order:
WpInfo0=473, 0, 131, 0, 8459, 2909.8, 0.0, 0.0 |
Comma separated list | Yes |
CountFP |
The number of flight path points recorded. | Integer | Yes |
FpN |
For each flight path point, a coded version of the latitude and longitude (in hex). Note that each line number (0 to N) holds four flight path points. For example: |
Comma separated list | Yes |
[Covers]
This section is related to the preflight checks that are done to prepare an aircraft before takeoff. Each parameter relates to a cover or item that needs to be removed before the aircraft can fligh and as such this section and parameter is only required in the hanger.flt
and apron.flt
.
[Dirt.N]
This section can be added to define the quantity of dirt, grime and general wear and tear the aircraft show show when spawned. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
Runway |
Defines how much runway dirt will be present on the aircraft. Value is expressed as a Percent Over 100. |
Float | No |
Regular |
Defines how much general dirt from use and wear and tear will be present on the aircraft. Value is expressed as a Percent Over 100. | Float | No |
FadedPaint |
Defines how faded the aircraft paint will appear. Value is expressed as a Percent Over 100. | Float | No |
Mud |
Defines how much mud will be present on the aircraft. Value is expressed as a Percent Over 100. | Float | No |
Dust |
Defines how much dust will be present on the aircraft. Value is expressed as a Percent Over 100. | Float | No |
[DateTimeSeason]
Sets the date, time and seasonal details for the flight. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
Season |
The current season. |
String:
|
Yes |
Year |
The current year. | Integer | Yes |
Day |
The current day (0 to 365). | Integer | Yes |
Hours |
The current hour (0 to 23), local time. | Integer | Yes |
Minutes |
The current minute (0 to 57). | Integer | Yes |
Seconds |
The current second (0 to 57). | Float | Yes |
UseZuluTime |
Set to True to use Zulu Time or False otherwise. |
Boolean | Yes |
[Camera.N.i]
These sections are used for setting a camera for the flight and there can be a large number of these entries in every FLT
file. The section is numbered using the following format:
Camera.<window number>.<camera number>
The available parameters for each of these sections are:
Parameter | Description | Type | Required |
---|---|---|---|
Guid |
The GUID of the camera. One of these entries will match the GUID for the CurrentCamera in each of the [Window.N] sections. See here for how to generate these ID string: GUIDs. |
String | Yes |
Zoom |
Zoom factor of the camera (refer to the Camera Configuration documentation for more details). | Float | Yes |
Translation |
The X, Y and Z offset of the camera. This is a 3 value comma separated list, for example: Translation=0,0,0 |
3 Floats | Yes |
Rotation |
Rotation of the camera for pitch, bank and heading. This is a 3 value comma separated list, for example: This entry is not required for external views. |
3 Floats | No |
ChaseDirection |
The chase camera direction. This entry is not required for external views. | Float | No |
ChaseDistance |
The chase camera distance. This entry is not required for external views. | Float | No |
ChaseAltitude |
The chase camera altitude. This entry is not required for external views. | Float | No |
[SimplifiedSim.N]
This sets an optimised simulation type for the AI aircraft in the simulation. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
Mode |
The implied simulation mode to use. |
String:
|
Yes |
[Sim.N]
There will be one sim entry for each sim object saved off. This will include one entry for the user aircraft, and one for each mission object. If mission objects are saved off then each one is noted by one [Sim.n]
, [SimVars.N]
, [Slew.N]
and [Freeze.N]
entry. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
Sim |
The title of the aircraft, or object, in the aircraft.cfg. | String | Yes |
Livery |
This is the name of the livery folder that is to be used for the activity that this section is assigned to. | String | No |
Pilot |
This is the title of the SimObject - as set in the sim.cfg file for a human SimObject - that is to be used as the pilot for the mission. If you do not set this parameter - or set it to an empty string - then the pilot that is set in the NOTE: In "freeflight", this parameter will be created with an empty string as the parameter value as part of the automatic creation of the |
String | No |
Copilot |
This is the title of the SimObject - as set in the sim.cfg file for a human SimObject - that is to be used as the copilot for the mission. If you do not set this parameter - or set it to an empty string - then the copilot that is set in the NOTE: In "freeflight", this parameter will be created with an empty string as the parameter value as part of the automatic creation of the |
String | No |
Instructor |
This is the title of the SimObject - as set in the sim.cfg file for a human SimObject - that is to be used as the instructor in the aircraft. This title is only used for user aircraft (never AI ones). For a list of instructors available without creating your own SimObjects, please see the List Of Included Pilot/Copilot/Instructor SimObjects. Note that you may also set this to "default", in which case the instructor defined will be that which has been defined in the [PILOT] section of the aircraft.cfg file for the aircraft being flown. |
String | No |
TailNumber |
|||
AirlineCallSign |
|||
FlightNumber |
|||
AppendHeavy |
|||
SimFile |
Load a specific aircraft configuration at the start of the mission, depending on the Sim state you need. |
String, one of the following:
|
No |
ChecklistFolder |
Used to load a specific checklist, overriding the one for the aircraft. If a checklist isn't needed by the activity, set this field to "NONE" to free memory and loading time. | String | No |
[Panel.N]
For the user aircraft there is a [Panel.N]
entry for every panel, such as the main panel, radio stack, GPS, throttle controls, and so on. The panels are numbered from 1, and will be in the same order that they appear in the Panel Configuration Files. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
ScreenUniCoords |
The current screen co-ordinates of the panel window. See the note on Universal Screen Co-ordinates. | 4 Floats | Yes |
UndocCoords |
The co-ordinates of the window if it has been undocked. See the note on Universal Screen Co-ordinates. | 4 Floats | Yes |
Visible |
True if the window is visible, False otherwise. |
Boolean | Yes |
Undocked |
Set to True if the window has been undocked, in which case the window will be located at undoccoords. |
Boolean | Yes |
HiddenOn |
Unused. Always False. | Boolean | No |
ID |
The ID number of the panel. A panel with the ID of 20000 is the mini-panel. Panels from 22001 to 22008 are racing aid panels used by the mission system (in the order: Point of interest, Timer, Dropable Object, Race map, Race Info, G meter, Race penalty, and Countdown) which are saved off even if a mission is not being run. | Integer | Yes |
ViewsOn |
This value will be set to 1 if the panel should be displayed if the full cockpit is in view. The panel may not be visible though if the view is currently set to the mini-panel, or to no panel. | Integer | Yes |
[Avionics.N]
There will be one avionics entry for each aircraft. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
Comm1Active |
Frequency of COM1. | Float | Yes |
Comm1Standby |
Frequency of COM1 standby. | Float | Yes |
Comm2Active |
Frequency of COM2. | Float | Yes |
Comm2Standby |
Frequency of COM2 standby. | Float | Yes |
Comm3Active |
Frequency of COM3. | Float | Yes |
Comm3Standby |
Frequency of COM3 standby. | Float | Yes |
Nav1Active |
Frequency of NAV1. | Float | Yes |
Nav1Standby |
Frequency of NAV1 standby. | Float | Yes |
OBS1 |
Position of the OBS for NAV1, in degrees. | Float | Yes |
Nav2Active |
Frequency of NAV2. | Float | Yes |
Nav2Standby |
Frequency of NAV2 standby. | Float | Yes |
OBS2 |
Position of OBS for NAV2, in degrees. | Float | Yes |
Nav3Active |
Frequency of NAV3. | Float | Yes |
Nav3Standby |
Frequency of NAV3 standby. | Float | Yes |
OBS3 |
Position of OBS for NAV3, in degrees. | Float | Yes |
Nav4Active |
Frequency of NAV4. | Float | Yes |
Nav4Standby |
Frequency of NAV4 standby. | Float | Yes |
OBS4 |
Position of OBS for NAV4, in degrees. | Float | Yes |
Transponder |
Frequency of transponder (an octal code number that should match the coded assigned squawk number from the [ATC_Aircraft.N] section). |
String | Yes |
TransponderState |
The transponder state. |
Integer:
|
Yes |
ADFActive |
The frequency of ADF 1 (automatic direction finder). | Float | Yes |
ADF2Active |
The frequency of ADF 2. | Float | Yes |
DMESelected |
The selected DME, either 1 or 2. | Integer | Yes |
ComTransmit |
The selected COM channel, either 1 or 2. | Integer | Yes |
ComReceiveBoth |
True if the switch is on, False otherwise. |
Boolean | Yes |
Com1Receive |
Yes | ||
Com2Receive |
Yes | ||
Com3Receive |
Yes | ||
AudioNav1Listen |
True if the switch is on, False otherwise. |
Boolean | Yes |
AudioNav2Listen |
True if the switch is on, False otherwise. |
Boolean | Yes |
AudioMarkerListen |
True if the switch is on, False otherwise. |
Boolean | Yes |
AudioDmeListen |
True if the switch is on, False otherwise. |
Boolean | Yes |
AudioAdfListen |
True if the switch is on, False otherwise. |
Boolean | Yes |
AudioAdf2Listen |
True if the switch is on, False otherwise. |
Boolean | Yes |
AvionicsSwitch |
True if the switch is on, False otherwise. |
Boolean | Yes |
[Slew.N]
There will be a slew entry for each simulation object saved off. In slew mode an object is simply being moved at a constant speed in various directions or orientations. Some, but not all, information on the slew movement is preserved in the [SimVars.N]
section. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
Active |
True indicates the object is in slew mode, False means it is not. |
Boolean | Yes |
[Freeze.N]
If the aircraft is under control from a SimConnect addon, for example, then the simulator is instructed not to alter certain parameters by "freezing" it out. The available parameters that can be frozen are:
[SystemFailureN.i]
Optional entries. These will only be present if one or more system failures are set, which can be from a mission. The first number (N) is the index of the failure, indexed from 0. The second number (i) is the aircraft reference, usually 0 for the user aircraft. So the first entry is usually [SystemFailure0.0]
, followed by [SystemFailure1.0]
, and so on. There can be up to 1000 failures on an aircraft. The available parameters that can be frozen are:
Parameter | Description | Type | Required |
---|---|---|---|
ID |
One entry from the Failure Code Table, identifying the component that has, or is to, fail. Note that the alpha characters (A through F) must be in upper case. | String | Yes |
SubIndex |
If there are multiple components, such as engines, this parameter gives the index of the component to fail, indexed from 0. Indexing starts from the left. | Integer | Yes |
Health |
The percentage health of the system, from 0.0 (total failure) to 1.0(fully functional). The system will be set to this health value when the flight file is loaded -- so this is the current health, not the health to be applied when the system fails after a certain time. | Float | Yes |
Armed |
If set to If set to |
Boolean | Yes |
ArmedFailureFromTime |
Time in seconds from the start of the simulation when the component might fail. | Float | Yes |
ArmedFailureToTime |
Time in seconds from the start of the simulation when the component will fail. | Float | Yes |
[Engine Parameters.N.i]
There is one of these entries for each engine, so - for example - a Cessna will have one entry, and a Boeing 747 will have four. The first number (N) is the engine number, starting at 1, and the second (i) is the aircraft number (0 for the user aircraft). The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
ThrottleLeverPct |
Percentage that the throttle lever has been applied, from 0 to 1.0. | Float | Yes |
PropellerLeverPct |
Percentage that the propeller lever has been applied, from 0 to 1.0. | Float | No |
MixtureLeverPct |
Percentage that the mixture lever has been applied, from 0 to 1.0. | Float | No |
Pct Engine RPM |
Current engine rpm as a percentage of rated rpm. The normal range is 0 to 1.0, but for some engines going over the rated rpm is possible. | Float | No |
MaxReachedEngineRPM |
Some gauges record the maximum rpm reached on a flight, so this value is recorded here. | Float | No |
Pct N1 |
Set the N1 value that the aircraft should start with, expressed as a Percent Over 100. | Float | No |
Pct N2 |
Set the N2 value that the aircraft should start with, expressed as a Percent Over 100. | Float | No |
LeftMagneto |
True if the switch is on. | Boolean | No |
RightMagneto |
True if the switch is on. | Boolean | No |
GeneratorSwitch |
True if the switch is on. | Boolean | No |
CowlFlapPct |
Percentage that the cowl flaps are open. This affects the cylinder head temperature cooling as follows: CHTCooling = true_airspeed_fps * density_ratio / temperature_ratio + cowl_flaps_pos * 80 |
Float | No |
FuelPumpSwitch |
True if the switch is on. The corresponding SimVar is GENERAL ENG FUEL PUMP SWITCH . |
Boolean | No |
FuelPumpSwitch_EX1 |
Overrides FuelPumpSwitch , but is an integer rather than a Boolean. Allows you to set GENERAL ENG FUEL PUMP SWITCH EX1 to "Auto". Defaults to -1, which means that FuelPumpSwitch is read instead. |
Integer | No |
FuelValveOpen |
True if the valve is open. | Boolean | No |
FuelPressurePSF |
Set the fuel pressure level (in psf). The corresponding SimVar is GENERAL ENG FUEL PRESSURE . |
Float | No |
CarbHeat/DeiceSwitch |
True if the switch is on. | Boolean | No |
EngineMasterSwitch |
True if the switch is on. | Boolean | No |
GlowPlugTemperaturePct |
No | ||
IgnitionSwitch |
Used to set the initial value of the SimVar TURB_ENG_IGNITION_SWITCH_EX1 . |
Integer:
|
No |
StarterSwitch |
Sets whether or not the Starter is enabled. | Boolean | No |
EGT_DegR |
No | ||
ITT_DegR |
No | ||
Afterburner |
Optional entry, recording the stage of the afterburner. | Integer | No |
CorrectedFF |
Sets the corrected Fuel flow at spawn, in lbs per hour. Default value is 0 if the aircraft is spawned on the ground and 500 if spawned in the air. |
Float | No |
[Propeller.N.i]
There is one of these entries for each propeller, and the first number (N) is the engine number that the propeller belongs to - starting at 1 - and the second (i) is the aircraft number (0 for the user aircraft). The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
prop_beta |
The "prop beta" is the pitch of the blades of the propeller. | Float | No |
prop_max_rpm_percent |
No |
[HYDRAULICS_SYSTEM_EX1.N]
This section is for setting the parameters required by the modular hydraulics system. These are only required if the [HYDRAULICS_SYSTEM_EX1]
section has been set up for the aircraft. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
Reservoir[Name] |
This parameter takes a hashmap with a single key -
For example:
|
Hash Map (see Data Types for more information) |
No |
Valve[Name] |
This parameter takes a hashmap with a single key - For example:
|
||
Junction[Name] |
This parameter takes a hashmap with a single key - For example:
|
||
Pump[Name] |
This parameter takes a hashmap with up to three keys -
For example:
|
||
PTU[Name] |
This parameter takes a hashmap with up to six keys -
For example:
|
||
Accumulator[Name] |
This parameter takes a hashmap with up to two keys -
For example:
|
||
Actuator[Name] |
This parameter takes a hashmap with a single key - For example:
|
||
Line[Name] |
This parameter takes a hashmap with up to 4 keys -
For example:
|
[FuelSystem.N]
This section is for setting the parameters required by the modular fuel system. These are only required if the [FUEL_SYSTEM]
section has been set up for the aircraft. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
Tank[Name] |
This parameter takes a hashmap with a single key - Default value is:
or whatever setting the user has made in the main menu. |
Float | No |
Valve[Name] |
This parameter takes a hashmap with a single key - Default value is:
|
Bool | No |
Junction[Name] |
This parameter takes a hashmap with a single key - Default value is:
|
Integer | No |
Pump[Name] |
This parameter takes a hashmap with a single key -
Default value is:
|
Integer | No |
Trigger[Name] |
This parameter takes a hashmap with a single key - Default value is:
|
Integer | No |
[PNEUMATIC_SYSTEM_EX1.N]
This section is for setting the parameters required by the modular pneumatic system. These are only required if the [PNEUMATIC_SYSTEM_EX1]
section has been set up for the aircraft, and even then they may be omitted if you wish to have the aircraft in its default state. It should be noted that multiple parameters require an index value. This is the index of the component that they are referring to.
The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
Engine_Bleed.N |
Sets the bleed air status of the indexed Engine component to enabled (1, TRUE) or disabled (0, FALSE). Default value is 0 (FALSE). |
Boolean | No |
Pack_Active.N |
Sets the status of the indexed Pack component to enabled (1, TRUE) or disabled (0, FALSE). Default value is 1 (TRUE). |
Boolean | |
Pack_Switch.N |
Sets the status of the indexed Pack overhead switch to enabled (1, TRUE) or disabled (0, FALSE). Default value is 1 (TRUE). |
Boolean | |
Pack_PackFlow.N |
Sets the percentage of airflow through the indexed Pack component, as a Percent Over 100. Default value is 1. |
Float | |
Pack_PackFlowMode.N |
Sets the initial mode of the indexed Pack component, which can be one of the following:
Default value is 1. |
Integer | |
Pack_PackFlowAuto.N |
Sets whether the indexed Pack component is set to "Auto" (1, TRUE) or not (0, FALSE). Default value is 1 (TRUE). |
Boolean | |
Area_TargetTemperature_C.N |
Sets the target temperature (in °C) for the indexed Area component. Default value is -1. |
Float | |
Area_Temperature_C.N |
Sets the current temperature (in °C) for the indexed Area component. Default value is 0. |
Float | |
Valve_OpeningStatus.N |
Sets the percentage that the indexed Valve component is opened, as a Percent Over 100. Default value is 1. |
Float | |
Valve_TargetStatus.N |
Sets the target percentage that the indexed Valve component should open to, as a Percent Over 100. Default value is 1. |
Float | |
Valve_Mode.N |
Sets the initial mode of the indexed Valve component, which can be one of the following:
Default value is 0. |
Integer | |
PacksOnDefaultValues |
Sets whether the packs are using the default temperature output values (1, TRUE) or not (0, FALSE). Default value is 0 (FALSE). |
Boolean | |
AircraftTargetAltitude_ft |
The target cabin altitude for the aircraft, in ft. Default value is 7000. |
Float | |
AircraftTemperature_C |
The initial temperature of the aircraft areas (average of all areas combined), in °C. Default value is 0. |
Float | |
AircraftPressure_kPa |
The initial pressure of the aircraft areas (average of all areas combined), in kiloPascals. Default value is 0. |
Float |
[Electrical.N]
This section sets up the electrical system for an aircraft. There should be one [Electrical.N]
entry per aircraft. The available parameters are:
Parameter | Description | SimVar | Type | Required |
---|---|---|---|---|
Circuit[Name] |
This parameter takes a hashmap with a two keys -
Default value is:
For more information on circuits, please see here: Circuit. |
Circuits | Hash Map | No |
Battery[Name] |
This parameter takes a hashmap with a two keys -
Default value is:
For more information on batteries, please see here: Battery. |
Batteries | ||
Generator[Name] |
This parameter takes a hashmap with one key - Default value is:
For more information on generators, please see here: Generator. |
N/A |
||
ExternalPower[Name] |
This parameter takes a hashmap with one key - Default value is:
For more information on external power sources, please see here: ExternalPower. |
External Power | ||
Line[Name] |
This parameter takes a hashmap with one key - Default value is:
For more information on lines, please see here: Line. |
Lines | ||
Breaker[LineName] |
This parameter takes a hashmap with a two keys -
Default value is:
|
Breakers |
[Liquid Dropping System.N]
There will be one entry of the liquid dropping system for each aircraft that requires it.
The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
Tank.N |
The volume of liquid that should be stored in the indexed Tank, in Gallons. | Float | Yes |
[Burner_System.N]
There will be one entry of the burner system for each aircraft that requires it.
The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
Burner[ID] |
The initial setup for a Burner. This parameter requires an ID (name or index) to specify which burner component is being targetted, and then you give a hashmap to set whether combustion is active or not, using the following format where "true" is active and "false" is inactive:
For example:
|
No | |
Valve[ID] |
The initial setup for a Valve. This parameter requires an ID (name or index) to specify which valve component is being targetted, and then you give a hashmap to set the opening status, using the following format where a value of 0 is fully closed, and a value of 1 is fully open:
For example:
|
Float | No |
[Switches.N]
There will be one switches entry for each aircraft. The available parameters are:
Parameter | Description | SimVar | Type | Required |
---|---|---|---|---|
PitotHeat |
True if the switch is on. |
PITOT_HEAT_SWITCH |
Boolean | Yes |
PitotHeat_EX1 |
An extended version of the PitotHeat parameter which offers more control. | PITOT_HEAT_SWITCH |
Integer:
|
No |
WindshieldDeice |
Sets the state of the windshield de-icer | WINDSHIELD_DEICE_SWITCH |
Integer:
|
Yes |
BeaconLights |
True if the lights are on. |
LIGHT_BEACON |
Boolean | Yes |
LandingLights |
True if the lights are on. |
LIGHT_LANDING |
Boolean | Yes |
LogoLights |
True if the lights are on. |
LIGHT_LOGO |
Boolean | Yes |
NavLights |
True if the lights are on. |
LIGHT_NAV |
Boolean | Yes |
PanelLights |
True if the lights are on. |
LIGHT_PANEL |
Boolean | Yes |
RecognitionLights |
True if the lights are on. |
LIGHT_RECOGNITION |
Boolean | Yes |
StrobeLights |
True if the lights are on. |
LIGHT_STROBE |
Boolean | Yes |
TaxiLights |
True if the lights are on. |
LIGHT_TAXI |
Boolean | Yes |
WingLights |
True if the lights are on. |
LIGHT_WING |
Boolean | Yes |
CabinLights |
True if the lights are on. |
LIGHT_CABIN |
Boolean | Yes |
GlareshieldLights |
True if the lights are on. |
LIGHT_GLARESHIELD |
Boolean | Yes |
PedestalLights |
True if the lights are on. |
LIGHT_PEDESTRAL |
Boolean | Yes |
AmbientLights |
True if the lights are on. |
Not linked to a SimVar | Boolean | Yes |
BeaconLightsNight |
True if the light is on. This is an optional setting that, if set, will override the basic setting if the flight starts at night. |
LIGHT_BEACON |
Boolean | No |
LandingLightsNight |
True if the light is on. This is an optional setting that, if set, will override the basic setting if the flight starts at night. |
LIGHT_LANDING |
Boolean | No |
LogoLightsNight |
True if the light is on. This is an optional setting that, if set, will override the basic setting if the flight starts at night. |
LIGHT_LOGO |
Boolean | No |
NavLightsNight |
True if the light is on. This is an optional setting that, if set, will override the basic setting if the flight starts at night. |
LIGHT_NAV |
Boolean | No |
PanelLightsNight |
True if the light is on. This is an optional setting that, if set, will override the basic setting if the flight starts at night. |
LIGHT_PANEL |
Boolean | No |
RecognitionLightsNight |
True if the light is on. This is an optional setting that, if set, will override the basic setting if the flight starts at night. |
LIGHT_RECOGNITION |
Boolean | No |
StrobeLightsNight |
True if the light is on. This is an optional setting that, if set, will override the basic setting if the flight starts at night. |
LIGHT_STROBE |
Boolean | No |
TaxiLightsNight |
True if the light is on. This is an optional setting that, if set, will override the basic setting if the flight starts at night. |
LIGHT_TAXI |
Boolean | No |
WingLightsNight |
True if the light is on. This is an optional setting that, if set, will override the basic setting if the flight starts at night. |
LIGHT_WING |
Boolean | No |
CabinLightsNight |
True if the light is on. This is an optional setting that, if set, will override the basic setting if the flight starts at night. |
LIGHT_CABIN |
Boolean | No |
GlareshieldLightsNight |
True if the light is on. This is an optional setting that, if set, will override the basic setting if the flight starts at night. |
LIGHT_GLARESHIELD |
Boolean | No |
PedestalLightsNight |
True if the light is on. This is an optional setting that, if set, will override the basic setting if the flight starts at night. |
LIGHT_PEDESTRAL |
Boolean | No |
AmbientLightsNight |
True if the light is on. This is an optional setting that, if set, will override the basic setting if the flight starts at night. |
Not linked to a SimVar | Boolean | No |
Potentiometer.N |
Sets the state of the light potentiometer N. A value between 0 and 1 is required. | LIGHT_POTENTIOMETER |
Float | Yes |
[Systems.N]
There will be one systems entry for each aircraft. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
BatterySwitch |
True if the switch is on. |
Boolean | Yes |
StructuralDeiceSwitch |
True if the switch is on. |
Boolean | Yes |
StructuralDeiceSwitch_EX1 |
True if the switch is on. |
Boolean | Yes |
PropDeiceSwitch |
True if the switch is on. |
Boolean | Yes |
Autobrakes |
Set to 1 if the aircraft has automatic brakes, 0 otherwise. | Integer | Yes |
StandbyVacuum |
True if the switch is on. |
Boolean | Yes |
PropSync |
True if the switch is on. |
Boolean | Yes |
AutoFeatherSwitch |
True if the switch is on. |
Boolean | Yes |
FlightDirector |
True if the switch is on. |
Boolean | Yes |
PanelLights |
True if the switch is on. |
Boolean | Yes |
ExternalPowerSwitch |
True if the switch is on. |
Boolean | Yes |
AuxPowerUnitSwitch |
True if the switch is on. |
Boolean | Yes |
SeatBeltsSwitch |
True if the switch is on. |
Boolean | Yes |
NoSmokingSwitch |
True if the switch is on. |
Boolean | Yes |
LaunchBarSwitch |
True if the launchbar has been deployed. These next five properties apply only to carrier launched aircraft. |
Boolean | Yes |
LaunchBarState |
One of: 0 if the launchbar is retracted, 1 if it is extended. | Integer | No |
TailhookHandle |
True if the tailhook handle has been deployed. |
Boolean | No |
TailhookState |
One of: 0 if the tailhook is retracted, 1 if it is extended. | Integer | No |
FoldingWingsHandle |
True if the folding wings handle has been deployed. |
Boolean | No |
FoldingWingsState |
Two values for the left and right wings, set to 0 if the wings are in a flying state, and 1 if they are folded (to save space on deck). | Integer | No |
ClutchSwitch |
For helicopters, this specifies whether the clutch is engaged (1, TRUE) or not (0, FALSE). | Boolean | No |
GovernorSwitch |
For helicopters, this specifies whether the governor is engaged (1, TRUE) or not (0, FALSE). | Boolean | No |
GovernorTarget |
For helicopters, this specifies the target RPM, as a ratio of nominal RPM. For example, if the helicopter has a nominal RPM of 390, and its idle state is 52% of that, then setting this to 0.52 will make the governor target the proper 200 RPM idle state value. | Percent Over 100 | No |
[Gauges.N]
There will be one gauges entry for each aircraft. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
kollsmansetting |
Records the Kollsman setting (barometric pressure at sea level, in inches of mercury). | Float | Yes |
AutoBaroSetting |
If this parameter is set to true, the simulation will call the BAROMETRIC key event to set the barometer level at the start of the flight. Default value is false (0). |
Boolean | No |
[BleedAir.N]
Setup the bleed air system for the engines on an aircraft, one entry for each aircraft. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
BleedAirSource |
Initial value of BleedAirSource enum. Default is 0. | Integer | No |
EngineAirBleed.N |
True if EngineBleedAir is enabled for the indexed engine. | Bool | No |
APUAirBleed |
True if APU AirBleed is enabled. | Bool | No |
[Navigation_Graph.N]
There will be one payload entry for each aircraft. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
PayloadList |
If the aircraft is not carrying a payload, this will be -1. If it is then the payload weights in pounds in the list correspond to the payload locations defined in the aircraft configuration file. | Comma separated list | Yes |
[CabinService.N]
This section can be added when the flight or mission requires the use of some Navigation Service. The section is indexed from 0, and if you need to define multiple navigation services for the aircraft or mission, then you can add more sections, incrementing the index N by 1 each time.
The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
Name |
The name of the navigation service to use on the mission. This is the name as defined in the services.XML file. | String | Yes |
GraphPath |
The path to the navigation graph CFG file that is to be used. | String | No |
[CabinServiceObject.N]
This section can be added to define a single behaviour object that will be used as part of a Navigation Service. The section is indexed from 0, and if you need to define multiple objects, then you can add more sections, incrementing the index N by 1 each time. These objects will usually be spawned by a mission file using the <SimMission.CreateCabinServiceObject>
element.
The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
CabinServiceName |
The name of the navigation service that will be using this behaviour object. This is the name as defined in the services.XML file. | String | Yes |
BehaviourName |
This is the name of the behaviour to assign to the object. The name must be the same as the one used in the <Behaviour> element of the associated navigation service XML. |
String | Yes |
Weight |
Defines how much the object weighs, in lbs. | Float | No |
Quantity |
Defines the number of behaviour objects that should be spawned. Note that you can only use this parameter or |
Float | No (Yes if NodeTag is not defined) |
NodeTag |
A node tag. Using this parameter means that number of behaviour objects that should be spawned will be based on the number of nodes with the given tag on the navigation graph for the associated service. You may modify this value using the Note that you can only use this parameter or |
String | No (Yes if Quantity is not defined) |
Density |
This is a percentage value that is only required when using the Default value is 100. |
Float | No |
RemoveOnFlightReset |
Defines whether the behaviour object should be removed on flight reset (1, TRUE) or not (0, FALSE). Default value is 1 (TRUE). |
Boolean | No |
GeneratedCharacters |
Here you give one of the available pre-generated characters to be used as the spawned object. If this is used then you cannot use the |
String | No (Yes if neither SimObject.N nor PropSetContainerGUID is defined) |
SimObject.N |
Here you give the name of a SimObject to use as the spawned object. Objects should be indexed from 0 and increment by 1, and if you supply more than one SimObject then spawned objects will be picked randomly from list. If this is used then you cannot use the |
String | No (Yes if neither GeneratedCharacters nor PropSetContainerGUID is defined) |
PropSetContainerGUID |
Here you give the GUID of a PropSetContainer to be used as the spawned object. If you supply this parameter, it must be accompanied with the If this is used then you cannot use the |
String | No (Yes if neither GeneratedCharacters nor SimObject.N is defined) |
PropSetFile |
The file that defines the PropSet to be used as the spawned object. This parameter is only used when a PropSetContainerGUID is supplied. |
String | No |
[InteractivePoints.N]
IMPORTANT! This section is currently not supported by Microsoft Flight Simulator 2024 and will be ignored. Future updates to the simulation will fix this.
There will be one interactive point section per-aircraft. The available parameters are:
[WEAR_AND_TEAR_SYSTEM.N]
There will be one failure system entry for each aircraft. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
inhibitAll |
If set to 1 (True) then this will inhibit all the failures on this aircraft, essentially disabling the failure system and meaning you do not need to use the inhibitCategory parameter. |
Boolean | No |
inhibitCategory |
This parameter permits you to inhibit (disable) entire categories of failures. To do this, you need to give a comma separated list of each of the failure categories that you wish to inhibit, for example: inhibitCategory=Engine,Controls,LandingGear The available failure categories are as follows:
The parameter has no default value, and if you do not wish to inhibit any categories, simply omit the parameter from the file. Note too that this requires that the |
List of strings (see Data Types for more information) |
No |
[Controls.N]
There will be one controls entry for each aircraft. The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
SpoilersHandle |
Percentage of maximum spoilers handle position. | Float | Yes |
FlapsHandle |
Percentage of maximum flap handle position. | Float | Yes |
LeftFlap |
Percentage of maximum flap position of left flaps. If the maximum flap position is 40 degrees, then the example of 2.50 indicates the flaps are at 1 degree. | Float | Yes |
RightFlap |
Percentage of maximum flap position of right flaps. | Float | Yes |
GearsHandle |
Percentage of maximum gear handle position. 0 is fully retracted. | Float | Yes |
Gear1 |
Percentage of maximum extended gear position - for the center wheel gear. | Float | Yes |
Gear2 |
Percentage of maximum extended gear position - for the left wheel gear. | Float | Yes |
Gear3 |
Percentage of maximum extended gear position - for the right wheel gear. | Float | Yes |
YokeY |
Position of the yoke in the forward/backward direction. 0 is fully forward, 100 fully backward, 50 is dead center. | Float | Yes |
YokeX |
Position of the yoke in the left/right direction. 0 is fully left, 100 is fully right, 50 is dead center. | Float | Yes |
Rudder |
Position of the rudder expressed as a percentage of its full range of movement. | Float | Yes |
LeftBrake |
Percentage of maximum application of left brake. | Float | Yes |
RightBrake |
Percentage of maximum application of right brake. | Float | Yes |
ParkingBrake |
Percentage of maximum application of parking brake. | Float | Yes |
ElevatorTrim |
Percentage of maximum elevator trim, linked to the SimVar ELEVATOR TRIM PCT . |
Float | Yes |
RudderTrimPct |
Percentage of maximum application of rudder trim, linked to the SimVar RUDDER_TRIM_PCT . |
Float | Yes |
AileronTrimPct |
Percentage of maximum application of aileron trim, linked to the SimVar AILERON TRIM PCT . |
Float | Yes |
AileronTrimDisabled |
Used to set the initial value of the SimVar AILERON TRIM DISABLED , which disables the aileron trim. |
Boolean | Yes |
ElevatorTrimDisabled |
Used to set the initial value of the SimVar ELEVATOR TRIM DISABLED , which disables the elevator trim. |
Boolean | Yes |
RudderTrimDisabled |
Used to set the initial value of the SimVar RUDDER_TRIM_DISABLED , which disables the rudder trim. |
Boolean | Yes |
GLimiterSetting |
This controls the setting of the G-limiter on an aircraft. This value can then be accessed through the SimVar
|
Integer. | Yes |
SpoilersArmed |
Sets whether the spoilers are armed (1, TRUE) or not (0, FALSE). | Boolean | Yes |
AntiSkidActive |
Controls whether the anti-skid breaking system is active or not. This setting can be accessed using the ANTISKID BRAKES ACTIVE SimVar. |
Boolean | Yes |
TailwheelLock |
Controls whether the tail wheel is locked or not. This setting can be accessed using the TAILWHEEL_LOCK_ON SimVar. |
Boolean | Yes |
NosewheelLock |
Controls whether the nose wheel is locked or not. This setting can be accessed using the NOSEWHEEL_LOCK_ON SimVar. |
Boolean | Yes |
Collective |
Sets the collective position for helicopters, as a percentage between 0 1nd 100. | Float | No |
LateralTrim |
Sets the lateral trim for helicopters, where 0 is -100% trim, 50 is neutral (0%) trim, and 100 is 100% trim. | Float | No |
LongitudinalTrim |
Sets the longitudinal trim for helicopters, where 0 is -100% trim, 50 is neutral (0%) trim, and 100 is 100% trim. | Float | No |
[SimVars.N]
There will be one simvars entry for each sim object saved off. The available parameters are:
[SimVarForSpawningInTheAir]
This section can be added when the flight or mission is designed to start with the aircraft in the air, rather than on the ground. Note that adding this section will cause some of the other *.flt
file parameters to be overridden. This happens because when you have this section then start the simulation, the engine has to try and balance the plane using the requested configuration so it can start flying immediately. As such this will mean that some system and engine parameters will be overwritten.
NOTE: This section is not applicable to helicopters, and will have no effect on how they are spawned.
The available parameters are:
Parameter | Description | Type | Required |
---|---|---|---|
Altitude |
The altitude at which the plane should spawn, measured in ft. | Float | No |
Slope |
The slope of the aircraft when the flight/mission starts, in degrees. | Float | No |
IAS |
The IAS at which the plane should be flying when the flight/mission starts. Value is in ft per seconds. | Float | No |
FlapsDegree |
The level of flaps, in degrees. | Float | No |
ThrottlePct |
This sets the position of the throttle, expressed as a Percent Over 100, where 0 is no throttle and 1 is full throttle. | Float | No |
PropellerPct |
This sets the position of the propeller lever, expressed as a Percent Over 100. | Float | No |
[LocalVars.N]
This section can be used to define and initialise un-scoped local variables to be used in missions. Localvars will be defined here using the same format as the rest of the options that exist in the configuration files, eg: varname = value
. Unlike the local variables created in the [LocalVars]
section of the systems.cfg
file these variables are not persisted between runs. To access these variables in the code you need to use the "L:
" var identifier using Reverse Polish Notation, and if you are using the JavaScript API then this is done using the same function as for SimVars: GetSimVarValue(name, unit, dataSource = "")
. These variables are shared between aircraft if multiple instances of the aircraft are spawned. In general this is not what you want and you should use the scoped L:1
variable type instead, defined in the [LocalVars_EX1.N]
section.
[LocalVars_EX1.N]
This section can be used to define and initialise scoped local variables to be used in missions. Localvars will be defined here using the same format as the rest of the options that exist in the configuration files, eg: varname = value
. Unlike the local variables created in the [LocalVars]
section of the systems.cfg
file these variables are not persisted between runs. To access these variables in the code you need to use the "L:1
" var identifier using Reverse Polish Notation, and if you are using the JavaScript API then this is done using the same function as for SimVars: GetSimVarValue(name, unit, dataSource = "")
. These variables are scoped to each instance of the aircraft that use them, so each instance will have a unique version of the local variables you define in this section (unlike the un-scoped L
var type defined in the [LocalVars.N]
section).
[SimScheduler]
This section is for setting some very specific simulation parameters that will affect the way the simulation runs. The available parameters are: