MIST msgBullseye

mist.msgBullseye

Added with: Mist 3.0

Description

Utilizes mist.getBRString and 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 teams bullseye 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.msgBullseye(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, alt = boolean alt, } units is a UnitNameTable- a table of unit names that follow a special set of rules (see the entry on mist.UnitNameTables). ref is the name of the coalition whose bullseye point is to be referenced. 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 alt is a boolean value that will display the message in Bearing Range Altitude Format

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