MIST msgLeadingBR
mist.msgLeadingBR
| Added with: Mist 3.0 |
| Description |
| Utilizes mist.getBRString and mist.message.add functions to display the coordinates in the Bearing Range Altitude (BRA) format of the concentration of units most in the heading direction. The units are defined by a UnitNameTable. The string is created based on the reference point defined by a vec3 table ref. If metric is not present the function will assume all values are in imperial units and will return the Range and Altitude in Nautical Miles and Feet. If metric is present the metric system will be used for these values. The message will be displayed to the specified recipients for the given displayTime. If text is provided, the coordinates will be added to the end of the text message. |
| Syntax |
| nothing mist.msgLeadingBR(table vars ) |
| Valid Input Values: |
|
vars tables have the following recognized fields( required entries in blue, optional in green): vars =
{
units = UnitNameTable units,
ref = string ref,
displayTime = number displayTime,
msgFor = table msgFor,
heading/headingDegrees = number/number heading/headingDegrees,
radius = number radius,
text = string text,
metric = boolean metric,
alt = boolean alt,
}
units is a UnitNameTable- a table of unit names that follow a special set of rules (see the entry on UnitNameTables). ref is the name of the coalition whose bullseye point is to be referenced. displayTime is the time in seconds the message will display for. msgFor is the list of message recipients as outlined in the mist.message.add documenation heading/headingDegrees heading or headingDegrees define the orientation units must be heading in to be considered. heading is measured in radians. headingDegrees is measured in degrees radius is the radius of units to be considered. text is an optional variable of text to be displayed before the BR coordinates metric is a boolean value that if present will display the coordinates using the metric system alt is a boolean value that will display the message in Bearing Range Altitude Format |
| Return value: |
| nothing |
| Return example: |
| nothing |
| Usage Examples: |
|
| Notes: |
| Related Functions |
| messageAdd, removeById, remove , msgMGRS, msgLL, msgBR, msgBRA, msgBullseye, msgLeadingLL, msgLeadingMGRS, msgLeadingBR |
