Difference between revisions of "MIST getLeadingBRString"

From DCS World Wiki - Hoggitworld.com
 
(No difference)

Latest revision as of 22:57, 13 April 2018


mist.getLeadingLLString

Added with: Mist 3.0
Description
Returns a string of the coordinates in Latitude and Longitude 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. If the optional variable DMS exists, the format will be in Degrees Minutes Seconds. If DMS is not present the format will be in Degrees Minutes Thousandths of Minutes.
Syntax
string mist.getLeadingLLString(table vars )
Valid Input Values:

vars tables have the following recognized fields( required entries in blue, optional in green):

 vars = 
 {
 units = UnitNameTable units, 
 radius = number radius, 
 heading/headingDegrees = number/number heading/headingDegrees, 
 ref = table ref,
 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 UnitNameTables).

radius is the radius of units to be considered.

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

ref is the reference point from which the will be used to form the Bearing Range callout

metric boolean value if present will display the distance and altitude in the metric system. If not present distance will be Nautical Miles and Altitude will be in feet

alt boolean value of present will display the altitude making the string into a "Bearing Range Altitude" callout.

Return value:
string
Return example:
Usage Examples:

do

 TBD

end

Notes:
Related Functions
tostringMGRS, tostringLL, tostringBR, getMGRSString, getLLString, getBRString, getLeadingPos, getLeadingMGRSString, getLeadingLLString, getLeadingBRString, getMilString, getClockString, getDateString, stringMatch, stringCondense

Scripting Engine

MIST Root Page