navigation_graph.cfg
The [navigation_graph].cfg
file is an optional aircraft CFG File for defining nodes and edges (connections or paths) within a SimObject or an Airport that permit interactions of some kind to occur. Navigation graph files are normally named using the following naming convention:
navigation_graph_[SimObjName]_<Identifier>.cfg
navigation_graph_[AirportICAO]_<identifier>.cfg
IMPORTANT! You cannot have a file called simply navigation_graph.cfg
. This will cause issues, bith with the editor and potentially with the simulation itself.
The [SimObjName]
/ [AirportICAO]
part is optional, but all files should have a unique identifier string to differentiate them from other files of the same type. Below are a few examples:
navigation_graph_da62_passengers.cfg
navigation_graph_skydivers.cfg
navigation_graph_EGLL_small_gate.cfg
navigation_graph_bus_seat.cfg
The files you create must be placed into a folder labelled navigation_graph. The exact location of this folder will depend on whether they are for a SimObject or for an Airport. For a modular aircraft SimObject it would be one of the following:
[Aircraft Project]\PackageSources\SimObjects\Airplanes\[Aircraft Name]\common\navigation_graph\ [Aircraft Project]\PackageSources\SimObjects\Airplanes\[Aircraft Name]\presets\[Company Name]\[Aircraft Name]\navigation_graph\ [Aircraft Project]\PackageSources\SimObjects\Airplanes\[Aircraft Name]\attachments\[Company Name]\[Attachment Name]\navigation_graph\
And for an airport it would be:
[Airport Project]\PackageSources\data\navigation_graph\
It should be noted that we do not recommend that you edit these files by hand, and instead you should be using the Node Graph Editor, as explained on the following page:
Also note that for airport projects, the Node Graph Editor should be using the World Coordinate System in the MainGraph section.
Finally, for setting up a navigation graph for use with airport Apron Services and also the various missions available to aircraft, please see here:
[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 |
[MainGraph.N]
This section is for defining the contents of the Main Graph for the SimObject. Main graphs should be numbered from N = 0, where each subsequent MainGraph increments N by 1. Note that if indices are not consecutive, later indices will be ignored, for example, if you have MainGraph.0
and MainGraph.2
, only MainGraph.0
will be considered by the simulation.
This is the "top level" main graph that will contain a list of all the nodes
and (optionally) a list of all the edges
assigned to the graph. For example:
[MainGraph.N]
nodes = SKYDIVE_PATH_NODE_0, SKYDIVE_JUMP_NODE
edges = SKYDIVE_PATH_EDGE_0, SKYDIVE_PATH_EDGE_1, SKYDIVE_PATH_EDGE_2
exclusionAreas = 4,5,6
Parameter | Description | Type | Required |
---|---|---|---|
nodes |
This is a comma separated list of the names of the nodes to be included in the Main Graph. |
List of strings |
Yes |
edges |
This is a comma separated list of the names of the edges to be included in the Main Graph. |
List of integers |
No |
exclusionAreas |
This is a comma separated list of the names of the exclusion areas to be included in the Main Graph. |
List of integers |
No |
massSections |
This is a comma separated list of the names of the mass sections to be included in the Main Graph. |
List of integers |
No |
coordinate_system |
The coordinate system to use for the nodes in the graph. Can be either of the following:
Default value is:
|
String | Yes |
[SubGraph.N]
This section is for defining the contents of one or more SubGraph. SubGraphs should be numbered from N = 0, where each subsequent Sub Graph increments N by 1. Note that if indices are not consecutive, later indices will be ignored, for example, if you have SubGraph.0
and SubGraph.2
, only SubGraph.0
will be considered by the simulation. Each sub graph has a list of nodes
and (optionally) a list of edges
which are assigned to the sub graph. For example:
[SubGraph.0]
name = SUB_GRAPH_SEATING
nodes = NODE_PASSAGE_1, NODE_PASSAGE_2
[SubGraph.1]
name = SUB_GRAPH_STEWARDS
nodes = NODE_PASSAGE_1, NODE_POST_1
edges = EDGE_PASSAGE_POST
Parameter | Description | Type | Required |
---|---|---|---|
name |
The common name assigned to the sub graph. Should only contain alpha-numeric characters and the "_" and "-" symbols. Default value is:
|
String | No |
nodes |
This is a comma separated list of the names of the nodes to be included in the Sub Graph. |
List of strings |
Yes |
edges |
This is a comma separated list of the names of the edges to be included in the Sub Graph. |
List of strings |
No |
[Node.N]
The [Node.N]
section is for defining the individual nodes that will be used by both the [MainGraph.N]
and any [SubGraph.N]
elements that you create. When defining each node, you should start at N = 0 and increment N by 1 for each node thereafter. Each node has the following parameters:
Parameter | Description | Type | Required |
---|---|---|---|
name |
The common name assigned to the node and will be used in other parameters to reference the node, and as part of the merge process for the modular SimObject. It is not used in the XML files that reference the navigation graph (for that see Default value is a dynamic parameter, with the form depending on whether the node is on the main graph or a sub-graph. If the node is not on the main graph, the dynamic param will simply be it's index, eg:
If the node is on a sub-graph, then it will have the name of the node it's attached to on the main graph and its index, eg:
For example:
This node is the 5th node on the sub-graph, and is attached to the node named
|
String | No |
coordinate_system |
The coordinate system to use for the node
If this parameter is not included - or is set to "inherited" - the node will inherit the coordinate system defined in the
Default value is:
|
String | No |
pos |
Sets the X/Y/Z position of the node being defined relative to either:
Default value is:
|
List of floats |
No |
pbh |
Sets the pitch/bank/heading of the node, relative to either:
Default value is:
|
List of floats |
No |
modelNode |
This is where you can give a node name from the aircraft glTF to place the navigation graph node on. If supplied, the Default value is:
|
String | No |
tag |
This is a string that is used to name the node, and can be shared by multiple nodes within multiple files (unlike the Default value is:
|
String | No |
sharedSeat |
This is only required if you want to have the copilot node of the Default value is:
|
Bool | No |
subgraph |
The Sub Graph that the node should be added to. Note that you can only assign a node to a single sub graph, not multiple. If this parameter is included, you may also include the Default value is:
|
Integer | No |
loadVolume |
This defines the three dimensional volume associated with the node, using values for the width/height/depth. The defined volume is the approximate space that any payload on the node would occupy (whether it is a passenger, a suitcase, a bag of rice, etc...). Default values are:
|
List of floats |
No |
spawnLoad |
This defines whether a load should be spawned automatically on the node. When set to Default value is:
|
Bool | No |
massSection |
The name of one or more
Default value is:
|
String | No |
node_occlusion_factor |
This sets the factor with which to modify the base ambient occlusion factor for the SimObject, as set in the SimObject Editor tab using the Default value is:
|
Float | No |
distanceToNotAnimate |
This defines the distance (in meters) from the camera at which any object on this node will stop being animated. If the value is set to -1, then the object will always be animated. Default value is:
|
Float | No |
projectOnGround |
When this is set to Default value is:
|
Bool | No |
isExit |
When this is set to Default value is:
|
Bool | No |
mouserectLinked |
Defines a MouseRect to which the node is linked to. Default value is:
|
String | No |
edgeToMainNode |
This option is only applicable if the node being defined is part of a Default value is 0 (FALSE):
|
Bool | No |
interactiveObject |
The name of an interactive object that is to be associated with the node. Default value is:
|
String | No |
interactiveVolume |
This defines the three dimensional volume associated with the node, using values for the width/height/depth. The volume given will be used to determine where interactions will be triggered. Default values are:
|
List of floats |
No |
interactiveVolumeOffset |
This defines the offset of the interactive volume from the node along the X/Y/Z axis. Default values are:
|
List of floats |
No |
interactiveVolumeConstraint |
This sets a constraint on which object actors can trigger the volume interaction. Available options are as follows:
Default value is:
|
String | No |
interactionVolume |
Here you can add a GUID reference to a <ServiceInteraction.InteractionVolume> element of a Service Interaction XML file used by the aircraft. |
String | No |
interactionState |
Here you can add a GUID reference to a <ServiceInteraction.InteractionState> element of a Service Interaction XML file used by the aircraft. |
String | No |
interactionGUID.n |
Here you can add one or more GUID references to the
|
List of strings |
No |
interactionFile.n |
A path of an interaction XML file to load. If the XML has a Note that it is possible to include additional parameters to be used as string substitutions within the XML. This requires that the parameter be formatted as a hashmap where:
For example:
In the above example, all mentions of the string "SEATBELT_FASTEN" will instead be read as "SEATBELT_C172_Pilot_Fasten". You can pass in several parameters in this way simply by separating them with a comma, for example:
|
String | No |
[Edge.N]
The [Edge.N]
section is for defining the individual edges (paths) that connect any two nodes together. When defining each edge, you should start at N = 0 and increment N by 1 for each edge thereafter.
NOTE: You can only define an edge between two nodes and no more, and an edge is always considered as two-way, ie: movement is available along the edge from the start node to the end node and vice-versa.Each edge has the following parameters:
Parameter | Description | Type | Required |
---|---|---|---|
name |
The common name assigned to the edge and will be used to reference the edge in other parameters. Should only contain alpha-numeric characters and the "_" and "-" symbols. Default value is a dynamic parameter formed as:
For example:
Note that if the nodes have no names defined, then the parameter will simply be formed as:
|
String | No |
nodeStart |
The name of the [Node.N] that should be considered as the first node of the edge connection. |
String | Yes |
nodeEnd |
The name of the [Node.N] that should be considered as the last node of the edge connection. |
String | Yes |
[ExclusionArea.N]
The [ExclusionArea.N]
section is for defining an area that will invalidate any edge that crosses it, such that no behaviour can move on it. This is useful when using interactive objects linked by multiple edges to the main graph. These areas should be defined as a set of at least 3 nodes that form a closed polygon. For example:
[ExclusionArea.0]
nodes = NODE_EXCLUDE_1, NODE_EXCLUDE_2, NODE_EXCLUDE_3, NODE_EXCLUDE_4
When defining each exclusion area, you should start at N = 0 and increment N by 1 for each area thereafter. Each exclusion area has the following parameters:
Parameter | Description | Type | Required |
---|---|---|---|
name |
The common name assigned to the exclusion area. Should only contain alpha-numeric characters and the "_" and "-" symbols. Default value is:
|
String | No |
nodes |
This is a comma separated list of the names of the nodes to be used to define the exclusion area. There must be at least three nodes in the list for a valid exclusion area to be formed. |
List of strings |
Yes |
[MassSection.N]
The [MassSection.N]
section is used to apply the mass of the behaviours of a navigation service to the SimObject holding the navigation service. When a behaviour is attached to a SimObject, it applies (or removes) its mass at the end of each of its movements along the navigation graph, or when it gets attached or detached. The position at which its mass is applied will depend on the position defined for the station_load.N
that the mass section references. For example:
[MassSection.0]
name = ecoSeats
stationLoadName = seat_rows_left
maxMass = 500
When defining each mass section, you should start at N = 0 and increment N by 1 for each section thereafter. Each mass section has the following parameters:
Parameter | Description | Type | Required |
---|---|---|---|
name |
The common name assigned to the mass section. Should only contain alpha-numeric characters and the "_" and "-" symbols. Default value is:
|
String | No |
stationLoadName |
Sets the name of the station load (as defined by the |
List of floats |
Yes |
maxMass |
The maximum mass (in lbs) that can be applied in this mass section. If more than the amount specified is applied, then it will be clamped to this amount. Default value is:
Note that a value of -1 means that the value is uncapped. |
Float | No |
fillProportion |
The value here is used to determine the default placement configuration of mass as it is added to the nodes. For example, if you have mass section [0] with a fill proportion of 4, and mass section [B] with a fill proportion of 2, then the percentage of SimObjects that will be sent to [A] is 66% and to [B], 33%. Default value is:
Note that a value of 0 means that there is no fill proportion and each mass area will be filled until the |
Integer | No |