Grimes at 09:31, 11 November 2021

2021-11-11T09:31:10Z

Grimes at 23:23, 13 April 2018

2018-04-13T23:23:53Z

New page

{{Mission Scripting

|fName= mist.msgBRA

|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 unitName 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

|reqType1= table

|reqName1= vars

|reqType2=

|reqName2=

|reqType3=

|reqName3=

|reqType4=

|reqName4=

|reqType5=

|reqName5=

|optType1=

|optName1=

|optType2=

|optName2=

|optType3=

|optName3=

|optType4=

|optName4=

|optType5=

|optName5=

|varExamples= {{varsTable

|r1T= UnitNameTable
|r1N= units

|r2T= string
|r2N= ref

|r3T= number
|r3N= displayTime

|r4T= table
|r4N= msgFor

|r5T=
|r5N=

|r6T=
|r6N=

|o1T= string
|o1N= text

|o2T= boolean
|o2N= metric

|o3T=
|o3N=

|o4T=
|o4N=

|o5T=
|o5N=

|r1D= is a UnitNameTable- a table of unit names that follow a special set of rules (see the entry on UnitNameTables).
|r2D= is the reference unit the Bearing Range, and Altitude message will be vectored from.
|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
|r5D=
|r6D=

|o1D= is an optional variable of text to be displayed before the BR coordinates
|o2D= is a boolean value that if present will display the coordinates using the metric system
|o3D=
|o4D=
|o5D=

}}

|rtnExamples= nothing

|example= <code>
do
TBD
end
</code>

|notes= Same as [[msgBR]] however it defaults altitude to true and is based off the reference point of a specific unit.

|funcs= {{listOfMistMessageFuncs}}

}}
[[Category: MIST|msgBRA]]

@@ Line 5: / Line 5: @@
 |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 unitName 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.
+|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
@@ Line 84: / Line 84: @@
 |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.
 |r4D= is the list of message recipients as outlined in the [[MIST messageAdd|mist.message.add]] documenation
@@ Line 101: / Line 101: @@
 |rtnExamples= nothing
-|example= <code>
+|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
-do
+<pre>
-  TBD
+    mist.msgBRA({
-end
+        units = mist.makeUnitTable({"[g]mig28s"}),
-</code>
+        ref = 'USS Ranger',
+        metric = false,
 |notes= Same as [[msgBR]] however it defaults altitude to true and is based off the reference point of a specific unit.

MIST msgBRA - Revision history

Grimes at 09:31, 11 November 2021

Grimes at 23:23, 13 April 2018