View source for Mission Scripting Tools Documentation

<center>{{#widget:AdSense
|name=Hoggitwiki header
|client=ca-pub-6997190595986605
|slot=7221930773
|width = 728px
|height = 90px
}}</center>


Current release: 4.5 

[http://forums.eagle.ru/showthread.php?t=98616 ED Forums Thread] For discussion and downloads of current and legacy versions.

[https://github.com/mrSkortch/MissionScriptingTools GitHub Link] Mist is now on github. Suggest your own features, write your own code for merging, or make your own modifications to mist!

[[MIST Changelog]]

= Introduction = 
'''''MI'''''ssion '''''S'''''cripting '''''T'''''ools (Mist) is a collection of Lua functions and databases that is intended to 
be a supplement to the standard Lua functions included in the simulator scripting engine.  Mist 
functions and databases provide ready-made solutions to many common scripting tasks and 
challenges, enabling easier scripting and saving mission scripters time. The table mist.flagFuncs 
contains a set of Lua functions (that are similar to Slmod functions) that do not require detailed 
Lua knowledge to use.  However, the majority of Mist does require knowledge of the Lua 
language, and, if you are going to utilize these components of Mist, it is necessary that you read 
the Simulator Scripting Engine guide on the official ED wiki.

= Using Mist in a mission = 
How to Load It 
Mist is not a mod of the game files.  You include it into your missions simply by using any of the DO SCRIPT FILE trigger actions to load Mist at or near mission start.  The screenshot 
below illustrates trigger logic that loads Mist at mission time = 1 sec (using DO SCRIPT FILE). 
 
(Also note that in the above screenshot the trigger named "Mission Script". This trigger is 
similar to the trigger activating mist, however the condition is "Time More (2)." The mission script used in this example requires Mist to be loaded first, otherwise a LUA error will occur and 
the mission will not function correctly.) 
Once your mission trigger logic loads Mist, Mist exists within the global mission scripting Lua 
environment, and its components are accessible in all subsequent scripts run with DO SCRIPT, 
DO SCRIPT FILE, AI Lua stop conditions, etc. The 1.2.4 patch added the "initialization" script or 
script file option in the triggers list, this also works.

'''NOTE #1:''' 
Due to its size Mist must be loaded using a DO SCRIPT FILE. Mist is simply too large to paste into a DO SCRIPT text box.

'''NOTE #2:''' 
It is best if Mist is loaded into your mission as early as possible.  Unlike Slmod, Mist should not 
be vulnerable to being used too early, and it will be fine if you load it on a MISSION START type 
trigger.


<center>{{#widget:AdSense
|name=Hoggitwiki header
|client=ca-pub-6997190595986605
|slot=7221930773
|width = 728px
|height = 90px
}}</center>


== List of Functions ==
{|class="wikitable" width="910"
|-
|bgcolor="LightBlue"| <font size="3">General Purpose</font>
|-
|{{listOfMistGeneralPurposeFuncs}}
|-
|bgcolor="LightBlue"| <font size="3">Unit Orientation</font>
|-
|{{ListOfMistUnitOrientation}}
|-
|bgcolor="LightBlue"| <font size="3">Flag Functions</font>
|-
|{{listOfMistFlagFuncs}}
|-
|bgcolor="LightBlue"| <font size="3">Tasks and Events</font>
|-
|{{listOfMistSSEReplacements}}
|-

|bgcolor="LightBlue"| <font size="3">Coordinate Conversion</font>
|-
|{{listOfMistCoordinateConv}}
|-
|bgcolor="LightBlue"| <font size="3">Unit Conversion</font>
|-
|{{listOfMistUnitConversions}}
|-
|bgcolor="LightBlue"| <font size="3">Utilities</font>
|-
|{{listOfMistUtils}}
|-
|bgcolor="LightBlue"| <font size="3">Debug</font>
|-
|{{listOfMistDebug}}
|-
|bgcolor="LightBlue"| <font size="3">Vectors</font>
|-
|{{listOfMistVectors}}
|-
|bgcolor="LightBlue"| <font size="3">Markers</font>
|-
|{{listOfMistMarkerFuncs}}
|-
|bgcolor="LightBlue"| <font size="3">Messages</font>
|-
|{{listOfMistMessageFuncs}}
|-
|bgcolor="LightBlue"| <font size="3">Group Orders</font>
|-
|{{listOfMistGroupOrders}}
|-
|bgcolor="LightBlue"| <font size="3">Group Data</font>
|-
|{{listOfMistGroupData}}
|-
|bgcolor="LightBlue"| <font size="3">Group Spawning</font>
|-
|{{listOfMistDynAddFuncs}}
|-
|bgcolor="LightBlue"| <font size="3">Strings</font>
|-
|{{listOfMistStringFuncs}}
|-
|bgcolor="LightBlue"| <font size="3">Time</font>
|-
|{{listOfMistTimeFuncs}}
|-
|bgcolor="LightBlue"| <font size="3">Logger</font>
|-
|{{listOfMistLoggerFuncs}}
|}


[[Category:MIST]]
[[Category:Scripting]]

<center>{{#widget:AdSense
|name=Hoggitwiki header
|client=ca-pub-6997190595986605
|slot=7221930773
|width = 728px
|height = 90px
}}</center>