Grimes at 23:24, 13 April 2018

2018-04-13T23:24:04Z

New page

{{Mission Scripting

|fName= mist.msgLeadingBR

|vNum = Mist 3.0

|desc= Utilizes [[MIST getBRString|mist.getBRString]] and [[MIST messageAdd|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.

|rtnType= nothing

|reqType1= table

|reqName1= vars

|reqType2=

|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= number/number
|r5N= heading/headingDegrees

|r6T= number
|r6N= radius

|r7T=
|r7N=

|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 name of the coalition whose bullseye point is to be referenced.
|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= heading or headingDegrees define the orientation units must be heading in to be considered. '''heading''' is measured in radians. '''headingDegrees''' is measured in degrees
|r6D= is the radius of units to be considered.

|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= <code>
do
TBD
end
</code>

|notes=

|funcs= {{listOfMistMessageFuncs}}

}}
[[Category: MIST|msgLeadingBR]]

MIST msgLeadingBR - Revision history

Grimes at 23:24, 13 April 2018