Difference between revisions of "MIST msgBRA"
From DCS World Wiki - Hoggitworld.com
| Line 5: | Line 5: | ||
|vNum = Mist 3.0 | |vNum = Mist 3.0 | ||
| − | |desc= Utilizes [[MIST getBRString|mist.getBRString]] and [[MIST messageAdd|mist.message.add]] functions to display a coordinates in the bearing range altitude format of the average position of units at the specified accuracy from the position of | + | |desc= Utilizes [[MIST getBRString|mist.getBRString]] and [[MIST messageAdd|mist.message.add]] functions to display a coordinates in the bearing range altitude format of the average position of units at the specified accuracy from the position of the reference unit via the mist message system to the specified recipients for the given displayTime. If text is provided, the coordinates will be added to the end of the text message. |
|rtnType= nothing | |rtnType= nothing | ||
| Line 84: | Line 84: | ||
|o5N= | |o5N= | ||
| − | |r1D= is a UnitNameTable- a table of unit names that follow a special set of rules (see the entry on UnitNameTables). | + | |r1D= is a UnitNameTable- a table of unit names that follow a special set of rules (see the entry on UnitNameTables). The average position of the alive units will be used to define the point that the message will vector to. |
| − | |r2D= is the reference unit the Bearing Range, and Altitude message will be vectored from. | + | |r2D= is the string name for the reference unit the Bearing Range, and Altitude message will be vectored from. |
|r3D= is the time in seconds the message will display for. | |r3D= is the time in seconds the message will display for. | ||
|r4D= is the list of message recipients as outlined in the [[MIST messageAdd|mist.message.add]] documenation | |r4D= is the list of message recipients as outlined in the [[MIST messageAdd|mist.message.add]] documenation | ||
| Line 101: | Line 101: | ||
|rtnExamples= nothing | |rtnExamples= nothing | ||
| − | |example= < | + | |example= The following will display a message to a player in aircraft named "tomcat1". The bearing range and altitude will be appended to the end of the text string. The |
| − | + | <pre> | |
| − | + | mist.msgBRA({ | |
| − | + | units = mist.makeUnitTable({"[g]mig28s"}), | |
| − | </ | + | ref = 'USS Ranger', |
| − | + | metric = false, | |
| + | text ="BRA from da Bulls: ", | ||
| + | displayTime = 30, | ||
| + | msgFor = {units = {'tomcat1'}} | ||
| + | }) | ||
| + | </pre> | ||
|notes= Same as [[msgBR]] however it defaults altitude to true and is based off the reference point of a specific unit. | |notes= Same as [[msgBR]] however it defaults altitude to true and is based off the reference point of a specific unit. | ||
Latest revision as of 09:31, 11 November 2021
mist.msgBRA
| Added with: Mist 3.0 |
| Description |
| Utilizes mist.getBRString and mist.message.add functions to display a coordinates in the bearing range altitude format of the average position of units at the specified accuracy from the position of the reference unit via the mist message system 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.msgBRA(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,
text = string text,
metric = boolean metric,
}
units is a UnitNameTable- a table of unit names that follow a special set of rules (see the entry on UnitNameTables). The average position of the alive units will be used to define the point that the message will vector to. ref is the string name for the reference unit the Bearing Range, and Altitude message will be vectored from. 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 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 |
| Return value: |
| nothing |
| Return example: |
| nothing |
| Usage Examples: |
The following will display a message to a player in aircraft named "tomcat1". The bearing range and altitude will be appended to the end of the text string. The
mist.msgBRA({
units = mist.makeUnitTable({"[g]mig28s"}),
ref = 'USS Ranger',
metric = false,
text ="BRA from da Bulls: ",
displayTime = 30,
msgFor = {units = {'tomcat1'}}
})
|
| Notes: |
| Same as msgBR however it defaults altitude to true and is based off the reference point of a specific unit. |
| Related Functions |
| messageAdd, removeById, remove , msgMGRS, msgLL, msgBR, msgBRA, msgBullseye, msgLeadingLL, msgLeadingMGRS, msgLeadingBR |
