Module Utilities.Utils
Utilities - Derived utilities taken from the MIST framework, added helpers from the MOOSE community.
Authors:
- Grimes : Design & Programming of the MIST framework.
Contributions:
- FlightControl : Rework to OO framework.
- And many more
Global(s)
Global BIGSMOKEPRESET |
Global CALLSIGN |
Global DCSMAP |
Global FLARECOLOR |
Global SMOKECOLOR |
Global UTILS |
Global lookup_table |
Type(s)
Fields and Methods inherited from BIGSMOKEPRESET | Description |
---|---|
Fields and Methods inherited from CALLSIGN | Description |
---|---|
Fields and Methods inherited from DCSMAP | Description |
---|---|
Caucasus map. |
|
South Atlantic map. |
|
Mariana Islands map. |
|
Nevada Test and Training Range map. |
|
Normandy map. |
|
Persian Gulf map. |
|
Sinai map. |
|
Syria map. |
|
The Channel map. |
Fields and Methods inherited from FLARECOLOR | Description |
---|---|
Fields and Methods inherited from SMOKECOLOR | Description |
---|---|
Fields and Methods inherited from UTILS | Description |
---|---|
Basic serialize (porting in Slmod's "safestring" basic serialize). |
|
Heading Degrees (0-360) to Cardinal |
|
Beaufort scale: returns Beaufort number and wind description as a function of wind speed in m/s. |
|
Convert temperature from Celsius to Fahrenheit. |
|
Function to check if a file exists. |
|
Checks the current memory usage collectgarbage("count"). |
|
Convert clock time from hours, minutes and seconds to seconds. |
|
Deep copy a table. |
|
Display clock and mission time on screen as a message to all. |
|
Executes the given string. |
|
Ensure the passed object is a table. |
|
Checks if a file exists or not. |
|
Get the time difference between GMT and local time. |
|
Dumps the global table _G. |
|
Function to generate valid FM frequencies in mHz for radio beacons (FM). |
|
Function to generate valid laser codes for JTAC. |
|
Function to generate valid UHF Frequencies in mHz (AM). |
|
Function to generate valid VHF frequencies in kHz for radio beacons (FM). |
|
Get the callsign name from its enumerator value |
|
Get a table of all characters in a string. |
|
Get the enemy coalition for a given coalition. |
|
Get the coalition name from its numerical ID, e.g. |
|
Function to obtain a table of typenames from the group given with the number of units of the same type in the group. |
|
Returns the DCS map/theatre as optained by |
|
Returns the mission date. |
|
Get the day of the year. |
|
Returns the magnetic declination of the map. |
|
Returns the day of the mission. |
|
Returns the current day of the year of the mission. |
|
Get the modulation name from its numerical value. |
|
Get OS time. |
|
Get a random element of a table. |
|
Get the NATO reporting name of a unit type name |
|
UTILS.GetSunRiseAndSet(DayOfYear, Latitude, Longitude, Rising, Tlocal) |
Get sunrise or sun set of a specific day of the year at a specific location. |
UTILS.GetSunrise(Day, Month, Year, Latitude, Longitude, Rising, Tlocal) |
Get sun rise of a specific day of the year at a specific location. |
UTILS.GetSunset(Day, Month, Year, Latitude, Longitude, Rising, Tlocal) |
Get sun set of a specific day of the year at a specific location. |
Calculate the difference between two "heading", i.e. |
|
Returns the heading from one vec3 to another vec3. |
|
Convert indicated airspeed (IAS) to true airspeed (TAS) for a given altitude above main sea level. |
|
Check if any object of multiple given objects is contained in a table. |
|
Check if an object is contained in a table. |
|
Function to infer instance of an object Examples:
|
|
(Helicopter) Check if one loading door is open. |
|
Convert knots to altitude corrected KIAS, e.g. |
|
Convert knots to meters per second. |
|
Function to save an object to a file |
|
UTILS.LoadSetOfGroups(Path, Filename, Spawn, Structured, Cinematic, Effect, Density) |
Load back a SET of groups from file. |
Load back a SET of statics from file. |
|
UTILS.LoadStationaryListOfGroups(Path, Filename, Reduce, Structured, Cinematic, Effect, Density) |
Load back a stationary list of groups from file. |
UTILS.LoadStationaryListOfStatics(Path, Filename, Reduce, Dead, Cinematic, Effect, Density) |
Load back a stationary list of statics from file. |
Convert meters per second to knots. |
|
Convert meters per second to miles per hour. |
|
Serialize a given table. |
|
Helper function to plot a racetrack on the F10 Map - curtesy of Buur. |
|
Generate a Gaussian pseudo-random number. |
|
Randomize a value by a certain amount. |
|
Remove an object (marker, circle, arrow, text, quad, ...) on the F10 map. |
|
Replace illegal characters [<>|/?*:\] in a string. |
|
Rotate 3D vector in the 2D (x,z) plane. |
|
From http://lua-users.org/wiki/SimpleRound use negative idp for rounding ahead of decimal place, positive for rounding after decimal place |
|
Function to save the state of a set of Wrapper.Group#GROUP objects. |
|
Function to save the state of a set of Wrapper.Static#STATIC objects. |
|
UTILS.SaveStationaryListOfGroups(List, Path, Filename, Structured) |
Function to save the state of a list of groups found by name |
Function to save the state of a list of statics found by name |
|
Function to save an object to a file |
|
Seconds of today. |
|
Convert time in seconds to hours, minutes and seconds. |
|
Cound seconds until next midnight. |
|
Shuffle a table accoring to Fisher Yeates algorithm |
|
Split string at seperators. |
|
Converts a TACAN Channel/Mode couple into a frequency in Hz. |
|
Returns table in a easy readable string representation. |
|
Convert true airspeed (TAS) to indicated airspeed (IAS) for a given altitude above main sea level. |
|
Create a BRAA NATO call string BRAA between two GROUP objects |
|
Calculate the total vector of two 2D vectors by adding the x,y components of each other. |
|
Calculate the dot product of two 2D vectors. |
|
Calculate "heading" of a 2D vector in the X-Y plane. |
|
Calculate the euclidean norm (length) of a 2D vector. |
|
Rotate 2D vector in the 2D (x,z) plane. |
|
Calculate the difference between two 2D vectors by substracting the x,y components from each other. |
|
Translate 2D vector in the 2D (x,z) plane. |
|
Calculate the total vector of two 3D vectors by adding the x,y,z components of each other. |
|
Calculate the angle between two 3D vectors. |
|
Calculate the cross product of two 3D vectors. |
|
Calculate the distance between two 2D vectors. |
|
Calculate the distance between two 3D vectors. |
|
Calculate the dot product of two vectors. |
|
Calculate "heading" of a 3D vector in the X-Z plane. |
|
Calculate the euclidean norm (length) of a 3D vector. |
|
Calculate the difference between two 3D vectors by substracting the x,y,z components from each other. |
|
Translate 3D vector in the 2D (x,z) plane. |
|
Marker index counter. Running number when marker is added. |
|
Serialize a table to a single line string. |
|
Convert pressure from hecto Pascal (hPa) to inches of mercury (inHg). |
|
Convert pressure from hecto Pascal (hPa) to millimeters of mercury (mmHg). |
|
Convert kilo gramms (kg) to pounds (lbs). |
|
Here is a customized version of pairs, which I called kpairs because it iterates over the table in a sorted order, based on a function that will determine the keys as reference first. |
|
Here is a customized version of pairs, which I called rpairs because it iterates over the table in a random order. |
|
Here is a customized version of pairs, which I called spairs because it iterates over the table in a sorted order. |
|
Big smoke preset enum.
Field(s)
Function(s)
Field(s)
AWACS
Aircraft
FARP
JTAC
Tanker
Function(s)
DCS map as returned by env.mission.theatre
.
Field(s)
Caucasus map.
South Atlantic map.
Mariana Islands map.
Nevada Test and Training Range map.
Normandy map.
Persian Gulf map.
Sinai map.
Syria map.
The Channel map.
Function(s)
Field(s)
Function(s)
Field(s)
Function(s)
Utilities static class.
Field(s)
Marker index counter. Running number when marker is added.
Function(s)
Basic serialize (porting in Slmod's "safestring" basic serialize).
Defined in:
UTILS
Parameter:
#string s
Table to serialize.
Heading Degrees (0-360) to Cardinal
Defined in:
UTILS
Parameter:
#number Heading
The heading
Return value:
#string:
Cardinal, e.g. "NORTH"
Beaufort scale: returns Beaufort number and wind description as a function of wind speed in m/s.
Defined in:
UTILS
Parameter:
#number speed
Wind speed in m/s.
Return values:
#number:
Beaufort number.
#string:
Beauford wind description.
Convert temperature from Celsius to Fahrenheit.
Defined in:
UTILS
Parameter:
#number Celcius
Temperature in degrees Celsius.
Return value:
#number:
Temperature in degrees Fahrenheit.
Function to check if a file exists.
Defined in:
UTILS
Parameters:
#string Path
The path to use. Use double backslashes \\ on Windows filesystems.
#string Filename
The name of the file.
Return value:
#boolean:
outcome True if reading is possible, else false.
Checks the current memory usage collectgarbage("count").
Info is printed to the DCS log file. Time stamp is the current mission runtime.
Defined in:
UTILS
Parameter:
#boolean output
If true, print to DCS log file.
Return value:
#number:
Memory usage in kByte.
Convert clock time from hours, minutes and seconds to seconds.
Defined in:
UTILS
Parameter:
#string clock
String of clock time. E.g., "06:12:35" or "5:1:30+1". Format is (H)H:(M)M:((S)S)(+D) H=Hours, M=Minutes, S=Seconds, D=Days.
Return value:
#number:
Seconds. Corresponds to what you cet from timer.getAbsTime() function.
Deep copy a table.
See http://lua-users.org/wiki/CopyTable
Defined in:
UTILS
Parameter:
#table object
The input table.
Return value:
#table:
Copy of the input table.
Display clock and mission time on screen as a message to all.
Defined in:
UTILS
Parameter:
#number duration
Duration in seconds how long the time is displayed. Default is 5 seconds.
Executes the given string.
borrowed from Slmod
Defined in:
UTILS
Parameter:
#string s
string containing LUA code.
Return value:
#boolean:
true
if successfully executed, false
otherwise.
Ensure the passed object is a table.
Defined in:
UTILS
Parameters:
#table Object
The object that should be a table.
#boolean ReturnNil
If true
, return #nil
if Object
is nil. Otherwise an empty table {}
is returned.
Return value:
#table:
The object that now certainly is a table.
Defined in:
UTILS
Parameter:
feet
Checks if a file exists or not.
This requires io to be desanitized.
Defined in:
UTILS
Parameter:
#string file
File that should be checked.
Return value:
#boolean:
True if the file exists, false if the file does not exist or nil if the io module is not available and the check could not be performed.
Get the time difference between GMT and local time.
Defined in:
UTILS
Return value:
#number:
Local time difference in hours compared to GMT. E.g. Dubai is GMT+4 ==> +4 is returned.
Dumps the global table _G.
This dumps the global table G to a file in the DCS\Logs directory. This function requires you to disable script sanitization in $DCSROOT\Scripts\MissionScripting.lua to access lfs and io libraries.
Defined in:
UTILS
Parameter:
#string fname
File name.
Function to generate valid FM frequencies in mHz for radio beacons (FM).
Defined in:
UTILS
Return value:
#table:
Table of frequencies.
Function to generate valid laser codes for JTAC.
Defined in:
UTILS
Return value:
#table:
Laser Codes.
Function to generate valid UHF Frequencies in mHz (AM).
Defined in:
UTILS
Return value:
#table:
UHF Frequencies
Function to generate valid VHF frequencies in kHz for radio beacons (FM).
Defined in:
UTILS
Return value:
#table:
VHFrequencies
Get the callsign name from its enumerator value
Defined in:
UTILS
Parameter:
#number Callsign
The enumerator callsign.
Return value:
#string:
The callsign name or "Ghostrider".
Get a table of all characters in a string.
Defined in:
UTILS
Parameter:
#string str
Sting.
Return value:
#table:
Individual characters.
Get the enemy coalition for a given coalition.
Defined in:
UTILS
Parameters:
#number Coalition
The coalition ID.
#boolean Neutral
Include neutral as enemy.
Return value:
#table:
Enemy coalition table.
Get the coalition name from its numerical ID, e.g.
coalition.side.RED.
Defined in:
UTILS
Parameter:
#number Coalition
The coalition ID.
Return value:
#string:
The coalition name, i.e. "Neutral", "Red" or "Blue" (or "Unknown").
Function to obtain a table of typenames from the group given with the number of units of the same type in the group.
Defined in:
UTILS
Parameter:
Wrapper.Group#GROUP Group
The group to list
Return value:
#table:
Table of typnames and typename counts, e.g. {["KAMAZ Truck"]=3,["ATZ-5"]=1}
Returns the DCS map/theatre as optained by env.mission.theatre
.
Defined in:
UTILS
Return value:
#string:
DCS map name.
Returns the mission date.
This is the date the mission started.
Defined in:
UTILS
Return values:
#string:
Mission date in yyyy/mm/dd format.
#number:
The year anno domini.
#number:
The month.
#number:
The day.
Get the day of the year.
Counting starts on 1st of January.
Defined in:
UTILS
Parameters:
#number Year
The year.
#number Month
The month.
#number Day
The day.
Return value:
#number:
The day of the year.
Returns the magnetic declination of the map.
Returned values for the current maps are:
- Caucasus +6 (East), year ~ 2011
- NTTR +12 (East), year ~ 2011
- Normandy -10 (West), year ~ 1944
- Persian Gulf +2 (East), year ~ 2011
- The Cannel Map -10 (West)
- Syria +5 (East)
- Mariana Islands +2 (East)
- Falklands +12 (East) - note there's a LOT of deviation across the map, as we're closer to the South Pole
- Sinai +4.8 (East)
Defined in:
UTILS
Parameter:
#string map
(Optional) Map for which the declination is returned. Default is from env.mission.theatre
Return value:
#number:
Declination in degrees.
Returns the day of the mission.
Defined in:
UTILS
Parameter:
#number Time
(Optional) Abs. time in seconds. Default now, i.e. the value return from timer.getAbsTime().
Return value:
#number:
Day of the mission. Mission starts on day 0.
Returns the current day of the year of the mission.
Defined in:
UTILS
Parameter:
#number Time
(Optional) Abs. time in seconds. Default now, i.e. the value return from timer.getAbsTime().
Return value:
#number:
Current day of year of the mission. For example, January 1st returns 0, January 2nd returns 1 etc.
Get the modulation name from its numerical value.
Defined in:
UTILS
Parameter:
#number Modulation
The modulation enumerator number. Can be either 0 or 1.
Return value:
#string:
The modulation name, i.e. "AM"=0 or "FM"=1. Anything else will return "Unknown".
Get OS time.
Needs os to be desanitized!
Defined in:
UTILS
Return value:
#number:
Os time in seconds.
Get a random element of a table.
Defined in:
UTILS
Parameters:
#table t
Table.
#boolean replace
If true
, the drawn element is replaced, i.e. not deleted.
Return value:
#number:
Table element.
Get the NATO reporting name of a unit type name
Defined in:
UTILS
Parameter:
#number Typename
The type name.
Return value:
#string:
The Reporting name or "Bogey".
Get sunrise or sun set of a specific day of the year at a specific location.
Defined in:
UTILS
Parameters:
#number DayOfYear
The day of the year.
#number Latitude
Latitude.
#number Longitude
Longitude.
#boolean Rising
If true, calc sun rise, or sun set otherwise.
#number Tlocal
Local time offset in hours. E.g. +4 for a location which has GMT+4.
Return value:
#number:
Sun rise/set in seconds of the day.
Get sun rise of a specific day of the year at a specific location.
Defined in:
UTILS
Parameters:
#number Day
Day of the year.
#number Month
Month of the year.
#number Year
Year.
#number Latitude
Latitude.
#number Longitude
Longitude.
#boolean Rising
If true, calc sun rise, or sun set otherwise.
#number Tlocal
Local time offset in hours. E.g. +4 for a location which has GMT+4. Default 0.
Return value:
#number:
Sun rise in seconds of the day.
Get sun set of a specific day of the year at a specific location.
Defined in:
UTILS
Parameters:
#number Day
Day of the year.
#number Month
Month of the year.
#number Year
Year.
#number Latitude
Latitude.
#number Longitude
Longitude.
#boolean Rising
If true, calc sun rise, or sun set otherwise.
#number Tlocal
Local time offset in hours. E.g. +4 for a location which has GMT+4. Default 0.
Return value:
#number:
Sun rise in seconds of the day.
Calculate the difference between two "heading", i.e.
angles in [0,360) deg.
Defined in:
UTILS
Parameters:
#number h1
Heading one.
#number h2
Heading two.
Return value:
#number:
Heading difference in degrees.
Returns the heading from one vec3 to another vec3.
Convert indicated airspeed (IAS) to true airspeed (TAS) for a given altitude above main sea level.
The conversion is based on the approximation that TAS is ~2% higher than IAS with every 1000 ft altitude above sea level.
Defined in:
UTILS
Parameters:
#number ias
Indicated air speed in any unit (m/s, km/h, knots, ...)
#number altitude
Altitude above main sea level in meters.
#number oatcorr
(Optional) Outside air temperature correction factor. Default 0.017.
Return value:
#number:
True airspeed in the same unit the IAS has been given.
Check if any object of multiple given objects is contained in a table.
Defined in:
UTILS
Parameters:
#table Table
The table.
#table Objects
The objects to check.
#string Key
(Optional) Key to check.
Return value:
Returns true
if object is in table.
Test if a Vec2 is in a radius of another Vec2
Defined in:
UTILS
Parameters:
InVec2
Vec2
Radius
Test if a Vec3 is in the sphere of another Vec3
Defined in:
UTILS
Parameters:
InVec3
Vec3
Radius
Check if an object is contained in a table.
Defined in:
UTILS
Parameters:
#table Table
The table.
#table Object
The object to check.
#string Key
(Optional) Key to check. By default, the object itself is checked.
Return value:
Returns true
if object is in table.
Function to infer instance of an object
Examples:
UTILS.IsInstanceOf( 'some text', 'string' ) will return true
UTILS.IsInstanceOf( some_function, 'function' ) will return true
UTILS.IsInstanceOf( 10, 'number' ) will return true
UTILS.IsInstanceOf( false, 'boolean' ) will return true
UTILS.IsInstanceOf( nil, 'nil' ) will return true
UTILS.IsInstanceOf( ZONE:New( 'some zone', ZONE ) will return true
UTILS.IsInstanceOf( ZONE:New( 'some zone', 'ZONE' ) will return true
UTILS.IsInstanceOf( ZONE:New( 'some zone', 'zone' ) will return true
UTILS.IsInstanceOf( ZONE:New( 'some zone', 'BASE' ) will return true
UTILS.IsInstanceOf( ZONE:New( 'some zone', 'GROUP' ) will return false
Defined in:
UTILS
Parameters:
object
is the object to be evaluated
className
is the name of the class to evaluate (can be either a string or a Moose class)
Return value:
#boolean:
(Helicopter) Check if one loading door is open.
Defined in:
UTILS
Parameter:
#string unit_name
Unit name to be checked
Return value:
#boolean:
Outcome - true if a (loading door) is open, false if not, nil if none exists.
Defined in:
UTILS
Parameter:
kilometers
Defined in:
UTILS
Parameter:
kilometers
Defined in:
UTILS
Parameter:
kilometers
Defined in:
UTILS
Parameter:
knots
Defined in:
UTILS
Parameter:
kmph
Convert knots to altitude corrected KIAS, e.g.
for tankers.
Defined in:
UTILS
Parameters:
#number knots
Speed in knots.
#number altitude
Altitude in feet
Return value:
#number:
Corrected KIAS
Defined in:
UTILS
Parameter:
knots
Convert knots to meters per second.
Defined in:
UTILS
Parameter:
#number knots
Speed in knots.
Return value:
#number:
Speed in m/s.
Function to save an object to a file
Defined in:
UTILS
Parameters:
#string Path
The path to use. Use double backslashes \\ on Windows filesystems.
#string Filename
The name of the file.
Return values:
#boolean:
outcome True if reading is possible and successful, else false.
#table:
data The data read from the filesystem (table of lines of text). Each line is one single #string!
Load back a SET of groups from file.
Defined in:
UTILS
Parameters:
#string Path
The path to use. Use double backslashes \\ on Windows filesystems.
#string Filename
The name of the file.
#boolean Spawn
If set to false, do not re-spawn the groups loaded in location and reduce to size.
#boolean Structured
(Optional, needs Spawn=true)If true, and the data has been saved as structure before, remove the correct unit types as per the saved list.
#boolean Cinematic
(Optional, needs Structured=true) If true, place a fire/smoke effect on the dead static position.
#number Effect
(Optional for Cinematic) What effect to use. Defaults to a random effect. Smoke presets are: 1=small smoke and fire, 2=medium smoke and fire, 3=large smoke and fire, 4=huge smoke and fire, 5=small smoke, 6=medium smoke, 7=large smoke, 8=huge smoke.
#number Density
(Optional for Cinematic) What smoke density to use, can be 0 to 1. Defaults to 0.5.
Return values:
Set of GROUP objects.
Returns nil when file cannot be read. Returns a table of data entries if Spawn is false: { groupname=groupname, size=size, coordinate=coordinate, template=template }
#table:
When using Cinematic: table of names of smoke and fire objects, so they can be extinguished with COORDINATE.StopBigSmokeAndFire( name )
Load back a SET of statics from file.
Defined in:
UTILS
Parameters:
#string Path
The path to use. Use double backslashes \\ on Windows filesystems.
#string Filename
The name of the file.
Return value:
Set SET_STATIC containing the static objects.
Load back a stationary list of groups from file.
Defined in:
UTILS
Parameters:
#string Path
The path to use. Use double backslashes \\ on Windows filesystems.
#string Filename
The name of the file.
#boolean Reduce
If false, existing loaded groups will not be reduced to fit the saved number.
#boolean Structured
(Optional, needs Reduce = true) If true, and the data has been saved as structure before, remove the correct unit types as per the saved list.
#boolean Cinematic
(Optional, needs Structured = true) If true, place a fire/smoke effect on the dead static position.
#number Effect
(Optional for Cinematic) What effect to use. Defaults to a random effect. Smoke presets are: 1=small smoke and fire, 2=medium smoke and fire, 3=large smoke and fire, 4=huge smoke and fire, 5=small smoke, 6=medium smoke, 7=large smoke, 8=huge smoke.
#number Density
(Optional for Cinematic) What smoke density to use, can be 0 to 1. Defaults to 0.5.
Return values:
#table:
Table of data objects (tables) containing groupname, coordinate and group object. Returns nil when file cannot be read.
#table:
When using Cinematic: table of names of smoke and fire objects, so they can be extinguished with COORDINATE.StopBigSmokeAndFire( name )
Load back a stationary list of statics from file.
Defined in:
UTILS
Parameters:
#string Path
The path to use. Use double backslashes \\ on Windows filesystems.
#string Filename
The name of the file.
#boolean Reduce
If false, do not destroy the units with size=0.
#boolean Dead
(Optional, needs Reduce = true) If Dead is true, re-spawn the dead object as dead and do not just delete it.
#boolean Cinematic
(Optional, needs Dead = true) If true, place a fire/smoke effect on the dead static position.
#number Effect
(Optional for Cinematic) What effect to use. Defaults to a random effect. Smoke presets are: 1=small smoke and fire, 2=medium smoke and fire, 3=large smoke and fire, 4=huge smoke and fire, 5=small smoke, 6=medium smoke, 7=large smoke, 8=huge smoke.
#number Density
(Optional for Cinematic) What smoke density to use, can be 0 to 1. Defaults to 0.5.
Return values:
#table:
Table of data objects (tables) containing staticname, size (0=dead else 1), coordinate and the static object. Dead objects will have coordinate points {x=0,y=0,z=0}
#table:
When using Cinematic: table of names of smoke and fire objects, so they can be extinguished with COORDINATE.StopBigSmokeAndFire( name )
Returns nil when file cannot be read.
Defined in:
UTILS
Parameter:
meters
Defined in:
UTILS
Parameter:
meters
Defined in:
UTILS
Parameter:
meters
Defined in:
UTILS
Parameter:
miph
Defined in:
UTILS
Parameter:
mps
Convert meters per second to knots.
Defined in:
UTILS
Parameter:
#number mps
Speed in m/s.
Return value:
#number:
Speed in knots.
Convert meters per second to miles per hour.
Defined in:
UTILS
Parameter:
#number mps
Speed in m/s.
Return value:
#number:
Speed in miles per hour.
Defined in:
UTILS
Parameter:
NM
Defined in:
UTILS
Parameter:
NM
Serialize a given table.
Defined in:
UTILS
Parameter:
#table tbl
Input table.
Return value:
#string:
Table as a string.
Helper function to plot a racetrack on the F10 Map - curtesy of Buur.
Defined in:
UTILS
Parameters:
Core.Point#COORDINATE Coordinate
#number Altitude
Altitude in feet
#number Speed
Speed in knots
#number Heading
Heading in degrees
#number Leg
Leg in NM
#number Coalition
Coalition side, e.g. coaltion.side.RED or coaltion.side.BLUE
#table Color
Color of the line in RGB, e.g. {1,0,0} for red
#number Alpha
Transparency factor, between 0.1 and 1
#number LineType
Line type to be used, line type: 0=No line, 1=Solid, 2=Dashed, 3=Dotted, 4=Dot dash, 5=Long dash, 6=Two dash. Default 1=Solid.
#boolean ReadOnly
Defined in:
UTILS
Parameters:
table
indent
Generate a Gaussian pseudo-random number.
Defined in:
UTILS
Parameters:
#number x0
Expectation value of distribution.
#number sigma
(Optional) Standard deviation. Default 10.
#number xmin
(Optional) Lower cut-off value.
#number xmax
(Optional) Upper cut-off value.
#number imax
(Optional) Max number of tries to get a value between xmin and xmax (if specified). Default 100.
Return value:
#number:
Gaussian random number.
Randomize a value by a certain amount.
Defined in:
UTILS
Parameters:
#number value
The value which should be randomized
#number fac
Randomization factor.
#number lower
(Optional) Lower limit of the returned value.
#number upper
(Optional) Upper limit of the returned value.
Return value:
#number:
Randomized value.
Usages:
UTILS.Randomize(100, 0.1) returns a value between 90 and 110, i.e. a plus/minus ten percent variation.
UTILS.Randomize(100, 0.5, nil, 120) returns a value between 50 and 120, i.e. a plus/minus fivty percent variation with upper bound 120.
Remove an object (marker, circle, arrow, text, quad, ...) on the F10 map.
Defined in:
UTILS
Parameters:
#number MarkID
Unique ID of the object.
#number Delay
(Optional) Delay in seconds before the mark is removed.
Replace illegal characters [<>|/?*:\] in a string.
Defined in:
UTILS
Parameters:
#string Text
Input text.
#string ReplaceBy
Replace illegal characters by this character or string. Default underscore "_".
Return value:
#string:
The input text with illegal chars replaced.
Rotate 3D vector in the 2D (x,z) plane.
y-component (usually altitude) unchanged.
From http://lua-users.org/wiki/SimpleRound use negative idp for rounding ahead of decimal place, positive for rounding after decimal place
Defined in:
UTILS
Parameters:
num
idp
Function to save the state of a set of Wrapper.Group#GROUP objects.
Defined in:
UTILS
Parameters:
of objects to save
#string Path
The path to use. Use double backslashes \\ on Windows filesystems.
#string Filename
The name of the file.
#boolean Structured
Append the data with a list of typenames in the group plus their count.
Return value:
#boolean:
outcome True if saving is successful, else false.
Usage:
We will go through the set and find the corresponding group and save the current group size and current position.
The idea is to respawn the groups **spawned during an earlier run of the mission** at the given location and reduce
the number of units in the group when reloading the data again to restart the saved mission. Note that *dead* groups
cannot be covered with this.
**Note** Do NOT use dashes or hashes in group template names (-,#)!
The data will be a simple comma separated list of groupname and size, with one header line.
The current task/waypoint/etc cannot be restored.
Function to save the state of a set of Wrapper.Static#STATIC objects.
Defined in:
UTILS
Parameters:
of objects to save
#string Path
The path to use. Use double backslashes \\ on Windows filesystems.
#string Filename
The name of the file.
Return value:
#boolean:
outcome True if saving is successful, else false.
Usage:
We will go through the set and find the corresponding static and save the current name and postion when alive.
The data will be a simple comma separated list of name and state etc, with one header line.
Function to save the state of a list of groups found by name
Defined in:
UTILS
Parameters:
#table List
Table of strings with groupnames
#string Path
The path to use. Use double backslashes \\ on Windows filesystems.
#string Filename
The name of the file.
#boolean Structured
Append the data with a list of typenames in the group plus their count.
Return value:
#boolean:
outcome True if saving is successful, else false.
Usage:
We will go through the list and find the corresponding group and save the current group size (0 when dead).
These groups are supposed to be put on the map in the ME and have *not* moved (e.g. stationary SAM sites).
Position is still saved for your usage.
The idea is to reduce the number of units when reloading the data again to restart the saved mission.
The data will be a simple comma separated list of groupname and size, with one header line.
Function to save the state of a list of statics found by name
Defined in:
UTILS
Parameters:
#table List
Table of strings with statics names
#string Path
The path to use. Use double backslashes \\ on Windows filesystems.
#string Filename
The name of the file.
Return value:
#boolean:
outcome True if saving is successful, else false.
Usage:
We will go through the list and find the corresponding static and save the current alive state as 1 (0 when dead).
Position is saved for your usage. **Note** this works on UNIT-name level.
The idea is to reduce the number of units when reloading the data again to restart the saved mission.
The data will be a simple comma separated list of name and state etc, with one header line.
Function to save an object to a file
Defined in:
UTILS
Parameters:
#string Path
The path to use. Use double backslashes \\ on Windows filesystems.
#string Filename
The name of the file. Existing file will be overwritten.
#table Data
The LUA data structure to save. This will be e.g. a table of text lines with an \n at the end of each line.
Return value:
#boolean:
outcome True if saving is possible, else false.
Seconds of today.
Defined in:
UTILS
Return value:
#number:
Seconds passed since last midnight.
Convert time in seconds to hours, minutes and seconds.
Defined in:
UTILS
Parameters:
#number seconds
Time in seconds, e.g. from timer.getAbsTime() function.
#boolean short
(Optional) If true, use short output, i.e. (HH:)MM:SS without day.
Return value:
#string:
Time in format Hours:Minutes:Seconds+Days (HH:MM:SS+D).
Cound seconds until next midnight.
Defined in:
UTILS
Return value:
#number:
Seconds to midnight.
Shuffle a table accoring to Fisher Yeates algorithm
Defined in:
UTILS
Parameter:
#table t
Table to be shuffled.
Return value:
#table:
Shuffled table.
Split string at seperators.
C.f. split-string-in-lua.
Defined in:
UTILS
Parameters:
#string str
Sting to split.
#string sep
Speparator for split.
Return value:
#table:
Split text.
Converts a TACAN Channel/Mode couple into a frequency in Hz.
Defined in:
UTILS
Parameters:
#number TACANChannel
The TACAN channel, i.e. the 10 in "10X".
#string TACANMode
The TACAN mode, i.e. the "X" in "10X".
Return value:
#number:
Frequency in Hz or #nil if parameters are invalid.
Returns table in a easy readable string representation.
Defined in:
UTILS
Parameters:
tbl
table to show
loc
indent
tableshow_tbls
Return value:
Human readable string representation of given table.
Convert true airspeed (TAS) to indicated airspeed (IAS) for a given altitude above main sea level.
The conversion is based on the approximation that TAS is ~2% higher than IAS with every 1000 ft altitude above sea level.
Defined in:
UTILS
Parameters:
#number tas
True air speed in any unit (m/s, km/h, knots, ...)
#number altitude
Altitude above main sea level in meters.
#number oatcorr
(Optional) Outside air temperature correction factor. Default 0.017.
Return value:
#number:
Indicated airspeed in the same unit the TAS has been given.
Defined in:
UTILS
Parameter:
angle
Defined in:
UTILS
Parameter:
angle
Create a BRAA NATO call string BRAA between two GROUP objects
Defined in:
UTILS
Parameters:
Wrapper.Group#GROUP FromGrp
GROUP object
Wrapper.Group#GROUP ToGrp
GROUP object
Return value:
#string:
Formatted BRAA NATO call
Calculate the total vector of two 2D vectors by adding the x,y components of each other.
Calculate the dot product of two 2D vectors.
The result is a number.
Calculate "heading" of a 2D vector in the X-Y plane.
Defined in:
UTILS
Parameter:
DCS#Vec2 a
Vector in 2D with x, y components.
Return value:
#number:
Heading in degrees in [0,360).
Calculate the euclidean norm (length) of a 2D vector.
Defined in:
UTILS
Parameter:
DCS#Vec2 a
Vector in 2D with x, y components.
Return value:
#number:
Norm of the vector.
Rotate 2D vector in the 2D (x,z) plane.
Calculate the difference between two 2D vectors by substracting the x,y components from each other.
Translate 2D vector in the 2D (x,z) plane.
Calculate the total vector of two 3D vectors by adding the x,y,z components of each other.
Calculate the angle between two 3D vectors.
Calculate the cross product of two 3D vectors.
The result is a 3D vector.
Calculate the distance between two 2D vectors.
Calculate the distance between two 3D vectors.
Calculate the dot product of two vectors.
The result is a number.
Calculate "heading" of a 3D vector in the X-Z plane.
Defined in:
UTILS
Parameter:
DCS#Vec3 a
Vector in 3D with x, y, z components.
Return value:
#number:
Heading in degrees in [0,360).
Calculate the euclidean norm (length) of a 3D vector.
Defined in:
UTILS
Parameter:
DCS#Vec3 a
Vector in 3D with x, y, z components.
Return value:
#number:
Norm of the vector.
Calculate the difference between two 3D vectors by substracting the x,y,z components from each other.
Translate 3D vector in the 2D (x,z) plane.
y-component (usually altitude) unchanged.
Serialize a table to a single line string.
Defined in:
UTILS
Parameter:
#table tbl
table to serialize.
Return value:
#string:
string containing serialized table.
Convert pressure from hecto Pascal (hPa) to inches of mercury (inHg).
Defined in:
UTILS
Parameter:
#number hPa
Pressure in hPa.
Return value:
#number:
Pressure in inHg.
Convert pressure from hecto Pascal (hPa) to millimeters of mercury (mmHg).
Defined in:
UTILS
Parameter:
#number hPa
Pressure in hPa.
Return value:
#number:
Pressure in mmHg.
Convert kilo gramms (kg) to pounds (lbs).
Defined in:
UTILS
Parameter:
#number kg
Mass in kg.
Return value:
#number:
Mass in lbs.
Here is a customized version of pairs, which I called kpairs because it iterates over the table in a sorted order, based on a function that will determine the keys as reference first.
Defined in:
UTILS
Parameters:
#table t
The table
#string getkey
The function to determine the keys for sorting
#string order
(Optional) The sorting function itself
Return values:
#string:
key The index key
#string:
value The value at the indexed key
Usage:
for key,value in UTILS.kpairs(mytable, getkeyfunc) do
-- your code here
end
Here is a customized version of pairs, which I called rpairs because it iterates over the table in a random order.
Defined in:
UTILS
Parameter:
#table t
The table
Return values:
#string:
key The index key
#string:
value The value at the indexed key
Usage:
for key,value in UTILS.rpairs(mytable) do
-- your code here
end
Here is a customized version of pairs, which I called spairs because it iterates over the table in a sorted order.
Defined in:
UTILS
Parameters:
#table t
The table
#string order
(Optional) The sorting function
Return values:
#string:
key The index key
#string:
value The value at the indexed key
Usage:
for key,value in UTILS.spairs(mytable) do
-- your code here
end
acc: in DM: decimal point of minutes. In DMS: decimal point of seconds. position after the decimal of the least significant digit: So: 42.32 - acc of 2.
Defined in:
UTILS
Parameters:
lat
lon
acc
DMS
acc- the accuracy of each easting/northing. 0, 1, 2, 3, 4, or 5.
Defined in:
UTILS
Parameters:
MGRS
acc