reference_points.cfg
NOTE: This page is purely for reference as this file is currently only used by the Microsoft Flight Simulator engine and offers no functionality for users creating Add-Ons. Future updates may expose the functionality to use this kind of file to everyone.
This file is used to define a number of reference points on a SimObject. These points can then be refernced in your code and used for specific purposes. 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.
[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 underbar "_". 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. |
1D Table of Floats (see Data Types for more information) |
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. |
1D Table of Floats (see Data Types for more information) |
Yes |