DCS World Wiki - Hoggitworld.com - User contributions [en]

DCS hook onPlayerTryChangeSlot

2026-02-22T22:58:31Z

Grimes:

{{Template:DCS_hooks_callbacks

|fName= onPlayerTryChangeSlot

|vNum= 2.5.0

|par1= [[DCS_server_hooks|hook]]

|par2=

|par3=

|par4=

|desc= Occurs when a player clicks on a new slot to try and enter a given aircraft. Can be used for slot blocking purposes within a mission or to force players access to one team or the other.

playerId is who is attempting to join a slot

side is the coalition the aircraft belongs to

slotId is an identifier for the slot the player is trying to join. The identifier is based on the unitID for a given aircraft. However with multicrew seats the slotId has an additional "_x" added to the unitId to specify which seat it is.

'''IMPORTANT: ''' If any value is returned with this function then any other callback that uses it will be ignored. If no choice is to be made, then do NOT return any value. DCS itself uses this callback as part of the multicrew slot interface. By returning true the pilot will not get the prompt or have any choice in allowing another player from entering their aircraft.

|rtnType= nothing

|rtnExample= Value 1: boolean
True: Allows the user into the slot
False prevents the user from entering the slot.
nil: Does nothing. Will allow additional hooks using this callback to be checked.

|reqType1= number

|reqName1= playerId

|reqType2= number

|reqName2= side

|reqType3= string

|reqName3= slotId

|reqType4=

|reqName4=

|reqType5=

|optType1=

|optName1=

|optType2=

|related=
List of Callbacks: {{listOfDCSHooks}}

|examples= Checks a list of players indexed by UCID to see if they have a coalition value assigned to them. If they do and the side is not the same then it denies the request. Otherwise it creates the entry with the specified side and does not return the function as to allow any other callback that might check for onPlayerTryChangeSlot to do its code.

function myCall.onPlayerTryChangeSlot(playerId, side, slotId)
local ucid = net.get_player_info(id, 'ucid')
if someList[ucid] and someList[ucid].coa ~= side then
return false
else
someList[ucid] = {coa = side}
end
end
|notes=
}}
[[Category:DCS Hooks|onPlayerTryChangeSlot]]

Category:Terrain Information

2025-06-05T23:11:11Z

Grimes:

{{Template:dcs_maps_scripting

|name= Caucuses

|desc= This region along the eastern Black Sea consists of Russian, Georgian, and Turkish territory. This area includes many airbases, urban areas, lines of communications, and all four seasons.

|list=

12 : Anapa-Vityazevo
13 : Krasnodar-Center
14 : Novorossiysk
15 : Krymsk
16 : Maykop-Khanskaya
17 : Gelendzhik
18 : Sochi-Adler
19 : Krasnodar-Pashkovsky
20 : Sukhumi-Babushara
21 : Gudauta
22 : Batumi
23 : Senaki-Kolkhi
24 : Kobuleti
25 : Kutaisi
26 : Mineralnye Vody
27 : Nalchik
28 : Mozdok
29 : Tbilisi-Lochini
30 : Soganlug
31 : Vaziani
32 : Beslan

|mapImage= [[File:Cauc_map_orign.jpg|200px|thumb]]

|note= Airbase Id 1 - 11 represents removed airbases from the Crimean part of the map dating back to the LOMAC game series.

}}

{{Template:dcs_maps_scripting

|name= Nevada

|desc= The Nevada Test and Training Range (NTTR) has the largest contiguous air and ground space available for peacetime military operations in the free world. The NTTR land area includes simulated air defense systems, mock airbases, and several target ranges. The NTTR was also used for nuclear testing. Today, it is home to RED FLAG and other military exercises that include countries from around the world. The NTTR map for DCS World 2 includes Nellis AFB, Creech AFB, and the infamous Groom Lake AFB (aka Area 51). This map also includes the city of Las Vegas, McCarran International Airport, and Hoover Dam.

|list=

1 : Creech AFB
2 : Groom Lake AFB
3 : McCarran International Airport
4 : Nellis AFB
5 : Beatty Airport
6 : Boulder City Airport
7 : Echo Bay
8 : Henderson Executive Airport
9 : Jean Airport
10 : Laughlin Airport
11 : Lincoln County
13 : Mesquite
14 : Mina Airport 3Q0
15 : North Las Vegas
16 : Pahute Mesa Airstrip
17 : Tonopah Airport
18 : Tonopah Test Range Airfield

|mapImage= [[File:Nevada_map_origin.jpg|200px|thumb]]

|note= 2.1 added bases 5-18

Mina Airport has 0 ramp spawns

}}
{{Template:dcs_maps_scripting

|name= Normandy

|desc= The DCS: Normandy 1944 Map is centered on the World War II battlefield of Normandy, France and is specifically created to depict the period after the D-Day landings and the establishment of several allied airfields in Normandy to support the beachhead breakout in late June 1944. The map measures 267 x 348 kilometers and includes airfields in both Normandy and southern England. The map includes the famous D-Day landing beaches and the "Atlantic Wall", rolling bocage fields of Normandy, large cities like Caen and Rouen, ports of Cherbourg and Le Havre, and 30 airfields. The map also includes multiple seasons.

|list=

1 : Saint Pierre du Mont
2 : Lignerolles
3 : Cretteville
4 : Maupertus
5 : Brucheville
6 : Meautis
7 : Cricqueville-en-Bessin
8 : Lessay
9 : Sainte-Laurent-sur-Mer
10 : Biniville
11 : Cardonville
12 : Deux Jumeaux
13 : Chippelle
14 : Beuzeville
15 : Azeville
16 : Picauville
17 : Le Molay
18 : Longues-sur-Mer
19 : Carpiquet
20 : Bazenville
21 : Sainte-Croix-sur-Mer
22 : Beny-sur-Mer
23 : Rucqueville
24 : Sommervieu
25 : Lantheuil
26 : Evreux
27 : Chailey
28 : Needs Oar Point
29 : Funtington
30 : Tangmere
31 : Ford
32 : Argentan
33 : Goulet
34 : Barville
35 : Essay
36 : Hauterive
37 : Lymington
38 : Vrigny
39 : Odiham
40 : Conches
41 : West Malling
42 : Villacoublay
43 : Kenley
44 : Beauvais-Tille
45 : Cormeilles-en-Vexin
46 : Creil
47 : Guyancourt
48 : Lonrai
49 : Dinan-Trelivan
50 : Heathrow
51 : Fecamp-Benouville
52 : Farnborough
53 : Friston
54 : Deanland
55 : Triqueville
56 : Poix
57 : Orly
58 : Stoney Cross
59 : Amiens-Glisy
60 : Ronai
61 : Rouen-Boos
62 : Deauville
63 : Saint-Aubin
64 : Flers
65 : Avranches Le Val-Saint-Pere
66 : Gravesend
67 : Beaumont-le-Roger
68 : Broglie
69 : Bernay Saint Martin
70 : Saint-Andre-de-lEure

|mapImage= [[File:Normandy2_map_area.jpg|200px|thumb]]

|note= 2.5.6 Patch added airbases 32-40.

2.8.4 saw the release of Normandy 2.0. Added area to the map including Paris and London. With airbases 41-70

}}
{{Template:dcs_maps_scripting

|name= Persian Gulf

|desc= The Persian Gulf Map for DCS World focuses on the Strait of Hormuz, which is the strategic choke point between the oil-rich Persian Gulf and the rest of the world. Flanked by Iran to the North and western-supported UAE and Oman to the south, this has been one of the world’s most dangerous flash points for decades. It was the location of Operation Praying Mantis in 1988 in which the US Navy sank several Iranian naval vessels.

|list=

1 : Abu Musa Island
2 : Bandar Abbas Intl
3 : Bandar Lengeh
4 : Al Dhafra AFB
5 : Dubai Intl
6 : Al Maktoum Intl
7 : Fujairah Intl
8 : Tunb Island AFB
9 : Havadarya
10 : Khasab
11 : Lar
12 : Al Minhad AFB
13 : Qeshm Island
14 : Sharjah Intl
15 : Sirri Island
16 : Tunb Kochak
17 : Sir Abu Nuayr
18 : Kerman
19 : Shiraz Intl
20 : Sas Al Nakheel
21 : Bandar-e-Jask
22 : Abu Dhabi Intl
23 : Al-Bateen
24 : Kish Intl
25 : Al Ain Intl
26 : Lavan Island
27 : Jiroft
28 : Ras Al Khaimah Intl
29 : Liwa AFB

|mapImage= [[File:PG_map_origin.jpg|200px|thumb]]

|note= Additional airbases are expected to be added in time.

Yes I know Bahrain is missing.

Patch 2.5.6.59398 renamed several of the airbases. Primarily changed "International" to "Intl", "AB" to "AFB", and removed "airport" or "airfield" from any name that had it.

}}

{{Template:dcs_maps_scripting

|name= The Channel

|desc= Separating England from the Third Reich in World War II, the English Channel provided a barrier that the axis could not breach. The Channel map provides a detailed and accurate representation of southeastern England and the adjacent region across the Channel in mainland Europe. It encompasses all of the historical airfields, urban areas, roads and rails, ports and other features that make it the perfect setting for the World War II air war in Europe between the late 1930s and 1944.

|list=

1 : Abbeville Drucat
2 : Merville Calonne
3 : Saint Omer Longuenesse
4 : Dunkirk Mardyck
5 : Manston
6 : Hawkinge
7 : Lympne
8 : Detling
12 : High Halden

|mapImage= [[File:Channel_map_origin.jpg|200px|thumb]]

|note= Unknown why IDs 9, 10, and 11 are currently skipped.
}}

