Grimes at 23:23, 13 April 2018

2018-04-13T23:23:44Z

New page

{{Mission Scripting

|fName= mist.msgBR

|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 format of the average position of units at the specified accuracy from the reference point 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= table
|r2N= ref

|r3T= number
|r3N= displayTime

|r4T= table
|r4N= msgFor

|r5T=
|r5N=

|r6T=
|r6N=

|o1T= string
|o1N= text

|o2T= boolean
|o2N= metric

|o3T= boolean
|o3N= alt

|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 accuracy which the Bearing Range format will be displayed at
|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= is a boolean value that will display the message in Bearing Range Altitude Format
|o4D=
|o5D=

}}

|rtnExamples= nothing

|example= The following will return a ground groups bearing and range from a player aircraft.
<pre>

do
mist.msgBR({
units = mist.makeUnitTable('[g]targets'),
ref = Unit.getByName('player'):getPosition().p,
displayTime = 20,
msgFor = {units = {'pilot1'}},
})
end
</pre>

|notes=

|funcs= {{listOfMistMessageFuncs}}

}}
[[Category: MIST|msgBR]]

MIST msgBR - Revision history

Grimes at 23:23, 13 April 2018