View source for Simulator Scripting Engine Documentation

<center>{{#widget:AdSense
|name=Hoggitwiki header
|width = 728px
|height = 90px
}}</center>

== Simulator Scripting Engine ==

The scripting engine is a power resource for mission design and creation. It gives mission builders access to lua functions to perform a variety of commands from displaying customized messages to controlling AI forces. See the [[Scripting Engine Introduction]] for more details in how the scripting engine interfaces with the mission editor and some basics on how to use it. 

===Singletons ===
Singletons represent a type of object that have only a single instance. Singletons are grouped by overall functionality.

[[DCS_singleton_env|env]]

[[DCS_singleton_timer|timer]]

[[DCS_singleton_land|land]]

[[DCS_singleton_atmosphere|atmosphere]]

[[DCS_singleton_world|world]]

[[DCS_singleton_coalition|coalition]]

[[DCS_singleton_trigger|trigger]]

[[DCS_singleton_coord|coord]]

[[DCS_singleton_missionCommands|missionCommands]]

[[DCS_singleton_voiceChat|VoiceChat]]

[[DCS_singleton_net|net]]

===Classes===
Classes represent the types of objects that could have multiple instances. Most objects you see in game belong to a class where data can be gathered on that object and commands can be executed. 

'''Class Hierarchy'''
*[[DCS_Class_Object| Object]]
**[[DCS_Class_Scenery_Object| Scenery Object]]
**[[DCS_Class_Coalition_Object| Coalition Object]]
***[[DCS_Class_Unit| Unit]]
***[[DCS_Class_Airbase| Airbase]]
****[[DCS_Class_Warehouse|Warehouse]]
***[[DCS_Class_Weapon| Weapon]]
***[[DCS_Class_Static_Object | Static Object]]
*[[DCS_Class_Group| Group]]
*[[DCS_Class_Controller| Controller]]
*[[DCS_Class_Spot| Spot]]

=== Enumerators ===
Enumerators is another name for a constant variable. Within DCS these consist of lua tables with specific values that never change. These values are either indexed numerically or by a string. 

[[DCS_enum_country|country]]

[[DCS_enum_AI|AI]]

[[DCS_enum_world|world]]

[[DCS_enum_radio|radio]]

[[DCS_enum_trigger|trigger]]

[[DCS_enum_coalition|coalition]]

[[DCS_enum_weapon|weapon]]

[[DCS_enum_callsigns|callsign]]

[[DCS_enum_formation|formation]]

[[DCS_enum_attributes|attributes]]

=== Lists ===
[[:Category:Functions|Scripting Functions]]

[[:Category:Class Functions|Class Functions]]

[[:Category:Singleton Functions|Singleton Functions]]

[[:Category:Tasks|AI Tasks]]

[[:Category:Events|Events]]

[[:Category:Terrain Information|Terrain Information]]

[[ScriptingFunctionsByPatch|Scripting Functions By Patch]]

== Other Documentation == 

[[Scripting Engine Changelog]]

[[Scripting Documentation Guide]]


This wiki also hosts documentation for user created scripting libraries. 

[[Mission Scripting Tools Documentation]]

[[IADScript Documentation]]


Much of this guide is based on the Eagle Dynamics Wiki. Due to reasons, the editing of the ED wiki by non ED employees has been offline for a long period of time. The Hoggit wiki has served as a substitute, with more detailed and newly formatted scripting documentation available. The following links are provided as is and are to only be edited to reflect the ED wiki.  

ED Documentation 

*[[DCS_Scripting_orig_Part 1|Part 1]]

*[[DCS_Scripting_orig_Part 2|Part 2]]