{{Template:dcs_maps_scripting

|name= Syria

|desc= Map size 600*420 km., map area 250 thousand sq. km. In the Central part of the map are the States of Syria and Lebanon, which are washed by the Mediterranean sea. The Northern part of the map is limited to Turkey, in the South - Israel and Jordan.

|list=

1 : Abu al-Duhur
2 : Adana Sakirpasa
3 : Al Qusayr
4 : An Nasiriyah
5 : Tha'lah
6 : Beirut-Rafic Hariri
7 : Damascus
8 : Marj as Sultan South
9 : Al-Dumayr
10 : Eyn Shemer
11 : Gaziantep
12 : H4
13 : Haifa
14 : Hama
15 : Hatay
16 : Incirlik
17 : Jirah
18 : Khalkhalah
19 : King Hussein Air College
20 : Kiryat Shmona
21 : Bassel Al-Assad
22 : Marj as Sultan North
23 : Marj Ruhayyil
24 : Megiddo
25 : Mezzeh
26 : Minakh
27 : Aleppo
28 : Palmyra
29 : Qabr as Sitt
30 : Ramat David
31 : Kuweires
32 : Rayak
33 : Rene Mouawad
34 : Rosh Pina
35 : Sayqal
36 : Shayrat
37 : Tabqa
38 : Taftanaz
39 : Tiyas
40 : Wujah Al Hajar
41 : Gazipasa
42 : Deir ez-Zor
43 : Nicosia
44 : Akrotiri
45 : Kingsfield
46 : Paphos
47 : Larnaca
48 : Lakatamia
49 : Ercan
50 : Gecitkale
51 : Pinarbashi
52 : Naqoura
53 : H3
54 : H3 Northwest
55 : H3 Southwest
57 : Ruwayshid
58 : Sanliurfa
59 : Kharab Ishk
60 : Tal Siman
63 : At Tanf
64 : Prince Hassan
65 : King Abdullah II
66 : Herzliya
67 : Amman
68 : Muwaffaq Salti

|mapImage= [[File:Syria_map_origin.jpg|200px|thumb]]

|note=

2.9.3 Added ids 64-68
}}
{{Template:dcs_maps_scripting
|name= Marianas Islands
|desc= The Marianas Islands are an island chain in the Pacific Ocean.

|list=

1 : Rota Intl
2 : Saipan Intl
3 : Tinian Intl
4 : Antonio B. Won Pat Intl
5 : Olf Orote
6 : Andersen AFB
7 : Pagan Airstrip
8 : North West Field

|mapImage= [[File:Marianas map.jpg|200px|thumb]]

|note= This map is free to use.

Map origin is located exactly above the Antonio B Won Pat Intl airport.
}}

{{Template:dcs_maps_scripting

|name= South Atlantic

|desc= Covering an area of 3.1 Million Square Kilometers Razbam presents The South Atlantic. A beautiful combination of Argentina, Chile and the Falkland Islands. Landclass textures have been drawn from aerial and satellite photography detailing this truly majestic area of the world, from the rugged mountains of Chile, colourful plains of Patagonia and the windswept Falkland Islands. Home to one of the smallest cities in the world Stanley.

|list=

1 : Port Stanley
2 : Mount Pleasant
3 : San Carlos FOB
5 : Rio Gallegos
6 : Rio Grande
7 : Ushuaia
8 : Ushuaia Helo Port
9 : Punta Arenas
10 : Pampa Guanaco
11 : San Julian
12 : Puerto Williams
13 : Puerto Natales
14 : El Calafate
15 : Puerto Santa Cruz
16 : Comandante Luis Piedrabuena
17 : Aerodromo De Tolhuin
18 : Porvenir Airfield
19 : Almirante Schroeders
20 : Rio Turbio
21 : Rio Chico
22 : CaletaTortel
23 : Franco Bianco
24 : Goose Green
25 : Hipico Flying Club
26 : Aeropuerto de Gobernador Gregores
27 : Aerodromo O'Higgins
28 : Cullen Airport
29 : Gull Point

|mapImage= [[File:SouthAtlanticMapArea.jpg|200px|thumb]]

|note= Map origin is located just south of East Falkands Island.

Airbase list is as of DCS 2.8.4.

}}

{{Template:dcs_maps_scripting

|name= Sinai

|desc= The territory includes the entire Sinai Peninsula, eastern Egypt, the Nile Delta, the southern part of Israel, the west of Jordan and Saudi Arabia, Palestine - the Gaza Strip. This area includes many airbases, urban areas, wide variety of landscapes such as mountains, desert, sea and bays.

|list=

1 : Difarsuwar Airfield
2 : Abu Suwayr
3 : As Salihiyah
4 : Al Ismailiyah
5 : Melez
6 : Fayed
7 : Hatzerim
8 : Nevatim
9 : Ramon Airbase
10 : Ovda
11 : Kibrit Air Base
12 : Kedem
13 : Wadi al Jandali
14 : Al Mansurah
15 : AzZaqaziq
16 : Bilbeis Air Base
17 : Cairo International Airport
18 : Cairo West
19 : Inshas Airbase
20 : Hatzor
21 : Palmachim
22 : Sde Dov
23 : Tel Nof
24 : Ben-Gurion
25 : St Catherine
26 : Abu Rudeis
27 : Baluza
28 : Bir Hasanah
29 : El Arish
30 : El Gora
31 : Al Khatatbah
32 : Al Rahmaniyah Air Base
33 : Beni Suef
34 : Birma Air Base
35 : Borj El Arab International Airport
36 : El Minya
37 : Gebel El Basur Air Base
38 : Hurghada International Airport
39 : Jiyanklis Air Base
40 : Kom Awshim
41 : Ramon International Airport
42 : Sharm El Sheikh International Airport
43 : Wadi Abu Rish
44 : Al Bahr al Ahmar
45 : Quwaysina

|mapImage= [[File:Sinai_map_origin.jpg|200px|thumb]]

|note= Map origin is located in Cairo, Egypt.

Airbase list is as of DCS 2.9.7

}}

{{Template:dcs_maps_scripting

|name= Kola Peninsula

|desc= The Kola map covers northern Norway, Sweden, and Finland, as well as Murmansk and parts of the Karelia regions of northwestern Russia. The map also includes large portions of the Barents Sea and Norwegian Sea to the north and west.

|list=

1 : Lakselv
2 : Rovaniemi
3 : Kemi Tornio
4 : Bas 100
5 : Kiruna
6 : Severomorsk3
7 : Bodo
8 : Severomorsk1
9 : Olenegorsk
10 : Monchegorsk
11 : Jokkmokk
12 : Murmansk International
13 : Kalixfors

|mapImage= [[File:Kola_map_origin.jpg|200px|thumb]]

|note= Map origin is located near the Swedish and Finish boarder in the middle of nowhere.

Airbase list is as of DCS 2.9.4.

}}

{{Template:dcs_maps_scripting

|name= Cold War Germany

|desc= The Cold War Germany covers the territory of Central Europe and includes FRG and GDR, Poland, Czech Republic, Denmark and the Baltic Sea. The period 1970-1990, which was the peak of the arms race, is represented, as well as earlier and later historical periods. The size of the map is 980 km north to south and 800 km east to west, giving a total area of 784,000 square kilometers. More than 100 airfields are represented on the map.

|list=

1 : Wittstock
2 : Altes Lager
3 : Barth
4 : Zerbst
5 : Bremen
6 : Briest
7 : Buckeburg
8 : Celle
9 : Cochstedt
10 : Damgarten
11 : Fassberg
12 : Finow
13 : Garz
14 : Gatow
15 : Templin
16 : Gutersloh
17 : Hamburg
18 : Hamburg Finkenwerder
19 : Hannover
20 : Laage
21 : Larz
22 : Mahlwinkel
23 : Neubrandenburg
24 : Neuruppin
25 : Peenemunde
26 : Schonefeld
27 : Stendal
28 : Tegel
29 : Tempelhof
30 : Tutow
31 : Werneuchen
32 : Wunstorf
53 : H FRG 01
54 : H FRG 02
55 : H FRG 03
56 : H FRG 04
57 : H FRG 05
58 : H FRG 06
59 : H FRG 07
60 : H FRG 08
61 : H FRG 09
62 : H FRG 10
64 : H FRG 12
65 : H FRG 13
66 : H FRG 14
67 : H GDR 01
68 : H GDR 02
69 : H GDR 03
70 : H GDR 04
71 : H GDR 05
72 : H GDR 06
73 : H GDR 07
74 : H GDR 08
75 : H GDR 09
76 : H GDR 10
77 : H GDR 11
78 : H FRG 15
80 : Gross Mohrdorf
81 : Lubeck
82 : Kothen
83 : Dessau
84 : Parchim
85 : H GDR 12
86 : Uetersen
89 : Luneburg
90 : Northeim
91 : H GDR 13
92 : H GDR 14
93 : H GDR 15
94 : H GDR 16
95 : H GDR 17
96 : H FRG 16
97 : H FRG 17
98 : H FRG 18
99 : H FRG 19
100 : H FRG 11
101 : Sperenberg
102 : Uelzen
103 : Dedelow
104 : Kammermark
106 : Weser Wumme
107 : Braunschweig
108 : Wismar
109 : Waren Vielist
110 : Bienenfarm
111 : Pinnow
112 : Gardelegen
113 : Glindbruchkippe
114 : Ummern
115 : Hildesheim
116 : Verden-Scharnhorst
117 : Rinteln
118 : Holzdorf
119 : H Med GDR 01
120 : H Med GDR 02
121 : H Med GDR 03
122 : H GDR 33
123 : Airracing Koblenz
124 : H GDR 34
126 : H Med GDR 08
127 : H Med GDR 09
128 : H Med GDR 10
129 : H Med FRG 01
130 : H Med FRG 02
132 : H Med FRG 04
134 : H Med FRG 06
139 : H Med FRG 11
140 : Hasselfelde
141 : Grosse Wiese
142 : H GDR 18
143 : H FRG 20
144 : H Med FRG 12
145 : H GDR 19
146 : H GDR 30
147 : H Med GDR 11
148 : H FRG 21
149 : H FRG 50
150 : H FRG 23
151 : H FRG 39
152 : H GDR 21
153 : H GDR 22
154 : Fritzlar
155 : Hahn
156 : Sembach
157 : Allstedt
158 : Zweibrucken
159 : Giebelstadt
160 : Schweinfurt
161 : Haina
162 : Spangdahlem
163 : Frankfurt
164 : Bindersleben
165 : Ramstein
166 : Fulda
167 : Obermehler Schlotheim
168 : Mendig
169 : Merseburg
170 : Wiesbaden
171 : Leipzig Halle
180 : H Med GDR 12
181 : H Med GDR 13
182 : H Med GDR 14
184 : H Med GDR 16
185 : H GDR 24
186 : H Med FRG 13
187 : H Med FRG 14
188 : H Med FRG 15
189 : H Med FRG 16
190 : H Med FRG 17
191 : H FRG 25
193 : H Radar GDR 01
194 : H Radar GDR 02
195 : H Radar GDR 03
196 : H Radar GDR 04
197 : H Radar GDR 05
198 : H Radar GDR 06
199 : H Radar GDR 07
200 : Bitburg
201 : Airracing Lubeck
202 : H FRG 27
204 : Airracing Frankfurt
208 : H Med FRG 21
211 : H FRG 30
212 : H FRG 31
213 : H FRG 32
215 : H FRG 34
218 : H FRG 51
219 : H FRG 38
220 : H FRG 48
221 : H FRG 49
222 : H Med FRG 24
223 : H Radar FRG 02
225 : H Med FRG 26
226 : H GDR 25
227 : H GDR 26
229 : H GDR 31
230 : H GDR 32
231 : H Med FRG 27
232 : Pferdsfeld
233 : H Med FRG 29
234 : H FRG 40
235 : Buchel
236 : Leipzig Mockau
237 : H FRG 43
238 : H FRG 44
239 : H FRG 45
240 : H FRG 46
241 : H FRG 47
242 : Bad Durkheim
243 : Gelnhausen
244 : Herrenteich
245 : Hockenheim
246 : Langenselbold
247 : Walldorf
248 : Ober-Morlen
249 : Pottschutthohe
250 : Worms
251 : H Radar GDR 09
252 : H Radar GDR 08
253 : H FRG 41
254 : H FRG 42

|mapImage=

|note=

}}

