Module Functional.ATC_Ground
Functional - Monitor airbase traffic and regulate speed while taxiing.
Features:
- Monitor speed of the airplanes of players during taxi.
- Communicate ATC ground operations.
- Kick speeding players during taxi.
Missions: None
Contributions: Dutch Baron - Concept & Testing
Author: FlightControl - Framework Design & Programming
Refactoring to use the Runway auto-detection: Applevangelist
Global(s)
Global ATC_GROUND |
[DEPRECATED, use ATC_GROUND_UNIVERSAL] Base class for ATC_GROUND implementations. |
[DEPRECATED, use ATC_GROUND_UNIVERSAL] Base class for ATC_GROUND implementations.
Global ATC_GROUND_CAUCASUS |
ATC_GROUND_CAUCASUS, extends #ATC_GROUND_UNIVERSALThe ATC_GROUND_CAUCASUS class monitors the speed of the airplanes at the airbase during taxi. |
ATC_GROUND_CAUCASUS, extends #ATC_GROUND_UNIVERSAL
The ATC_GROUND_CAUCASUS class monitors the speed of the airplanes at the airbase during taxi.
The pilots may not drive faster than the maximum speed for the airbase, or they will be despawned.
The default maximum speed for the airbases at Caucasus is 50 km/h. Warnings are given if this speed limit is trespassed. Players will be immediately kicked when driving faster than 150 km/h on the taxi way.
The pilot will receive 3 times a warning during speeding. After the 3rd warning, if the pilot is still driving faster than the maximum allowed speed, the pilot will be kicked.
Different airbases have different maximum speeds, according safety regulations.
Airbases monitored
The following airbases are monitored at the Caucasus region. Use the Wrapper.Airbase#AIRBASE.Caucasus enumeration to select the airbases to be monitored.
AIRBASE.Caucasus.Anapa_VityazevoAIRBASE.Caucasus.BatumiAIRBASE.Caucasus.BeslanAIRBASE.Caucasus.GelendzhikAIRBASE.Caucasus.GudautaAIRBASE.Caucasus.KobuletiAIRBASE.Caucasus.Krasnodar_CenterAIRBASE.Caucasus.Krasnodar_PashkovskyAIRBASE.Caucasus.KrymskAIRBASE.Caucasus.KutaisiAIRBASE.Caucasus.Maykop_KhanskayaAIRBASE.Caucasus.Mineralnye_VodyAIRBASE.Caucasus.MozdokAIRBASE.Caucasus.NalchikAIRBASE.Caucasus.NovorossiyskAIRBASE.Caucasus.Senaki_KolkhiAIRBASE.Caucasus.Sochi_AdlerAIRBASE.Caucasus.SoganlugAIRBASE.Caucasus.Sukhumi_BabusharaAIRBASE.Caucasus.Tbilisi_LochiniAIRBASE.Caucasus.Vaziani
Installation
In Single Player Missions
ATC_GROUND is fully functional in single player.
In Multi Player Missions
ATC_GROUND is functional in multi player, however ...
Due to a bug in DCS since release 1.5, the despawning of clients are not anymore working in multi player. To work around this problem, a much better solution has been made, using the slot blocker script designed by Ciribob.
With the help of Ciribob, this script has been extended to also kick client players while in flight. ATC_GROUND is communicating with this modified script to kick players!
Install the file SimpleSlotBlockGameGUI.lua on the server, following the installation instructions described by Ciribob.
Simple Slot Blocker from Ciribob & FlightControl
Script it!
1. ATC_GROUND_CAUCASUS Constructor
Creates a new ATC_GROUND_CAUCASUS object that will monitor pilots taxiing behaviour.
-- This creates a new ATC_GROUND_CAUCASUS object.
-- Monitor all the airbases.
ATC_Ground = ATC_GROUND_CAUCASUS:New()
-- Monitor specific airbases only.
ATC_Ground = ATC_GROUND_CAUCASUS:New(
{ AIRBASE.Caucasus.Gelendzhik,
AIRBASE.Caucasus.Krymsk
}
)
2. Set various options
There are various methods that you can use to tweak the behaviour of the ATC_GROUND classes.
2.1 Speed limit at an airbase.
- ATC_GROUND.SetKickSpeed(): Set the speed limit allowed at an airbase in meters per second.
- ATC_GROUND.SetKickSpeedKmph(): Set the speed limit allowed at an airbase in kilometers per hour.
- ATC_GROUND.SetKickSpeedMiph(): Set the speed limit allowed at an airbase in miles per hour.
2.2 Prevent Takeoff at an airbase. Players will be kicked immediately.
- ATC_GROUND.SetMaximumKickSpeed(): Set the maximum speed allowed at an airbase in meters per second.
- ATC_GROUND.SetMaximumKickSpeedKmph(): Set the maximum speed allowed at an airbase in kilometers per hour.
- ATC_GROUND.SetMaximumKickSpeedMiph(): Set the maximum speed allowed at an airbase in miles per hour.
Global ATC_GROUND_MARIANAISLANDS |
ATC_GROUND_MARIANA, extends #ATC_GROUNDThe ATC_GROUND_MARIANA class monitors the speed of the airplanes at the airbase during taxi. |
ATC_GROUND_MARIANA, extends #ATC_GROUND
The ATC_GROUND_MARIANA class monitors the speed of the airplanes at the airbase during taxi.
The pilots may not drive faster than the maximum speed for the airbase, or they will be despawned.
The default maximum speed for the airbases at Persian Gulf is 50 km/h. Warnings are given if this speed limit is trespassed. Players will be immediately kicked when driving faster than 150 km/h on the taxi way.
The ATC_GROUND_MARIANA class monitors the speed of the airplanes at the airbase during taxi. The pilots may not drive faster than the maximum speed for the airbase, or they will be despawned.
The pilot will receive 3 times a warning during speeding. After the 3rd warning, if the pilot is still driving faster than the maximum allowed speed, the pilot will be kicked.
Different airbases have different maximum speeds, according safety regulations.
Airbases monitored
The following airbases are monitored at the Mariana Island region. Use the Wrapper.Airbase#AIRBASE.MarianaIslands enumeration to select the airbases to be monitored.
- AIRBASE.MarianaIslands.Rota_Intl
- AIRBASE.MarianaIslands.Andersen_AFB
- AIRBASE.MarianaIslands.Antonio_B_Won_Pat_Intl
- AIRBASE.MarianaIslands.Saipan_Intl
- AIRBASE.MarianaIslands.Tinian_Intl
- AIRBASE.MarianaIslands.Olf_Orote
Installation
In Single Player Missions
ATC_GROUND is fully functional in single player.
In Multi Player Missions
ATC_GROUND is functional in multi player, however ...
Due to a bug in DCS since release 1.5, the despawning of clients are not anymore working in multi player. To work around this problem, a much better solution has been made, using the slot blocker script designed by Ciribob.
With the help of Ciribob, this script has been extended to also kick client players while in flight. ATC_GROUND is communicating with this modified script to kick players!
Install the file SimpleSlotBlockGameGUI.lua on the server, following the installation instructions described by Ciribob.
Simple Slot Blocker from Ciribob & FlightControl
Script it!
1. ATC_GROUND_MARIANAISLANDS Constructor
Creates a new ATC_GROUND_MARIANAISLANDS object that will monitor pilots taxiing behaviour.
-- This creates a new ATC_GROUND_MARIANAISLANDS object.
-- Monitor for these clients the airbases.
AirbasePoliceCaucasus = ATC_GROUND_MARIANAISLANDS:New()
ATC_Ground = ATC_GROUND_MARIANAISLANDS:New(
{ AIRBASE.MarianaIslands.Andersen_AFB,
AIRBASE.MarianaIslands.Saipan_Intl
}
)
2. Set various options
There are various methods that you can use to tweak the behaviour of the ATC_GROUND classes.
2.1 Speed limit at an airbase.
- ATC_GROUND.SetKickSpeed(): Set the speed limit allowed at an airbase in meters per second.
- ATC_GROUND.SetKickSpeedKmph(): Set the speed limit allowed at an airbase in kilometers per hour.
- ATC_GROUND.SetKickSpeedMiph(): Set the speed limit allowed at an airbase in miles per hour.
2.2 Prevent Takeoff at an airbase. Players will be kicked immediately.
- ATC_GROUND.SetMaximumKickSpeed(): Set the maximum speed allowed at an airbase in meters per second.
- ATC_GROUND.SetMaximumKickSpeedKmph(): Set the maximum speed allowed at an airbase in kilometers per hour.
- ATC_GROUND.SetMaximumKickSpeedMiph(): Set the maximum speed allowed at an airbase in miles per hour.
Global ATC_GROUND_NEVADA |
ATC_GROUND_NEVADA, extends #ATC_GROUNDThe ATC_GROUND_NEVADA class monitors the speed of the airplanes at the airbase during taxi. |
ATC_GROUND_NEVADA, extends #ATC_GROUND
The ATC_GROUND_NEVADA class monitors the speed of the airplanes at the airbase during taxi.
The pilots may not drive faster than the maximum speed for the airbase, or they will be despawned.
The default maximum speed for the airbases at Nevada is 50 km/h. Warnings are given if this speed limit is trespassed. Players will be immediately kicked when driving faster than 150 km/h on the taxi way.
The ATC_GROUND_NEVADA class monitors the speed of the airplanes at the airbase during taxi. The pilots may not drive faster than the maximum speed for the airbase, or they will be despawned.
The pilot will receive 3 times a warning during speeding. After the 3rd warning, if the pilot is still driving faster than the maximum allowed speed, the pilot will be kicked.
Different airbases have different maximum speeds, according safety regulations.
Airbases monitored
The following airbases are monitored at the Nevada region. Use the Wrapper.Airbase#AIRBASE.Nevada enumeration to select the airbases to be monitored.
AIRBASE.Nevada.BeattyAIRBASE.Nevada.Boulder_CityAIRBASE.Nevada.CreechAIRBASE.Nevada.Echo_BayAIRBASE.Nevada.Groom_LakeAIRBASE.Nevada.Henderson_ExecutiveAIRBASE.Nevada.JeanAIRBASE.Nevada.LaughlinAIRBASE.Nevada.Lincoln_CountyAIRBASE.Nevada.McCarran_InternationalAIRBASE.Nevada.MesquiteAIRBASE.Nevada.MinaAIRBASE.Nevada.NellisAIRBASE.Nevada.North_Las_VegasAIRBASE.Nevada.Pahute_MesaAIRBASE.Nevada.TonopahAIRBASE.Nevada.Tonopah_Test_Range
Installation
In Single Player Missions
ATC_GROUND is fully functional in single player.
In Multi Player Missions
ATC_GROUND is functional in multi player, however ...
Due to a bug in DCS since release 1.5, the despawning of clients are not anymore working in multi player. To work around this problem, a much better solution has been made, using the slot blocker script designed by Ciribob.
With the help of Ciribob, this script has been extended to also kick client players while in flight. ATC_GROUND is communicating with this modified script to kick players!
Install the file SimpleSlotBlockGameGUI.lua on the server, following the installation instructions described by Ciribob.
Simple Slot Blocker from Ciribob & FlightControl
Script it!
1. ATC_GROUND_NEVADA Constructor
Creates a new ATC_GROUND_NEVADA object that will monitor pilots taxiing behaviour.
-- This creates a new ATC_GROUND_NEVADA object.
-- Monitor all the airbases.
ATC_Ground = ATC_GROUND_NEVADA:New()
-- Monitor specific airbases.
ATC_Ground = ATC_GROUND_NEVADA:New(
{ AIRBASE.Nevada.Laughlin,
AIRBASE.Nevada.Lincoln_County,
AIRBASE.Nevada.North_Las_Vegas,
AIRBASE.Nevada.McCarran_International
}
)
2. Set various options
There are various methods that you can use to tweak the behaviour of the ATC_GROUND classes.
2.1 Speed limit at an airbase.
- ATC_GROUND.SetKickSpeed(): Set the speed limit allowed at an airbase in meters per second.
- ATC_GROUND.SetKickSpeedKmph(): Set the speed limit allowed at an airbase in kilometers per hour.
- ATC_GROUND.SetKickSpeedMiph(): Set the speed limit allowed at an airbase in miles per hour.
2.2 Prevent Takeoff at an airbase. Players will be kicked immediately.
- ATC_GROUND.SetMaximumKickSpeed(): Set the maximum speed allowed at an airbase in meters per second.
- ATC_GROUND.SetMaximumKickSpeedKmph(): Set the maximum speed allowed at an airbase in kilometers per hour.
- ATC_GROUND.SetMaximumKickSpeedMiph(): Set the maximum speed allowed at an airbase in miles per hour.
Global ATC_GROUND_NORMANDY |
ATC_GROUND_NORMANDY, extends #ATC_GROUNDThe ATC_GROUND_NORMANDY class monitors the speed of the airplanes at the airbase during taxi. |
ATC_GROUND_NORMANDY, extends #ATC_GROUND
The ATC_GROUND_NORMANDY class monitors the speed of the airplanes at the airbase during taxi.
The pilots may not drive faster than the maximum speed for the airbase, or they will be despawned.
The default maximum speed for the airbases at Normandy is 40 km/h. Warnings are given if this speed limit is trespassed. Players will be immediately kicked when driving faster than 100 km/h on the taxi way.
The ATC_GROUND_NORMANDY class monitors the speed of the airplanes at the airbase during taxi. The pilots may not drive faster than the maximum speed for the airbase, or they will be despawned.
The pilot will receive 3 times a warning during speeding. After the 3rd warning, if the pilot is still driving faster than the maximum allowed speed, the pilot will be kicked.
Different airbases have different maximum speeds, according safety regulations.
Airbases monitored
The following airbases are monitored at the Normandy region. Use the Wrapper.Airbase#AIRBASE.Normandy enumeration to select the airbases to be monitored.
AIRBASE.Normandy.AzevilleAIRBASE.Normandy.BazenvilleAIRBASE.Normandy.Beny_sur_MerAIRBASE.Normandy.BeuzevilleAIRBASE.Normandy.BinivilleAIRBASE.Normandy.BruchevilleAIRBASE.Normandy.CardonvilleAIRBASE.Normandy.CarpiquetAIRBASE.Normandy.ChaileyAIRBASE.Normandy.ChippelleAIRBASE.Normandy.CrettevilleAIRBASE.Normandy.Cricqueville_en_BessinAIRBASE.Normandy.Deux_JumeauxAIRBASE.Normandy.EvreuxAIRBASE.Normandy.FordAIRBASE.Normandy.FuntingtonAIRBASE.Normandy.LantheuilAIRBASE.Normandy.Le_MolayAIRBASE.Normandy.LessayAIRBASE.Normandy.LignerollesAIRBASE.Normandy.Longues_sur_MerAIRBASE.Normandy.MaupertusAIRBASE.Normandy.MeautisAIRBASE.Normandy.Needs_Oar_PointAIRBASE.Normandy.PicauvilleAIRBASE.Normandy.RucquevilleAIRBASE.Normandy.Saint_Pierre_du_MontAIRBASE.Normandy.Sainte_Croix_sur_MerAIRBASE.Normandy.Sainte_Laurent_sur_MerAIRBASE.Normandy.SommervieuAIRBASE.Normandy.TangmereAIRBASE.Normandy.ArgentanAIRBASE.Normandy.GouletAIRBASE.Normandy.EssayAIRBASE.Normandy.HauteriveAIRBASE.Normandy.BarvilleAIRBASE.Normandy.ConchesAIRBASE.Normandy.Vrigny
Installation
In Single Player Missions
ATC_GROUND is fully functional in single player.
In Multi Player Missions
ATC_GROUND is functional in multi player, however ...
Due to a bug in DCS since release 1.5, the despawning of clients are not anymore working in multi player. To work around this problem, a much better solution has been made, using the slot blocker script designed by Ciribob.
With the help of Ciribob, this script has been extended to also kick client players while in flight. ATC_GROUND is communicating with this modified script to kick players!
Install the file SimpleSlotBlockGameGUI.lua on the server, following the installation instructions described by Ciribob.
Simple Slot Blocker from Ciribob & FlightControl
Script it!
1. ATC_GROUND_NORMANDY Constructor
Creates a new ATC_GROUND_NORMANDY object that will monitor pilots taxiing behaviour.
-- This creates a new ATC_GROUND_NORMANDY object.
-- Monitor for these clients the airbases.
AirbasePoliceCaucasus = ATC_GROUND_NORMANDY:New()
ATC_Ground = ATC_GROUND_NORMANDY:New(
{ AIRBASE.Normandy.Chippelle,
AIRBASE.Normandy.Beuzeville
}
)
2. Set various options
There are various methods that you can use to tweak the behaviour of the ATC_GROUND classes.
2.1 Speed limit at an airbase.
- ATC_GROUND.SetKickSpeed(): Set the speed limit allowed at an airbase in meters per second.
- ATC_GROUND.SetKickSpeedKmph(): Set the speed limit allowed at an airbase in kilometers per hour.
- ATC_GROUND.SetKickSpeedMiph(): Set the speed limit allowed at an airbase in miles per hour.
2.2 Prevent Takeoff at an airbase. Players will be kicked immediately.
- ATC_GROUND.SetMaximumKickSpeed(): Set the maximum speed allowed at an airbase in meters per second.
- ATC_GROUND.SetMaximumKickSpeedKmph(): Set the maximum speed allowed at an airbase in kilometers per hour.
- ATC_GROUND.SetMaximumKickSpeedMiph(): Set the maximum speed allowed at an airbase in miles per hour.
Global ATC_GROUND_PERSIANGULF |
ATC_GROUND_PERSIANGULF, extends #ATC_GROUNDThe ATC_GROUND_PERSIANGULF class monitors the speed of the airplanes at the airbase during taxi. |
ATC_GROUND_PERSIANGULF, extends #ATC_GROUND
The ATC_GROUND_PERSIANGULF class monitors the speed of the airplanes at the airbase during taxi.
The pilots may not drive faster than the maximum speed for the airbase, or they will be despawned.
The default maximum speed for the airbases at Persian Gulf is 50 km/h. Warnings are given if this speed limit is trespassed. Players will be immediately kicked when driving faster than 150 km/h on the taxi way.
The ATC_GROUND_PERSIANGULF class monitors the speed of the airplanes at the airbase during taxi. The pilots may not drive faster than the maximum speed for the airbase, or they will be despawned.
The pilot will receive 3 times a warning during speeding. After the 3rd warning, if the pilot is still driving faster than the maximum allowed speed, the pilot will be kicked.
Different airbases have different maximum speeds, according safety regulations.
Airbases monitored
The following airbases are monitored at the PersianGulf region. Use the Wrapper.Airbase#AIRBASE.PersianGulf enumeration to select the airbases to be monitored.
AIRBASE.PersianGulf.Abu_Musa_IslandAIRBASE.PersianGulf.Al_Dhafra_AFBAIRBASE.PersianGulf.Al_Maktoum_IntlAIRBASE.PersianGulf.Al_Minhad_AFBAIRBASE.PersianGulf.Bandar_Abbas_IntlAIRBASE.PersianGulf.Bandar_LengehAIRBASE.PersianGulf.Dubai_IntlAIRBASE.PersianGulf.Fujairah_IntlAIRBASE.PersianGulf.HavadaryaAIRBASE.PersianGulf.KermanAIRBASE.PersianGulf.KhasabAIRBASE.PersianGulf.LarAIRBASE.PersianGulf.Qeshm_IslandAIRBASE.PersianGulf.Sharjah_IntlAIRBASE.PersianGulf.Shiraz_IntlAIRBASE.PersianGulf.Sir_Abu_NuayrAIRBASE.PersianGulf.Sirri_IslandAIRBASE.PersianGulf.Tunb_Island_AFBAIRBASE.PersianGulf.Tunb_KochakAIRBASE.PersianGulf.Sas_Al_NakheelAIRBASE.PersianGulf.Bandar_e_JaskAIRBASE.PersianGulf.Abu_Dhabi_IntlAIRBASE.PersianGulf.Al_BateenAIRBASE.PersianGulf.Kish_IntlAIRBASE.PersianGulf.Al_Ain_IntlAIRBASE.PersianGulf.Lavan_IslandAIRBASE.PersianGulf.Jiroft
Installation
In Single Player Missions
ATC_GROUND is fully functional in single player.
In Multi Player Missions
ATC_GROUND is functional in multi player, however ...
Due to a bug in DCS since release 1.5, the despawning of clients are not anymore working in multi player. To work around this problem, a much better solution has been made, using the slot blocker script designed by Ciribob.
With the help of Ciribob, this script has been extended to also kick client players while in flight. ATC_GROUND is communicating with this modified script to kick players!
Install the file SimpleSlotBlockGameGUI.lua on the server, following the installation instructions described by Ciribob.
Simple Slot Blocker from Ciribob & FlightControl
Script it!
1. ATC_GROUND_PERSIANGULF Constructor
Creates a new ATC_GROUND_PERSIANGULF object that will monitor pilots taxiing behaviour.
-- This creates a new ATC_GROUND_PERSIANGULF object.
-- Monitor for these clients the airbases.
AirbasePoliceCaucasus = ATC_GROUND_PERSIANGULF:New()
ATC_Ground = ATC_GROUND_PERSIANGULF:New(
{ AIRBASE.PersianGulf.Kerman,
AIRBASE.PersianGulf.Al_Minhad_AFB
}
)
2. Set various options
There are various methods that you can use to tweak the behaviour of the ATC_GROUND classes.
2.1 Speed limit at an airbase.
- ATC_GROUND.SetKickSpeed(): Set the speed limit allowed at an airbase in meters per second.
- ATC_GROUND.SetKickSpeedKmph(): Set the speed limit allowed at an airbase in kilometers per hour.
- ATC_GROUND.SetKickSpeedMiph(): Set the speed limit allowed at an airbase in miles per hour.
2.2 Prevent Takeoff at an airbase. Players will be kicked immediately.
- ATC_GROUND.SetMaximumKickSpeed(): Set the maximum speed allowed at an airbase in meters per second.
- ATC_GROUND.SetMaximumKickSpeedKmph(): Set the maximum speed allowed at an airbase in kilometers per hour.
- ATC_GROUND.SetMaximumKickSpeedMiph(): Set the maximum speed allowed at an airbase in miles per hour.
Global ATC_GROUND_UNIVERSAL |
Base class for ATC_GROUND_UNIVERSAL implementations. |
Global SSB |
This is simple slot blocker is used on the server.
Type(s)
| Fields and Methods inherited from ATC_GROUND | Description |
|---|---|
|
[DEPRECATED, use ATC_GROUND_UNIVERSAL] Creates a new ATC_GROUND object. |
|
|
Set the maximum speed in meters per second (Mps) until the player gets kicked. |
|
|
Set the maximum speed in Kmph until the player gets kicked. |
|
|
Set the maximum speed in Miph until the player gets kicked. |
|
|
Set the maximum kick speed in meters per second (Mps) until the player gets kicked. |
|
ATC_GROUND:SetMaximumKickSpeedKmph(MaximumKickSpeed, Airbase) |
Set the maximum kick speed in kilometers per hour (Kmph) until the player gets kicked. |
ATC_GROUND:SetMaximumKickSpeedMiph(MaximumKickSpeedMiph, Airbase) |
Set the maximum kick speed in miles per hour (Miph) until the player gets kicked. |
|
Smoke the airbases runways. |
|
| Fields and Methods inherited from BASE | Description |
|---|---|
|
The ID number of the class. |
|
|
The name of the class. |
|
|
The name of the class concatenated with the ID number of the class. |
|
|
Clear the state of an object. |
|
ATC_GROUND:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) |
Creation of a Birth Event. |
ATC_GROUND:CreateEventCrash(EventTime, Initiator, IniObjectCategory) |
Creation of a Crash Event. |
ATC_GROUND:CreateEventDead(EventTime, Initiator, IniObjectCategory) |
Creation of a Dead Event. |
|
Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event. |
|
|
Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event. |
|
|
Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event. |
|
|
Creation of a S_EVENT_NEW_DYNAMIC_CARGO event. |
|
|
Creation of a |
|
|
Creation of a Remove Unit Event. |
|
|
Creation of a Takeoff Event. |
|
|
Creation of a Crash Event. |
|
|
Log an exception which will be traced always. |
|
|
Returns the event dispatcher |
|
|
Remove all subscribed events |
|
|
Trace a function call. |
|
|
Trace a function call level 2. |
|
|
Trace a function call level 3. |
|
|
Get the ClassID of the class instance. |
|
|
Get the ClassName of the class instance. |
|
|
Get the ClassName + ClassID of the class instance. |
|
|
Get the Class Core.Event processing Priority. |
|
|
This is the worker method to retrieve the Parent class. |
|
|
Get a Value given a Key from the Object. |
|
|
Subscribe to a DCS Event. |
|
|
Log an information which will be traced always. |
|
|
This is the worker method to inherit from a parent class. |
|
|
This is the worker method to check if an object is an (sub)instance of a class. |
|
|
Enquires if tracing is on (for the class). |
|
|
BASE constructor. |
|
|
Occurs when an Event for an object is triggered. |
|
|
BDA. |
|
|
Occurs when a ground unit captures either an airbase or a farp. |
|
|
Occurs when any object is spawned into the mission. |
|
|
Occurs when any aircraft crashes into the ground and is completely destroyed. |
|
|
Occurs when an object is dead. |
|
|
Unknown precisely what creates this event, likely tied into newer damage model. |
|
|
Discard chair after ejection. |
|
|
Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo. |
|
|
Occurs when a dynamic cargo crate is removed. |
|
|
Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo. |
|
|
Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs when any aircraft shuts down its engines. |
|
|
Occurs when any aircraft starts its engines. |
|
|
Occurs whenever an object is hit by a weapon. |
|
|
Occurs when any system fails on a human controlled aircraft. |
|
|
Occurs on the death of a unit. |
|
|
Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up. |
|
|
Landing quality mark. |
|
|
Occurs when a new mark was added. |
|
|
Occurs when a mark text was changed. |
|
|
Occurs when a mark was removed. |
|
|
Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs when a player creates a dynamic cargo object from the F8 ground crew menu. |
|
|
Weapon add. |
|
|
Occurs when the pilot of an aircraft is killed. |
|
|
Occurs when a player enters a slot and takes control of an aircraft. |
|
|
Occurs when any player assumes direct control of a unit. |
|
|
Occurs when any player relieves control of a unit to the AI. |
|
|
Occurs when an aircraft connects with a tanker and begins taking on fuel. |
|
|
Occurs when an aircraft is finished taking fuel. |
|
|
Occurs when any modification to the "Score" as seen on the debrief menu would occur. |
|
|
Occurs when any unit stops firing its weapon. |
|
|
Occurs when any unit begins firing a weapon that has a high rate of fire. |
|
|
Occurs whenever any unit in a mission fires a weapon. |
|
|
Occurs when an aircraft takes off from an airbase, farp, or ship. |
|
|
Trigger zone. |
|
|
Occurs when the game thinks an object is destroyed. |
|
|
Schedule a new time event. |
|
ATC_GROUND:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...) |
Schedule a new time event. |
|
Stops the Schedule. |
|
|
Set the Class Core.Event processing Priority. |
|
|
Set a state or property of the Object given a Key and a Value. |
|
|
Trace a function logic level 1. |
|
|
Trace a function logic level 2. |
|
|
Trace a function logic level 3. |
|
|
Trace all methods in MOOSE |
|
|
Set tracing for a class |
|
|
Set tracing for a specific method of class |
|
|
Set trace level |
|
|
Set trace off. |
|
|
Set trace on. |
|
|
Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default. |
|
|
UnSubscribe to a DCS event. |
|
ATC_GROUND:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function call. |
|
(Internal) Serialize arguments |
|
ATC_GROUND:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function logic. |
|
The main event handling function... |
| Fields and Methods inherited from ATC_GROUND_CAUCASUS | Description |
|---|---|
|
Creates a new ATC_GROUND_CAUCASUS object. |
|
|
Start SCHEDULER for ATC_GROUND_CAUCASUS object. |
| Fields and Methods inherited from ATC_GROUND_MARIANAISLANDS | Description |
|---|---|
|
Creates a new ATC_GROUND_MARIANAISLANDS object. |
|
|
Start SCHEDULER for ATC_GROUND_MARIANAISLANDS object. |
| Fields and Methods inherited from ATC_GROUND_NEVADA | Description |
|---|---|
|
Creates a new ATC_GROUND_NEVADA object. |
|
|
Start SCHEDULER for ATC_GROUND_NEVADA object. |
| Fields and Methods inherited from ATC_GROUND_NORMANDY | Description |
|---|---|
|
Creates a new ATC_GROUND_NORMANDY object. |
|
|
Start SCHEDULER for ATC_GROUND_NORMANDY object. |
| Fields and Methods inherited from ATC_GROUND_PERSIANGULF | Description |
|---|---|
|
Creates a new ATC_GROUND_PERSIANGULF object. |
|
|
Start SCHEDULER for ATC_GROUND_PERSIANGULF object. |
| Fields and Methods inherited from ATC_GROUND_UNIVERSAL | Description |
|---|---|
|
Draw the airbases boundaries. |
|
|
Draw the airbases runways. |
|
|
Creates a new ATC_GROUND_UNIVERSAL object. |
|
|
Add a specific Airbase Boundary if you don't want to use the round zone that is auto-created. |
|
|
Set the maximum speed in meters per second (Mps) until the player gets kicked. |
|
|
Set the maximum speed in Kmph until the player gets kicked. |
|
ATC_GROUND_UNIVERSAL:SetKickSpeedMiph(KickSpeedMiph, Airbase) |
Set the maximum speed in Miph until the player gets kicked. |
ATC_GROUND_UNIVERSAL:SetMaximumKickSpeed(MaximumKickSpeed, Airbase) |
Set the maximum kick speed in meters per second (Mps) until the player gets kicked. |
ATC_GROUND_UNIVERSAL:SetMaximumKickSpeedKmph(MaximumKickSpeed, Airbase) |
Set the maximum kick speed in kilometers per hour (Kmph) until the player gets kicked. |
ATC_GROUND_UNIVERSAL:SetMaximumKickSpeedMiph(MaximumKickSpeedMiph, Airbase) |
Set the maximum kick speed in miles per hour (Miph) until the player gets kicked. |
|
Smoke the airbases runways. |
|
|
Start SCHEDULER for ATC_GROUND_UNIVERSAL object. |
|
|
[Internal] Monitoring function |
| Fields and Methods inherited from BASE | Description |
|---|---|
|
The ID number of the class. |
|
|
The name of the class. |
|
|
The name of the class concatenated with the ID number of the class. |
|
|
Clear the state of an object. |
|
ATC_GROUND_UNIVERSAL:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) |
Creation of a Birth Event. |
ATC_GROUND_UNIVERSAL:CreateEventCrash(EventTime, Initiator, IniObjectCategory) |
Creation of a Crash Event. |
ATC_GROUND_UNIVERSAL:CreateEventDead(EventTime, Initiator, IniObjectCategory) |
Creation of a Dead Event. |
ATC_GROUND_UNIVERSAL:CreateEventDynamicCargoLoaded(DynamicCargo) |
Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event. |
ATC_GROUND_UNIVERSAL:CreateEventDynamicCargoRemoved(DynamicCargo) |
Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event. |
ATC_GROUND_UNIVERSAL:CreateEventDynamicCargoUnloaded(DynamicCargo) |
Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event. |
ATC_GROUND_UNIVERSAL:CreateEventNewDynamicCargo(DynamicCargo) |
Creation of a S_EVENT_NEW_DYNAMIC_CARGO event. |
ATC_GROUND_UNIVERSAL:CreateEventPlayerEnterAircraft(PlayerUnit) |
Creation of a |
ATC_GROUND_UNIVERSAL:CreateEventRemoveUnit(EventTime, Initiator) |
Creation of a Remove Unit Event. |
ATC_GROUND_UNIVERSAL:CreateEventTakeoff(EventTime, Initiator) |
Creation of a Takeoff Event. |
ATC_GROUND_UNIVERSAL:CreateEventUnitLost(EventTime, Initiator) |
Creation of a Crash Event. |
|
Log an exception which will be traced always. |
|
|
Returns the event dispatcher |
|
|
Remove all subscribed events |
|
|
Trace a function call. |
|
|
Trace a function call level 2. |
|
|
Trace a function call level 3. |
|
|
Get the ClassID of the class instance. |
|
|
Get the ClassName of the class instance. |
|
|
Get the ClassName + ClassID of the class instance. |
|
|
Get the Class Core.Event processing Priority. |
|
|
This is the worker method to retrieve the Parent class. |
|
|
Get a Value given a Key from the Object. |
|
|
Subscribe to a DCS Event. |
|
|
Log an information which will be traced always. |
|
|
This is the worker method to inherit from a parent class. |
|
|
This is the worker method to check if an object is an (sub)instance of a class. |
|
|
Enquires if tracing is on (for the class). |
|
|
BASE constructor. |
|
|
Occurs when an Event for an object is triggered. |
|
|
BDA. |
|
|
Occurs when a ground unit captures either an airbase or a farp. |
|
|
Occurs when any object is spawned into the mission. |
|
|
Occurs when any aircraft crashes into the ground and is completely destroyed. |
|
|
Occurs when an object is dead. |
|
|
Unknown precisely what creates this event, likely tied into newer damage model. |
|
ATC_GROUND_UNIVERSAL:OnEventDiscardChairAfterEjection(EventData) |
Discard chair after ejection. |
|
Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo. |
|
|
Occurs when a dynamic cargo crate is removed. |
|
|
Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo. |
|
|
Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs when any aircraft shuts down its engines. |
|
|
Occurs when any aircraft starts its engines. |
|
|
Occurs whenever an object is hit by a weapon. |
|
|
Occurs when any system fails on a human controlled aircraft. |
|
|
Occurs on the death of a unit. |
|
|
Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up. |
|
|
Landing quality mark. |
|
|
Occurs when a new mark was added. |
|
|
Occurs when a mark text was changed. |
|
|
Occurs when a mark was removed. |
|
|
Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs when a player creates a dynamic cargo object from the F8 ground crew menu. |
|
|
Weapon add. |
|
|
Occurs when the pilot of an aircraft is killed. |
|
|
Occurs when a player enters a slot and takes control of an aircraft. |
|
|
Occurs when any player assumes direct control of a unit. |
|
|
Occurs when any player relieves control of a unit to the AI. |
|
|
Occurs when an aircraft connects with a tanker and begins taking on fuel. |
|
|
Occurs when an aircraft is finished taking fuel. |
|
|
Occurs when any modification to the "Score" as seen on the debrief menu would occur. |
|
|
Occurs when any unit stops firing its weapon. |
|
|
Occurs when any unit begins firing a weapon that has a high rate of fire. |
|
|
Occurs whenever any unit in a mission fires a weapon. |
|
|
Occurs when an aircraft takes off from an airbase, farp, or ship. |
|
|
Trigger zone. |
|
|
Occurs when the game thinks an object is destroyed. |
|
ATC_GROUND_UNIVERSAL:ScheduleOnce(Start, SchedulerFunction, ...) |
Schedule a new time event. |
ATC_GROUND_UNIVERSAL:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...) |
Schedule a new time event. |
|
Stops the Schedule. |
|
|
Set the Class Core.Event processing Priority. |
|
|
Set a state or property of the Object given a Key and a Value. |
|
|
Trace a function logic level 1. |
|
|
Trace a function logic level 2. |
|
|
Trace a function logic level 3. |
|
|
Trace all methods in MOOSE |
|
|
Set tracing for a class |
|
|
Set tracing for a specific method of class |
|
|
Set trace level |
|
|
Set trace off. |
|
|
Set trace on. |
|
|
Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default. |
|
|
UnSubscribe to a DCS event. |
|
ATC_GROUND_UNIVERSAL:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function call. |
|
(Internal) Serialize arguments |
|
ATC_GROUND_UNIVERSAL:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function logic. |
|
The main event handling function... |
Field(s)
Kickspeed
Function(s)
[DEPRECATED, use ATC_GROUND_UNIVERSAL] Creates a new ATC_GROUND object.
Defined in:
ATC_GROUND
Parameters:
Airbases
A table of Airbase Names.
AirbaseList
Return value:
self
Set the maximum speed in meters per second (Mps) until the player gets kicked.
An airbase can be specified to set the kick speed for.
Defined in:
ATC_GROUND
Parameters:
#number KickSpeed
The speed in Mps.
Wrapper.Airbase#AIRBASE Airbase
(optional) The airbase to set the kick speed for.
Return value:
self
Usage:
-- Declare Atc_Ground using one of those, depending on the map.
Atc_Ground = ATC_GROUND_CAUCAUS:New()
Atc_Ground = ATC_GROUND_NEVADA:New()
Atc_Ground = ATC_GROUND_NORMANDY:New()
Atc_Ground = ATC_GROUND_PERSIANGULF:New()
-- Then use one of these methods...
Atc_Ground:SetKickSpeed( UTILS.KmphToMps( 80 ) ) -- Kick the players at 80 kilometers per hour
Atc_Ground:SetKickSpeed( UTILS.MiphToMps( 100 ) ) -- Kick the players at 100 miles per hour
Atc_Ground:SetKickSpeed( 24 ) -- Kick the players at 24 meters per second ( 24 * 3.6 = 86.4 kilometers per hour )
Set the maximum speed in Kmph until the player gets kicked.
Defined in:
ATC_GROUND
Parameters:
#number KickSpeed
Set the speed in Kmph.
Wrapper.Airbase#AIRBASE Airbase
(optional) The airbase to set the kick speed for.
Return value:
self
Atc_Ground:SetKickSpeedKmph( 80 ) -- Kick the players at 80 kilometers per hour
Set the maximum speed in Miph until the player gets kicked.
Defined in:
ATC_GROUND
Parameters:
#number KickSpeedMiph
Set the speed in Mph.
Wrapper.Airbase#AIRBASE Airbase
(optional) The airbase to set the kick speed for.
Return value:
self
Atc_Ground:SetKickSpeedMiph( 100 ) -- Kick the players at 100 miles per hour
Set the maximum kick speed in meters per second (Mps) until the player gets kicked.
There are no warnings given if this speed is reached, and is to prevent players to take off from the airbase! An airbase can be specified to set the maximum kick speed for.
Defined in:
ATC_GROUND
Parameters:
#number MaximumKickSpeed
The speed in Mps.
Wrapper.Airbase#AIRBASE Airbase
(optional) The airbase to set the kick speed for.
Return value:
self
Usage:
-- Declare Atc_Ground using one of those, depending on the map.
Atc_Ground = ATC_GROUND_CAUCAUS:New()
Atc_Ground = ATC_GROUND_NEVADA:New()
Atc_Ground = ATC_GROUND_NORMANDY:New()
Atc_Ground = ATC_GROUND_PERSIANGULF:New()
-- Then use one of these methods...
Atc_Ground:SetMaximumKickSpeed( UTILS.KmphToMps( 80 ) ) -- Kick the players at 80 kilometers per hour
Atc_Ground:SetMaximumKickSpeed( UTILS.MiphToMps( 100 ) ) -- Kick the players at 100 miles per hour
Atc_Ground:SetMaximumKickSpeed( 24 ) -- Kick the players at 24 meters per second ( 24 * 3.6 = 86.4 kilometers per hour )
Set the maximum kick speed in kilometers per hour (Kmph) until the player gets kicked.
There are no warnings given if this speed is reached, and is to prevent players to take off from the airbase! An airbase can be specified to set the maximum kick speed for.
Defined in:
ATC_GROUND
Parameters:
#number MaximumKickSpeed
Set the speed in Kmph.
Wrapper.Airbase#AIRBASE Airbase
(optional) The airbase to set the kick speed for.
Return value:
self
Atc_Ground:SetMaximumKickSpeedKmph( 150 ) -- Kick the players at 150 kilometers per hour
Set the maximum kick speed in miles per hour (Miph) until the player gets kicked.
There are no warnings given if this speed is reached, and is to prevent players to take off from the airbase! An airbase can be specified to set the maximum kick speed for.
Defined in:
ATC_GROUND
Parameters:
#number MaximumKickSpeedMiph
Set the speed in Mph.
Wrapper.Airbase#AIRBASE Airbase
(optional) The airbase to set the kick speed for.
Return value:
self
Atc_Ground:SetMaximumKickSpeedMiph( 100 ) -- Kick the players at 100 miles per hour
Smoke the airbases runways.
Defined in:
ATC_GROUND
Parameter:
Utilities.Utils#SMOKECOLOR SmokeColor
The color of the smoke around the runways.
Return value:
self
Field(s)
Kickspeed
Function(s)
Clear the state of an object.
Defined in:
Parameters:
Object
The object that holds the Value set by the Key.
StateName
The key that is should be cleared.
Creation of a Birth Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
#string IniUnitName
The initiating unit name.
place
subplace
Creation of a Crash Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
IniObjectCategory
Creation of a Dead Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
IniObjectCategory
Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.
Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.
Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.
Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.
Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.
Creation of a Remove Unit Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
Creation of a Takeoff Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
Creation of a Crash Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
Log an exception which will be traced always.
Can be anywhere within the function logic.
Returns the event dispatcher
Remove all subscribed events
Trace a function call.
Must be at the beginning of the function logic.
Trace a function call level 2.
Must be at the beginning of the function logic.
Trace a function call level 3.
Must be at the beginning of the function logic.
Get the ClassID of the class instance.
Get the ClassName of the class instance.
Get the ClassName + ClassID of the class instance.
The ClassName + ClassID is formatted as '%s#%09d'.
Get the Class Core.Event processing Priority.
The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.
This is the worker method to retrieve the Parent class.
Note that the Parent class must be passed to call the parent class method.
self:GetParent(self):ParentMethod()
Get a Value given a Key from the Object.
Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.
Defined in:
Parameters:
Object
The object that holds the Value set by the Key.
Key
The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!
Return value:
The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.
Subscribe to a DCS Event.
Defined in:
Parameters:
Core.Event#EVENTS EventID
Event ID.
#function EventFunction
(optional) The function to be called when the event occurs for the unit.
Return value:
Log an information which will be traced always.
Can be anywhere within the function logic.
This is the worker method to inherit from a parent class.
Defined in:
Parameters:
Child
is the Child class that inherits.
#BASE Parent
is the Parent class that the Child inherits from.
Return value:
Child
This is the worker method to check if an object is an (sub)instance of a class.
Examples:
ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false
Defined in:
Parameter:
ClassName
is the name of the class or the class itself to run the check against
Return value:
#boolean:
Enquires if tracing is on (for the class).
BASE constructor.
This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.
function EVENT:New()
local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
return self
end
Occurs when an Event for an object is triggered.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that triggered the event.
Occurs when a ground unit captures either an airbase or a farp.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.
Occurs when any object is spawned into the mission.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was spawned
Occurs when any aircraft crashes into the ground and is completely destroyed.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that has crashed
Occurs when an object is dead.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is dead.
Unknown precisely what creates this event, likely tied into newer damage model.
Will update this page when new information become available.
- initiator: The unit that had the failure.
Discard chair after ejection.
Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Occurs when a dynamic cargo crate is removed.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.
initiator : The unit that has ejected
Occurs when any aircraft shuts down its engines.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is stopping its engines.
Occurs when any aircraft starts its engines.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is starting its engines.
Occurs whenever an object is hit by a weapon.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.
Occurs when any system fails on a human controlled aircraft.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that had the failure
Occurs on the death of a unit.
Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs. Have a look at the class Core.Event#EVENT as these are just the prototypes.
- initiator: The unit that killed the target
- target: Target Object
- weapon: Weapon Object
Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes.
initiator : The unit that has landed place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships
Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.
Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker. Have a look at the class Core.Event#EVENT as these are just the prototypes.
- initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
- place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
- subplace: is always 0 for unknown reasons.
Occurs when a new mark was added.
Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.
Occurs when a mark text was changed.
Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.
Occurs when a mark was removed.
Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.
Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Weapon add.
Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted. Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when the pilot of an aircraft is killed.
Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the pilot has died in.
Occurs when a player enters a slot and takes control of an aircraft.
Have a look at the class Core.Event#EVENT as these are just the prototypes. NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. initiator : The unit that is being taken control of.
Occurs when any player assumes direct control of a unit.
Note - not Mulitplayer safe. Use PlayerEnterAircraft. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is being taken control of.
Occurs when any player relieves control of a unit to the AI.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the player left.
Occurs when an aircraft connects with a tanker and begins taking on fuel.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is receiving fuel.
Occurs when an aircraft is finished taking fuel.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was receiving fuel.
Occurs when any modification to the "Score" as seen on the debrief menu would occur.
There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard. Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when any unit stops firing its weapon.
Event will always correspond with a shooting start event. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was doing the shooting.
Occurs when any unit begins firing a weapon that has a high rate of fire.
Most common with aircraft cannons (GAU-8), autocannons, and machine guns. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is doing the shooting. target: The unit that is being targeted.
Occurs whenever any unit in a mission fires a weapon.
But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when an aircraft takes off from an airbase, farp, or ship.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships
Occurs when the game thinks an object is destroyed.
Have a look at the class Core.Event#EVENT as these are just the prototypes.
- initiator: The unit that is was destroyed.
Schedule a new time event.
Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.
Defined in:
Parameters:
#number Start
Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.
#function SchedulerFunction
The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
#table ...
Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
Return value:
#string:
The Schedule ID of the planned schedule.
Schedule a new time event.
Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.
Defined in:
Parameters:
#number Start
Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.
#number Repeat
Specifies the interval in seconds when the scheduler will call the event function.
#number RandomizeFactor
Specifies a randomization factor between 0 and 1 to randomize the Repeat.
#number Stop
Specifies the amount of seconds when the scheduler will be stopped.
#function SchedulerFunction
The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
#table ...
Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
Return value:
#string:
The Schedule ID of the planned schedule.
Stops the Schedule.
Defined in:
Parameter:
#string SchedulerID
(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.
Set the Class Core.Event processing Priority.
The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.
Set a state or property of the Object given a Key and a Value.
Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.
Defined in:
Parameters:
Object
The object that will hold the Value set by the Key.
Key
The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!
Value
The value to is stored in the object.
Return value:
The Value set.
Trace a function logic level 1.
Can be anywhere within the function logic.
Trace a function logic level 2.
Can be anywhere within the function logic.
Trace a function logic level 3.
Can be anywhere within the function logic.
Trace all methods in MOOSE
Set tracing for a class
Set tracing for a specific method of class
Set trace off.
Set trace on.
Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.
So tracing must be switched on manually in your mission if you are using Moose statically. When moose is loading dynamically (for moose class development), tracing is switched on by default.
Defined in:
Parameter:
#boolean TraceOnOff
Switch the tracing on or off.
Usage:
-- Switch the tracing On
BASE:TraceOnOff( true )
-- Switch the tracing Off
BASE:TraceOnOff( false )
UnSubscribe to a DCS event.
Trace a function call.
This function is private.
Defined in:
Parameters:
Arguments
A #table or any field.
DebugInfoCurrentParam
DebugInfoFromParam
(Internal) Serialize arguments
Trace a function logic.
Defined in:
Parameters:
Arguments
A #table or any field.
DebugInfoCurrentParam
DebugInfoFromParam
The main event handling function...
This function captures all events generated for the class.
Field(s)
Function(s)
Creates a new ATC_GROUND_CAUCASUS object.
Defined in:
ATC_GROUND_CAUCASUS
Parameter:
AirbaseNames
A list {} of airbase names (Use AIRBASE.Caucasus enumerator).
Return value:
self
Start SCHEDULER for ATC_GROUND_CAUCASUS object.
Defined in:
ATC_GROUND_CAUCASUS
Parameter:
RepeatScanSeconds
Time in second for defining occurency of alerts.
Return value:
nothing
Field(s)
Function(s)
Creates a new ATC_GROUND_MARIANAISLANDS object.
Defined in:
ATC_GROUND_MARIANAISLANDS
Parameter:
AirbaseNames
A list {} of airbase names (Use AIRBASE.MarianaIslands enumerator).
Return value:
Start SCHEDULER for ATC_GROUND_MARIANAISLANDS object.
Defined in:
ATC_GROUND_MARIANAISLANDS
Parameter:
RepeatScanSeconds
Time in second for defining occurency of alerts.
Return value:
nothing
Field(s)
Function(s)
Creates a new ATC_GROUND_NEVADA object.
Defined in:
ATC_GROUND_NEVADA
Parameter:
AirbaseNames
A list {} of airbase names (Use AIRBASE.Nevada enumerator).
Return value:
self
Start SCHEDULER for ATC_GROUND_NEVADA object.
Defined in:
ATC_GROUND_NEVADA
Parameter:
RepeatScanSeconds
Time in second for defining occurency of alerts.
Return value:
nothing
Field(s)
Function(s)
Creates a new ATC_GROUND_NORMANDY object.
Defined in:
ATC_GROUND_NORMANDY
Parameter:
AirbaseNames
A list {} of airbase names (Use AIRBASE.Normandy enumerator).
Return value:
self
Start SCHEDULER for ATC_GROUND_NORMANDY object.
Defined in:
ATC_GROUND_NORMANDY
Parameter:
RepeatScanSeconds
Time in second for defining occurency of alerts.
Return value:
nothing
Field(s)
Function(s)
Creates a new ATC_GROUND_PERSIANGULF object.
Defined in:
ATC_GROUND_PERSIANGULF
Parameter:
AirbaseNames
A list {} of airbase names (Use AIRBASE.PersianGulf enumerator).
Return value:
self
Start SCHEDULER for ATC_GROUND_PERSIANGULF object.
Defined in:
ATC_GROUND_PERSIANGULF
Parameter:
RepeatScanSeconds
Time in second for defining occurency of alerts.
Return value:
nothing
Field(s)
Function(s)
Draw the airbases boundaries.
Defined in:
ATC_GROUND_UNIVERSAL
Parameter:
#table Color
The color of the line around the runways, in RGB, e.g {1,0,0} for red.
Return value:
self
Draw the airbases runways.
Defined in:
ATC_GROUND_UNIVERSAL
Parameter:
#table Color
The color of the line around the runways, in RGB, e.g {1,0,0} for red.
Return value:
self
Creates a new ATC_GROUND_UNIVERSAL object.
This works on any map.
Defined in:
ATC_GROUND_UNIVERSAL
Parameter:
AirbaseList
A table of Airbase Names. Leave empty to cover all airbases of the map.
Return value:
self
Usage:
-- define monitoring for one airbase
local atc=ATC_GROUND_UNIVERSAL:New({AIRBASE.Syria.Gecitkale})
-- set kick speed
atc:SetKickSpeed(UTILS.KnotsToMps(20))
-- start monitoring evey 10 secs
atc:Start(10)Add a specific Airbase Boundary if you don't want to use the round zone that is auto-created.
Defined in:
ATC_GROUND_UNIVERSAL
Parameters:
#string Airbase
The name of the Airbase
Core.Zone#ZONE Zone
The ZONE object to be used, e.g. a ZONE_POLYGON
Return value:
self
Set the maximum speed in meters per second (Mps) until the player gets kicked.
An airbase can be specified to set the kick speed for.
Defined in:
ATC_GROUND_UNIVERSAL
Parameters:
#number KickSpeed
The speed in Mps.
#string Airbase
(optional) The airbase name to set the kick speed for.
Return value:
self
Usage:
-- Declare Atc_Ground
Atc_Ground = ATC_GROUND_UNIVERSAL:New()
-- Then use one of these methods...
Atc_Ground:SetKickSpeed( UTILS.KmphToMps( 80 ) ) -- Kick the players at 80 kilometers per hour
Atc_Ground:SetKickSpeed( UTILS.MiphToMps( 100 ) ) -- Kick the players at 100 miles per hour
Atc_Ground:SetKickSpeed( 24 ) -- Kick the players at 24 meters per second ( 24 * 3.6 = 86.4 kilometers per hour )
Set the maximum speed in Kmph until the player gets kicked.
Defined in:
ATC_GROUND_UNIVERSAL
Parameters:
#number KickSpeed
Set the speed in Kmph.
#string Airbase
(optional) The airbase name to set the kick speed for.
Return value:
self
Atc_Ground:SetKickSpeedKmph( 80 ) -- Kick the players at 80 kilometers per hour
Set the maximum speed in Miph until the player gets kicked.
Defined in:
ATC_GROUND_UNIVERSAL
Parameters:
#number KickSpeedMiph
Set the speed in Mph.
#string Airbase
(optional) The airbase name to set the kick speed for.
Return value:
self
Atc_Ground:SetKickSpeedMiph( 100 ) -- Kick the players at 100 miles per hour
Set the maximum kick speed in meters per second (Mps) until the player gets kicked.
There are no warnings given if this speed is reached, and is to prevent players to take off from the airbase! An airbase can be specified to set the maximum kick speed for.
Defined in:
ATC_GROUND_UNIVERSAL
Parameters:
#number MaximumKickSpeed
The speed in Mps.
#string Airbase
(optional) The airbase name to set the kick speed for.
Return value:
self
Usage:
-- Declare Atc_Ground
Atc_Ground = ATC_GROUND_UNIVERSAL:New()
-- Then use one of these methods...
Atc_Ground:SetMaximumKickSpeed( UTILS.KmphToMps( 80 ) ) -- Kick the players at 80 kilometers per hour
Atc_Ground:SetMaximumKickSpeed( UTILS.MiphToMps( 100 ) ) -- Kick the players at 100 miles per hour
Atc_Ground:SetMaximumKickSpeed( 24 ) -- Kick the players at 24 meters per second ( 24 * 3.6 = 86.4 kilometers per hour )
Set the maximum kick speed in kilometers per hour (Kmph) until the player gets kicked.
There are no warnings given if this speed is reached, and is to prevent players to take off from the airbase! An airbase can be specified to set the maximum kick speed for.
Defined in:
ATC_GROUND_UNIVERSAL
Parameters:
#number MaximumKickSpeed
Set the speed in Kmph.
#string Airbase
(optional) The airbase name to set the kick speed for.
Return value:
self
Atc_Ground:SetMaximumKickSpeedKmph( 150 ) -- Kick the players at 150 kilometers per hour
Set the maximum kick speed in miles per hour (Miph) until the player gets kicked.
There are no warnings given if this speed is reached, and is to prevent players to take off from the airbase! An airbase can be specified to set the maximum kick speed for.
Defined in:
ATC_GROUND_UNIVERSAL
Parameters:
#number MaximumKickSpeedMiph
Set the speed in Mph.
#string Airbase
(optional) The airbase name to set the kick speed for.
Return value:
self
Atc_Ground:SetMaximumKickSpeedMiph( 100 ) -- Kick the players at 100 miles per hour
Smoke the airbases runways.
Defined in:
ATC_GROUND_UNIVERSAL
Parameter:
Utilities.Utils#SMOKECOLOR SmokeColor
The color of the smoke around the runways.
Return value:
self
Start SCHEDULER for ATC_GROUND_UNIVERSAL object.
Defined in:
ATC_GROUND_UNIVERSAL
Parameter:
RepeatScanSeconds
Time in second for defining schedule of alerts.
Return value:
self
[Internal] Monitoring function
Field(s)
Function(s)
Clear the state of an object.
Defined in:
Parameters:
Object
The object that holds the Value set by the Key.
StateName
The key that is should be cleared.
Creation of a Birth Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
#string IniUnitName
The initiating unit name.
place
subplace
Creation of a Crash Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
IniObjectCategory
Creation of a Dead Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
IniObjectCategory
Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.
Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.
Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.
Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.
Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.
Creation of a Remove Unit Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
Creation of a Takeoff Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
Creation of a Crash Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
Log an exception which will be traced always.
Can be anywhere within the function logic.
Returns the event dispatcher
Remove all subscribed events
Trace a function call.
Must be at the beginning of the function logic.
Trace a function call level 2.
Must be at the beginning of the function logic.
Trace a function call level 3.
Must be at the beginning of the function logic.
Get the ClassID of the class instance.
Get the ClassName of the class instance.
Get the ClassName + ClassID of the class instance.
The ClassName + ClassID is formatted as '%s#%09d'.
Get the Class Core.Event processing Priority.
The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.
This is the worker method to retrieve the Parent class.
Note that the Parent class must be passed to call the parent class method.
self:GetParent(self):ParentMethod()
Get a Value given a Key from the Object.
Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.
Defined in:
Parameters:
Object
The object that holds the Value set by the Key.
Key
The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!
Return value:
The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.
Subscribe to a DCS Event.
Defined in:
Parameters:
Core.Event#EVENTS EventID
Event ID.
#function EventFunction
(optional) The function to be called when the event occurs for the unit.
Return value:
Log an information which will be traced always.
Can be anywhere within the function logic.
This is the worker method to inherit from a parent class.
Defined in:
Parameters:
Child
is the Child class that inherits.
#BASE Parent
is the Parent class that the Child inherits from.
Return value:
Child
This is the worker method to check if an object is an (sub)instance of a class.
Examples:
ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false
Defined in:
Parameter:
ClassName
is the name of the class or the class itself to run the check against
Return value:
#boolean:
Enquires if tracing is on (for the class).
BASE constructor.
This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.
function EVENT:New()
local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
return self
end
Occurs when an Event for an object is triggered.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that triggered the event.
Occurs when a ground unit captures either an airbase or a farp.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.
Occurs when any object is spawned into the mission.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was spawned
Occurs when any aircraft crashes into the ground and is completely destroyed.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that has crashed
Occurs when an object is dead.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is dead.
Unknown precisely what creates this event, likely tied into newer damage model.
Will update this page when new information become available.
- initiator: The unit that had the failure.
Discard chair after ejection.
Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Occurs when a dynamic cargo crate is removed.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.
initiator : The unit that has ejected
Occurs when any aircraft shuts down its engines.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is stopping its engines.
Occurs when any aircraft starts its engines.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is starting its engines.
Occurs whenever an object is hit by a weapon.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.
Occurs when any system fails on a human controlled aircraft.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that had the failure
Occurs on the death of a unit.
Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs. Have a look at the class Core.Event#EVENT as these are just the prototypes.
- initiator: The unit that killed the target
- target: Target Object
- weapon: Weapon Object
Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes.
initiator : The unit that has landed place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships
Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.
Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker. Have a look at the class Core.Event#EVENT as these are just the prototypes.
- initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
- place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
- subplace: is always 0 for unknown reasons.
Occurs when a new mark was added.
Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.
Occurs when a mark text was changed.
Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.
Occurs when a mark was removed.
Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.
Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Weapon add.
Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted. Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when the pilot of an aircraft is killed.
Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the pilot has died in.
Occurs when a player enters a slot and takes control of an aircraft.
Have a look at the class Core.Event#EVENT as these are just the prototypes. NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. initiator : The unit that is being taken control of.
Occurs when any player assumes direct control of a unit.
Note - not Mulitplayer safe. Use PlayerEnterAircraft. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is being taken control of.
Occurs when any player relieves control of a unit to the AI.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the player left.
Occurs when an aircraft connects with a tanker and begins taking on fuel.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is receiving fuel.
Occurs when an aircraft is finished taking fuel.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was receiving fuel.
Occurs when any modification to the "Score" as seen on the debrief menu would occur.
There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard. Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when any unit stops firing its weapon.
Event will always correspond with a shooting start event. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was doing the shooting.
Occurs when any unit begins firing a weapon that has a high rate of fire.
Most common with aircraft cannons (GAU-8), autocannons, and machine guns. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is doing the shooting. target: The unit that is being targeted.
Occurs whenever any unit in a mission fires a weapon.
But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when an aircraft takes off from an airbase, farp, or ship.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships
Occurs when the game thinks an object is destroyed.
Have a look at the class Core.Event#EVENT as these are just the prototypes.
- initiator: The unit that is was destroyed.
Schedule a new time event.
Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.
Defined in:
Parameters:
#number Start
Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.
#function SchedulerFunction
The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
#table ...
Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
Return value:
#string:
The Schedule ID of the planned schedule.
Schedule a new time event.
Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.
Defined in:
Parameters:
#number Start
Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.
#number Repeat
Specifies the interval in seconds when the scheduler will call the event function.
#number RandomizeFactor
Specifies a randomization factor between 0 and 1 to randomize the Repeat.
#number Stop
Specifies the amount of seconds when the scheduler will be stopped.
#function SchedulerFunction
The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
#table ...
Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
Return value:
#string:
The Schedule ID of the planned schedule.
Stops the Schedule.
Defined in:
Parameter:
#string SchedulerID
(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.
Set the Class Core.Event processing Priority.
The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.
Set a state or property of the Object given a Key and a Value.
Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.
Defined in:
Parameters:
Object
The object that will hold the Value set by the Key.
Key
The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!
Value
The value to is stored in the object.
Return value:
The Value set.
Trace a function logic level 1.
Can be anywhere within the function logic.
Trace a function logic level 2.
Can be anywhere within the function logic.
Trace a function logic level 3.
Can be anywhere within the function logic.
Trace all methods in MOOSE
Set tracing for a class
Set tracing for a specific method of class
Set trace level
Set trace off.
Set trace on.
Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.
So tracing must be switched on manually in your mission if you are using Moose statically. When moose is loading dynamically (for moose class development), tracing is switched on by default.
Defined in:
Parameter:
#boolean TraceOnOff
Switch the tracing on or off.
Usage:
-- Switch the tracing On
BASE:TraceOnOff( true )
-- Switch the tracing Off
BASE:TraceOnOff( false )
UnSubscribe to a DCS event.
Trace a function call.
This function is private.
Defined in:
Parameters:
Arguments
A #table or any field.
DebugInfoCurrentParam
DebugInfoFromParam
(Internal) Serialize arguments
Trace a function logic.
Defined in:
Parameters:
Arguments
A #table or any field.
DebugInfoCurrentParam
DebugInfoFromParam
The main event handling function...
This function captures all events generated for the class.