MIST msgLeadingMGRS

mist.msgMGRS

Added with: Mist 3.0

Description

Utilizes mist.getLeadingMGRSString and mist.message.add functions to display a coordinates in the MGRS format of the average position of the concentration of units most in the heading direction to the defined accuracy. The units are defined by the table UnitNameTable and the concentration is within the specified radius. 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.msgMGRS(table vars )

Valid Input Values:

vars tables have the following recognized fields( required entries in blue, optional in green): vars = { units = UnitNameTable units, acc = number acc, displayTime = number displayTime, msgFor = table msgFor, heading/headingDegrees = number/number heading/headingDegrees, radius = number radius, text = string text, } units is a UnitNameTable- a table of unit names that follow a special set of rules (see the entry on UnitNameTables). acc is the accuracy which the MGRS format will be displayed at 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 documentation 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 MGRS coordinates

Return value:

nothing

Return example:

nothing

Usage Examples:

do TBD end

Notes:

Related Functions

messageAdd, removeById, remove , msgMGRS, msgLL, msgBR, msgBRA, msgBullseye, msgLeadingLL, msgLeadingMGRS, msgLeadingBR

Scripting Engine

MIST Root Page