DCS func getResourceMap

2025-05-28T22:10:18Z

Grimes:

{{Template:dcs_funcs

|fName= getResourceMap

|vNum= 2.8.8

|par1= [[DCS_Class_Warehouse|Warehouse]]

|par2=

|par3=

|par4=

|desc= Returns the wsType of every object that exists in DCS. A wsType is a table consisting of 4 entries indexed numerically. It can be used to broadly categorize object types. The table can be broken down as: {mainCategory, subCat1, subCat2, index}

A vague breakdown of the wsTypes:

1 : Aircraft
1: Airplanes
1: Fighters
2: Fast Bombers
3: Interceptors
4: Bombers
5: Misc support
6: Attack
2: Helicopters
2 : Vehicles
3 : Ships
4 : Weapons

For example all 3 A-10 aircraft in game will have a wsType of {1, 1, 6, n} where n is whichever index the unit happens to be in.

There are several items that have a wsType of {0, 0, 0, 0}. Typically these include shells, static objects, and turrets.

|rtnType= table

|rtnExample= A table indexed by string of the object name containing the wsType table associated with the object.
{
["S-60_Type59_Artillery"] = { [1] = 2, [2] = 16, [3] = 26, [4] = 259, },
["Daimler_AC"] = { [1] = 2, [2] = 17, [3] = 26, [4] = 7, },
["weapons.shells.KDA_35_FAPDS"] = { [1] = 0, [2] = 0, [3] = 0, [4] = 0, },
["weapons.missiles.P_24T"] = { [1] = 4, [2] = 4, [3] = 7, [4] = 26,
}

|reqType1= Class

|reqName1= self

|reqType2=

|reqName2=

|reqType3=

|optType1=

|optType2=

|examples=

|related=
[[DCS_Class_Warehouse|'''Warehouse Functions:''']] {{listOfScriptingWarehouseFuncs}}
|notes=
}}
[[Category:Class Functions|getResourceMap]]
[[Category:Game Patch 2.8.8|getResourceMap]]

DCS func scheduleFunction

2025-04-27T10:25:24Z

Grimes:

{{Template:dcs_funcs

|fName= scheduleFunction

|vNum= 1.2.0

|par1= [[DCS_singleton_timer|timer]]

|par2=

|par3=

|par4=

|desc= Schedules a function to run at a time in the future. This is a very powerful function.

The function that is called is expected to return nil or a number which will indicate the next time the function will be rescheduled.
Use the second argument in that function to retrieve the current time and add the desired amount of delay (expressed in seconds).

|rtnType= functionId

|rtnExample= 3

|reqType1= function

|reqName1= functionToCall

|reqType2= functionArgs

|reqName2= anyFunctionArguement

|reqType3= time

|reqName3= modelTime

|reqType4=

|optType1=

|optName1=

|optType2=

|related=
[[DCS_singleton_timer|'''timer Functions:''']] {{listOfTimerFuncs}}

|examples= The following will run a function named "main" 120 seconds from one the code would run.
timer.scheduleFunction(main, {}, timer.getTime() + 120)

The following example sets up a repetitive call loop where function CheckStatus is called every 5 seconds or.

function CheckStatus(ourArgument, time)
-- Do things to check, use ourArgument (which is the scheduleFunction's second argument)
if ourArgument == 53 and someExternalCondition then
-- Keep going
return time + 5
else
-- That's it we're done looping
return nil
end
end
timer.scheduleFunction(CheckStatus, 53, timer.getTime() + 5)

This function will check if any red coalition units are in a trigger zone named "anyReds" and will set the flag "zoneOccupied" to true. This function will schedule itself to run every 60 seconds.

local function checkZone(zoneName)
timer.scheduleFunction(checkZone, zoneName, timer.getTime() + 60)
local zone = trigger.misc.getZone(zoneName)
local groups = coalition.getGroups(1)
local count = 0
for i = 1, #groups do
local units = groups[i]:getUnits()
for j = 1, #units do
local unitPos = units[j]:getpoint()
if math.sqrt((zone.point.x - unitPos.x)^2 + (zone.point.z - unitPos.z)^2) < zone.radius then
count = count + 1
end
end
end
if count > 0 then
trigger.action.setUserFlag("zoneOccupied", true)
else
trigger.action.setUserFlag("zoneOccupied", false)
end
end
checkZone("anyReds")

|notes=
}}
[[Category:Singleton Functions|scheduleFunction]]
[[Category:Game Patch 1.2.0|scheduleFunction]]

Template:DCS enum naval val ROE

2025-04-27T09:49:46Z

Grimes:

AI.Option.Naval.val.ROE
OPEN_FIRE = 2
RETURN_FIRE = 3
WEAPON_HOLD = 4

Template:DCS enum ground val ROE

2025-04-27T09:49:39Z

Grimes:

AI.Option.Ground.val.ROE
OPEN_FIRE = 2
RETURN_FIRE = 3
WEAPON_HOLD = 4

DCS func createLaser

2025-04-27T09:47:25Z

Grimes:

{{Template:dcs_funcs

|fName= createLaser

|vNum= 1.2.6

|par1= [[DCS_Class_Spot| Spot]]

|par2=

|par3=

|par4=

|desc= Creates a laser ray emanating from the given object to a point in 3d space.

localRef is technically an optional variable, however the functions format requires an entry to be made. If not used, simply replace with nil

If optional variable laserCode is not present the beam will automatically be set to a IR beam. If laserCode is specified the beam is a laser which can be used to guide laser guided bombs.

Laser code is any 4 digit number between 1111 and 1788.

|rtnType= [[DCS_Class_Spot|Spot Object]]

|rtnExample=

|reqType1= Object

|reqName1= Source

|reqType2= Vec3

|reqName2= localRef

|reqType3= Vec3

|reqName3= pointTarget

|reqType4=

|optType1= number

|optName1= laseCode

|optType2=

|related=
[[DCS_Class_Spot|'''Spot Functions:''']] {{listofScriptingSpotFuncs}}

|examples= The following will create a laser emitting 1 meter above the jtac unit toward the targeted group. The laser code is 1337.

local jtac = Unit.getByName('jtacBob')
local target = Unit.getByName('BMPAirDefenseSystemGroup1_unit1'):getPoint()

local ray = Spot.createLaser(jtac, {x = 0, y = 1, z = 0}, target, 1337)
|notes=
}}
[[Category:Class Functions|createLaser]]
[[Category:Game Patch 1.2.6|createLaser]]

DCS Class Controller

2025-04-27T09:34:36Z

Grimes:

{{Template:DCSscriptingClasses
|cName= Controller

|vNum= 1.2.0

|xVar= none

|inVar= none

|desc= Controller is an object that performs AI-routines. In other words a controller is an instance of the AI. Controller stores the current main task, active enroute tasks, and behavior options. Controllers also can perform commands. Controllers exist at both a group and unit level. However only planes and helicopters can be controlled individually at a unit level. Some functions can only work for Unit Controllers.

Different tasks, options, and commands are available for the different group types. (Plane, Helicopter, Ground Unit, and Ship). See the linked articles on these subjects for more information.

|type= Detection Types

Controller.Detection
VISUAL 1
OPTIC 2
RADAR 4
IRST 8
RWR 16
DLINK 32

|structures=

|staticFuncs=

|memberFuncs= {{listofScriptingControllerFuncs}}

|funcs= [[DCS_func_getController|getController]]

|events=

|notes=
}}
[[Category:Tasks|Controller]]
[[Category:Game Patch 1.2.0|Controller class]]

DCS option allow formation side swap

2025-03-20T07:21:00Z

Grimes:

{{Template:DCS_tasking

|tName= All Formation Side Swap

|vNum= 2.9.14

|type= [[DCS_func_setOption|Option]]

|for= Airplanes, Helicopters

|avail= Everything

|desc= Defines whether or not the AI aircraft are allowed to swap sides when doing a tactical turn.

'''''Behaviors:'''''

True: AI will swap sides

False: (Default) AI will not swap sides. (Editor will auto add as enabled)

|form= All options have an option ID and Value. For more information see the article on [[DCS_enum_AI|the AI enumerator]].

Option Identifier:

AI.Option.Air.id.ALLOW_FORMATION_SIDE_SWAP

Option Values:

true
false

|enum= ALLOW_FORMATION_SIDE_SWAP = 35
|exam=

|notes=

See article [[Mission Editor: AI Tasking]] for more information on how AI tasking is handled within DCS.

}}
[[Category:Aircraft Task|Allow Formation Side Swap]]
[[Category:Helicopter Task|Allow Formation Side Swap]]

Template:DCS enum air options

2025-03-20T07:19:51Z

Grimes:

AI.Option.Air.id
ROE = 0
REACTION_ON_THREAT = 1
RADAR_USING = 3
FLARE_USING = 4
Formation = 5
RTB_ON_BINGO = 6
SILENCE = 7
RTB_ON_OUT_OF_AMMO = 10
ECM_USING = 13
PROHIBIT_AA = 14
PROHIBIT_JETT = 15
PROHIBIT_AB = 16
PROHIBIT_AG = 17
MISSILE_ATTACK = 18
PROHIBIT_WP_PASS_REPORT = 19
OPTION_RADIO_USAGE_CONTACT = 21
OPTION_RADIO_USAGE_ENGAGE = 22
OPTION_RADIO_USAGE_KILL = 23
JETT_TANKS_IF_EMPTY = 25
FORCED_ATTACK = 26
PREFER_VERTICAL = 32
ALLOW_FORMATION_SIDE_SWAP = 35

DCS option allow formation side swap

2025-03-20T07:19:13Z

Grimes: Created page with "{{Template:DCS_tasking |tName= Prohibit AA |vNum= 2.9.14 |type= Option |for= Airplanes, Helicopters |avail= Everything |desc= Defines whether or..."

{{Template:DCS_tasking

|tName= Prohibit AA

|vNum= 2.9.14

|type= [[DCS_func_setOption|Option]]

|for= Airplanes, Helicopters

|avail= Everything

|desc= Defines whether or not the AI aircraft are allowed to swap sides when doing a tactical turn.

'''''Behaviors:'''''

True: AI will swap sides

False: (Default) AI will not swap sides. (Editor will auto add as enabled)

|form= All options have an option ID and Value. For more information see the article on [[DCS_enum_AI|the AI enumerator]].

Option Identifier:

AI.Option.Air.id.ALLOW_FORMATION_SIDE_SWAP

Option Values:

true
false

|enum= ALLOW_FORMATION_SIDE_SWAP = 35
|exam=

|notes=

See article [[Mission Editor: AI Tasking]] for more information on how AI tasking is handled within DCS.

}}
[[Category:Aircraft Task|Allow Formation Side Swap]]
[[Category:Helicopter Task|Allow Formation Side Swap]]

Template:ListOfOptions

2025-03-20T07:03:49Z

Grimes:

[[DCS_option_roe|ROE]], [[DCS_option_reactionToThreat|Reaction To Threat]], [[DCS_option_radarUsing|Radar Using]], [[DCS_option_flareUsing|Flare Using]], [[DCS_option_formation|Formation]], [[DCS_option_rtbOnBingo|RTB On Bingo]], [[DCS_option_silence|silence]], [[DCS_option_disperseOnAttack|Disperse on Attack]], [[DCS_option_alarmState|Alarm State]], [[DCS_option_rtbOnOutOfAmmo|RTB on Out of Ammo]], [[DCS_option_ECMUsing|ECM Using]], [[DCS_option_prohibitAA|Prohibit AA]], [[DCS_option_prohibitJett|Prohibit Jettison]], [[DCS_option_prohibitAB|Prohibit Afterburner]], [[DCS_option_ProhibitAG|Prohibit AG]], [[DCS_option_missileAttack|Missile Attack Range]], [[DCS_option_prohibitWPPassReport|Prohibit WP Pass Report]], [[DCS_option_engage_air_weapons|Engage Air Weapons]], [[DCS_option_radioContact|Option Radio Usage Contact]],
[[DCS_option_radioEngage|Option Radio Usage Engage]], [[DCS_option_radioKill|Option Radio Usage Kill]], [[DCS_option_engagementRange|AC Engagement Range Restriction]], [[DCS_option_jettTankIfEmpty|jett tanks if empty]], [[DCS_option_forcedAttack|forced attack]], [[DCS_option_altitudeRestrictionMin|Altitude Restriction for AAA Min]], [[DCS_option_restrictTargets|restrict targets]], [[DCS_option_altitudeRestrictionMax|Altitude Restriction for AAA Max]], [[DCS_option_prefer vertical|Prefer Vertical]], [[DCS_option_Evasion_of_arm|Evasion Of ARM]], [[DCS_option_formation interval|Formation Interval]], [[DCS_option_allow_formation_side_swap|Allow Formation Side Swap]]

Template:ListOfOptions

2025-03-20T07:03:06Z

Grimes:

DCS enum country

2025-03-20T07:01:13Z

Grimes:

{{Template:DCSenumertorTables

|name= country

|vNum= 1.2.0

|desc= The country enumerator contains the constant countryIds and strings for each country present in DCS World. Country ids are indexed starting at 0.

|uses=

|format= The country enumerator contains 3 nested tables within. id, name, and names. These tables are formatted in the following manner with indexes corresponding to their constant values.
country = {
id = {
['RUSSIA'] = 0,
['UKRAINE'] = 1,
['USA'] = 2,
...
},
name = {
[0] = 'RUSSIA',
[1] = 'UKRAINE',
[2] = 'USA',
...
},
names = {
[0] = 'RUSSIA',
[1] = 'UKRAINE',
[2] = 'USA',
...
},
}

|constants= Below is a full listing of countries and their corresponding ids in YAML format
<pre>
---
0: RUSSIA
1: UKRAINE
2: USA
3: TURKEY
4: UK
5: FRANCE
6: GERMANY
7: AGGRESSORS
8: CANADA
9: SPAIN
10: THE_NETHERLANDS
11: BELGIUM
12: NORWAY
13: DENMARK
15: ISRAEL
16: GEORGIA
17: INSURGENTS
18: ABKHAZIA
19: SOUTH_OSETIA
20: ITALY
21: AUSTRALIA
22: SWITZERLAND
23: AUSTRIA
24: BELARUS
25: BULGARIA
26: CHEZH_REPUBLIC
27: CHINA
28: CROATIA
29: EGYPT
30: FINLAND
31: GREECE
32: HUNGARY
33: INDIA
34: IRAN
35: IRAQ
36: JAPAN
37: KAZAKHSTAN
38: NORTH_KOREA
39: PAKISTAN
40: POLAND
41: ROMANIA
42: SAUDI_ARABIA
43: SERBIA
44: SLOVAKIA
45: SOUTH_KOREA
46: SWEDEN
47: SYRIA
48: YEMEN
49: VIETNAM
50: VENEZUELA
51: TUNISIA
52: THAILAND
53: SUDAN
54: PHILIPPINES
55: MOROCCO
56: MEXICO
57: MALAYSIA
58: LIBYA
59: JORDAN
60: INDONESIA
61: HONDURAS
62: ETHIOPIA
63: CHILE
64: BRAZIL
65: BAHRAIN
66: THIRDREICH
67: YUGOSLAVIA
68: USSR
69: ITALIAN_SOCIAL_REPUBLIC
70: ALGERIA
71: KUWAIT
72: QATAR
73: OMAN
74: UNITED_ARAB_EMIRATES
75: SOUTH_AFRICA
76: CUBA
77: PORTUGAL
78: GDR
79: LEBANON
80: CJTF_BLUE
81: CJTF_RED
82: UN_PEACEKEEPERS
83: Argentina
84: Cyprus
85: Slovenia
86: BOLIVIA
87: GHANA
88: NIGERIA
89: PERU
90: ECUADOR
91: AFGHANISTAN
92: NEW ZEALAND
</pre>
|notes= Yes index 14 doesn't exist. No you aren't crazy. No I don't know what happened to it. Some say it has been missing since Lock-on.

DCS 1.5 has doubled the list of countries available, not all countries are populated with assets yet.

Countries 48-65 were added at or around 1.5.4/2.0.4.

DCS 2.1 added 4 countries (66-69) associated with the World War 2 setting.

DCS 2.5 added 70-82 at assorted patches.

DCS 2.7 added 83-89

DCS 2.8 added 90
}}

DCS task orbit

2025-03-20T06:59:36Z

Grimes:

{{Template:DCS_tasking

|tName= Orbit

|vNum= 1.2.4

|type= Main task

|for= Airplanes, Helicopters

|avail= All aircraft tasks

|desc= Orders an aircraft group to orbit at the waypoint.

DCS. 2.9.14 added the anchored orbit type.

|form= This task needs to be in the following format.

Orbit = {
id = 'Orbit',
params = {
pattern = = string
point = Vec2,
point2 = Vec2,
speed = Distance,
altitude = Distance,
hotLegDir = radians,
legLength = distance,
width = distance,
clockWise = boolean,
}
}

'''Required parameters''':
pattern: defines the type of orbit pattern the AI will execute.

'''Optional Parameters''':
All other variables are optional.

point: vec2 point for which the orbit will originate from. If not defined the position of their current waypoint will be used.

point2: vec2 second point for a Race-Rrack orbit pattern. If not defined the next waypoint position will be used.

speed: Speed in meters per second the AI will orbit at. If no speed is defined then the AI will orbit at 1.5 their stall speed.

altitude: Altitude in meters the AI will orbit at. If not defined the altitude of their current waypoint will be used.

hotLegDir: (anchored param) Heading in radians that the aircraft will fly for the return leg of the orbit

legLength: (anchored param) Distance in meters that the aircraft will fly before turning.

width: (anchored param) Distance in meters that represents the diameter of the orbit

clockWise: (anchored param) true/false value for whether the orbit will fly clockwise or anti-clockwise. Anti-clockwise is default.

|enum= {{DCS_enum_AI_orbitPattern}}

Not in the AI.Task.OrbitPattern table but is a valid pattern value:
"Anchored"
|exam= The following example uses mist functions to make an aircraft group named "Reaper" orbit at the average position of a group named "arty"

local orbit = {
id = 'Orbit',
params = {
pattern = 'Circle',
point = mist.utils.makeVec2(mist.getAvgPos(mist.makeUnitTable({'[g]arty'}))),
speed = 200,
altitude = 8000,
}
}
Group.getByName('Reaper'):getController():pushTask(orbit)

|notes= See article [[Mission Editor: AI Tasking]] for more information on how AI tasking is handled within DCS.

}}
[[Category:Aircraft Task|Orbit]]
[[Category:Helicopter Task|Orbit]]

DCS task orbit

2025-03-20T06:58:57Z

Grimes:

{{Template:DCS_tasking

|tName= Orbit

|vNum= 1.2.4

|type= Main task

|for= Airplanes, Helicopters

|avail= All aircraft tasks

|desc= Orders an aircraft group to orbit at the waypoint.

DCS. 2.9.14 added the anchored orbit type.

|form= This task needs to be in the following format.

Orbit = {
id = 'Orbit',
params = {
pattern = AI.Task.OrbitPattern,
point = Vec2,
point2 = Vec2,
speed = Distance,
altitude = Distance,
hotLegDir = radians,
legLength = distance,
width = distance,
clockWise = boolean,
}
}

'''Required parameters''':
pattern: defines the type of orbit pattern the AI will execute.

'''Optional Parameters''':
All other variables are optional.

point: vec2 point for which the orbit will originate from. If not defined the position of their current waypoint will be used.

point2: vec2 second point for a Race-Rrack orbit pattern. If not defined the next waypoint position will be used.

speed: Speed in meters per second the AI will orbit at. If no speed is defined then the AI will orbit at 1.5 their stall speed.

altitude: Altitude in meters the AI will orbit at. If not defined the altitude of their current waypoint will be used.

hotLegDir: (anchored param) Heading in radians that the aircraft will fly for the return leg of the orbit

legLength: (anchored param) Distance in meters that the aircraft will fly before turning.

width: (anchored param) Distance in meters that represents the diameter of the orbit

clockWise: (anchored param) true/false value for whether the orbit will fly clockwise or anti-clockwise. Anti-clockwise is default.

|enum= {{DCS_enum_AI_orbitPattern}}

Not in the AI.Task.OrbitPattern table but is a valid pattern value:
"Anchored"
|exam= The following example uses mist functions to make an aircraft group named "Reaper" orbit at the average position of a group named "arty"

local orbit = {
id = 'Orbit',
params = {
pattern = 'Circle',
point = mist.utils.makeVec2(mist.getAvgPos(mist.makeUnitTable({'[g]arty'}))),
speed = 200,
altitude = 8000,
}
}
Group.getByName('Reaper'):getController():pushTask(orbit)

|notes= See article [[Mission Editor: AI Tasking]] for more information on how AI tasking is handled within DCS.

}}
[[Category:Aircraft Task|Orbit]]
[[Category:Helicopter Task|Orbit]]

DCS task orbit

2025-03-19T23:43:35Z

Grimes:

{{Template:DCS_tasking

|tName= Orbit

|vNum= 1.2.4

|type= Main task

|for= Airplanes, Helicopters

|avail= All aircraft tasks

|desc= Orders an aircraft group to orbit at the waypoint.

DCS. 2.9.14 added the anchored orbit type.

|form= This task needs to be in the following format.

Orbit = {
id = 'Orbit',
params = {
pattern = AI.Task.OrbitPattern,
point = Vec2,
point2 = Vec2,
speed = Distance,
altitude = Distance,
hotLegDir = radians,
legLength = distance,
width = distance,
clockWise = boolean,
}
}

'''Required parameters''':
pattern: defines the type of orbit pattern the AI will execute.

'''Optional Parameters''':
All other variables are optional.

point: vec2 point for which the orbit will originate from. If not defined the position of their current waypoint will be used.

point2: vec2 second point for a Race-Rrack orbit pattern. If not defined the next waypoint position will be used.

speed: Speed in meters per second the AI will orbit at. If no speed is defined then the AI will orbit at 1.5 their stall speed.

altitude: Altitude in meters the AI will orbit at. If not defined the altitude of their current waypoint will be used.

hotLegDir: (anchored param) Heading in radians that the aircraft will fly for the return leg of the orbit

legLength: (anchored param) Distance in meters that the aircraft will fly before turning.

width: (anchored param) Distance in meters that represents the diameter of the orbit

clockWise: (anchored param) true/false value for whether the orbit will fly clockwise or anti-clockwise. Anti-clockwise is default.

|enum= {{DCS_enum_AI_orbitPattern}}
|exam= The following example uses mist functions to make an aircraft group named "Reaper" orbit at the average position of a group named "arty"

local orbit = {
id = 'Orbit',
params = {
pattern = 'Circle',
point = mist.utils.makeVec2(mist.getAvgPos(mist.makeUnitTable({'[g]arty'}))),
speed = 200,
altitude = 8000,
}
}
Group.getByName('Reaper'):getController():pushTask(orbit)

|notes= See article [[Mission Editor: AI Tasking]] for more information on how AI tasking is handled within DCS.

}}
[[Category:Aircraft Task|Orbit]]
[[Category:Helicopter Task|Orbit]]

DCS task orbit

2025-03-19T23:17:24Z

Grimes:

{{Template:DCS_tasking

|tName= Orbit

|vNum= 1.2.4

|type= Main task

|for= Airplanes, Helicopters

|avail= All aircraft tasks

|desc= Orders an aircraft group to orbit at the waypoint.

DCS. 2.9.14 added the anchored orbit type.

|form= This task needs to be in the following format.

Orbit = {
id = 'Orbit',
params = {
pattern = AI.Task.OrbitPattern,
point = Vec2,
point2 = Vec2,
speed = Distance,
altitude = Distance,
hotLegDir = radians,
legLength = distance,
width = distance,
clockWise = boolean,
}
}

'''Required parameters''':
pattern: defines the type of orbit pattern the AI will execute.

'''Optional Parameters''':
All other variables are optional.

point: vec2 point for which the orbit will originate from. If not defined the position of their current waypoint will be used.

point2: vec2 second point for a Race-Rrack orbit pattern. If not defined the next waypoint position will be used.

speed: Speed in meters per second the AI will orbit at. If no speed is defined then the AI will orbit at 1.5 their stall speed.

altitude: Altitude in meters the AI will orbit at. If not defined the altitude of their current waypoint will be used.

hotLegDir: (anchored param) Heading in radians that the aircraft will fly for the initial leg of the orbit

legLength: (anchored param) Distance in meters that the aircraft will fly before turning.

width: (anchored param) Distance in meters that represents the diameter of the orbit

clockWise: (anchored param) true/false value for whether the orbit will fly clockwise or anti-clockwise. Anti-clockwise is default.

|enum= {{DCS_enum_AI_orbitPattern}}
|exam= The following example uses mist functions to make an aircraft group named "Reaper" orbit at the average position of a group named "arty"

local orbit = {
id = 'Orbit',
params = {
pattern = 'Circle',
point = mist.utils.makeVec2(mist.getAvgPos(mist.makeUnitTable({'[g]arty'}))),
speed = 200,
altitude = 8000,
}
}
Group.getByName('Reaper'):getController():pushTask(orbit)

|notes= See article [[Mission Editor: AI Tasking]] for more information on how AI tasking is handled within DCS.

}}
[[Category:Aircraft Task|Orbit]]
[[Category:Helicopter Task|Orbit]]

DCS func getAmmo

2025-02-08T01:11:25Z

Grimes:

{{Template:dcs_funcs

|fName= getAmmo

|vNum= 1.2.4

|par1= [[DCS_Class_Unit|Unit]]

|par2=

|par3=

|par4=

|desc= Returns an ammo table for all types of loaded ammunition on a given object. Ammo table is indexed by ammo type and contains a weapon description table and a count variable defining "how much" is on board.

Note that for aircraft this function only returns ammo. It does not return non-ammo items like targeting pods, external fuel tanks, or any other non ammo item that can be mounted via the re-arm menu.

|rtnType= table

|rtnExample= A SA-15 Tor returned this table

{
[1] =
{
["count"] = 8,
["desc"] =
{
["missileCategory"] = 2,
["rangeMaxAltMax"] = 12000,
["rangeMin"] = 1500,
["displayName"] = "9M330",
["rangeMaxAltMin"] = 8000,
["altMax"] = 6000,
["RCS"] = 0.03070000000298,
["box"] =
{
["min"] =
{
["y"] = -0.26701140403748,
["x"] = -1.678077340126,
["z"] = -0.26600670814514,
}, -- end of ["min"]
["max"] =
{
["y"] = 0.26701140403748,
["x"] = 1.8263295888901,
["z"] = 0.26600670814514,
}, -- end of ["max"]
}, -- end of ["box"]
["altMin"] = 10,
["life"] = 2,
["fuseDist"] = 7,
["category"] = 1,
["guidance"] = 4,
["warhead"] =
{
["explosiveMass"] = 14.5,
["type"] = 1,
["caliber"] = 220,
["mass"] = 14.5,
}, -- end of ["warhead"]
["typeName"] = "9M330",
["Nmax"] = 30,
}, -- end of ["desc"]
}, -- end of [1]
} -- end of Tor Ammo

|reqType1= Class

|reqName1= Self

|reqType2=

|reqName2=

|optType1=

|optType2=

|examples=

|related= [[DCS_Class_Unit|'''Unit Functions:''']] {{listOfScriptingUnitFuncs}}
[[DCS_Class_Object|'''Object Functions:''']] {{listofScriptingObjectFuncs}}

[[DCS_Class_Coalition_Object| '''Coalition Object Functions:''']] {{listofScriptingCoaObjectFuncs}}

|notes=
}}
[[Category:Class Functions|getAmmo]]
[[Category:Game Patch 1.2.4|getAmmo]]

DCS func setFogAnimation

2024-12-02T05:29:16Z

Grimes:

{{Template:dcs_funcs

|fName= setFogAnimation

|vNum= 2.9.10

|par1= [[DCS_singleton_world|world.weather]]

|par2=

|par3=

|par4=

|desc= Uses data from the passed table to change the fog visibility and thickness over a desired timeframe. This allows for a gradual increase/decrease of fog values rather than abruptly applying the values.

Animation Key Format: {time, visibility, thickness}

'''Time: in seconds 0 to infinity'''

Time is relative to when the function was called. Time value for each key must be larger than the previous key. If time is set to 0 then the fog will be applied to the corresponding visibility and thickness values at that key. Any time value greater than 0 will result in the current fog being inherited and changed to the first key.

'''Visibility: in meters 100 to 100000'''

'''Thickness: in meters 100 to 5000'''

The speed at which the visibility and thickness changes is based on the time between keys and the values that visibility and thickness are being set to.

When the function is passed an empty table {} or nil the fog animation will be discarded and whatever the current thickness and visibility are set to will remain.

|rtnType=

|rtnExample=

|reqType1= table

|reqName1= fogAnimationKeys/discard

|reqType2=

|reqName2=

|reqType5=

|optType1=

|optName1=

|optType2=

|examples= The following will set the fog in the mission to disappear in 1 minute.

world.weather.setFogAnimation({ {60, 0, 0} })

The following will take 1 hour to get to the first fog setting, it will maintain that fog setting for another hour, then lightly removes the fog over the 2nd and 3rd hour, the completely removes the fog after 3 hours and 3 minutes from when the function was called.

world.weather.setFogAnimation({
{3600, 10000, 3000}, -- one hour to get to that fog setting
{7200, 10000, 3000}, -- will maintain for 2 hours
{10800, 20000, 2000}, -- at 3 hours visibility will have been increased while thickness decreases slightly
{12600, 0, 0}, -- at 3:30 after the function was called the fog will be completely removed.
})

The following will discard the animation resulting in whatever the current fog settings are to become static.

world.weather.setFogAnimation({})

|related=
[[DCS_singleton_world|'''World Functions:''']] {{ListOfWorldFuncs}}

|notes=

}}

[[Category:Singleton Functions|setFogAnimation]]
[[Category:Game Patch 2.9.10|setFogAnimation]]

DCS func setFogAnimation

2024-12-02T05:20:10Z

Grimes:

{{Template:dcs_funcs

|fName= setFogAnimation

|vNum= 2.9.10

|par1= [[DCS_singleton_world|world.weather]]

|par2=

|par3=

|par4=

|desc= Uses data from the passed table to change the fog visibility and thickness over a desired timeframe. This allows for a gradual increase/decrease of fog values rather than abruptly applying the values.

Animation Key Format: {time, visibility, thickness}

'''Time: in seconds 0 to infinity'''

Time is relative to when the function was called. Time value for each key must be larger than the previous key. If time is set to 0 then the fog will be applied to the corresponding visibility and thickness values at that key. Any time value greater than 0 will result in the current fog being inherited and changed to the first key.

'''Visibility: in meters 100 to 100000'''

'''Thickness: in meters 100 to 5000'''

The speed at which the visibility and thickness changes is based on the time between keys and the values that visibility and thickness are being set to.

|rtnType=

|rtnExample=

|reqType1= table

|reqName1= fogAnimationKeys

|reqType2=

|reqName2=

|reqType5=

|optType1=

|optName1=

|optType2=

|examples= The following will set the fog in the mission to disappear in 1 minute.

world.weather.setFogAnimation({ {60, 0, 0} })

The following will take 1 hour to get to the first fog setting, it will maintain that fog setting for another hour, then lightly removes the fog over the 2nd and 3rd hour, the completely removes the fog after 3 hours and 3 minutes from when the function was called.

world.weather.setFogAnimation({
{3600, 10000, 3000}, -- one hour to get to that fog setting
{7200, 10000, 3000}, -- will maintain for 2 hours
{10800, 20000, 2000}, -- at 3 hours visibility will have been increased while thickness decreases slightly
{12600, 0, 0}, -- at 3:30 after the function was called the fog will be completely removed.
})

|related=
[[DCS_singleton_world|'''World Functions:''']] {{ListOfWorldFuncs}}

|notes=
}}

[[Category:Singleton Functions|setFogAnimation]]
[[Category:Game Patch 2.9.10|setFogAnimation]]

DCS func setFogAnimation

2024-12-02T05:18:49Z

Grimes: Created page with "{{Template:dcs_funcs |fName= setFogAnimation |vNum= 2.9.10 |par1= world.weather |par2= |par3= |par4= |desc= Uses data from the passed table to..."

{{Template:dcs_funcs

|fName= setFogAnimation

|vNum= 2.9.10

|par1= [[DCS_singleton_world|world.weather]]

|par2=

|par3=

|par4=

|desc= Uses data from the passed table to change the fog visibility and thickness over a desired timeframe. This allows for a gradual increase/decrease of fog values rather than abruptly applying the values.

Animation Key Format: {time, visibility, thickness}

'''Time: in seconds 0 to infinity'''

Time is relative to when the function was called. Time value for each key must be larger than the previous key. If time is set to 0 then the fog will be applied to the corresponding visibility and thickness values at that key. Any time value greater than 0 will result in the current fog being inherited and changed to the first key.

'''Visibility: in meters 100 to 100000'''

'''Thickness: in meters 100 to 5000'''

The speed at which the visibility and thickness changes is based on the time between keys and the values that visibility and thickness are being set to.

|rtnType=

|rtnExample=

|reqType1= table

|reqName1= fogAnimationKeys

|reqType2=

|reqName2=

|reqType5=

|optType1=

|optName1=

|optType2=

|examples= The following will set the fog in the mission to disappear in 1 minute.

world.weather.setFogAnimation({ {60, 0, 0} })

The following will take 1 hour to get to the set fog setting, maintain that fog setting for another hour, then lightly removes

world.weather.setFogAnimation({
{3600, 10000, 3000}, -- one hour to get to that fog setting
{7200, 10000, 3000}, -- will maintain for 2 hours
{10800, 20000, 2000}, -- at 3 hours visibility will have been increased while thickness decreases slightly
{12600, 0, 0}, -- at 3:30 after the function was called the fog will be completely removed.
})

|related=
[[DCS_singleton_world|'''World Functions:''']] {{ListOfWorldFuncs}}

|notes=
}}

[[Category:Singleton Functions|setFogAnimation]]
[[Category:Game Patch 2.9.10|setFogAnimation]]

DCS func setFogVisibilityDistance

2024-12-02T04:51:51Z

Grimes:

{{Template:dcs_funcs

|fName= setFogVisibilityDistance

|vNum= 2.9.10

|par1= [[DCS_singleton_world|world.weather]]

|par2=

|par3=

|par4=

|desc= Sets the maximum visibility at sea level in meters.

Limit: 100 to 100000

If 0 is passed to the function the fog will be removed.

|rtnType=

|rtnExample=

|reqType1= number

|reqName1= visibility

|reqType2=

|reqName2=

|reqType5=

|optType1=

|optName1=

|optType2=

|examples=

|related=
[[DCS_singleton_world|'''World Functions:''']] {{ListOfWorldFuncs}}

|notes=
}}

[[Category:Singleton Functions|setFogVisibilityDistance]]
[[Category:Game Patch 2.9.10|setFogVisibilityDistance]]

DCS func setFogVisibilityDistance

2024-12-02T04:38:09Z

Grimes:

{{Template:dcs_funcs

|fName= setFogVisibilityDistance

|vNum= 2.9.10

|par1= [[DCS_singleton_world|world.weather]]

|par2=

|par3=

|par4=

|desc= Sets the maximum visibility at sea level in meters.

Limit: 100 to 100000

|rtnType=

|rtnExample=

|reqType1= number

|reqName1= visibility

|reqType2=

|reqName2=

|reqType5=

|optType1=

|optName1=

|optType2=

|examples=

|related=
[[DCS_singleton_world|'''World Functions:''']] {{ListOfWorldFuncs}}

|notes=
}}

[[Category:Singleton Functions|setFogVisibilityDistance]]
[[Category:Game Patch 2.9.10|setFogVisibilityDistance]]

DCS func setFogVisibilityDistance

2024-12-02T04:15:27Z

Grimes: Created page with "{{Template:dcs_funcs |fName= setFogVisibilityDistance |vNum= 2.9.10 |par1= world.weather |par2= |par3= |par4= |desc= Sets the maximum visibili..."

{{Template:dcs_funcs

|fName= setFogVisibilityDistance

|vNum= 2.9.10

|par1= [[DCS_singleton_world|world.weather]]

|par2=

|par3=

|par4=

|desc= Sets the maximum visibility at sea level in meters.

Limit: 100 to 100000

|rtnType=

|rtnExample=

|reqType1=

|reqName1=

|reqType2=

|reqName2=

|reqType5=

|optType1=

|optName1=

|optType2=

|examples=

|related=
[[DCS_singleton_world|'''World Functions:''']] {{ListOfWorldFuncs}}

|notes=
}}

[[Category:Singleton Functions|setFogVisibilityDistance]]
[[Category:Game Patch 2.9.10|setFogVisibilityDistance]]

DCS func getFogVisibilityDistance

2024-12-02T04:10:59Z

Grimes: Created page with "{{Template:dcs_funcs |fName= getFogVisibilityDistance |vNum= 2.9.10 |par1= world.weather |par2= |par3= |par4= |desc= Gets the maximum visibili..."

{{Template:dcs_funcs

|fName= getFogVisibilityDistance

|vNum= 2.9.10

|par1= [[DCS_singleton_world|world.weather]]

|par2=

|par3=

|par4=

|desc= Gets the maximum visibility distance of the current fog setting.

Returns 0 if no fog is present.

|rtnType= number

|rtnExample= 1337

|reqType1=

|reqName1=

|reqType2=

|reqName2=

|reqType5=

|optType1=

|optName1=

|optType2=

|examples=

|related=
[[DCS_singleton_world|'''World Functions:''']] {{ListOfWorldFuncs}}

|notes=
}}

[[Category:Singleton Functions|getFogVisibilityDistance]]
[[Category:Game Patch 2.9.10|getFogVisibilityDistance]]

DCS func setFogThickness

2024-12-02T04:03:50Z

Grimes:

{{Template:dcs_funcs

|fName= setFogThickness

|vNum= 2.9.10

|par1= [[DCS_singleton_world|world.weather]]

|par2=

|par3=

|par4=

|desc= Sets the fog to the desired thickness in meters at sea level. Any fog animation will be discarded.

Valid range : 100 to 5000

If 0 is passed to the function the fog will be removed.

|rtnType=

|rtnExample=

|reqType1= number

|reqName1= thiccness

|reqType2=

|reqName2=

|reqType5=

|optType1=

|optName1=

|optType2=

|examples= The following sets the fog to a random value between 1000 and 3000 meter visibility.

world.weather.setFogThickness(math.random(1000, 3000))

|related=
[[DCS_singleton_world|'''World Functions:''']] {{ListOfWorldFuncs}}

|notes=
}}

[[Category:Singleton Functions|setFogThickness]]
[[Category:Game Patch 2.9.10|setFogThickness]]

DCS func getFogThickness

2024-12-02T04:03:36Z

Grimes:

{{Template:dcs_funcs

|fName= getFogThickness

|vNum= 2.9.10

|par1= [[DCS_singleton_world|world.weather]]

|par2=

|par3=

|par4=

|desc= Returns the current fog thickness in meters. Returns zero if fog is not present.

|rtnType= number

|rtnExample= 55

|reqType1=

|reqName1=

|reqType2=

|reqName2=

|reqType5=

|optType1=

|optName1=

|optType2=

|examples=

|related=
[[DCS_singleton_world|'''World Functions:''']] {{ListOfWorldFuncs}}

|notes=
}}

[[Category:Singleton Functions|getFogThickness]]
[[Category:Game Patch 2.9.10|getFogThickness]]

Template:ListOfWorldFuncs

2024-12-02T04:02:39Z

Grimes:

[[DCS_func_addEventHandler|addEventHandler]], [[DCS_func_removeEventHandler|removeEventHandler]], [[DCS_func_getPlayer|getPlayer]], [[DCS_func_getAirbases|getAirbases]], [[DCS_func_searchObjects|searchObjects]], [[DCS_func_getMarkPanels|getMarkPanels]], [[DCS_func_removeJunk|removeJunk]]

'''world.weather'''
[[DCS_func_getFogThickness|getFogThickness]], [[DCS_func_setFogThickness|setFogThickness]],
[[DCS_func_getFogVisibilityDistance|getFogVisibilityDistance]], [[DCS_func_setFogVisibilityDistance|setFogVisibilityDistance]], [[DCS_func_setFogAnimation|setFogAnimation]]

DCS singleton world

2024-12-02T04:02:07Z

Grimes:

{{Template:DCSscriptingSingleton

|cName= world

|vNum= 1.2.0

|desc= The world singleton contains functions centered around two different but extremely useful functions.
1. Events and event handlers are all governed within world.

'''Event Types:''' {{listOfEvents}}

2. A number of functions to get information about the game world.

2A. In DCS 2.9.10 a few functions governing fog were added to a weather table within the world singleton. These functions currently control and get information on fog in mission.

|funcs= {{listOfWorldFuncs}}

|enums=

The event enumerator defines all of the types of events that can occur.

{{DCS_enum_events}}

The birthplace enumerator is used to define where an aircraft or helicopter has spawned in association with [[DCS_event_birth|birth]]

world.BirthPlace = {
wsBirthPlace_Air,
wsBirthPlace_RunWay,
wsBirthPlace_Park,
wsBirthPlace_Heliport_Hot,
wsBirthPlace_Heliport_Cold,
}

The volumeType enumerator defines the types of 3d geometery used within the [[DCS_func_searchObjects|world.searchObjects]] function
world.VolumeType = {
SEGMENT,
BOX,
SPHERE,
PYRAMID
}
{{listOfVolumes}}

|notes=
2.5.5 Inserted S_EVENT_DETAILED_FAILURE into id 17.
2.5.6 Added S_EVENT_KILL, S_EVENT_SCORE , S_EVENT_UNIT_LOST , S_EVENT_LANDING_AFTER_EJECTION , -- Redacted for now. And changed S_EVENT_MAX to 33,

2.7.1? - 2.7.12 added events 38 through 45.

2.8.0 added events 46-48.

2.9.0 added 51-56

2.9.6 Moved and renamed some events, added other events to max list at 61

}}
[[Category:Game Patch 1.2.0|world singleton]]

DCS func setFogThickness

2024-12-02T03:58:50Z

Grimes: Created page with "{{Template:dcs_funcs |fName= setFogThickness |vNum= 2.9.10 |par1= world |par2= |par3= |par4= |desc= Sets the fog to the desired thickness in m..."

{{Template:dcs_funcs

|fName= setFogThickness

|vNum= 2.9.10

|par1= [[DCS_singleton_world|world]]

|par2=

|par3=

|par4=

|desc= Sets the fog to the desired thickness in meters at sea level. Any fog animation will be discarded.

Valid range : 100 to 5000

If 0 is passed to the function the fog will be removed.

|rtnType=

|rtnExample=

|reqType1= number

|reqName1= thiccness

|reqType2=

|reqName2=

|reqType5=

|optType1=

|optName1=

|optType2=

|examples= The following sets the fog to a random value between 1000 and 3000 meter visibility.

world.weather.setFogThickness(math.random(1000, 3000))

|related=
[[DCS_singleton_world|'''World Functions:''']] {{ListOfWorldFuncs}}

|notes=
}}

[[Category:Singleton Functions|setFogThickness]]
[[Category:Game Patch 2.9.10|setFogThickness]]

DCS func getFogThickness

2024-12-02T03:54:15Z

Grimes: Created page with "{{Template:dcs_funcs |fName= getFogThickness |vNum= 2.9.10 |par1= world |par2= |par3= |par4= |desc= Returns the current fog thickness in meter..."

{{Template:dcs_funcs

|fName= getFogThickness

|vNum= 2.9.10

|par1= [[DCS_singleton_world|world]]

|par2=

|par3=

|par4=

|desc= Returns the current fog thickness in meters. Returns zero if fog is not present.

|rtnType= number

|rtnExample= 55

|reqType1=

|reqName1=

|reqType2=

|reqName2=

|reqType5=

|optType1=

|optName1=

|optType2=

|examples=

|related=
[[DCS_singleton_world|'''World Functions:''']] {{ListOfWorldFuncs}}

|notes=
}}

[[Category:Singleton Functions|getFogThickness]]
[[Category:Game Patch 2.9.10|getFogThickness]]

Template:ListOfWorldFuncs

2024-12-02T03:50:08Z

Grimes:

[[DCS_func_addEventHandler|addEventHandler]], [[DCS_func_removeEventHandler|removeEventHandler]], [[DCS_func_getPlayer|getPlayer]], [[DCS_func_getAirbases|getAirbases]], [[DCS_func_searchObjects|searchObjects]], [[DCS_func_getMarkPanels|getMarkPanels]], [[DCS_func_removeJunk|removeJunk]]

'''world.weather'''
[[DCS_func_getFogThickness|getFogThickness]], [[DCS_func_setFogThickness|setFogThickness]],
[[DCS_func_getFogVisibilityDistance|getFogVisibilityDistance]], [[DCS_func_setFogVisibilityDistanc|setFogVisibilityDistanc]], [[DCS_func_setFogThickness|setFogThickness]], [[DCS_func_setFogAnimation|setFogAnimation]]

MIST getHeadingPoints

2024-10-13T22:33:47Z

Grimes:

{{Mission Scripting

|fName= mist.utils.getHeadingPoints|

|vNum = Mist 4.5

|desc= Returns the heading from the first point to the second point in radians. If the optional corrected value is passed then the heading will be corrected for any north offset. Use this optional value if you are giving a heading direction for a player to follow with their avionics. Do not pass it if you are using this function to get the orientation for AI.

|rtnType= number

|reqType1= table

|reqName1= point1

|reqType2= table

|reqName2= point2

|reqType3=

|optType1= boolean

|optName1= corrected

|optType2=

|varExamples= point1 = vec2 or vec3

point2 = vec2 or vec3

|rtnExamples= 1.34674373

|example= The following example could be used when spawning a JTAC so that it is facing toward the group it is setup to designate.

heading = mist.utils.getHeadingPoints(jtacPoint, targetPoint)

|notes=

|funcs= {{listOfMistVectors}}

}}
[[Category: MIST|getHeadingPoints]]

MIST groundPatrolRoute

2024-10-12T01:30:19Z

Grimes:

{{Mission Scripting

|fName= mist.ground.patrolRoute

|vNum = Mist 3.2

|desc= This function will re-assign a route for groupName once the group reaches the end if its route.

|rtnType= nothing

|reqType1= table

|reqName1= vars

|reqType2=

|reqName2=

|reqType3=

|reqName3=

|reqType4=

|reqName4=

|reqType5=

|reqName5=

|optType1=

|optName1=

|optType2=

|optName2=

|optType3=

|optName3=

|optType4=

|optName4=

|optType5=

|optName5=

|varExamples= {{varsTable

|r1T= string/table
|r1N= groupName/groupTable

|r2T=
|r2N=

|r3T=
|r3N=

|r4T=
|r4N=

|r5T=
|r5N=

|r6T=
|r6N=

|o1T= string/table
|o1N= useGroupRoute/route

|o2T= number
|o2N= speed

|o3T= string
|o3N= offRoadForm

|o4T= string
|o4N= onRoadForm

|o5T= string
|o5N= patrolType

|o6N=

|r1D= is a Group class table of the group (Group.getByName('myGroup')) or a string of the groups name.
|r2D=
|r3D=
|r4D=
|r5D=
|r6D=

|o1D= Is an optional variable to define which route is to be used.
If neither value is given the route used will be the default route defined by the mission editor for the group set to patrol

useGroupRoute is the name of the group from which the patrol route will be used.

route is a table of route data that overrides the useGroupRoute variable to define the route used.
|o2D= is the speed in meters per second that the group will travel at. If not provided the speed of each waypoint as defined in the editor is used. If speed is invalid the default value of 6 meters per second is used.
|o3D= specifies the formation used while off road enroute to the waypoint. Offroad formations default to the formation "cone" as defined in mist.ground.buildWP.
|o4D= specifies the formation used for waypoints specified as "on road".
|o5D= specifies the type of patrol used.
doubleBack - Group follows the route in the order of 1, 2, 3, 2, 1, 2, 3, 2, ...
nil or anything - Group follows route, when route is finish group travels back to WP 1: 1, 2, 3, 1, 2, 3, 1, ...

}}

|rtnExamples= nothing

|example= <code>
do
local vars = {}
vars.gpData = 'myGroup',
vars.useGroupRoute = 'dummyPatrolRoute'
vars.offRoadForm = 'diamond'
vars.pType = 'doubleBack'
mist.ground.patrolRoute(vars)
end

do
mist.ground.patrolRoute({gpData = 'myGroup', pType = 'doubleBack', offRoadForm = 'diamond'})

end
</code>

|notes=

|funcs= {{listOfMistGroupOrders}}

}}
[[Category: MIST|groundPatrolRoute]]

Category:Terrain Information

2024-09-10T21:20:28Z

Grimes:

DCS func getZone

2024-09-06T01:48:09Z

Grimes:

{{Template:dcs_funcs

|fName= getZone

|vNum= 1.2.0

|par1= [[DCS_singleton_trigger|trigger.misc]]

|par2=

|par3=

|par4=

|desc= Returns a trigger zone table of a given name.

For more information on the zone table you can [[Miz_mission_structure#Triggers| parse the miz]] file to find the table for the zone.

|rtnType= table

|rtnExample= ZoneTable Format

TriggerZone = {
point = Vec3,
radius = Distance
}

|reqType1= string

|reqName1= zoneName

|reqType2=

|reqName2=

|optType1=

|optType2=

|examples=

local zone = trigger.misc.getZone('shortBusStop')
trigger.action.outText('The Radius of the bus stop zone is: ' .. zone.radius, 20)

|related=
[[DCS_singleton_trigger|'''Trigger Functions:''']] {{ListOfTriggerFuncs}}
|notes= If it is a quad zone then it will not return any information on the points.
}}
[[Category:Singleton Functions|getZone]]
[[Category:Game Patch 1.2.0|getZone]]

DCS func addCommandForGroup

2024-09-05T23:02:58Z

Grimes:

{{Template:dcs_funcs

|fName= addCommandForGroup

|vNum= 1.2.4

|par1= [[DCS_singleton_missionCommands|missionCommands]]

|par2=

|par3=

|par4=

|desc= Adds a command to the "F10 Other" radio menu allowing players to run specified scripting functions. Command is added for the specified groupId. The string name is the text that will be displayed in the F10 Other menu and is also used in the function to remove the command from the menu.

Path is an optional value that defines whether or not the command will be in a named submenu.

FunctionToCall is the name of the function, with the optional argument value designating any passed values.

|rtnType= table

|rtnExample= none

|reqType1= number

|reqName1= groupId

|reqType2= string

|reqName2= name

|reqType3= table/nil

|reqName3= path

|reqType4= function

|reqName4= functionToRun

|reqType5=

|optType1= any

|optName1= anyArguement

|optType2=

|examples= The following iterates the table, finds their groupIds, and passes the groupName to the imLost function whenever someone from the group selects the F10 choice.
local function imLost(gName)
-- whatever
end
local tbl = {'group1', 'group2', 'group3', 'group4' ,'group5'}
for i = 1, #tbl do
if Group.getByName(tbl[i]) then
local groupId = Group.getByName(tbl[i]):getID()
missionCommands.addCommandForGroup(groupId, 'Halp', nil , imLost, tbl[i])
end
end
|related=
[[DCS_singleton_missionCommands|'''missionCommands Functions:''']] {{listOfMissionCommandFuncs}}
|notes= See page on [[DCS_func_addCommand|missionCommands.addCommand]] on information for the path and more examples.
}}
[[Category:Singleton Functions|addCommandForGroup]]
[[Category:Game Patch 1.2.4|addCommandForGroup]]

DCS func addCommand

2024-09-05T23:02:45Z

Grimes:

{{Template:dcs_funcs

|fName= addCommand

|vNum= 1.2.4

|par1= [[DCS_singleton_missionCommands|missionCommands]]

|par2=

|par3=

|par4=

|desc= Adds a command to the "F10 Other" radio menu allowing players to run specified scripting functions. Command is added for both teams. The string name is the text that will be displayed in the F10 Other menu and is also used in the function to remove the command from the menu.

Path is an optional value that defines whether or not the command will be in a named submenu.

FunctionToCall is the name of the function, with the optional argument value designating any passed values.

|rtnType= table

|rtnExample= Function returns a table indexed numerically indicating where in the F10 menu the command resides.

{
[1] = "Negative Ghostrider",
}

{
[1] = "SubMenuInRoot",
[2] = "Command in the submenu",
}

{
[1] = "SubMenuInRoot",
[2] = "SubMenuInSubMenu",
[3] = "Command in nested submenu",
}

|reqType1= string

|reqName1= name

|reqType2= table/nil

|reqName2= path

|reqType3= function

|reqName3= functionToRun

|reqType4=

|optType1= any

|optName1= anyArguement

|optType2=

|examples=
The sample below will generate a base menu accessed via F10 called "Display Requests" for all users with two sub-items for a negative or positive response

local function displayMsg(vars)
if vars.flyby == true then
trigger.action.outText("Roger that Ghostrider, you may do a flyby.", 20)
else
trigger.action.outText("Negative Ghostrider, the pattern is full", 20)
end
end
local displayRequests = missionCommands.addSubMenu( "Display Requests")
local negativeReply = missionCommands.addCommand( "Negative Ghostrider", displayRequests , displayMsg, {flyby = false})
local positiveReply = missionCommands.addCommand( "Roger Ghostrider", displayRequests , displayMsg, {flyby = true})

|related=
[[DCS_singleton_missionCommands|'''missionCommands Functions:''']] {{listOfMissionCommandFuncs}}
|notes=
}}
[[Category:Singleton Functions|addCommand]]
[[Category:Game Patch 1.2.4|addCommand]]

DCS event runway touch

2024-08-09T22:44:12Z

Grimes:

{{Template:DCS_events

|eName=RUNWAY_TOUCH

|vNum= 2.9.6

|id = 55

|desc= Occurs the moment when the player aircraft aircraft lands at an airbase, farp or ship.

Initiator : The unit that has landed

place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships

|form= The shot event table is in the following format.

Event = {
id = 4,
time = Time,
initiator = [[DCS_Class_Unit|Unit]],
place = [[DCS_Class_Airbase|Airbase]],
subPlace = 0
}

|exam=

|notes= DCS 2.9.6 changed the functionality of the [[DCS_event_takeoff|takeoff]] and [[DCS_event_land|land]] event effectively applying their previous behavior to [[DCS_event_runway_takeoff|runway_takeoff]], [[DCS_event_runway_touch|runway_touch]].

For example an aircraft that "bolters" a landing on the aircraft carrier will now call runway touch, runway takeoff rather than land and takeoff.

}}
[[Category:Game Patch 2.9.6|event runway touch]]

DCS event runway takeoff

2024-08-09T22:43:27Z

Grimes:

{{Template:DCS_events

|eName=RUNWAY_TAKEOFF

|vNum= 2.9.6

|id = 54

|desc= Occurs when an aircraft leaves the ground and takes off.

Initiator : The unit that tookoff

place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

|form= The takeoff event table is in the following format.

Event = {
id = 54,
time = Time,
initiator = [[DCS_Class_Unit|Unit]],
place = [[DCS_Class_Airbase|Airbase]],
subPlace = 0
}

|exam=

|notes= DCS 2.9.6 changed the functionality of the [[DCS_event_takeoff|takeoff]] and [[DCS_event_land|land]] event effectively applying their previous behavior to [[DCS_event_runway_takeoff|runway_takeoff]], [[DCS_event_runway_touch|runway_touch]].

For example an aircraft that "bolters" a landing on the aircraft carrier will now call runway touch, runway takeoff rather than land and takeoff.

}}
[[Category:Game Patch 2.9.6|event runway takeoff]]

DCS event runway takeoff

2024-08-09T22:43:15Z

Grimes:

DCS event land

2024-08-09T22:38:58Z

Grimes:

{{Template:DCS_events

|eName=LAND

|vNum= 1.2.4

|id = 4

|desc= Occurs when an aircraft lands at an airbase, farp or ship and sufficiently slows down.

Initiator : The unit that has landed

place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships

|form= The shot event table is in the following format.

Event = {
id = 4,
time = Time,
initiator = [[DCS_Class_Unit|Unit]],
place = [[DCS_Class_Airbase|Airbase]],
subPlace = 0
}

|exam=

|notes= DCS 2.9.6 changed the functionality of the [[DCS_event_takeoff|takeoff]] and [[DCS_event_land|land]] event effectively applying their previous behavior to [[DCS_event_runway_takeoff|runway_takeoff]], [[DCS_event_runway_touch|runway_touch]].

Use [[DCS_event_runway_touch|runway_touch]] for the event related to the exact moment when an aircraft touches the ground after being airborne.

}}
[[Category:Game Patch 1.2.4|event land]]

DCS event takeoff

2024-08-09T22:36:32Z

Grimes:

{{Template:DCS_events

|eName=TAKEOFF

|vNum= 1.2.4

|id = 3

|desc= Occurs when an aircraft takes off from an airbase, farp, or ship. Occurs several seconds after take-off.

Initiator : The unit that tookoff

place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

|form= The takeoff event table is in the following format.

Event = {
id = 3,
time = Time,
initiator = [[DCS_Class_Unit|Unit]],
place = [[DCS_Class_Airbase|Airbase]],
subPlace = 0
}

|exam=

|notes= DCS 2.9.6 changed the functionality of the [[DCS_event_takeoff|takeoff]] and [[DCS_event_land|land]] event effectively applying their previous behavior to [[DCS_event_runway_takeoff|runway_takeoff]], [[DCS_event_runway_touch|runway_touch]].

Use [[DCS_event_runway_takeoff|runway_takeoff]] for the event related to the exact moment when an aircraft is no longer on the ground.

}}
[[Category:Game Patch 1.2.4|event takeoff]]

DCS event takeoff

2024-08-09T22:33:51Z

Grimes:

{{Template:DCS_events

|eName=TAKEOFF

|vNum= 1.2.4

|id = 3

|desc= Occurs when an aircraft takes off from an airbase, farp, or ship. Occurs several seconds after take-off.

Initiator : The unit that tookoff

place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

|form= The takeoff event table is in the following format.

Event = {
id = 3,
time = Time,
initiator = [[DCS_Class_Unit|Unit]],
place = [[DCS_Class_Airbase|Airbase]],
subPlace = 0
}

|exam=

|notes= DCS 2.9.6 changed the functionality of the [[DCS_event_takeoff|takeoff]] and [[DCS_event_land|land]] event effectively applying their previous behavior to [[DCS_event_runway_takeoff|runway_takeoff]], [[DCS_event_runway_touch|runway_touch].

Use [[DCS_event_runway_takeoff|runway_takeoff]] for the event related to the exact moment when an aircraft is no longer on the ground.

}}
[[Category:Game Patch 1.2.4|event takeoff]]

Template:DCS events

2024-07-25T23:54:52Z

Grimes:

__NOTOC__

{|class="wikitable" width="1080" style="border-style:hidden"
|-style="border-style:hidden"
|width="125" style="text-align:right"| Event: 
|width="750" colspan="2"| '''S_EVENT_{{{eName}}}'''
|style="text-align:right"| Added with: {{{vNum}}}

|-
|height="10" width="1080" style="border-style:hidden" colspan="4" bgcolor="LightBlue"|
|-style="border-style:hidden"
|style="text-align:right" | Enum ID:
|width="550" colspan="2" | {{{id}}}
|style="text-align:right" |Event Locality: {{#ifexist:{{{local}}}|{{{local}}}|None}}
|-style="border-style:hidden"
|-style="vertical-align:top"
|style="text-align:right" height="100"| Description:
|width="550" colspan="3" |{{{desc}}}

|-
|height="20" colspan="4" bgcolor="LightBlue"|
|-style="vertical-align:top"
|style="text-align:right"|Table Format:
|height="100" colspan="3" |{{{form}}}

|-
|height="10" colspan="4" bgcolor="LightBlue"|

|-
|style="text-align:right; vertical-align:top"|Examples:
|colspan="3"|{{{exam}}}
|-
|style="text-align:right"|Notes:
|colspan="3"|{{{notes}}}

|-
|style="text-align:right"|Events:
|colspan="3"|{{listOfEvents}}
|}

[[Category:Scripting|{{{eName}}}]]
[[Category:Events|{{{eName}}}]]

<noinclude>[[Category:Templates|{{PAGENAME}}]]</noinclude>

Template:DCS events

2024-07-25T23:54:04Z

Grimes:

__NOTOC__

{|class="wikitable" width="1080" style="border-style:hidden"
|-style="border-style:hidden"
|width="125" style="text-align:right"| Event: 
|width="750" colspan="2"| '''S_EVENT_{{{eName}}}'''
|style="text-align:right"| Added with: {{{vNum}}}

|-
|height="10" width="1080" style="border-style:hidden" colspan="4" bgcolor="LightBlue"|
|-style="border-style:hidden"
|style="text-align:right" | Enum ID:
|width="550" colspan="2" | {{{id}}}
|style="text-align:right" |Event Locality: {{#if:{{{local}}}|{{{local}}}|None}}
|-style="border-style:hidden"
|-style="vertical-align:top"
|style="text-align:right" height="100"| Description:
|width="550" colspan="3" |{{{desc}}}

|-
|height="20" colspan="4" bgcolor="LightBlue"|
|-style="vertical-align:top"
|style="text-align:right"|Table Format:
|height="100" colspan="3" |{{{form}}}

|-
|height="10" colspan="4" bgcolor="LightBlue"|

|-
|style="text-align:right; vertical-align:top"|Examples:
|colspan="3"|{{{exam}}}
|-
|style="text-align:right"|Notes:
|colspan="3"|{{{notes}}}

|-
|style="text-align:right"|Events:
|colspan="3"|{{listOfEvents}}
|}

[[Category:Scripting|{{{eName}}}]]
[[Category:Events|{{{eName}}}]]

<noinclude>[[Category:Templates|{{PAGENAME}}]]</noinclude>

Template:DCS events

2024-07-25T23:50:25Z

Grimes:

Template:DCS events

2024-07-25T23:47:25Z

Grimes:

__NOTOC__

{|class="wikitable" width="1080" style="border-style:hidden"
|-style="border-style:hidden"
|width="125" style="text-align:right"| Event: 
|width="750" colspan="2"| '''S_EVENT_{{{eName}}}'''
|style="text-align:right"| Added with: {{{vNum}}}

|-
|height="10" width="1080" style="border-style:hidden" colspan="4" bgcolor="LightBlue"|
|-style="border-style:hidden"
|style="text-align:right" | Enum ID:
|width="550" colspan="2" | {{{id}}}
|style="text-align:right" |Event Locality: {{#ifexist:{{{local}}}|{{{local}}}|All}}
|-style="border-style:hidden"
|-style="vertical-align:top"
|style="text-align:right" height="100"| Description:
|width="550" colspan="3" |{{{desc}}}

|-
|height="20" colspan="4" bgcolor="LightBlue"|
|-style="vertical-align:top"
|style="text-align:right"|Table Format:
|height="100" colspan="3" |{{{form}}}

|-
|height="10" colspan="4" bgcolor="LightBlue"|

|-
|style="text-align:right; vertical-align:top"|Examples:
|colspan="3"|{{{exam}}}
|-
|style="text-align:right"|Notes:
|colspan="3"|{{{notes}}}

|-
|style="text-align:right"|Events:
|colspan="3"|{{listOfEvents}}
|}

[[Category:Scripting|{{{eName}}}]]
[[Category:Events|{{{eName}}}]]

<noinclude>[[Category:Templates|{{PAGENAME}}]]</noinclude>

DCS event player enter unit

2024-07-25T23:47:14Z

Grimes:

{{Template:DCS_events

|eName=PLAYER_ENTER_UNIT

|vNum= 1.2.4

|id = 20
|local= local
|desc=Occurs when any player assumes direct control of a unit.

Initiator : The unit that is being taken control of.

|form= The PLAYER ENTER UNIT event table is in the following format.

Event = {
id = 20,
time = Time,
initiator = Unit,
}

|exam=

|notes= As of DCS 1.5 this event should now correctly fire for any player/clients entering a Combined Arms unit.

ID moved from 19 to 20 sometime during patch 2.5.5.

}}
[[Category:Game Patch 1.2.4|event player enter unit]]