systems.cfg
The systems.cfg file is an optional aircraft file for defining different aircraft systems. Below you can find information on the different sections used in the systems.cfg file as well as what parameters and values are expected within them.
[Version]
The [Version] section provides version information for the configuration file. In Microsoft Flight Simulator 2024, major versions should always be at least equal to 1.
Note that this section information is mandatory and should always be included.
| Parameter | Description | Type | Required |
|---|---|---|---|
major |
Major CFG file version number, values must be greater than 0. | Integer | Yes |
minor |
Minor CFG file version number, values must be greater than 0. | Integer | Yes |
[BRAKES]
This section controls the aircraft's brake systems. Available parameters are:
| Parameter | Description | Type | Required |
|---|---|---|---|
brakes_aircraft_weight_ratio |
This defines the ratio of the total aircraft empty weight that each braking system weighs. Default value is 0.0005. |
Float | No |
brakes_cooling_factor |
This scalar is used to set the rate at which brakes will cool down when stopped. Default value is 0.001. |
Float | |
brakes_cooling_factor_100kts |
This scalar is used to set the speed at which brakes will cool down when moving at 100Knots Default value is 0.02. |
Float | |
brakes_wear_factor |
This scalar is used to set the speed at which brakes will wear down. Default value is 0.00001. |
Float | |
brakes_min_brake_effect_kelvin |
This defines the temperature at which the brakes are 100% effective (in Kelvin). Default value is 423.15. |
Float | |
brakes_max_brake_effect_kelvin |
This deifnes the temperature at which the brakes are minimally effective (in Kelvin). Default value is 623.15. |
Float | |
brakes_temperature_effect |
This defines the ratio of effectiveness of the brakes when at the temperature defined by the Default value is 0.75. |
Float | |
parking_brake |
The type of parking brake available. Default value is 1. |
Integer:
|
|
differential_braking_scale |
Differential braking is a function of using both brakes and the rudder pedal input. The amount of difference between the left and right brake is scaled by this value. Setting this to 0.0 means no differential braking is desired, while a setting of 1.0 is the normal setting for when differential braking is desired - which is particularly useful for tailwheel airplanes. Default value is 0. |
Float | |
toe_brakes_scale |
Sets the scaling of the toe braking effectiveness, expressed as a Percent Over 100. Note that a setting of 0.0 scales the brakes to no effectiveness. Default value is 1. |
Float | |
no_toe_brake_input_smoothing |
Whether to disable (TRUE, 1) or not (FALSE, 0) input smoothing for toe brakes. Default value is 0 (FALSE). |
Bool | |
toe_brakes_pressure_increment |
This value defines the maximum pressure that will be applied by the toe-brakes when used, expressed as a Percent Over 100. Default value is 0.033. |
Float | |
toe_brakes_pressure_release_delay |
This value sets the time (in seconds) after which the toe-brake pressure will start to decay. Default value is 0.25. |
Float | |
toe_brakes_pressure_decrease_tc |
This value is the time constant (factor) that will be used to determine the speed at which toe-brake pressure will decay. Default value is 3.0 |
Float | |
parking_brake_linked_to_toe_brakes |
This parameter governs whether the parking brake will release upon application of the toe brakes. Default value is 1 (TRUE), but a setting of 0 (FALSE) will prevent this behavior. |
Bool | |
hydraulic_system_scalar |
On brakes dependent on the hydraulic system, this is the ratio of hydraulic system to maximum brake hydraulic pressure. Default value is 0. |
Float | |
show_brake_message |
Whether to show the braking message (TRUE, 1) or not (FALSE, 0) in the UI. Default value is 1 (TRUE). |
Bool | |
auto_brakes |
The number of autobrakes available (0 means no autobrakes). Default value is 0. |
Integer | |
autobrakes_disabled_on_takeoff |
Whether the autobrake is disabled (TRUE, 1) or not (FALSE, 0) for takeoff. Default value is 0 (FALSE). |
Bool | |
autobrakes_requires_antiskid |
Whether the autobrake systems require anti-skid (TRUE, 1) or not (FALSE, 0). Default value is 0 (FALSE). |
Bool | |
autobrakes_disabled_on_braking |
Whether the autobrake is disabled (TRUE, 1) or not (FALSE, 0) when manually braking. Default value is 0 (FALSE). |
Bool | |
autobrakes_disabled_on_thrust |
Whether the autobrake is disabled (TRUE, 1) or not (FALSE, 0) on reverse thrust. Default value is 0 (FALSE). |
Bool | |
autobrakes_disabled_on_stop |
Whether the autobrake is disabled (TRUE, 1) or not (FALSE, 0) when the plane stops after a landing. Default value is 0 (FALSE). |
Bool | |
rto_disabled_on_stop |
Whether the autobrake is automatically disabled (TRUE, 1) or not (FALSE, 0) when the aircraft stops after an RTO. Default value is 0 (FALSE). |
Bool | |
rto_disabled_on_takeoff |
Whether the autobrake is disabled (TRUE, 1) or not (FALSE, 0) for an RTO. Default value is 0 (FALSE). |
Bool | |
rto_min_speed_for_trigger |
This sets the minimum speed (in Knots) at which an RTO will be activated when moving all throttles to idle. Default value is 85. |
Float |
[GEAR_WARNING_SYSTEM]
This section defines the functionality of the gear warning system for the aircraft. This is generally related to the throttle lever position and the flap deflection. Available parameters are:
[LIGHTS]
This section controls the lights on the aircraft. The given index value can then be passed to the corresponding light SimVar to apply a different behavior to different lights.
Available parameters are:
| Parameter | Description | Type | Required |
|---|---|---|---|
|
Each light has it's own definition as a hash map (explained below) where each item in the table has it's own definition. Lights are numbered from 0. | No |
The hash map that each light takes is comprised of the following key:value pairs, separated by the # symbol:
| Key | Value | Description | Required |
|---|---|---|---|
Name |
String | This is a name string that is used as an alias to identify the light. It will also be used as the reference index for SimVars, and note that the name is the only guaranteed reference to the component due to the fact that the Modular Aircraft Merging process may change the index. The name cannot contain special characters or spaces. | Yes |
Type |
Integer:
|
Tells the sim what type of light is being defined for the aircraft. | Yes |
Index |
Integer | This is the index of the electrical circuit.N that controls the light. Note that the value is the type index for the circuit, not the circuit index itself. Also note that if you set an index of 0 - or omit this key from the map - then the light will be part of the "general" circuit, meaning that a change to any light circuit will affect all lights with index 0 (or no defined index). |
No |
LocalPosition |
List of 3 values: z, x, y |
The local position offset relative to the Datum Reference Point. Values are in ft. | Yes |
LocalRotation |
List of 3 values: x, y, z | The local angle of rotation for the light. Values are in degrees from -360° to 360°. | Yes |
EffectFile |
FX file ID |
The FX file that describes the light. These files have For more information, please see here: Implementing Lights It should be noted that you do not have to create your own |
Yes |
Node |
Node name | The aircraft node to which you attach the light. | No |
PotentiometerIndex |
Integer | This drives the intensity of the light indexed when using the SimVar LIGHT_POTENTIOMETER. |
Yes |
EmMesh |
File ID | The name of the emissive mesh to use. Note that the material used for the mesh must be named LIGHTS and use the Standard material type. | No |
EmMeshMaterialName |
String | The name of the material that the emissive mesh uses. | No |
Below you can see an example of a light definition:
lightdef.18 = Name:light_strobe Type:4 #Index:0 #LocalPosition:-1.2,0.65,14.0 #LocalRotation:0,0,0 #EffectFile:fx_cockpit_small_yellow, #PotentiometerIndex:2
It is worth noting that we have a page giving an overview of how lights should be setup from the following link:
Legacy Lights
When working with legacy aircraft from before MSFS 2020 (for example) you will find that lights were defined slightly differently. Here we explain the format used for those lights, but for new aircraft you should be using the lightdef.N parameter.
Legacy lights are defined using the following parameter:
| Parameter | Description | Type | Required |
|---|---|---|---|
light.N |
This is a light definition comprised of a list of values. Lights are numbered from 0. |
List of Values |
No |
The table for these lights takes 8 entries, listed below:
| Position | Description | Type | Required |
|---|---|---|---|
| 0 | This defines which circuit, or switch, the light is connected to. Multiple lights may be connected to a single switch. |
Integer: 1 = Beacon 10 = Cabin 11 = Pedestal 12 = Glareshield 13 = Ambient |
Yes |
| 1 | The z position relative to the Datum Reference Point, in ft. | Float |
Yes (unless a NODE is specified, see below) |
| 2 | The x position relative to the Datum Reference Point, in ft. | Float | |
| 3 | The y position relative to the Datum Reference Point, in ft. | Float | |
| 4 | The X axis rotation, in degrees. | Float | No |
| 5 | The Y axis rotation, in degrees. | Float | |
| 6 | The Z axis rotation, in degrees. | Float | |
| 7 | The FX file name that is used by this light (for example, fx_navred). These files have *.fx extensions and should be placed in the root effects folder. |
String | Yes |
When writing out a light definition, you may specify a node on the aircraft model instead of the (z/x/y) position, and omit or include the rotation parameters depending on requirements. Below are examples of various combinations of data you can use to define a light:
; light.n = CircuitType, NODE_HELPER_NAME, fxfile
light.0 = 3, light_navigation_node, fx_navred
; light.n = CircuitType, ZOffset, XOffset, YOffset, XRotationInDegrees, YRotationInDegrees, ZRotationInDegrees, fxfile
light.0 = 3, -2.6, -17.4, 3.6, 90.0, 0.0, 0.0, fx_navred
; light.n = CircuitType, NODE_HELPER_NAME, XRotationInDegrees, YRotationInDegrees, ZRotationInDegrees, fxfile
light.0 = 3, light_navigation_node, 90.0, 0.0, 0.0, fx_navred
[ELECTRICAL]
This section controls everything related to the aircraft electrical systems. The electrical system is modular in nature and is based on a combination of component, configuration, and connection parameters. This section also has the following parameters that can be used to select a specific version of the system to be used:
| Parameter | Description | Type | Required |
|---|---|---|---|
Major |
What version of the electrical system you are using. Can be one of the following:
|
Integer | Yes |
Minor |
Not currently used. Should be set to 0. | Integer | Yes |
An electrical system is defined by its main components, of which there are multiple types:
| Parameter | Description | Type | Required |
|---|---|---|---|
circuit.N |
Defines one or more electrical circuits. A circuit consumes power, requiring current to function (see Circuits for governing SimVars). Details on the circuit map contents are given here: circuit.N |
No | |
battery.N |
This defines one or more batteries to be used in the electrical system. A battery is a power source with a set capacity in ampere hours (see Batteries for governing SimVars). Details on the battery map contents are given here: battery.N |
||
externalpower.N |
Defines one or more external power sources that form a part of the electrical system. This external power source will delivers power for as long as it is available (see External Power for governing SimVars). Details on the external power map contents are given here: externalpower.N |
||
generator.N |
Defines one or more generators that form a part of the electrical system. A generator is a power source inside the aircraft which will deliver power for as long as it is available. Details on the tank map contents are given here: generator.N |
||
bus.N |
Defines one or buses that form a part of the electrical system. A bus is a component that connects lines and other components within the electrical system (see General / Buses for governing SimVars). Note that only buses may have multiple lines connected to them (all other components can only have one line connection). Details on the bus map contents are given here: bus.N |
||
relay.N |
Defines one or relays that form a part of the electrical system. A relay is a component that can be used to connect/disconnet another line depending on whether the relay is powered or not. Details on the bus map contents are given here: relay.N |
To help with the configuration of the components you have configuration items:
| Parameter | Description | Type | Required |
|---|---|---|---|
supplier.N |
Defines the attributes of a source supplier of power, either AC, DC, or a Battery. Details on the supplier map contents are given here: supplier.N |
No | |
consumer.N |
Defines the attributes of power consumer (Battery or Custom). Details on the consumer map contents are given here: consumer.N |
||
curve.N |
A curve is defined as a list of paired values that can be used by other components. Details on the curve map contents are given here: curve.N |
Finally you have the connection components:
| Parameter | Description | Type | Required |
|---|---|---|---|
line.N |
A line is used to connect two components based on the assigned connection attributes. Each component can only have one line connection, unless it is a Bus, which can have more. Details on the line map contents are given here: line.N |
No | |
connection.N |
A connection defines the behaviour of electricity when passed through a line. Details on the connection map contents are given here: connection.N |
||
breaker.N |
A breaker is used to protect components from current overflow, and is used as part of the definition of a Connection. Details on the breaker map contents are given here: breaker.N |
||
transformer.N |
A transformer modifies the output voltage, and is used as part of the definition of a Connection. Details on the transformer map contents are given here: transformer.N |
||
diode.N |
A diode is used to direct the flow of electricity in a single direction along the line, and is used as part of the definition of a Connection. Details on the diode map contents are given here: diode.N |
Each of the components listed above can be defined multiple times as parameters within the [ELECTRICAL] configuration header. For how to access the information that these parameters add to an aircraft using SimVars, please see the following page:
For additional information that will help with setting up the electrical system, please see the following page:
[HYDRAULIC_SYSTEM]
This section controls the hydraulic pressure systems.
NOTE: This section is only for legacy Microsoft Flight Simulator 2020 aircraft, and for all new aircraft you should instead be using the [HYDRAULICS_SYSTEM_EX1] parameters. Note that you cannot use both this system and the modern system in the same aircraft.
Available parameters are:
| Parameter | Description | Type | Required |
|---|---|---|---|
normal_pressure |
The normal hydraulic pressure, in psi. Default value is 0. |
Float | No |
electric_pumps |
The number of electric pumps for the hydraulics. Default value is 0. |
Integer | |
engine_map |
This is a table of whether an engine has a hydraulic unit or not. For example:
This means there are pumps on engines 1 and 4, but not on any other. Default value is 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0. |
List of bools |
|
ailerons_require_hydraulics |
Sets whether the ailerons require hydraulics (TRUE, 1) or not (FALSE, 0). Default is 0 (FALSE). |
Bool | |
rudder_require_hydraulics |
Sets whether the rudder requires hydraulics (TRUE, 1) or not (FALSE, 0). Default is 0 (FALSE). |
Bool | |
spoilers_require_hydraulics |
Sets whether the spoilers require hydraulics (TRUE, 1) or not (FALSE, 0). Default is 0 (FALSE). |
Bool | |
elevator_require_hydraulics |
Sets whether the elevator requires hydraulics (TRUE, 1) or not (FALSE, 0). Default is 0 (FALSE). |
Bool |
[HYDRAULICS_SYSTEM_EX1]
This section controls everything related to the aircraft hydraulics system. The hydraulics system is modular in nature and is based on a combination of components, that are connected by lines, and each line can have special line features.
NOTE: This section is required for all modern aircraft, and only legacy Microsoft Flight Simulator 2020 aircraft should use the less comprehensive [HYDRAULIC_SYSTEM] section. Also note that you cannot use both systems in the same aircraft.Apart from components and line features, you also have the following parameter that is used to tell the simulation which version of the hydraulics system is being used:
A hydraulic system is defined by its main components, of which there are multiple types:
| Parameter | Description | Type | Required |
|---|---|---|---|
Reservoir.N |
The reservoir is a tank that stores hydraulic fluid as part of the hydraulic system. Details on the reservoir map contents are given here: Reservoir.N |
No | |
Pump.N |
A pump is used as part of the hydraulics to pressurise the system. Details on the pump map contents are given here: Pump.N |
||
PTU.N |
The PTU (Power Transfer Unit) is a hydraulic pump that uses the fluid under pressure from one circuit to run and pressurize another circuit without exchanging fluid. Details on the PTU map contents are given here: PTU.N |
||
Actuator.N |
This component acts as the link between the hydraulic system and the other aircraft parts. Details on the actuator map contents are given here: Actuator.N |
||
Junction.N |
A junction forms a crossroad for various lines to go through. Details on the junction map contents are given here: Junction.N |
||
Line.N |
These define how all the components are linked to one another. Details on the line map contents are given here: Line.N |
Additionally, you can add the following line features to the system lines:
| Parameter | Description | Type | Required |
|---|---|---|---|
Accumulator.N |
This line feature stores hydraulic fluid under pressure to be able to deliver at least a certain amount of fluid in the case of a system failure. Details on the accumulator map contents are given here: Accumulator.N |
No | |
Valve.N |
This line feature is used to control the flow of hydraulic fluid through the system. Details on the valve map contents are given here: Valve.N |
Each of the components listed above can be defined multiple times as parameters within the [HYDRAULICS_SYSTEM_EX1] configuration header. You can find more information on setting up the hydraulics system form the following page:
And you can find examples of use here:
[PNEUMATIC_SYSTEM]
This section controls the pneumatic system of the aircraft.
NOTE: This section is only for legacy Microsoft Flight Simulator 2020 aircraft, and for all new aircraft you should instead be using the [PNEUMATIC_SYSTEM_EX1] parameters. Note that you cannot use both this system and the modern system in the same aircraft.Available parameters are:
| Parameter | Description | Type | Required |
|---|---|---|---|
max_pressure |
The maximum permitted pressure for the pneumatic system, in psi. Default value is 0. |
Float | No |
apu_max_pressure |
The maximum pressure from the bleed permitted for the APU, in psi. Default value is 18. |
Float | No |
bleed_air_scalar |
Pneumatic pressure is a function of bleed air from the turbine engine. This scalar is used to multiply this bleed air pressure. Default value is 1. |
Float | No |
[PNEUMATIC_SYSTEM_EX1]
This section controls everything related to the aircraft pneumatic systems.
NOTE: This section is required for all modern aircraft, and only legacy Microsoft Flight Simulator 2020 aircraft should use the less comprehensive [PNEUMATIC_SYSTEM] section. Also note that you cannot use both systems in the same aircraft.
Apart from components and line features, you also have the following parameters:
| Parameter | Description | Type | Required |
|---|---|---|---|
Version |
What version of the hydraulic system you are using. Can be one of the following:
|
Integer | Yes |
AreasMinTemperature |
The lowest temperature (in °C) adjustable on the area knobs in the aircraft cockpit. | Float | Yes |
AreasMaxTemperature |
The highest temperature (in °C) adjustable on the area knobs in the aircraft cockpit. | Float | Yes |
MaxDifferencialPressure |
The maximum difference of pressure allowed between the aircraft cabin and the ambient air outside, in psi. Default value is 8.6. |
Float | No |
AreasMaxTemperatureInput |
The maximum temperature (°C) allowed to be pushed in the areas to avoid discomfort to the people inside of them. Default value is 70. |
Float | No |
A pneumatic system is defined by its main components, of which there are multiple types:
| Parameter | Description | Type | Required |
|---|---|---|---|
APU.N |
An auxiliary source of power providing airflow to turn on the engines or airflow to the main system in case of emergency. Details on the APU map contents are given here: APU |
No | |
Engine.N |
Primary engine providing air flow to the system. Details on the engine map contents are given here: Engine |
||
RamAir.N |
A source of air flow that is based on the aircraft speed. Details on the ram-air map contents are given here: RamAir |
||
Pack.N |
This component takes the bleed air coming from the engines and cools it. Details on the pack map contents are given here: Pack |
||
MixerUnit.N |
This component receives all the air flow coming from the packs, ram air, and the loop coming back from the areas, and then mixes them all together before sending the result into the areas. Details on the mixer unit map contents are given here: MixerUnit |
||
Area.N |
A zone of the aircraft into which air will be routed (cockpit, cabin, etc…). Details on the area map contents are given here: Area |
||
Outlet.N |
This component allows other systems to be fed air from the pneumatic system. These are systems that might be using air flow as a primary power source or as an emergency one, like wing deicing or brakes. Details on the outlet map contents are given here: Outlet |
||
Junction.N |
A junction forms a crossroad for various lines to go through. Details on the junction map contents are given here: Junction |
||
Line.N |
These define how all the components are linked to one another. Details on the line map contents are given here: Line |
||
Curve.N |
Used to define the engine temperature output(s). Details on the curve map contents are given here: Curve |
Additionally, you can add the following line features to the system lines:
| Parameter | Description | Type | Required |
|---|---|---|---|
Fan.N |
This line feature is used to create pressure difference (and thus, flow) in a line. Details on the fan map contents are given here: Fan |
No | |
Valve.N |
This line feature will limit the air flow going through it. Details on the valve map contents are given here: Valve |
Most of the components listed above can be defined multiple times as parameters within the [PNEUMATIC_SYSTEM_EX1] configuration header. You can find more information on setting up the pneumatics system form the following page:
And you can find examples of use here:
[VACUUM_SYSTEM]
This section controls the aircraft vacuum system. Vacuum system suction is controlled by the [PNEUMATIC_SYSTEM_EX1] section, specifically the Outlet.N hash map.
Available parameters are:
| Parameter | Description | Type | Required |
|---|---|---|---|
max_pressure |
The maximum suction pressure, in inHg. Default value is 0. |
Float | No |
vacuum_type |
The type of vacuum system installed on the aircraft. Default value is 1. |
Integer: 1 = engine pump |
No |
electric_backup_pressure |
The electrical backup pressure value, in inHg. Default value is 0. |
Float | No |
engine_map |
This is a table of whether an engine has a vacuum pump unit or not. For example:
This means there are pumps on engines 1 and 4, but not on any other. Default value is 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0. |
List of bools |
No |
suction_gain |
Speed at which suction grows. Default value is 0.85. |
Float | No |
suction_min |
Minimum suction value possible when system is operating. Default value is 4.05. |
Float | No |
[PITOT_STATIC]
A pitot-static system is a system of pressure-sensitive instruments that is most often used in aviation to determine an aircraft's airspeed, Mach number, altitude, and altitude trend. This section permits you to set certain attributes for using this system. Available parameters are:
[STALL_WARNING]
This section controls the stall warning system. Available parameters are:
[DEICE_SYSTEM]
This section controls the de-ice system. Available parameters are:
[RADIOS]
This section controls the aircraft radios. Note all systems listed here start at N = 1, and the available parameters are:
| Parameter | Description | Type | Required |
|---|---|---|---|
TransponderDefault |
Default Frequency of the aircraft (will be overridden by FLT and ATC values). Default value is 1234. |
Float | No |
Flarm |
The distance below which the FLARM system will detect threat objects, in meters. If set to -1 the system is disabled. Default value is -1. |
Float |
No |
Tcas |
Sets the status of the TCAS system, where:
Default value is 1. |
Float |
No |
Audio.N |
Set whether audio system N is available (TRUE, 1) or not (FALSE, 0). At least 1 audio system needs to be defined. |
Bool | Yes |
Com.N |
Set whether the com receiver N is available (TRUE, 1) or not (FALSE, 0) and whether it has a standby (TRUE, 1) or not (FALSE, 0). At least 1 com receiver needs to be defined, and you can have a maximum of 2. |
List of Bools |
Yes |
Nav.N |
Set whether the navigation receiver N is available (TRUE, 1) or not (FALSE, 0), whether it has a standby (TRUE, 1) or not (FALSE, 0), and whether it has glide-slope (TRUE, 1) or not (FALSE, 0). At least 1 navigation receiver needs to be defined, and you can have a maximum of 4. |
List of Bools |
Yes |
Adf.N |
Set whether the ADF system N is available (TRUE, 1) or not (FALSE, 0) and whether it has a standby (TRUE, 1) or not (FALSE, 0). At least 1 ADF system needs to be defined, and you can have a maximum of 2. |
List of Bools |
Yes |
Transponder.N |
Set whether the transponder N is available (TRUE, 1) or not (FALSE, 0). At least 1 transponder needs to be defined. Note that if the electrical system does not have a CIRCUIT_XPNDR circuit then the transponder will always work and be powered. |
Bool | Yes |
Marker.N |
Set whether the marker system N is available (TRUE, 1) or not (FALSE, 0). At least 1 marker system needs to be defined. |
Bool | Yes |
Tacan.N |
Set whether Tacan When you add this parameter it requires two values where the first sets whether the active frequency is available (1, TRUE) or not (0, FALSE) and the second sets whether the standby frequency is available (1, TRUE) or not (0, FALSE). For example: Tacan.1 = 1, 0 The line above adds the first Tacan receiver with an active frequency and no standby frequency. |
List of Bools |
No |
[AUTOPILOT]
This section controls the aircraft autopilot systems for both planes and helicopters.
The available parameters for planes are:
| Parameter | Description | Type | Required |
|---|---|---|---|
autopilot_available |
Setting this to 1 (TRUE) makes the autopilot system available to the aircraft, otherwise set it to 0 (FALSE) to disable autopilot. | Bool | Yes |
flight_director_available |
Setting this to 1 (TRUE) makes the flight director available to the aircraft, otherwise setting it to 0 (FALSE) will disable the flight director. | Bool | Yes |
min_feet_for_ap |
Set the height (in ft) below which the autopilot is automatically disabled. Default is -1000 (essentially disabled). | Float | No |
min_flight_time_for_ap |
Set the time (in seconds) after takeoff until the autopilot can be enabled. Default is 0 (essentially disabled). | Float | No |
default_vertical_speed |
The default vertical speed, in ft per second, that the autopilot will command when selecting a large altitude change. | Float | No |
autothrottle_available |
When this is set to 1 (TRUE) it makes available an autothrottle system on the aircraft. Set to 0 (FALSE) otherwise. | Bool | No |
autothrottle_arming_required |
When this is set to 1 (TRUE) the autothrottle is required to be armed prior to it being engaged. Setting it to 0 (FALSE) allows the autothrottle to be engaged directly. | Bool | No |
autothrottle_does_not_move_lever |
When this is set to 1 (TRUE) the autothrottle will not move the throttle lever. Set it to 0 (FALSE) if this is not the behavior you require. | Bool | No |
autothrottle_managed_by_plane |
When this is set to 1 (TRUE) the autothrottle will be managed automatically by the aircraft. Set it to 0 (FALSE) if this is not the behavior you require. | Bool | No |
autothrottle_takeoff_ga |
If this is set to 1 (TRUE) then takeoff / go-around operations with the autothrottle will be enabled. 0 (FALSE) disables this behavior. | Float | No |
autothrottle_max_rpm |
This sets the highest engine speed that the autothrottle will attempt to maintain as a percentage of the maximum engine speed. | Float | No |
auto_throttle_derivative_boundary |
The derivative gain boundary, a value that can be used to limit the derivative term in the PID controller that drives the behavior of the auto throttle. For more information on PIDs please see here: PID Primer Defaults value is 100. |
Float | No |
auto_throttle_derivative_control |
The derivative gain, a value that can be use to tune the magnitude of the contribution of the derivative term in the PID controller that drives the behavior of the auto throttle. For more information on PIDs please see here: PID Primer Defaults value is 0.2 |
Float | No |
auto_throttle_integrator_boundary
|
The ntegrator gain boundary, a value that can be used to limit the integrator term in the PID controller that drives the behavior of the auto throttle. For more information on PIDs please see here: PID Primer Defaults value is 5. |
Float | No |
auto_throttle_integrator_control
|
The integrator gain, a value that can be use to tune the magnitude of the contribution of the instantaneous error over time in the PID controller that drives the behavior of the auto throttle. For more information on PIDs please see here: PID Primer Defaults value is 0.0005. |
Float | No |
auto_throttle_proportional_control |
The proportional gain, a value that can be used to tune the magnitude of the contribution of the current error in the PID controller that drives the behavior of the auto throttle. For more information on PIDs please see here: PID Primer Defaults value is 0.01. |
Float | No |
pitch_takeoff_ga |
The default pitch that the Takeoff/Go-Around mode references, in degrees. | Float | No |
altimeter_indicator |
Indicates which altimeter indicator system on the aircraft is being referenced by the autopilot. | Integer | No |
attitude_indicator |
Indicates which attitude indicator system on the aircraft is being referenced by the autopilot | Integer | No |
direction_indicator |
Indicates which direction indicator system on the aircraft is being referenced by the autopilot, where 0 is the first (and default). | Integer | No |
use_no_default_pitch |
Setting this to 1 (TRUE) tells the autopilot not to use the default pitch option. Set to 0 (FALSE) to use it. | Bool | No |
default_pitch_mode |
This determines the default pitch mode when the autopilot is enabled. |
Integer:
|
No |
pitch_use_trim |
When set to 1 (TRUE) the autopilot will use the trim to hold pitch, and when set to 0 (FALSE) it will use the elevator directly. | Bool | No |
max_pitch |
The maximum pitch angle, in degrees, that the autopilot will command either up or down. | Float | No |
max_pitch_acceleration |
The maximum angular pitch acceleration, in degrees per second squared, that the autopilot will command up or down. | Float | No |
max_pitch_velocity_lo_alt |
The maximum angular pitch velocity, in degrees per second, which the autopilot will command when at an altitude below that specified by the parameter max_pitch_velocity_lo_alt_breakpoint. |
Float | No |
max_pitch_velocity_hi_alt |
The maximum angular pitch velocity, in degrees per second, which the autopilot will command when at an altitude above the altitude specified by the parameter max_pitch_velocity_hi_alt_breakpoint. The maximum velocity is interpolated between the hi and lo altitude velocities when between the hi and lo altitude breakpoints. |
Float | No |
max_pitch_velocity_lo_alt_breakpoint |
The altitude below which the autopilot maximum pitch velocity is limited by the parameter max_pitch_velocity_lo_alt. |
Float | No |
max_pitch_velocity_hi_alt_breakpoint |
The altitude above which the autopilot maximum pitch velocity is limited by the parameter max_pitch_velocity_hi_alt. The maximum velocity is interpolated between the hi and lo altitude velocities when between the hi and lo altitude breakpoints. |
Float | No |
max_pitch_velocity_lo_ang |
This defines the fly-by-wire load factor hold system's max pitch velocity at low angle differences. This parameter - along with Default value is 1. |
Float | No |
max_pitch_velocity_hi_ang |
This defines the fly-by-wire load factor hold system's max pitch velocity at high angle differences. This parameter - along with Default value is 5. |
Float | No |
use_no_default_bank |
Setting this to 1 (TRUE) tells the autopilot not to use the default bank option. Set to 0 (FALSE) to use it. |
Bool |
No |
default_bank_mode |
This determines the default bank mode when the autopilot is enabled. |
Enum:
|
No |
max_bank_acceleration |
The maximum angular bank acceleration, in degrees per second squared, that the autopilot will command left or right. Default value is 1.8. |
Float | No |
max_bank_velocity |
The maximum angular bank velocity, in degrees per second, which the autopilot will command left or right. This parameter takes a series of values, separated by commas, where each value corresponds to a specific bank switch position (see max_bank_velocity = 225, 10 Note that the number of entries given for this parameter should correspond with the number of values given for Default value is 3, and you can have a maximum of 6 values. |
List of Floats |
No |
max_bank |
The maximum bank angle, in degrees, that the autopilot will command either left or right.
This parameter takes a series of values, separated by commas, where each value corresponds to a specific bank switch position (see max_bank = 210, 30 Note that the number of entries given for this parameter should correspond with the number of values given for Default value is 25, and you can have a maximum of 6 values. |
List of Floats |
No |
auto_max_bank |
If 1 (TRUE) it adds an extra max bank selection for the autopilot that automatically changes depending on the airspeed. For more information, please see Set to 0 (FALSE) to disable the option. |
Bool | No |
auto_max_bank_table |
Sets the correspondence between an airspeed (in Knots) and a max bank value (in degrees), when
|
1D Curve of Floats |
No |
auto_max_bank_velocity_table |
Sets the correspondence between the angular bank velocity (in Knots) and a max bank value (in degrees / second). For example:
|
1D Curve of Floats |
No |
auto_max_bank_min_alt |
Sets the altitude (in ft) above ground level below which the max bank angle is limited (see auto_max_bank_min_alt_angle) in feet. |
Float | No |
auto_max_bank_min_alt_angle |
Sets the max bank angle (in degrees) when the plane is in auto max bank angle mode below the minimum altitude set by auto_max_bank_min_alt. |
Float | No |
max_throttle_rate |
This value sets the maximum rate at which the autothrottle will move the throttle position. | Float | No |
pitch_pid_reset_mode |
This parameter can be used to set the way that the pitch PID calculations will be updated. It can have the following values:
NOTE: A PID reset is triggered if the PID controller is executed in a frame and was not executed for the previous 10 frames. Usually this happens when an autopilot mode using the PID is switched ON. Default value is 0. |
Integer:
|
No |
pitch_pid_max_I_accumulation |
This sets the maximum accumulation permitted for the integral of the pitch PID. Default value is 1. |
Float | No |
pitch_proportional_control |
Pitch proportional controller constant. | Float | No |
pitch_integrator_control |
Pitch integral controller constant. | Float | No |
pitch_derivative_control |
Pitch derivative controller constant. | Float | No |
pitch_integrator_boundary |
The boundary, or maximum signal error, in degrees in which the pitch integrator function is active. | Float | No |
pitch_derivative_boundary |
The boundary, or maximum signal error, in degrees in which the pitch derivative function is active. | Float | No |
roll_pid_reset_mode |
This parameter can be used to set the way that the roll PID calculations will be updated. It can have the following values:
NOTE: A PID reset is triggered if the PID controller is executed in a frame and was not executed for the previous 10 frames. Usually this happens when an autopilot mode using the PID is switched ON. Default value is 0. |
Integer:
|
No |
roll_pid_max_I_accumulation |
This sets the maximum accumulation permitted for the integral of the roll PID. Default value is 1. |
Float | No |
roll_proportional_control |
Roll proportional controller constant. | Float | No |
roll_integrator_control |
Roll integral controller constant. | Float | No |
roll_derivative_control |
Roll derivative controller constant. | Float | No |
roll_integrator_boundary |
The boundary, or maximum signal error, in degrees in which the roll integrator function is active. | Float | No |
roll_derivative_boundary |
The boundary, or maximum signal error, in degrees in which the roll derivative function is active. | Float | No |
heading_pid_reset_mode |
This parameter can be used to set the way that the heading PID calculations will be updated. It can have the following values:
NOTE: A PID reset is triggered if the PID controller is executed in a frame and was not executed for the previous 10 frames. Usually this happens when an autopilot mode using the PID is switched ON. Default value is 0. |
Integer:
|
No |
heading_pid_max_I_accumulation |
This sets the maximum accumulation permitted for the integral of the heading PID. Default value is 0.05. |
Float | No |
hdg_proportional_control |
Heading proportional controller constant. | Float | No |
hdg_integrator_control |
Heading integral controller constant. | Float | No |
hdg_derivative_control |
Heading derivative controller constant. | Float | No |
hdg_integrator_boundary |
The boundary, or maximum signal error, in degrees in which the heading integrator function is active. | Float | No |
hdg_derivative_boundary |
The boundary, or maximum signal error, in degrees in which the heading derivative function is active. | Float | No |
vs_proportional_control |
Vertical speed proportional controller constant. | Float | No |
vs_integrator_control |
Vertical speed integral controller constant. | Float | No |
vs_derivative_control |
Vertical speed derivative controller constant. | Float | No |
vs_integrator_boundary |
The boundary, or maximum signal error, in degrees in which the vertical speed integrator function is active. | Float | No |
vs_derivative_boundary |
The boundary, or maximum signal error, in degrees in which the vertical speed derivative function is active. | Float | No |
nav_proportional_control_ex1 |
Proportional controller constant in lateral navigation modes. | Float | No |
nav_integrator_control_ex1 |
Integral controller constant in lateral navigation modes. | Float | No |
nav_derivative_control_ex1 |
Derivative controller constant in lateral navigation modes. | Float | No |
nav_integrator_boundary_ex1 |
The boundary, or maximum signal error, in degrees in which the integrator function is active. | Float | No |
nav_derivative_boundary_ex1 |
The boundary, or maximum signal error, in degrees in which the derivative function is active. | Float | No |
nav_yaw_proportional_control |
Proportional controller constant in yaw navigation modes. | Float | No |
nav_yaw_integrator_control |
Integral controller constant in yaw navigation modes. | Float | No |
nav_yaw_derivative_control |
Derivative controller constant in yaw navigation modes. | Float | No |
nav_yaw_integrator_boundary |
The boundary, or maximum signal error, in degrees in which the yaw integrator function is active. | Float | No |
nav_yaw_derivative_boundary |
The boundary, or maximum signal error, in degrees in which the yaw derivative function is active. | Float | No |
gs_proportional_control |
Proportional controller constant in glideslope mode. | Float | No |
gs_integrator_control |
Integral controller constant in glideslope mode. | Float | No |
gs_derivative_control |
Derivative controller constant in glideslope mode. | Float | No |
gs_integrator_boundary |
The boundary, or maximum signal error, in degrees in which the glideslope integrator function is active. | Float | No |
gs_derivative_boundary |
The boundary, or maximum signal error, in degrees in which the derivative function is active. | Float | No |
yaw_damper_gain |
The proportional gain on the yaw dampers yaw rate error. | Float | No |
head_hold_pid |
The full heading hold PID definition for the propeller, as a table. Follows the format of:
|
List of Floats |
No |
airspeed_hold_pid |
The full airspeed hold PID definition for the propeller, as a table. Follows the format of:
|
List of Floats |
No |
min_altitude_ref |
Sets the minimum altitude (in ft) that can be set in the Autopilot. Defaults to -99900. |
Float | No |
max_altitude_ref |
Sets the maximum altitude (in ft) that can be set in the Autopilot. Defaults to 99900. |
Float | No |
min_vertical_speed_ref |
Sets the minimum vertical speed (in ft per minute) that can be set in the Autopilot. Defaults to -9900. |
Float | No |
max_vertical_speed_ref |
Sets the maximum vertical speed (in ft per minute) that can be set in the Autopilot. Defaults to 9900. |
Float | No |
min_IAS_ref |
Sets the minimum IAS reference (in kias) that can be set in the Autopilot. Default is 0. |
Float | No |
max_IAS_ref |
Sets the maximum IAS reference (in kias) that can be set in the Autopilot. Default is 990. |
Float | No |
min_Mach_ref |
Sets the minimum Mach that can be set in the Autopilot. Defaults to 0. |
Float | No |
max_Mach_ref |
Sets the maximum Mach that can be set in the Autopilot. Defaults to 3. |
Float | No |
alt_mode_slot_index |
Set the default alt mode slot index (from 0 to 3). This is the index for the SimVar When this parameter is set to 1, 2 or 3, the altitude capture will watch the altitude set at that index, unless overridden by changing the currently observed slot using the key event When this config parameter is set to 0, the altitude capture will always use whatever the currently observed slot is set to and will not change slots or write to any slots on capture. |
Integer | No |
flc_proportional_control |
The FLC proportional control mode value. Default is 20.0. |
Float | No |
flc_integrator_control |
The FLC integrator control mode value. Default is 1.0. |
Float | No |
flc_derivative_control |
The FLC derivative control mode value. Default is 50.0. |
Float | No |
flc_integrator_boundary |
The FLC integrator control boundary. Default is 100.0. |
Float | No |
flc_derivative_boundary |
The FLC derivative control boundary. Default is 1000.0. |
Float | No |
flc_min_pitch_low_alt |
Sets the minimum AP pitch (in degrees) when the plane is in FLC mode and below flc_min_low_alt_limit. |
Float | No |
flc_min_low_alt_limit |
Sets the maximum height (in ft) below which the pitch in FLC mode is limited. Disabled if <=0. Default is 0. |
Float | No |
min_feet_for_athr |
Set the height (in ft) below which the auto-throttle is automatically disabled. Disabled by default. |
Float | No |
altitude_english_slow_increment |
Sets the slow increments (in ft) of the autopilot's altitude when in english units. | Float | No |
altitude_english_fast_increment |
Sets the fast increments (in ft) of the autopilot's altitude when in english units. | Float | No |
altitude_english_fastest_increment |
Sets the fastest increments (in ft) of the autopilot's altitude when in english units. | Float | No |
altitude_metric_slow_increment |
Sets the slow increments (in meters) of the autopilot's altitude when in metric units. | Float | No |
altitude_metric_fast_increment |
Sets the fast increments (in meters) of the autopilot's altitude when in metric units. | Float | No |
altitude_metric_fastest_increment |
Sets the fastest increments (in meters) of the autopilot's altitude when in metric units. | Float | No |
metric_VS_increment |
Sets the increments of the autopilot's vertical speed when in metric units (meters per minute). | Float | No |
english_VS_increment |
Sets the increments of the autopilot's vertical speed when in english units (ft per minute). | Float | No |
IAS_slow_increment |
Sets the slow increments of the autopilot's target speed (in Knots). | Float | No |
IAS_fast_increment |
Sets the fast increments of the autopilot's target speed (in Knots). | Float | No |
IAS_fastest_increment |
Sets the fastest increments of the autopilot's target speed (in Knots). | Float | No |
mach_increment |
Sets the increments of the autopilot's target speed (in Mach). | Float | No |
hdg_ref_var |
Set the compass variable to be used as the source of heading reference. |
Enum:
|
No |
auto_throttle_hold_vs |
If set to 0 (FALSE), the auto throttle will not attempt to hold the VS when attempting to hold an airspeed. If set to 1 (TRUE) it will. Default value is 1 (TRUE). |
Boolean | No |
auto_rudder_use_pedals |
If set to 0 (FALSE), the auto rudder will not move the cockpit pedals. If set to 1 (TRUE) it will. Default value is 1 (TRUE). |
Boolean | No |
auto_disengage_with_pilot_input |
When this is set to 1 (TRUE) then the autopilot will be disengaged when any pilot action on inputs is greater than 50% of the axis for more than 1 second. Default value is 1 (TRUE). |
Boolean | No |
basic_modes_disengage_with_FBW |
If set to 1 (TRUE) and the fly-by-wire is set to "ON" and the auto-pilot is on, then the Pitch, Bank and Yaw dampening modes are disengaged. Default value is 1 (TRUE). |
Boolean | No |
no_alt_capture_in_vs_mode |
When set to 1 (TRUE), this will disable the altitude capture by autopilot when the VS mode is engaged. Default value is 0 (FALSE). |
Boolean | No |
pitch_use_elevator_only |
If set to 1 (TRUE), the autopilot/fly-by-wire will not use trim for pitch inputs. Default value is 0 (FALSE), so it uses trimming for pitch inputs. |
Boolean | No |
FBWPitchTrimSpeedScalar |
This value can be used to scale the speed at which pitch trim is applied using a fly-by-wire system. Default value is 1. |
Float | No |
FBWHighSpeedRollSpeedScalar |
This value can be used to scale the speed at which roll is applied using a fly-by-wire system. Default value is 1. |
Float | No |
The parameters available to helicopters are:
[SMOKESYSTEM]
This section controls the aircraft smoke system. Available parameter is:
| Parameter | Description | Type | Required |
|---|---|---|---|
smoke.N |
Each parameter
The position values are the local position offset relative to the Datum Reference Point (in ft) and the |
List of Floats |
No |
[folding_wings]
If the aircraft being defined has folding wings, this section should be included. Available parameters are:
| Parameter | Description | Type | Required |
|---|---|---|---|
wing_fold_system_type |
The type of system used to fold the wings. Default value is 0. |
Integer:
|
No |
fold_rates |
The folding rates for the left wing and right wing, as a table of two values (left, right). Rates are expressed as 1/seconds. Default values are 0.1, 0.12. |
List of Floats |
No |
[TailHook]
This section controls the tailhook of the aircraft (if required). Available parameters are:
| Parameter | Description | Type | Required |
|---|---|---|---|
has_tailhook |
Sets whether the aircraft has a tailhook (1, TRUE) or not (0, FALSE). Note that you will need to have set up the Default value is 0 (FALSE). |
Boolean | No |
cable_force_adjust |
This is a scaling factor that can be used to adjust the cable spring force when an aircraft is hooked. The value acts as a multiplier, so a value of 2 would be double the spring force, while a value of 0.5 would half the spring force. You can change this value from the default if you're not satisfied with how the aircraft is arrested by the cables: for example, stopping a lightweight aircraft may require a lower force multiplier compared to stopping a very heavy one. Default value is 1. |
Float | No |
[launch_assistance]
This section controls the launchbar (assisted takeoff) parameters for an aircraft that requires them. Available parameters are:
NOTE: These parameters are currently purely visual as you cannot set an aircraft to take off from an aircraft carrier. Future updates may change this.
| Parameter | Description | Type | Required |
|---|---|---|---|
launch_bar_pivot |
Position of pivot attachment point relative to the Datum Reference Point. Values are in ft. Default value is 0, 0, 0. |
List of Floats |
No |
launch_bar_lug |
Position of lug attachment point relative to the Datum Reference Point. Values are in ft. Default value is 0, 0, 0. |
List of Floats |
No |
launch_bar_moveable |
Sets whether the launchbar is movable or not. Default value is 0 (FALSE). |
Boolean | No |
[VOICEALERTS]
This section controls any voice alerts for the aircraft. Available parameters are:
| Parameter | Description | Type | Required |
|---|---|---|---|
LowFuelPct |
Sets the low fuel warning voice alert, as a table of 3 values in the following order:
For check_type |
List of Floats |
No |
OverGLimit |
Sets the over G limit, as a table of 3 values in the following order:
For check_type |
List of Floats |
No |
[PRESSURIZATION]
This section controls the cabin pressurization systems. Available parameters are:
| Parameter | Description | Type | Required |
|---|---|---|---|
design_cabin_pressure |
The cabin pressure, as designed, in psi. This value is used to set the PRESSURIZATION_CABIN_ALTITUDE_GOAL SimVar. |
Float | No |
max_pressure_differential |
The maximum pressure deferential permitted, in psi. | Float | No |
[AUXILIARY POWER UNIT]
This section controls APU systems. Available parameter is:
| Parameter | Description | Type | Required |
|---|---|---|---|
Available |
Indicates whether there is an APU system (TRUE, 1) or not (FALSE, 0). | Bool | No |
[WATER BALLAST SYSTEM]
This section controls the water balance system. Available parameters are:
| Parameter | Description | Type | Required |
|---|---|---|---|
Version |
The version of the water ballast system being used. This will impact how the Tank.N parameter is defined. If not supplied then the version will be considered as 1. |
Integer | No |
NumberOfReleaseValves |
The number of ballast release valves available. | Integer | No |
DumpRate |
The dump rate for the ballast, in Gallons per second. | Float | No |
|
Version 2 And Above: Each parameter Tank.N = #Name:<string> #Capacity:<val> #position: <x>,<y>,<z> #Valve:<index> #DefaultFillPct:<val>
Versions before 2: Each parameter max_weight, z, x, y, valve_index The weight is in Gallons, the position values are the local position offset relative to the Datum Reference Point (in ft, and the index is the valve index (from 1 to
NOTE: You can only define a maximum of 6 water ballast tanks using the legacy version. |
Version 2+: Hash map
Previous Versions: List of Floats
|
No |
[Liquid Dropping System]
This section controls everything related to the aircraft Liquid Dropping System. This is a modular system that is made up from various connected components. The available components and parameters are as follows:
| Parameter | Description | Type | Required |
|---|---|---|---|
Tank.N |
The tank that holds the liquid which is to be available for dropping. Details on the tank map contents are given here: Tank.N |
No | |
Door.N |
A door that can be opened and closed to control the liquid dropping. Details on the door map contents are given here: Door.N |
||
Scoop.N |
This is the scoop which can be opened or closed to take on liquid and fill the tank(s). Details on the scoop map contents are given here: Scoop.N |
||
Curve.N |
This defines a curve which is used to define a Door (or Scoop) drop (or intake) rate for the liquids in the tank(s) connected. Details on the curve map contents are given here: Curve.N |
[Burner_System]
This section controls the burner system used by hot balloon sim objects. Available parameters are:
| Parameter | Description | Type | Required |
|---|---|---|---|
Burner.N |
This defines one or more liquid propane gas burners for a hot air balloon. Details on the scoop map contents are given here: Burner.N. |
No | |
Valve.N |
This defines one or more valves required by the burners of a hot air balloon. Details on the valve map contents are given here: Valve.N. |
Many of these components can be checked using SimVars, and you can find information about those here:
[LocalVars]
This section can be used to set the initial value of persistent local variables to be used in the XML Model Behaviours templates and gauges. These local vars are accessed using the "L:" var identifier in Reverse Polish Notation, and if you are using the JavaScript API then it's done the same way as for SimVars, using the GetSimVarValue(name, unit, dataSource = "") function. 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] section.
When an aircraft is selected by a user and the flight is first started, these "L:" vars are defined using the LocalVar.N parameter and then initialised using a default value (done using the LocalVarDefault.N parameter). Any changes to these variables that have been made will then be saved to a file (state.cfg) when the flight is exited. This file will be saved to a local location on the users computer using the following path schema:
STEAM: C:\Users\<USERNAME>\AppData\Roaming\Microsoft Flight Simulator\SimObjects\<AIRCRAFT_NAME>\state.cfg MS STORE: C:\Users\<USERNAME>\AppData\Local\Packages\Microsoft.FlightSimulator_8wekyb3d8bbwe\LocalCache\SimObjects\<AIRCRAFT_NAME>\state.cfg
The next time the aircraft is used, the local variables will be initialised as before, only now they will be set to the values stored in the state.cfg.
IMPORTANT! The variables defined here take precedence over those stored in the FLT file, and will overwrite any with the same name that are saved to that file when an aircraft is loaded.
Note that if you define a variable here but don't initialise it with a default value, then the first time it is used it will be considered as having a value of 0.
Note that if you require non-persistent local variables, then you should be setting them up using the [LocalVars.N] section of the FLT file.
[LocalVars_EX1]
This section can be used to set the initial value of persistent local variables to be used in the XML Model Behaviours templates and gauges. These local vars are accessed using the "L:1" var identifier in Reverse Polish Notation, and if you are using the JavaScript API then it's done the same way as for SimVars, using the GetSimVarValue(name, unit, dataSource = "") function. 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).
When an aircraft is selected by a user and the flight is first started, these "L:1" vars are defined using the LocalVar.N parameter and then initialised using a default value (done using the LocalVarDefault.N parameter). Any changes to these variables that have been made will then be saved to a file (state.cfg) when the flight is exited. This file will be saved to a local location on the users computer using the following path schema:
STEAM: C:\Users\<USERNAME>\AppData\Roaming\Microsoft Flight Simulator\SimObjects\<AIRCRAFT_NAME>\state.cfg MS STORE: C:\Users\<USERNAME>\AppData\Local\Packages\Microsoft.FlightSimulator_8wekyb3d8bbwe\LocalCache\SimObjects\<AIRCRAFT_NAME>\state.cfg
The next time the aircraft is used, the local variables will be initialised as before, only now they will be set to the values stored in the state.cfg.
IMPORTANT! The variables defined here take precedence over those stored in the FLT file, and will overwrite any with the same name that are saved to that file when an aircraft is loaded.
Note that if you define a variable here but don't initialise it with a default value, then the first time it is used it will be considered as having a value of 0.
Note that if you require non-persistent local variables, then you should be setting them up using the [LocalVars_EX1.N] section of the FLT file.
[WASM_SYSTEM.N]
This section is used to set up a reference to a WASM system module. This is an indexed section, with the indices starting at 0 and going up by 1 in consecutive order. Each indexed section is used to setup a single WASM system, and has the following parameters:
| Parameter | Description | Type | Required |
|---|---|---|---|
ModulePath |
This is the path to the WASM module relative to the root of your package. This path must point to a location in the same package as the SimObject referencing the module, as you cannot reference modules from outside the package. If you wish to share a module between multiple packages, then it should be configured as a SimAttachment. |
String | Yes |
SystemName |
The name of the system that is being added to the SimObject, for example: |
String | Yes |
ParameterString |
This is a string of data given back during the call to the INIT callback of the system. It may be, for example, the name of the aircraft variation so the module can selectively init variables, the number of engines, etc... How this string is parsed is up to the code in the module. |
String | No |
For more information on WASM System modules, please see the following page:
Related Topics