reference_points.cfg
This file is used to define a number of reference points on a SimObject. These points can then be referenced in your code and used for specific purposes (for an example of use, please see the Agricultural Aviation page).
This file should be created in the same folder as the sim.cfg file or aircraft.cfg file that will be using it. Below you can find information on the different sections used in the reference_points.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 |
[ReferencePoint.N]
Each file can contain multiple [ReferencePoint.N] entries, where each one will be used to create a unique reference point, numbered from 0. Each reference point has the following parameters:
| Parameter | Description | Type | Required |
|---|---|---|---|
Name |
This is the name of the reference point, which should be unique and contain only alpha-numeric characters and the under-bar "_". For example: Name=pt_runway_start |
String | Yes |
AttachTo |
This is the name of a node that the reference point is attached to. If supplied, then the reference point position and rotation will be relative to this node rather than the SimObject root node. | String | No |
IsExterior |
When set to 1 (TRUE) the reference point is flagged as exterior only, and when set to 0 (FALSE) it is interior only. Note that this means that you cannot access an exterior reference point from any interior code, and vice-versa. | Bool | Yes |
RelativePos |
This sets the offset position of the reference point relative to the (0, 0, 0) position of the SimObject root node (or AttachTo node, if supplied). The parameter requires a comma separated table of 3 values for the X/Y/Z relative offset. |
List of Floats |
Yes |
RelativeRot |
This sets the offset rotation of the reference point relative to the (0, 0, 0) position of the SimObject root node (or AttachTo node, if supplied). The parameter requires a comma separated table of 3 values for the X/Y/Z relative rotation. |
List of Floats |
Yes |
Related Topics