== Scripting Engine Links ==
=== Mission Scripting ===
====Tools====
{| class="wikitable sortable" border="1"
|-
! scope="col" | Name
! scope="col" | Authors
! scope="col" | Dependency
! scope="col" | Acronym
! scope="col" class="unsortable" | Description
|-
| [http://forums.eagle.ru/showthread.php?t=98616 Mission Scripting Tools] || Speed, Grimes || none || MIST
|-
| [http://forums.eagle.ru/showthread.php?t=96572 Mission Scripting Foundation] || BAntDit || none || MSF
|-
| [http://flightcontrol-master.github.io/MOOSE/ Mission Object Oriented Scripting Evironment] || FlightControl-Master || none || MOOSE
|}
====AI Enhancements====

{| class="wikitable sortable" border="1"
|-
! scope="col" | Name
! scope="col" | Authors
! scope="col" | Dependency
! scope="col" | Last Update
! scope="col" data-sort-type="text" | Game Version
! scope="col" class="unsortable" | Description
|-
| [http://forums.eagle.ru/showthread.php?t=107609 Artillery Enhancement Script] || MBot|| none || 06-23-2013 || 1.2.6 ||  Artillery groups will function much more independent and will for example evade and return counter barrages.
|-
| [http://forums.eagle.ru/showthread.php?t=120325 Autonomous CAP and GCI AI fighter script] || SNAFU || [[Mission_Scripting_Tools_Documentation|MIST]] || 02-06-2014 || 1.2.7 ||  Generates random aerial defense of both coalitions territories, including Combat Air Patrols that guard a specific area from air threats or interceptors that attack enemy aircraft that has been detected by radar when crossing the border between the coalitions.
|- 
| [http://forums.eagle.ru/showthread.php?t=96572 Detection Script] || BAntDit || none || 12-08-2013 || 1.2.6 || More realistic visual detection for SHORAD systems.
|- 
| [http://forums.eagle.ru/showthread.php?t=109676 Dismounts Script] || MBot|| none || 07-07-2013 || 1.2.7 || Adds infantry that dismounts and mounts ground vehicles like Armored Personnel Carriers or Infantry Vehicles or trucks etc
|- 
| [http://forums.eagle.ru/showpost.php?p=2102182&postcount=12 FLAK Script] || Sithspawn, Stonehouse || [[Mission_Scripting_Tools_Documentation|MIST]] || 06-27-2014 || 1.2.8 ||  Adds anti-air artillery barrages over an area
|-
| [http://forums.eagle.ru/showthread.php?p=2111716#post2111716 Ground Controlled Intercept (and divertable)] || RagnarDa || [[Mission_Scripting_Tools_Documentation|MIST]] || 07-08-2014 || 1.2.8 || Launches and diverts interceptors/fighters on aircrafts detected by radar (AWACS or EWR). Includes functionality to divert AI aircrafts and steer player fighters.
|-
| [http://forums.eagle.ru/showthread.php?t=118175 Integrated Air Defense Script] || Grimes || [[Mission_Scripting_Tools_Documentation|MIST]] || 12-24-2013 || 1.2.7 || Makes the SAMs and radar stations cooperate with each other to make life significantly more nasty for anything flying above.
|-
| [http://forums.eagle.ru/showthread.php?t=115939 Smarter SAM] || Prof_hilactic || None || 10-21-2013 || 1.2.6 || Air defences with self-preservation. Will make the SAM operators try to evade incoming anti-radiation missiles by turning off their radars and moving a bit, as they would in real life.
|-
| [http://forums.eagle.ru/showthread.php?t=107635 Suppression Fire Script] || MBot || None || 12-13-2013 || 1.2.6 || Makes ground units suppressable by firing on them
|}


<center>{{#widget:AdSense
|name=Hoggitwiki header
|width = 728px
|height = 90px
}}</center>


====Gameplay Scripts====

{| class="wikitable sortable" border="1"
|-
! scope="col" | Name
! scope="col" | Authors
! scope="col" | Dependency
! scope="col" | Last Update
! scope="col" data-sort-type="text" | Game Version
! scope="col" class="unsortable" | Description
|-
| [https://forums.eagle.ru/showthread.php?t=116135 Anti-Submarine Warfare ] || MBot|| none || 11-03-2013 || 1.2.6 || Search for and sink submerged submarines using sonobouys, torpedos and more.
|-
| [http://forums.eagle.ru/showthread.php?t=115907 Capture The Flag] || RagnarDa || none || 10-21-2013 || 1.2.6 ||  Classic multiplayer game style where two teams tries to steal the other teams flag and put it in their own base
|-
| [http://forums.eagle.ru/showthread.php?t=126327 Cargo Sling load assistance] || spinter || none ||  07-21-2014 || 1.2.7 ||  Gives audio cues to the pilot when picking up and dropping off sling-loaded cargo.
|-
| [http://forums.eagle.ru/showthread.php?t=110837 Combat Search And Rescue/Slot blocking ] || St3v3f|| slmod || 08-06-2013 || 1.2.5 || If a player is shot down, the client slot will be disabled until a CSAR picks up the pilot and returns him to an airpor
|-
| [http://forums.eagle.ru/showthread.php?t=108523 Complete Troops Transport Script ] || geloxo || none || 07-12-2013 || 1.2.5 ||  Pick up troops or logistics and transport them.
|-
| [http://forums.eagle.ru/showthread.php?t=120234 Cross-Country Racing] || Joe Kurr|| [[Mission_Scripting_Tools_Documentation|MIST]] || 02-03-2014 || 1.2.7 ||  Compete in getting from point A to point B in the shortest amount of time.
|-
| [http://forums.eagle.ru/showthread.php?t=106399  Dynamic Extraction Team Spawning] || Psyrixx || [[Mission_Scripting_Tools_Documentation|MIST]] || 05-15-2013 || 1.2.5 || Transport a extraction team that will disembark from your helicopter and go pick up an objective.
|-
| [http://forums.eagle.ru/showthread.php?t=107303 Dynamic Medevac Script] || RagnarDa|| [[Mission_Scripting_Tools_Documentation|MIST]] || 01-05-2014 || 1.2.7 || Rescue the crew members of destroyed ground or air vehicles.
|-
| [http://forums.eagle.ru/showthread.php?t=121903 Helicopter Script library ] || wolle|| [[Mission_Scripting_Tools_Documentation|MIST]]|| 03-21-2014 || 1.2.7 || A large scripting library with functions mostly related to helicopters, but also things like airsuperiority battle-generation and re-supply convoy generation. 
|-
| [http://forums.eagle.ru/showthread.php?t=118842 Multiplayer Racing] || BB.|| [[Mission_Scripting_Tools_Documentation|MIST]] || 01-05-2014 || 1.2.7 || Create race courses to challenge your friends who is the fastest airman.
|}

=== Scripting Mods===

=== LUA Reference ===
[http://www.lua.org/manual/5.2/ Lua 5.2 Online Reference Manual]

[http://lua-users.org/wiki/LuaDirectory lua-users wiki]

[http://lua-users.org/wiki/TutorialDirectory lua-users Tutorial Page]

[[Category:Scripting]]

<center>{{#widget:AdSense
|name=Hoggitwiki header
|width = 728px
|height = 90px
}}</center>