From be0ce2be29bf5ea2c4259b38aaaf96baed1e05ad Mon Sep 17 00:00:00 2001 From: Applevangelist Date: Mon, 25 Apr 2022 08:46:39 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2A_Cap.html | 11 + Documentation/AI.AI_A2A_Dispatcher.html | 11 + Documentation/AI.AI_A2A_GCI.html | 11 + Documentation/AI.AI_A2A_Patrol.html | 11 + Documentation/AI.AI_A2G_BAI.html | 11 + Documentation/AI.AI_A2G_CAS.html | 11 + Documentation/AI.AI_A2G_Dispatcher.html | 55 +- Documentation/AI.AI_A2G_SEAD.html | 11 + Documentation/AI.AI_AIR_Dispatcher.html | 55 +- Documentation/AI.AI_Air.html | 11 + Documentation/AI.AI_Air_Engage.html | 11 + Documentation/AI.AI_Air_Patrol.html | 11 + Documentation/AI.AI_Air_Squadron.html | 11 + Documentation/AI.AI_Bai.html | 11 + Documentation/AI.AI_Balancer.html | 11 + Documentation/AI.AI_Cap.html | 11 + Documentation/AI.AI_Cargo.html | 11 + Documentation/AI.AI_Cargo_APC.html | 11 + Documentation/AI.AI_Cargo_Airplane.html | 23 + Documentation/AI.AI_Cargo_Dispatcher.html | 11 + Documentation/AI.AI_Cargo_Dispatcher_APC.html | 11 + .../AI.AI_Cargo_Dispatcher_Airplane.html | 11 + .../AI.AI_Cargo_Dispatcher_Helicopter.html | 11 + .../AI.AI_Cargo_Dispatcher_Ship.html | 11 + Documentation/AI.AI_Cargo_Helicopter.html | 51 +- Documentation/AI.AI_Cargo_Ship.html | 11 + Documentation/AI.AI_Cas.html | 11 + .../AI.AI_ESCORT_DISPATCHER_REQUEST.html | 11 + Documentation/AI.AI_Escort.html | 11 + Documentation/AI.AI_Escort_Dispatcher.html | 11 + Documentation/AI.AI_Formation.html | 11 + Documentation/AI.AI_Patrol.html | 11 + Documentation/Actions.Account.html | 11 + Documentation/Actions.Assign.html | 11 + Documentation/Actions.Assist.html | 11 + Documentation/Actions.Route.html | 11 + Documentation/Cargo.Cargo.html | 11 + Documentation/Cargo.CargoCrate.html | 11 + Documentation/Cargo.CargoGroup.html | 11 + Documentation/Cargo.CargoSlingload.html | 11 + Documentation/Cargo.CargoUnit.html | 11 + Documentation/Core.Base.html | 11 + Documentation/Core.Beacon.html | 11 + Documentation/Core.Database.html | 11 + Documentation/Core.Event.html | 11 + Documentation/Core.Fsm.html | 11 + Documentation/Core.Goal.html | 11 + Documentation/Core.Menu.html | 11 + Documentation/Core.Message.html | 11 + Documentation/Core.Point.html | 62 +- Documentation/Core.Report.html | 11 + Documentation/Core.ScheduleDispatcher.html | 11 + Documentation/Core.Scheduler.html | 11 + Documentation/Core.Set.html | 11 + Documentation/Core.Settings.html | 15 +- Documentation/Core.Spawn.html | 271 +- Documentation/Core.SpawnStatic.html | 11 + Documentation/Core.Spot.html | 44 + Documentation/Core.Timer.html | 11 + Documentation/Core.UserFlag.html | 11 + Documentation/Core.Velocity.html | 11 + Documentation/Core.Zone.html | 61 + Documentation/DCS.html | 11 + Documentation/ENUMS.html | 290 +- Documentation/Functional.ATC_Ground.html | 11 + Documentation/Functional.Arty.html | 11 + Documentation/Functional.CleanUp.html | 11 + Documentation/Functional.Designate.html | 66 + Documentation/Functional.Detection.html | 17 +- Documentation/Functional.Escort.html | 11 + Documentation/Functional.FOX.html | 11 + Documentation/Functional.Mantis.html | 39 + Documentation/Functional.MissileTrainer.html | 11 + Documentation/Functional.Movement.html | 39 +- Documentation/Functional.PseudoATC.html | 11 + Documentation/Functional.Range.html | 23 +- Documentation/Functional.Rat.html | 23 + Documentation/Functional.Scoring.html | 11 + Documentation/Functional.Sead.html | 11 + Documentation/Functional.Shorad.html | 11 + Documentation/Functional.Suppression.html | 11 + Documentation/Functional.Warehouse.html | 11 + .../Functional.ZoneCaptureCoalition.html | 11 + Documentation/Functional.ZoneGoal.html | 11 + Documentation/Functional.ZoneGoalCargo.html | 11 + .../Functional.ZoneGoalCoalition.html | 11 + Documentation/Ops.Airboss.html | 84 +- Documentation/Ops.Atis.html | 11 + Documentation/Ops.CSAR.html | 32 +- Documentation/Ops.CTLD.html | 162 +- Documentation/Ops.RecoveryTanker.html | 11 + Documentation/Ops.RescueHelo.html | 11 + Documentation/Sound.MSRS.html | 142 +- Documentation/Sound.Radio.html | 11 + Documentation/Sound.RadioQueue.html | 11 + Documentation/Sound.RadioSpeech.html | 11 + Documentation/Sound.SoundOutput.html | 11 + Documentation/Sound.UserSound.html | 11 + Documentation/Tasking.CommandCenter.html | 11 + Documentation/Tasking.DetectionManager.html | 11 + Documentation/Tasking.Mission.html | 11 + Documentation/Tasking.Task.html | 33 +- Documentation/Tasking.TaskInfo.html | 11 + Documentation/Tasking.TaskZoneCapture.html | 11 + Documentation/Tasking.Task_A2A.html | 11 + .../Tasking.Task_A2A_Dispatcher.html | 11 + Documentation/Tasking.Task_A2G.html | 11 + .../Tasking.Task_A2G_Dispatcher.html | 11 + Documentation/Tasking.Task_Cargo.html | 17 +- Documentation/Tasking.Task_Cargo_CSAR.html | 11 + .../Tasking.Task_Cargo_Dispatcher.html | 55 + .../Tasking.Task_Cargo_Transport.html | 11 + Documentation/Tasking.Task_Manager.html | 11 + .../Tasking.Task_Zone_Capture_Dispatcher.html | 11 + Documentation/Utilities.PROFILER.html | 11 + Documentation/Utilities.Templates.html | 11 + Documentation/Utils.FiFo.html | 11573 ++++++++++++++++ Documentation/Utils.STTS.html | 11 + Documentation/Utils.html | 9375 +------------ Documentation/Wrapper.Airbase.html | 11 + Documentation/Wrapper.Client.html | 161 +- Documentation/Wrapper.Controllable.html | 11 + Documentation/Wrapper.Group.html | 134 +- Documentation/Wrapper.Identifiable.html | 11 + Documentation/Wrapper.Marker.html | 11 + Documentation/Wrapper.Object.html | 11 + Documentation/Wrapper.Positionable.html | 11 + Documentation/Wrapper.Scenery.html | 11 + Documentation/Wrapper.Static.html | 11 + Documentation/Wrapper.Unit.html | 147 + Documentation/index.html | 23 + Documentation/routines.html | 11 + 132 files changed, 14448 insertions(+), 9757 deletions(-) create mode 100644 Documentation/Utils.FiFo.html diff --git a/Documentation/AI.AI_A2A_Cap.html b/Documentation/AI.AI_A2A_Cap.html index 27611f7ba..b5c6ca4e8 100644 --- a/Documentation/AI.AI_A2A_Cap.html +++ b/Documentation/AI.AI_A2A_Cap.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_A2A_Dispatcher.html b/Documentation/AI.AI_A2A_Dispatcher.html index 4414d10ed..ae8e393b5 100644 --- a/Documentation/AI.AI_A2A_Dispatcher.html +++ b/Documentation/AI.AI_A2A_Dispatcher.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_A2A_GCI.html b/Documentation/AI.AI_A2A_GCI.html index e94597ac3..240eb81e0 100644 --- a/Documentation/AI.AI_A2A_GCI.html +++ b/Documentation/AI.AI_A2A_GCI.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_A2A_Patrol.html b/Documentation/AI.AI_A2A_Patrol.html index 45d2834c2..06dada556 100644 --- a/Documentation/AI.AI_A2A_Patrol.html +++ b/Documentation/AI.AI_A2A_Patrol.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_A2G_BAI.html b/Documentation/AI.AI_A2G_BAI.html index 8a2c4666f..2454134b0 100644 --- a/Documentation/AI.AI_A2G_BAI.html +++ b/Documentation/AI.AI_A2G_BAI.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_A2G_CAS.html b/Documentation/AI.AI_A2G_CAS.html index 328780144..3776ba5a6 100644 --- a/Documentation/AI.AI_A2G_CAS.html +++ b/Documentation/AI.AI_A2G_CAS.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html index 2bf247784..f47a16edd 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -4659,17 +4670,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
@@ -13104,17 +13104,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
@@ -14432,17 +14421,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
@@ -16066,17 +16044,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
diff --git a/Documentation/AI.AI_A2G_SEAD.html b/Documentation/AI.AI_A2G_SEAD.html index 640307440..4179f1bca 100644 --- a/Documentation/AI.AI_A2G_SEAD.html +++ b/Documentation/AI.AI_A2G_SEAD.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_AIR_Dispatcher.html b/Documentation/AI.AI_AIR_Dispatcher.html index b2641ffc8..55d37202e 100644 --- a/Documentation/AI.AI_AIR_Dispatcher.html +++ b/Documentation/AI.AI_AIR_Dispatcher.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -4437,17 +4448,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
@@ -9745,17 +9745,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
@@ -11073,17 +11062,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
@@ -12707,17 +12685,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
diff --git a/Documentation/AI.AI_Air.html b/Documentation/AI.AI_Air.html index 159977bc1..6614995ac 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_Air_Engage.html b/Documentation/AI.AI_Air_Engage.html index acf8c584e..e98fdbcda 100644 --- a/Documentation/AI.AI_Air_Engage.html +++ b/Documentation/AI.AI_Air_Engage.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_Air_Patrol.html b/Documentation/AI.AI_Air_Patrol.html index 973d77526..958d71ca6 100644 --- a/Documentation/AI.AI_Air_Patrol.html +++ b/Documentation/AI.AI_Air_Patrol.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_Air_Squadron.html b/Documentation/AI.AI_Air_Squadron.html index 0d4013861..7754da741 100644 --- a/Documentation/AI.AI_Air_Squadron.html +++ b/Documentation/AI.AI_Air_Squadron.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_Bai.html b/Documentation/AI.AI_Bai.html index a193374df..0502c0e3d 100644 --- a/Documentation/AI.AI_Bai.html +++ b/Documentation/AI.AI_Bai.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_Balancer.html b/Documentation/AI.AI_Balancer.html index 64008161c..4d9e9fb34 100644 --- a/Documentation/AI.AI_Balancer.html +++ b/Documentation/AI.AI_Balancer.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_Cap.html b/Documentation/AI.AI_Cap.html index 9cc4d2b98..d5a3fe81b 100644 --- a/Documentation/AI.AI_Cap.html +++ b/Documentation/AI.AI_Cap.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html index 3802dd9c7..3bcdd6a98 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_Cargo_APC.html b/Documentation/AI.AI_Cargo_APC.html index 2c43af345..07b5223a0 100644 --- a/Documentation/AI.AI_Cargo_APC.html +++ b/Documentation/AI.AI_Cargo_APC.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index 61dde2240..b533f9066 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -2664,6 +2675,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Aircraft is on a depoly mission.

+ @@ -4451,6 +4465,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Aircraft is on a depoly mission.

+ @@ -5080,6 +5097,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Aircraft is on a depoly mission.

+ @@ -6601,6 +6621,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Aircraft is on a depoly mission.

+ diff --git a/Documentation/AI.AI_Cargo_Dispatcher.html b/Documentation/AI.AI_Cargo_Dispatcher.html index 2736854d5..a0c7e2347 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher.html +++ b/Documentation/AI.AI_Cargo_Dispatcher.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_APC.html b/Documentation/AI.AI_Cargo_Dispatcher_APC.html index c439f6476..02020b2b1 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_APC.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_APC.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html b/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html index 7776bd481..f5f19aa24 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html b/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html index 10f075924..b754106f4 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_Ship.html b/Documentation/AI.AI_Cargo_Dispatcher_Ship.html index 77722ca41..cf8d41332 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_Ship.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_Ship.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_Cargo_Helicopter.html b/Documentation/AI.AI_Cargo_Helicopter.html index bd0d3f1c7..24588d187 100644 --- a/Documentation/AI.AI_Cargo_Helicopter.html +++ b/Documentation/AI.AI_Cargo_Helicopter.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -2785,22 +2796,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number AI_CARGO_HELICOPTER.landingheight + +

meter

+
- + #number AI_CARGO_HELICOPTER.landingspeed + +

kph

+
@@ -4703,22 +4720,28 @@ Adjust if necessary.
- + #number AI_CARGO_HELICOPTER.landingheight + +

meter

+
- + #number AI_CARGO_HELICOPTER.landingspeed + +

kph

+
@@ -5373,22 +5396,28 @@ Adjust if necessary.
- + #number AI_CARGO_HELICOPTER.landingheight + +

meter

+
- + #number AI_CARGO_HELICOPTER.landingspeed + +

kph

+
@@ -6935,22 +6964,28 @@ Adjust if necessary.
- + #number AI_CARGO_HELICOPTER.landingheight + +

meter

+
- + #number AI_CARGO_HELICOPTER.landingspeed + +

kph

+
diff --git a/Documentation/AI.AI_Cargo_Ship.html b/Documentation/AI.AI_Cargo_Ship.html index cc40d08eb..926f5dddd 100644 --- a/Documentation/AI.AI_Cargo_Ship.html +++ b/Documentation/AI.AI_Cargo_Ship.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_Cas.html b/Documentation/AI.AI_Cas.html index ab26c93a9..8878e44cc 100644 --- a/Documentation/AI.AI_Cas.html +++ b/Documentation/AI.AI_Cas.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_ESCORT_DISPATCHER_REQUEST.html b/Documentation/AI.AI_ESCORT_DISPATCHER_REQUEST.html index deb981cdc..c6b7b18c2 100644 --- a/Documentation/AI.AI_ESCORT_DISPATCHER_REQUEST.html +++ b/Documentation/AI.AI_ESCORT_DISPATCHER_REQUEST.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_Escort.html b/Documentation/AI.AI_Escort.html index 97cbb6267..c209eeabf 100644 --- a/Documentation/AI.AI_Escort.html +++ b/Documentation/AI.AI_Escort.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_Escort_Dispatcher.html b/Documentation/AI.AI_Escort_Dispatcher.html index 9cc927869..57a2f0906 100644 --- a/Documentation/AI.AI_Escort_Dispatcher.html +++ b/Documentation/AI.AI_Escort_Dispatcher.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_Formation.html b/Documentation/AI.AI_Formation.html index 5e232cf7f..bc8aef689 100644 --- a/Documentation/AI.AI_Formation.html +++ b/Documentation/AI.AI_Formation.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/AI.AI_Patrol.html b/Documentation/AI.AI_Patrol.html index 7e42cf341..46361b7a2 100644 --- a/Documentation/AI.AI_Patrol.html +++ b/Documentation/AI.AI_Patrol.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Actions.Account.html b/Documentation/Actions.Account.html index aaaabf7f2..1d9565099 100644 --- a/Documentation/Actions.Account.html +++ b/Documentation/Actions.Account.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Actions.Assign.html b/Documentation/Actions.Assign.html index 5da4e239a..33fc599cc 100644 --- a/Documentation/Actions.Assign.html +++ b/Documentation/Actions.Assign.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Actions.Assist.html b/Documentation/Actions.Assist.html index 1d3b68f17..9d3fe1dce 100644 --- a/Documentation/Actions.Assist.html +++ b/Documentation/Actions.Assist.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Actions.Route.html b/Documentation/Actions.Route.html index 6c750122f..d2515516a 100644 --- a/Documentation/Actions.Route.html +++ b/Documentation/Actions.Route.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Cargo.Cargo.html b/Documentation/Cargo.Cargo.html index 8430df00a..939b92165 100644 --- a/Documentation/Cargo.Cargo.html +++ b/Documentation/Cargo.Cargo.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Cargo.CargoCrate.html b/Documentation/Cargo.CargoCrate.html index 0db380efb..30f891073 100644 --- a/Documentation/Cargo.CargoCrate.html +++ b/Documentation/Cargo.CargoCrate.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index f82ea5469..a611bb354 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Cargo.CargoSlingload.html b/Documentation/Cargo.CargoSlingload.html index aebc75e11..331cabc71 100644 --- a/Documentation/Cargo.CargoSlingload.html +++ b/Documentation/Cargo.CargoSlingload.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index b3c66a4d4..4c3bb671d 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Core.Base.html b/Documentation/Core.Base.html index 67d793755..da642506d 100644 --- a/Documentation/Core.Base.html +++ b/Documentation/Core.Base.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Core.Beacon.html b/Documentation/Core.Beacon.html index 5e47722a3..f77c65d51 100644 --- a/Documentation/Core.Beacon.html +++ b/Documentation/Core.Beacon.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Core.Database.html b/Documentation/Core.Database.html index 8afe7517e..c4c4f09fb 100644 --- a/Documentation/Core.Database.html +++ b/Documentation/Core.Database.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Core.Event.html b/Documentation/Core.Event.html index 8ef599804..d3f0f11c9 100644 --- a/Documentation/Core.Event.html +++ b/Documentation/Core.Event.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html index 789151b7f..50463e781 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Core.Goal.html b/Documentation/Core.Goal.html index c74068526..ac8a54c9d 100644 --- a/Documentation/Core.Goal.html +++ b/Documentation/Core.Goal.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Core.Menu.html b/Documentation/Core.Menu.html index 0c05d2e41..65f1c859b 100644 --- a/Documentation/Core.Menu.html +++ b/Documentation/Core.Menu.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Core.Message.html b/Documentation/Core.Message.html index ea315459a..e81db7560 100644 --- a/Documentation/Core.Message.html +++ b/Documentation/Core.Message.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html index 554345f0b..fbc0e4264 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -1733,7 +1744,12 @@ the most optimal path following the road between two coordinates.

10) Drawings on F10 map

@@ -2104,7 +2120,7 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these -

COORDINATE:GetDistanceText(Distance, Settings, Language)

+

COORDINATE:GetDistanceText(Distance, Settings, Language, Precision)

Provides a distance text expressed in the units of measurement.

@@ -3845,7 +3861,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

POINT_VEC2:GetDistanceText(Distance, Settings, Language)

+

POINT_VEC2:GetDistanceText(Distance, Settings, Language, Precision)

Provides a distance text expressed in the units of measurement.

@@ -7442,7 +7458,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

COORDINATE:GetDistanceText(Distance, Settings, Language)

+

COORDINATE:GetDistanceText(Distance, Settings, Language, Precision)

Provides a distance text expressed in the units of measurement.

@@ -7481,11 +7497,27 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ #string Language

-

+ +

(optional) "EN" or "RU"

+ +
+
+
+
+

+ #number + Precision +

+
+
+ +

(optional) round to this many decimal places

+

Return value:

@@ -20044,7 +20076,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
-

POINT_VEC2:GetDistanceText(Distance, Settings, Language)

+

POINT_VEC2:GetDistanceText(Distance, Settings, Language, Precision)

Provides a distance text expressed in the units of measurement.

@@ -20083,11 +20115,27 @@ When moose is loading dynamically (for moose class development), tracing is swit

+ #string Language

-

+ +

(optional) "EN" or "RU"

+ +
+
+
+
+

+ #number + Precision +

+
+
+ +

(optional) round to this many decimal places

+

Return value:

diff --git a/Documentation/Core.Report.html b/Documentation/Core.Report.html index 51310e841..6f7aa34c4 100644 --- a/Documentation/Core.Report.html +++ b/Documentation/Core.Report.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+
+ +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Core.ScheduleDispatcher.html b/Documentation/Core.ScheduleDispatcher.html index 2d4eeb5a8..fc6940c29 100644 --- a/Documentation/Core.ScheduleDispatcher.html +++ b/Documentation/Core.ScheduleDispatcher.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Core.Scheduler.html b/Documentation/Core.Scheduler.html index d0fc7b585..b42a01b37 100644 --- a/Documentation/Core.Scheduler.html +++ b/Documentation/Core.Scheduler.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Core.Set.html b/Documentation/Core.Set.html index 9f36dc292..7624feaa6 100644 --- a/Documentation/Core.Set.html +++ b/Documentation/Core.Set.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index d1c66c9f5..cf9109572 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -2725,7 +2736,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + SETTINGS.A2GSystem @@ -4819,7 +4830,7 @@ It is advised to use this method at the start of the mission.

- #string + SETTINGS.A2GSystem diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index c07492ba1..b7a294680 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+
+
+
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -2729,6 +2740,18 @@ and any spaces before and after the resulting name are removed.

SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)

+ + + +

SPAWN.frequency

+ + + + + +

SPAWN.modulation

+ + @@ -3280,14 +3303,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SPAWN.AIOnOff - -

The AI is on by default when spawning a group.

-
@@ -3360,9 +3380,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.

-
@@ -3418,20 +3435,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #number -SPAWN.SpawnCount - - - - -

The internal counter of the amount of spawning the has happened since SpawnStart.

-
@@ -3454,6 +3457,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWN.SpawnGrouping + + +
@@ -3490,6 +3504,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWN.SpawnInitAirbase + + +
@@ -3523,6 +3548,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWN.SpawnInitFreq + + +
@@ -3585,26 +3621,42 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -SPAWN.SpawnInitKeepUnitNames +SPAWN.SpawnInitLimit - -

Overwrite unit names by default with group name.

-
- #boolean -SPAWN.SpawnInitLimit + +SPAWN.SpawnInitLivery +
+ +
+
+
+ -

By default, no InitLimit

+SPAWN.SpawnInitModex + + + +
+ +
+
+
+ + #string +SPAWN.SpawnInitSkill + +
@@ -3637,7 +3689,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxGroups @@ -3651,7 +3703,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxUnitsAlive @@ -3797,17 +3849,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -3820,7 +3861,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.

+

When the first Spawn executes, all the Groups need to be made visible before start.

@@ -3872,6 +3913,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

When working in UnControlled mode, all planes are Spawned in UnControlled mode before the scheduler starts.

+
+ +
+
+
+ + +SPAWN.frequency + + + +
+ +
+
+
+ + +SPAWN.modulation + + +
@@ -8637,14 +8700,11 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- #boolean + SPAWN.AIOnOff - -

The AI is on by default when spawning a group.

-
@@ -8717,9 +8777,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.

- @@ -8775,20 +8832,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- - -
-
- - #number -SPAWN.SpawnCount - - - - -

The internal counter of the amount of spawning the has happened since SpawnStart.

-
@@ -8811,6 +8854,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ + +
+
+ + +SPAWN.SpawnGrouping + + +
@@ -8847,6 +8901,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ + +
+
+ + +SPAWN.SpawnInitAirbase + + +
@@ -8880,6 +8945,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ + +
+
+ + +SPAWN.SpawnInitFreq + + +
@@ -8942,26 +9018,42 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

#boolean -SPAWN.SpawnInitKeepUnitNames +SPAWN.SpawnInitLimit - -

Overwrite unit names by default with group name.

-
- #boolean -SPAWN.SpawnInitLimit + +SPAWN.SpawnInitLivery +
+ +
+
+
+ -

By default, no InitLimit

+SPAWN.SpawnInitModex + + + +
+ +
+
+
+ + #string +SPAWN.SpawnInitSkill + +
@@ -8994,7 +9086,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- #number + SPAWN.SpawnMaxGroups @@ -9008,7 +9100,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- #number + SPAWN.SpawnMaxUnitsAlive @@ -9154,17 +9246,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- -
-
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -9177,7 +9258,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.

+

When the first Spawn executes, all the Groups need to be made visible before start.

@@ -9229,6 +9310,28 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

When working in UnControlled mode, all planes are Spawned in UnControlled mode before the scheduler starts.

+
+ + +
+
+ + +SPAWN.frequency + + + +
+ +
+
+
+ + +SPAWN.modulation + + +
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index cddd47534..3f666dc7d 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index 41988fee0..40f350567 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -2702,6 +2713,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.Target + + +
@@ -3948,6 +3970,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.Target + + +
@@ -5485,6 +5518,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.Target + + +
diff --git a/Documentation/Core.Timer.html b/Documentation/Core.Timer.html index 0590ef7ea..5615d3bb6 100644 --- a/Documentation/Core.Timer.html +++ b/Documentation/Core.Timer.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Core.UserFlag.html b/Documentation/Core.UserFlag.html index c11c68d6d..a75cd015d 100644 --- a/Documentation/Core.UserFlag.html +++ b/Documentation/Core.UserFlag.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Core.Velocity.html b/Documentation/Core.Velocity.html index 6c6338bbf..342e84a7d 100644 --- a/Documentation/Core.Velocity.html +++ b/Documentation/Core.Velocity.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Core.Zone.html b/Documentation/Core.Zone.html index 13a18e49d..220bd8e4f 100644 --- a/Documentation/Core.Zone.html +++ b/Documentation/Core.Zone.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -3276,6 +3287,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

ZONE_POLYGON_BASE:IsVec2InZone(Vec2)

Returns if a location is within the zone.

+ + + +

ZONE_POLYGON_BASE:IsVec3InZone(Vec3)

+ +

Returns if a point is within the zone.

@@ -11524,6 +11541,50 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +
+ +
+

ZONE_POLYGON_BASE:IsVec3InZone(Vec3)

+
+ +

Returns if a point is within the zone.

+ +
+
+

Defined in:

+
+

ZONE_POLYGON_BASE

+
+

Parameter:

+
+
+

+ DCS#Vec3 + Vec3 +

+
+
+ +

The point to test.

+ +
+
+

Return value:

+
+
+

#boolean:

+
+
+ +

true if the point is within the zone.

+ +
+
+
+
diff --git a/Documentation/DCS.html b/Documentation/DCS.html index 364f7a086..279d07ec7 100644 --- a/Documentation/DCS.html +++ b/Documentation/DCS.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/ENUMS.html b/Documentation/ENUMS.html index 9485f86d2..5cb911b2d 100644 --- a/Documentation/ENUMS.html +++ b/Documentation/ENUMS.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -1502,7 +1513,7 @@ If, for whatever reason, the value needs to be changed, you only have to change every value by hand.

Another big advantage is that the LDT intellisense "knows" the enumerators. So you can use the autocompletion feature and do not have to keep all the -values in your head or look them up in the docs.

+values in your head or look them up in the docs.

DCS itself provides a lot of enumerators for various things. See Enumerators on Hoggit.

@@ -1602,12 +1613,24 @@ values in your head or look them up in the docs.

ENUMS.ROT

+ + + +

ENUMS.ReportingName

+ +

ENUMS.WeaponFlag

+ + + +

ENUMS.WeaponType

+ + @@ -1676,12 +1699,24 @@ values in your head or look them up in the docs.

ENUMS.ROT

+ + + +

ENUMS.ReportingName

+ +

ENUMS.WeaponFlag

+ + + +

ENUMS.WeaponType

+ + @@ -2367,7 +2402,7 @@ values in your head or look them up in the docs.

ENUMS.ROE.OpenFire

-

AI will engage only targets specified in its tasking.

+

AI will engage only targets specified in its taskings.

@@ -2435,6 +2470,25 @@ values in your head or look them up in the docs.

ENUMS.ROT.PassiveDefense

AI will use jammers and other countermeasures in an attempt to defeat the threat. AI will not attempt a maneuver to defeat a threat.

+ + + + + +

Type ENUMS.ReportingName

+
+ ENUMS.ReportingName +
+
+ + + + + + + +
Fields and Methods inherited from ENUMS.ReportingNameDescription

ENUMS.ReportingName.NATO

 +
@@ -2555,7 +2609,7 @@ values in your head or look them up in the docs.

ENUMS.WeaponFlag.Auto

- +

Even More Genral

@@ -2738,12 +2792,73 @@ values in your head or look them up in the docs.

ENUMS.WeaponFlag.TeleASM

+ + + +

ENUMS.WeaponFlag.Torpedo

+ +

ENUMS.WeaponFlag.TvGB

+ + + +
+ +

Type ENUMS.WeaponType

+
+ ENUMS.WeaponType +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from ENUMS.WeaponTypeDescription

ENUMS.WeaponType.AAM

 +

Air-to-Air missiles.

+

ENUMS.WeaponType.Any

 +

Combinations.

+

ENUMS.WeaponType.Bomb

 +

Bombs.

+

ENUMS.WeaponType.Gun

 +

Guns.

+

ENUMS.WeaponType.Missile

 +

Missiles.

+

ENUMS.WeaponType.Rocket

 +

Rocket.

+

ENUMS.WeaponType.Torpedo

 +

Torpedos.
@@ -2854,6 +2969,17 @@ values in your head or look them up in the docs.

+
+ + +
+
+ + #ENUMS.ReportingName +ENUMS.ReportingName + + +
@@ -2865,6 +2991,17 @@ values in your head or look them up in the docs.

+ + + +
+
+ + #ENUMS.WeaponType +ENUMS.WeaponType + + +
@@ -2929,7 +3066,7 @@ values in your head or look them up in the docs.

Formations (new).

-

See the Formations on Hoggit wiki.

+

See the Formations on hoggit wiki.

Field(s)

@@ -2981,7 +3118,7 @@ values in your head or look them up in the docs.

The old format is a simplified version of the new formation enums, which allow more sophisticated settings. -See the Formations on Hoggit wiki.

+See the Formations on hoggit wiki.

Field(s)

@@ -4076,7 +4213,7 @@ See the Formation #number ENUMS.ROE.OpenFire -

AI will engage only targets specified in its tasking.

+

AI will engage only targets specified in its taskings.

@@ -4192,6 +4329,37 @@ See the Formation

AI will use jammers and other countermeasures in an attempt to defeat the threat. AI will not attempt a maneuver to defeat a threat.

+
+ + +
+

Function(s)

+
+ + + +

Type ENUMS.ReportingName

+
+
+ +

Reporting Names (NATO).

+ + +

See the Wikipedia. +DCS known aircraft types

+ + +
+

Field(s)

+
+
+
+ + #table +ENUMS.ReportingName.NATO + + +
@@ -4208,7 +4376,7 @@ See the Formation

Weapon types.

-

See the Weapon Flag enumerator on Hoggit wiki.

+

See the Weapon Flag enumerotor on hoggit wiki.

Field(s)

@@ -4409,7 +4577,7 @@ See the Formation #number ENUMS.WeaponFlag.Auto - +

Even More Genral

@@ -4752,6 +4920,17 @@ See the Formation +
+ +
+
+
+ + #number +ENUMS.WeaponFlag.Torpedo + + +
@@ -4763,6 +4942,101 @@ See the Formation + + + +
+

Function(s)

+
+ + + +

Type ENUMS.WeaponType

+
+
+ +

Weapon types by category.

+ + +

See the Weapon Flag enumerator on hoggit wiki.

+ +
+

Field(s)

+
+
+
+ + #table +ENUMS.WeaponType.AAM + +

Air-to-Air missiles.

+ +
+ +
+
+
+ + #table +ENUMS.WeaponType.Any + +

Combinations.

+ +
+ +
+
+
+ + #table +ENUMS.WeaponType.Bomb + +

Bombs.

+ +
+ +
+
+
+ + #table +ENUMS.WeaponType.Gun + +

Guns.

+ +
+ +
+
+
+ + #table +ENUMS.WeaponType.Missile + +

Missiles.

+ +
+ +
+
+
+ + #table +ENUMS.WeaponType.Rocket + +

Rocket.

+ +
+ +
+
+
+ + #table +ENUMS.WeaponType.Torpedo + +

Torpedos.

+
diff --git a/Documentation/Functional.ATC_Ground.html b/Documentation/Functional.ATC_Ground.html index f48a02146..2c52c55df 100644 --- a/Documentation/Functional.ATC_Ground.html +++ b/Documentation/Functional.ATC_Ground.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+
+ +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Functional.Arty.html b/Documentation/Functional.Arty.html index 40586a089..0cfa20127 100644 --- a/Documentation/Functional.Arty.html +++ b/Documentation/Functional.Arty.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Functional.CleanUp.html b/Documentation/Functional.CleanUp.html index c94a5579d..da5556cee 100644 --- a/Documentation/Functional.CleanUp.html +++ b/Documentation/Functional.CleanUp.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index 3517980c2..f7ed5ad4d 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -3422,6 +3433,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +DESIGNATE.LaseDuration + + +
@@ -6590,6 +6612,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + +DESIGNATE.LaseDuration + + +
@@ -7400,6 +7433,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + +DESIGNATE.LaseDuration + + +
@@ -8180,6 +8224,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + +DESIGNATE.LaseDuration + + +
@@ -9852,6 +9907,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + +DESIGNATE.LaseDuration + + +
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index faf978bb7..71b3e2e2a 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -19061,7 +19072,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
- + #number DETECTION_BASE.RefreshTimeInterval @@ -23774,7 +23785,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- + #number DETECTION_BASE.RefreshTimeInterval @@ -25542,7 +25553,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- + #number DETECTION_BASE.RefreshTimeInterval diff --git a/Documentation/Functional.Escort.html b/Documentation/Functional.Escort.html index 7c53e478d..aac64cac9 100644 --- a/Documentation/Functional.Escort.html +++ b/Documentation/Functional.Escort.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+
+
+
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Functional.FOX.html b/Documentation/Functional.FOX.html index 8a1d6198a..4c3716c0c 100644 --- a/Documentation/Functional.FOX.html +++ b/Documentation/Functional.FOX.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+
+
+
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index 20e252425..f37976b6f 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -2899,6 +2910,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The #DETECTION_AREAS object for AWACS

+ + + +
+
+ + +MANTIS.AWACS_Prefix + + +
@@ -3334,6 +3356,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

switch alarm state RED

+ @@ -6550,6 +6575,17 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

The #DETECTION_AREAS object for AWACS

+ + + +
+
+ + +MANTIS.AWACS_Prefix + + +
@@ -6985,6 +7021,9 @@ E.g. `mymantis:SetAdvancedMode(true, 90)` + +

switch alarm state RED

+ diff --git a/Documentation/Functional.MissileTrainer.html b/Documentation/Functional.MissileTrainer.html index f949f27f7..7c4df87b2 100644 --- a/Documentation/Functional.MissileTrainer.html +++ b/Documentation/Functional.MissileTrainer.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Functional.Movement.html b/Documentation/Functional.Movement.html index 618db0df7..70296466d 100644 --- a/Documentation/Functional.Movement.html +++ b/Documentation/Functional.Movement.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -2147,20 +2158,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

-
-
- - #number -MOVEMENT.AliveUnits - - - - -

Contains the counter how many units are currently alive

- -
- -
@@ -2391,20 +2388,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

-
-
- - #number -MOVEMENT.AliveUnits - - - - -

Contains the counter how many units are currently alive

- -
- -
diff --git a/Documentation/Functional.PseudoATC.html b/Documentation/Functional.PseudoATC.html index c68cd087b..a320213f5 100644 --- a/Documentation/Functional.PseudoATC.html +++ b/Documentation/Functional.PseudoATC.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+
+
+
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Functional.Range.html b/Documentation/Functional.Range.html index afdc24e7c..a0a971d15 100644 --- a/Documentation/Functional.Range.html +++ b/Documentation/Functional.Range.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -15687,13 +15698,13 @@ When moose is loading dynamically (for moose class development), tracing is swit
- + #number RANGE.BombResult.roundsFired -

RANGEBOSS

+

Rangeboss Edit

@@ -15701,13 +15712,13 @@ When moose is loading dynamically (for moose class development), tracing is swit
- + #number RANGE.BombResult.roundsHit -

RANGEBOSS

+

Rangeboss Edit

@@ -15715,13 +15726,13 @@ When moose is loading dynamically (for moose class development), tracing is swit
- + #string RANGE.BombResult.roundsQuality -

RANGEBOSS

+

Rangeboss Edit

diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html index a88353b22..30e35f721 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+
+
+
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -4325,6 +4336,18 @@ and any spaces before and after the resulting name are removed.

RAT:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)

+ + + +

RAT.frequency

+ + + + + +

RAT.modulation

+ + diff --git a/Documentation/Functional.Scoring.html b/Documentation/Functional.Scoring.html index 6c6c41ba6..9b28f65b2 100644 --- a/Documentation/Functional.Scoring.html +++ b/Documentation/Functional.Scoring.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Functional.Sead.html b/Documentation/Functional.Sead.html index a9e642251..32e1ab04b 100644 --- a/Documentation/Functional.Sead.html +++ b/Documentation/Functional.Sead.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Functional.Shorad.html b/Documentation/Functional.Shorad.html index 966e211f4..dfb0e641c 100644 --- a/Documentation/Functional.Shorad.html +++ b/Documentation/Functional.Shorad.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Functional.Suppression.html b/Documentation/Functional.Suppression.html index f5c9aef42..39aafedb6 100644 --- a/Documentation/Functional.Suppression.html +++ b/Documentation/Functional.Suppression.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Functional.Warehouse.html b/Documentation/Functional.Warehouse.html index cd741e13f..8436367b5 100644 --- a/Documentation/Functional.Warehouse.html +++ b/Documentation/Functional.Warehouse.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Functional.ZoneCaptureCoalition.html b/Documentation/Functional.ZoneCaptureCoalition.html index 2aa38949e..ae37e7379 100644 --- a/Documentation/Functional.ZoneCaptureCoalition.html +++ b/Documentation/Functional.ZoneCaptureCoalition.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Functional.ZoneGoal.html b/Documentation/Functional.ZoneGoal.html index 7c0018064..310d418ae 100644 --- a/Documentation/Functional.ZoneGoal.html +++ b/Documentation/Functional.ZoneGoal.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Functional.ZoneGoalCargo.html b/Documentation/Functional.ZoneGoalCargo.html index ab46ac99c..6f7f8f67a 100644 --- a/Documentation/Functional.ZoneGoalCargo.html +++ b/Documentation/Functional.ZoneGoalCargo.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Functional.ZoneGoalCoalition.html b/Documentation/Functional.ZoneGoalCoalition.html index 967307945..58a0874c8 100644 --- a/Documentation/Functional.ZoneGoalCoalition.html +++ b/Documentation/Functional.ZoneGoalCoalition.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index 41ae0a770..4b5fe1bc1 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -9222,17 +9233,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Radio queue of LSO.

- - - -
-
- - -AIRBOSS.RQLid - - -
@@ -9244,17 +9244,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Radio queue of marshal.

- - - -
-
- - -AIRBOSS.RQMid - - -
@@ -28387,17 +28376,6 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of LSO.

- - - -
-
- - -AIRBOSS.RQLid - - -
@@ -28409,17 +28387,6 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of marshal.

- - - -
-
- - -AIRBOSS.RQMid - - -
@@ -31390,17 +31357,6 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of LSO.

- - - -
-
- - -AIRBOSS.RQLid - - -
@@ -31412,17 +31368,6 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of marshal.

- - - -
-
- - -AIRBOSS.RQMid - - -
@@ -38824,7 +38769,7 @@ When moose is loading dynamically (for moose class development), tracing is swit -

Also decrease flag for section members of flight.

+

Set stack flag.

@@ -38972,6 +38917,9 @@ When moose is loading dynamically (for moose class development), tracing is swit + +

Set section lead of player flight.

+ @@ -39028,7 +38976,7 @@ When moose is loading dynamically (for moose class development), tracing is swit -

Set new time stamp.

+

Set time stamp.

diff --git a/Documentation/Ops.Atis.html b/Documentation/Ops.Atis.html index 33096c036..178ef0f77 100644 --- a/Documentation/Ops.Atis.html +++ b/Documentation/Ops.Atis.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Ops.CSAR.html b/Documentation/Ops.CSAR.html index fd35f2030..3b05df3b5 100644 --- a/Documentation/Ops.CSAR.html +++ b/Documentation/Ops.CSAR.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -3586,7 +3597,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.FreeVHFFrequencies @@ -3689,14 +3700,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CSAR.allheligroupset - -

GROUP_SET of all helis

-
@@ -8429,7 +8437,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.FreeVHFFrequencies @@ -8532,14 +8540,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CSAR.allheligroupset - -

GROUP_SET of all helis

-
@@ -10765,7 +10770,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.FreeVHFFrequencies @@ -10868,14 +10873,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CSAR.allheligroupset - -

GROUP_SET of all helis

-
diff --git a/Documentation/Ops.CTLD.html b/Documentation/Ops.CTLD.html index 1b616b136..d6ca39f46 100644 --- a/Documentation/Ops.CTLD.html +++ b/Documentation/Ops.CTLD.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+
+
+
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -6948,7 +6959,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.CtldUnits @@ -6970,7 +6981,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.DroppedTroops @@ -6995,11 +7006,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+ #number +CTLD.Engineers + + + +

use as counter

+ +
+ +
+
+
+ + #table CTLD.EngineersInField + +

holds #CTLD_ENGINEERING objects

+
@@ -7031,7 +7059,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeFMFrequencies @@ -7183,11 +7211,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.PilotGroups + +

tables

+
@@ -7415,6 +7446,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

#1570

+
+ +
+
+
+ + #table +CTLD.droppedBeacons + + +
@@ -7632,7 +7674,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

noob catch

+

time to repair a unit/group

@@ -7698,7 +7740,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number CTLD.troopdropzoneradius @@ -14472,7 +14514,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.CtldUnits @@ -14494,7 +14536,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.DroppedTroops @@ -14519,11 +14561,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+ #number +CTLD.Engineers + + + +

use as counter

+ +
+ +
+
+
+ + #table CTLD.EngineersInField + +

holds #CTLD_ENGINEERING objects

+
@@ -14555,7 +14614,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeFMFrequencies @@ -14707,11 +14766,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.PilotGroups + +

tables

+
@@ -14939,6 +15001,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

#1570

+
+ +
+
+
+ + #table +CTLD.droppedBeacons + + +
@@ -15156,7 +15229,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

noob catch

+

time to repair a unit/group

@@ -15222,7 +15295,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number CTLD.troopdropzoneradius @@ -16837,7 +16910,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.CtldUnits @@ -16859,7 +16932,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.DroppedTroops @@ -16884,11 +16957,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+ #number +CTLD.Engineers + + + +

use as counter

+ +
+ +
+
+
+ + #table CTLD.EngineersInField + +

holds #CTLD_ENGINEERING objects

+
@@ -16920,7 +17010,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeFMFrequencies @@ -17072,11 +17162,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.PilotGroups + +

tables

+
@@ -17304,6 +17397,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

#1570

+
+ +
+
+
+ + #table +CTLD.droppedBeacons + + +
@@ -17521,7 +17625,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

noob catch

+

time to repair a unit/group

@@ -17587,7 +17691,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number CTLD.troopdropzoneradius @@ -25144,17 +25248,6 @@ When moose is loading dynamically (for moose class development), tracing is swit -
- -
- @@ -25808,17 +25901,6 @@ When moose is loading dynamically (for moose class development), tracing is swit -
- -
- diff --git a/Documentation/Ops.RecoveryTanker.html b/Documentation/Ops.RecoveryTanker.html index 1ee09f1f8..4dd7f3145 100644 --- a/Documentation/Ops.RecoveryTanker.html +++ b/Documentation/Ops.RecoveryTanker.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+
+
+
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Ops.RescueHelo.html b/Documentation/Ops.RescueHelo.html index 8833dcf3d..b210ea706 100644 --- a/Documentation/Ops.RescueHelo.html +++ b/Documentation/Ops.RescueHelo.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+
+
+
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Sound.MSRS.html b/Documentation/Sound.MSRS.html index 94d28adf5..c13742ef6 100644 --- a/Documentation/Sound.MSRS.html +++ b/Documentation/Sound.MSRS.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+
+
+
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -1649,6 +1660,12 @@ Google's supported voices: https://cloud.google.com/text-to-speech/docs/voices

MSRS:GetFrequencies(Frequencies)

Get frequencies.

+ + + +

MSRS:GetLabel()

+ +

Get label.

@@ -1673,6 +1690,12 @@ Google's supported voices: https://cloud.google.com/text-to-speech/docs/voices

MSRS:Help()

Print SRS STTS help to DCS log file.

+ + + +

MSRS.Label

+ +

Label showing up on the SRS radio overlay. Default is "ROBOT". No spaces allowed.

@@ -1739,6 +1762,12 @@ Google's supported voices: https://cloud.google.com/text-to-speech/docs/voices

MSRS:SetGoogle(PathToCredentials)

Use google text-to-speech.

+ + + +

MSRS:SetLabel(Label)

+ +

Set label.

@@ -1772,7 +1801,7 @@ Google's supported voices: https://cloud.google.com/text-to-speech/docs/voices -

MSRS:_GetCommand(freqs, modus, coal, gender, voice, culture, volume, speed, port)

+

MSRS:_GetCommand(freqs, modus, coal, gender, voice, culture, volume, speed, port, label)

Get SRS command to play sound using the DCS-SR-ExternalAudio.exe.

@@ -2423,6 +2452,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+ + #string +MSRS.Label + +

Label showing up on the SRS radio overlay. Default is "ROBOT". No spaces allowed.

+ +
+
@@ -2641,6 +2681,36 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+ +
+ +
+

MSRS:GetLabel()

+
+ +

Get label.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Return value:

+
+
+

#number:

+
+
+ +

Label.

+ +
+
+
+
@@ -3323,6 +3393,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+ + + +
+ +
+

MSRS:SetLabel(Label)

+
+ +

Set label.

+ +
+
+

Defined in:

+
+

MSRS

+
+

Parameter:

+
+
+

+ #number + Label +

+
+
+ +

Default "ROBOT"

+ +
+
+

Return value:

+
+
+

#MSRS:

+
+
+ +

self

+ +
+
+
+
@@ -3555,7 +3669,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

MSRS:_GetCommand(freqs, modus, coal, gender, voice, culture, volume, speed, port)

+

MSRS:_GetCommand(freqs, modus, coal, gender, voice, culture, volume, speed, port, label)

Get SRS command to play sound using the DCS-SR-ExternalAudio.exe.

@@ -3682,6 +3796,19 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Port.

+
+ +
+
+

+ #string + label +

+
+
+ +

Label, defaults to "ROBOT" (displayed sender name in the radio overlay of SRS) - No spaces allowed!

+

Return value:

@@ -3773,6 +3900,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +
+
+ + #string +MSRS.Label + +

Label showing up on the SRS radio overlay. Default is "ROBOT". No spaces allowed.

+ +
+
diff --git a/Documentation/Sound.Radio.html b/Documentation/Sound.Radio.html index 2e28059dd..6629dc883 100644 --- a/Documentation/Sound.Radio.html +++ b/Documentation/Sound.Radio.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+
+ +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Sound.RadioQueue.html b/Documentation/Sound.RadioQueue.html index 66ad53ad3..9e7eaa922 100644 --- a/Documentation/Sound.RadioQueue.html +++ b/Documentation/Sound.RadioQueue.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Sound.RadioSpeech.html b/Documentation/Sound.RadioSpeech.html index 9573d7f05..b1cc77127 100644 --- a/Documentation/Sound.RadioSpeech.html +++ b/Documentation/Sound.RadioSpeech.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Sound.SoundOutput.html b/Documentation/Sound.SoundOutput.html index 6b3d14de4..9541f235b 100644 --- a/Documentation/Sound.SoundOutput.html +++ b/Documentation/Sound.SoundOutput.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Sound.UserSound.html b/Documentation/Sound.UserSound.html index 9c9da3f68..2fbcfa3dd 100644 --- a/Documentation/Sound.UserSound.html +++ b/Documentation/Sound.UserSound.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Tasking.CommandCenter.html b/Documentation/Tasking.CommandCenter.html index f0f60ceb1..1b64c1bfd 100644 --- a/Documentation/Tasking.CommandCenter.html +++ b/Documentation/Tasking.CommandCenter.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Tasking.DetectionManager.html b/Documentation/Tasking.DetectionManager.html index 953f5e368..d39fd9392 100644 --- a/Documentation/Tasking.DetectionManager.html +++ b/Documentation/Tasking.DetectionManager.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Tasking.Mission.html b/Documentation/Tasking.Mission.html index 4b3381f84..49b7cdba3 100644 --- a/Documentation/Tasking.Mission.html +++ b/Documentation/Tasking.Mission.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Tasking.Task.html b/Documentation/Tasking.Task.html index 4a6038ba4..2995d3cbe 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -2820,17 +2831,6 @@ but can separately be modified later in your mission using the - - - -
-
- - -TASK.TaskControlMenu - - -
@@ -7467,17 +7467,6 @@ If the Unit is part of the Task, true is returned.

- - - -
-
- - -TASK.TaskControlMenu - - -
diff --git a/Documentation/Tasking.TaskInfo.html b/Documentation/Tasking.TaskInfo.html index cb3a3e3af..99d8a0d53 100644 --- a/Documentation/Tasking.TaskInfo.html +++ b/Documentation/Tasking.TaskInfo.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Tasking.TaskZoneCapture.html b/Documentation/Tasking.TaskZoneCapture.html index 390d0dcab..0f785a18d 100644 --- a/Documentation/Tasking.TaskZoneCapture.html +++ b/Documentation/Tasking.TaskZoneCapture.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Tasking.Task_A2A.html b/Documentation/Tasking.Task_A2A.html index a23377080..edb7517c4 100644 --- a/Documentation/Tasking.Task_A2A.html +++ b/Documentation/Tasking.Task_A2A.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Tasking.Task_A2A_Dispatcher.html b/Documentation/Tasking.Task_A2A_Dispatcher.html index a4ec41421..cb4471e47 100644 --- a/Documentation/Tasking.Task_A2A_Dispatcher.html +++ b/Documentation/Tasking.Task_A2A_Dispatcher.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Tasking.Task_A2G.html b/Documentation/Tasking.Task_A2G.html index 9689081ff..9929e0a3f 100644 --- a/Documentation/Tasking.Task_A2G.html +++ b/Documentation/Tasking.Task_A2G.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Tasking.Task_A2G_Dispatcher.html b/Documentation/Tasking.Task_A2G_Dispatcher.html index 9d0f09a1e..c43505f93 100644 --- a/Documentation/Tasking.Task_A2G_Dispatcher.html +++ b/Documentation/Tasking.Task_A2G_Dispatcher.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html index bca37a61e..0a1befd29 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -3150,7 +3161,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -4572,7 +4583,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -9104,7 +9115,7 @@ If the Unit is part of the Task, true is returned.

- #number + TASK_CARGO.CargoLimit diff --git a/Documentation/Tasking.Task_Cargo_CSAR.html b/Documentation/Tasking.Task_Cargo_CSAR.html index 512556cd8..5d93e3d25 100644 --- a/Documentation/Tasking.Task_Cargo_CSAR.html +++ b/Documentation/Tasking.Task_Cargo_CSAR.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+
+
+
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index 143ad93b3..5e01b0385 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -3090,7 +3101,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+ #number +TASK_CARGO_DISPATCHER.CountCSAR + + +
+ +
+
+
+ + #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4169,7 +4191,18 @@ This method can only be used once!

+ #number +TASK_CARGO_DISPATCHER.CountCSAR + + +
+ +
+
+
+ + #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -5027,7 +5060,18 @@ This method can only be used once!

+ #number +TASK_CARGO_DISPATCHER.CountCSAR + + +
+ +
+
+
+ + #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -6520,7 +6564,18 @@ This method can only be used once!

+ #number +TASK_CARGO_DISPATCHER.CountCSAR + + +
+ +
+
+
+ + #table TASK_CARGO_DISPATCHER.DefaultDeployZones diff --git a/Documentation/Tasking.Task_Cargo_Transport.html b/Documentation/Tasking.Task_Cargo_Transport.html index dd38de39d..3e2d8815c 100644 --- a/Documentation/Tasking.Task_Cargo_Transport.html +++ b/Documentation/Tasking.Task_Cargo_Transport.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+
+
+
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Tasking.Task_Manager.html b/Documentation/Tasking.Task_Manager.html index f79f6c67b..9d4be89d8 100644 --- a/Documentation/Tasking.Task_Manager.html +++ b/Documentation/Tasking.Task_Manager.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+
+
+
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Tasking.Task_Zone_Capture_Dispatcher.html b/Documentation/Tasking.Task_Zone_Capture_Dispatcher.html index aee96d7e6..90913e90c 100644 --- a/Documentation/Tasking.Task_Zone_Capture_Dispatcher.html +++ b/Documentation/Tasking.Task_Zone_Capture_Dispatcher.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+
+ +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Utilities.PROFILER.html b/Documentation/Utilities.PROFILER.html index d86555234..68a06c3ca 100644 --- a/Documentation/Utilities.PROFILER.html +++ b/Documentation/Utilities.PROFILER.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Utilities.Templates.html b/Documentation/Utilities.Templates.html index 38e39a3ef..13a6807cc 100644 --- a/Documentation/Utilities.Templates.html +++ b/Documentation/Utilities.Templates.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Utils.FiFo.html b/Documentation/Utils.FiFo.html new file mode 100644 index 000000000..689c452b6 --- /dev/null +++ b/Documentation/Utils.FiFo.html @@ -0,0 +1,11573 @@ + + + + + + + + + + + + + + + +
+

+ +

+
+
+ + +Banner Image +
+
+

Module Utils.FiFo

+
+
+ +

UTILS - ClassicFiFo Stack.

+ + + +
+ +

Main Features:

+ +
    +
  • Build a simple multi-purpose FiFo (First-In, First-Out) stack for generic data.
    • +
  • [Wikipedia](https://en.wikipedia.org/wiki/FIFO_(computing_and_electronics)
    • +
+ +
+ +

Author: applevangelist

+ +
+

Global(s)

+
+ + + + + +

Global FIFO

 + +
+
+
+
+ + #FIFO +FIFO + + + +
+ +
+
+ + + + + +

Global LIFO

 + +
+
+
+
+ + #LIFO +LIFO + + + +
+ +
+

Type(s)

+

Type FIFO

+
+ FIFO +, extends Core.Base#BASE +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from FIFODescription

FIFO.ClassName

 +

Name of the class.

+

FIFO:Clear()

 +

Empty FIFO Stack

+

FIFO:Count()

 +

FIFO Get stack size

+

FIFO:Flatten()

 +

FIFO Housekeeping

+

FIFO:Flush()

 +

FIFO Print stacks to dcs.log

+

FIFO:ForEach(IteratorFunction, Arg, Function, FunctionArguments)

 +

Iterate the FIFO and call an iterator function for the given FIFO data, providing the object for each element of the stack and optional parameters.

+

FIFO:GetDataTable()

 +

FIFO Get table of data entries

+

FIFO:GetIDStack()

 +

FIFO Get the data stack by UniqueID

+

FIFO:GetIDStackSorted()

 +

FIFO Get table of UniqueIDs sorted smallest to largest

+

FIFO:GetPointerStack()

 +

FIFO Get the data stack by pointer

+

FIFO:GetSize()

 +

FIFO Get stack size

+

FIFO:GetSortedDataTable()

 +

FIFO Get sorted table of data entries by UniqueIDs (must be numerical UniqueIDs only!)

+

FIFO:HasUniqueID(UniqueID)

 +

FIFO Check if a certain UniqeID exists

+

FIFO:IsEmpty()

 +

FIFO Check Stack is empty

+

FIFO:IsNotEmpty()

 +

FIFO Check Stack is NOT empty

+

FIFO:New()

 +

Instantiate a new FIFO Stack

+

FIFO:Pull()

 +

FIFO Pull Object from Stack

+

FIFO:PullByID(UniqueID)

 +

FIFO Pull Object from Stack by UniqueID

+

FIFO:PullByPointer(Pointer)

 +

FIFO Pull Object from Stack by Pointer

+

FIFO:Push(Object, UniqueID)

 +

FIFO Push Object to Stack

+

FIFO:ReadByID(UniqueID)

 +

FIFO Read, not Pull, Object from Stack by UniqueID

+

FIFO:ReadByPointer(Pointer)

 +

FIFO Read, not Pull, Object from Stack by Pointer

+

FIFO.counter

 + +

FIFO.lid

 +

Class id string for output to DCS log file.

+

FIFO.pointer

 + +

FIFO.stackbyid

 + +

FIFO.stackbypointer

 + +

FIFO.uniquecounter

 + +

FIFO.version

 +

Version of FiFo

+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from BASEDescription

FIFO.ClassID

 +

The ID number of the class.

+

FIFO.ClassName

 +

The name of the class.

+

FIFO.ClassNameAndID

 +

The name of the class concatenated with the ID number of the class.

+

FIFO:ClearState(Object, StateName)

 +

Clear the state of an object.

+

FIFO:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

 +

Creation of a Birth Event.

+

FIFO:CreateEventCrash(EventTime, Initiator)

 +

Creation of a Crash Event.

+

FIFO:CreateEventDead(EventTime, Initiator)

 +

Creation of a Dead Event.

+

FIFO:CreateEventPlayerEnterAircraft(PlayerUnit)

 +

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

+

FIFO:CreateEventRemoveUnit(EventTime, Initiator)

 +

Creation of a Remove Unit Event.

+

FIFO:CreateEventTakeoff(EventTime, Initiator)

 +

Creation of a Takeoff Event.

+

FIFO:E(Arguments)

 +

Log an exception which will be traced always.

+

FIFO:EventDispatcher()

 +

Returns the event dispatcher

+

FIFO:EventRemoveAll()

 +

Remove all subscribed events

+

FIFO:F(Arguments)

 +

Trace a function call.

+

FIFO:F2(Arguments)

 +

Trace a function call level 2.

+

FIFO:F3(Arguments)

 +

Trace a function call level 3.

+

FIFO:GetClassID()

 +

Get the ClassID of the class instance.

+

FIFO:GetClassName()

 +

Get the ClassName of the class instance.

+

FIFO:GetClassNameAndID()

 +

Get the ClassName + ClassID of the class instance.

+

FIFO:GetEventPriority()

 +

Get the Class Event processing Priority.

+

FIFO:GetParent(Child, FromClass)

 +

This is the worker method to retrieve the Parent class.

+

FIFO:GetState(Object, Key)

 +

Get a Value given a Key from the Object.

+

FIFO:HandleEvent(EventID, EventFunction)

 +

Subscribe to a DCS Event.

+

FIFO:I(Arguments)

 +

Log an information which will be traced always.

+

FIFO:Inherit(Child, Parent)

 +

This is the worker method to inherit from a parent class.

+

FIFO:IsInstanceOf(ClassName)

 +

This is the worker method to check if an object is an (sub)instance of a class.

+

FIFO:IsTrace()

 +

Enquires if tracing is on (for the class).

+

FIFO:New()

 +

BASE constructor.

+

FIFO:OnEvent(EventData)

 +

Occurs when an object is completely destroyed.

+

FIFO:OnEventBDA(EventData)

 +

BDA.

+

FIFO:OnEventBaseCaptured(EventData)

 +

Occurs when a ground unit captures either an airbase or a farp.

+

FIFO:OnEventBirth(EventData)

 +

Occurs when any object is spawned into the mission.

+

FIFO:OnEventCrash(EventData)

 +

Occurs when any aircraft crashes into the ground and is completely destroyed.

+

FIFO:OnEventDead(EventData)

 +

Occurs when an object is dead.

+

FIFO:OnEventDetailedFailure(EventData)

 +

Unknown precisely what creates this event, likely tied into newer damage model.

+

FIFO:OnEventDiscardChairAfterEjection(EventData)

 +

Discard chair after ejection.

+

FIFO:OnEventEjection(EventData)

 +

Occurs when a pilot ejects from an aircraft +initiator : The unit that has ejected

+

FIFO:OnEventEngineShutdown(EventData)

 +

Occurs when any aircraft shuts down its engines.

+

FIFO:OnEventEngineStartup(EventData)

 +

Occurs when any aircraft starts its engines.

+

FIFO:OnEventHit(EventData)

 +

Occurs whenever an object is hit by a weapon.

+

FIFO:OnEventHumanFailure(EventData)

 +

Occurs when any system fails on a human controlled aircraft.

+

FIFO:OnEventKill(EventData)

 +

Occurs on the death of a unit.

+

FIFO:OnEventLand(EventData)

 +

Occurs when an aircraft lands at an airbase, farp or ship +initiator : The unit that has landed.

+

FIFO:OnEventLandingAfterEjection(EventData)

 +

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

+

FIFO:OnEventLandingQualityMark(EventData)

 +

Landing quality mark.

+

FIFO:OnEventMarkAdded(EventData)

 +

Occurs when a new mark was added.

+

FIFO:OnEventMarkChange(EventData)

 +

Occurs when a mark text was changed.

+

FIFO:OnEventMarkRemoved(EventData)

 +

Occurs when a mark was removed.

+

FIFO:OnEventMissionEnd(EventData)

 +

Occurs when a mission ends.

+

FIFO:OnEventMissionStart(EventData)

 +

Occurs when a mission starts.

+

FIFO:OnEventParatrooperLanding(EventData)

 +

Weapon add.

+

FIFO:OnEventPilotDead(EventData)

 +

Occurs when the pilot of an aircraft is killed.

+

FIFO:OnEventPlayerEnterAircraft(EventData)

 +

Occurs when a player enters a slot and takes control of an aircraft.

+

FIFO:OnEventPlayerEnterUnit(EventData)

 +

Occurs when any player assumes direct control of a unit.

+

FIFO:OnEventPlayerLeaveUnit(EventData)

 +

Occurs when any player relieves control of a unit to the AI.

+

FIFO:OnEventRefueling(EventData)

 +

Occurs when an aircraft connects with a tanker and begins taking on fuel.

+

FIFO:OnEventRefuelingStop(EventData)

 +

Occurs when an aircraft is finished taking fuel.

+

FIFO:OnEventScore(EventData)

 +

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

+

FIFO:OnEventShootingEnd(EventData)

 +

Occurs when any unit stops firing its weapon.

+

FIFO:OnEventShootingStart(EventData)

 +

Occurs when any unit begins firing a weapon that has a high rate of fire.

+

FIFO:OnEventShot(EventData)

 +

Occurs whenever any unit in a mission fires a weapon.

+

FIFO:OnEventTakeoff(EventData)

 +

Occurs when an aircraft takes off from an airbase, farp, or ship.

+

FIFO:OnEventTriggerZone(EventData)

 +

Trigger zone.

+

FIFO:OnEventUnitLost(EventData)

 +

Occurs when the game thinks an object is destroyed.

+

FIFO:ScheduleOnce(Start, SchedulerFunction, ...)

 +

Schedule a new time event.

+

FIFO:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

 +

Schedule a new time event.

+

FIFO:ScheduleStop(SchedulerFunction)

 +

Stops the Schedule.

+

FIFO.Scheduler

 + +

FIFO:SetEventPriority(EventPriority)

 +

Set the Class Event processing Priority.

+

FIFO:SetState(Object, Key, Value)

 +

Set a state or property of the Object given a Key and a Value.

+

FIFO:T(Arguments)

 +

Trace a function logic level 1.

+

FIFO:T2(Arguments)

 +

Trace a function logic level 2.

+

FIFO:T3(Arguments)

 +

Trace a function logic level 3.

+

FIFO:TraceAll(TraceAll)

 +

Trace all methods in MOOSE

+

FIFO:TraceClass(Class)

 +

Set tracing for a class

+

FIFO:TraceClassMethod(Class, Method)

 +

Set tracing for a specific method of class

+

FIFO:TraceLevel(Level)

 +

Set trace level

+

FIFO:TraceOff()

 +

Set trace off.

+

FIFO:TraceOn()

 +

Set trace on.

+

FIFO:TraceOnOff(TraceOnOff)

 +

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.

+

FIFO:UnHandleEvent(EventID)

 +

UnSubscribe to a DCS event.

+

FIFO._

 + +

FIFO:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function call.

+

FIFO:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function logic.

+

FIFO.__

 + +

FIFO:onEvent(event)

 + +
+
+ +

Type FIFO.IDEntry

+
+ FIFO.IDEntry +
+
+ + + + + + + + + + + + + + + + + +
Fields and Methods inherited from FIFO.IDEntryDescription

FIFO.IDEntry.data

 + +

FIFO.IDEntry.pointer

 + +

FIFO.IDEntry.uniqueID

 + +
+
+ +

Type LIFO

+
+ LIFO +, extends Core.Base#BASE +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from LIFODescription

LIFO.ClassName

 +

Name of the class.

+

LIFO:Clear()

 +

Empty LIFO Stack

+

LIFO:Count()

 +

LIFO Get stack size

+

LIFO:Flatten()

 +

LIFO Housekeeping

+

LIFO:Flush()

 +

LIFO Print stacks to dcs.log

+

LIFO:ForEach(IteratorFunction, Arg, Function, FunctionArguments)

 +

Iterate the LIFO and call an iterator function for the given LIFO data, providing the object for each element of the stack and optional parameters.

+

LIFO:GetDataTable()

 +

LIFO Get table of data entries

+

LIFO:GetIDStack()

 +

LIFO Get the data stack by UniqueID

+

LIFO:GetIDStackSorted()

 +

LIFO Get table of UniqueIDs sorted smallest to largest

+

LIFO:GetPointerStack()

 +

LIFO Get the data stack by pointer

+

LIFO:GetSize()

 +

LIFO Get stack size

+

LIFO:GetSortedDataTable()

 +

LIFO Get sorted table of data entries by UniqueIDs (must be numerical UniqueIDs only!)

+

LIFO:HasUniqueID(UniqueID)

 +

LIFO Check if a certain UniqeID exists

+

LIFO:IsEmpty()

 +

LIFO Check Stack is empty

+

LIFO:IsNotEmpty()

 +

LIFO Check Stack is NOT empty

+

LIFO:New()

 +

Instantiate a new LIFO Stack

+

LIFO:Pull()

 +

LIFO Pull Object from Stack

+

LIFO:PullByID(UniqueID)

 +

LIFO Pull Object from Stack by UniqueID

+

LIFO:PullByPointer(Pointer)

 +

LIFO Pull Object from Stack by Pointer

+

LIFO:Push(Object, UniqueID)

 +

LIFO Push Object to Stack

+

LIFO:ReadByID(UniqueID)

 +

LIFO Read, not Pull, Object from Stack by UniqueID

+

LIFO:ReadByPointer(Pointer)

 +

LIFO Read, not Pull, Object from Stack by Pointer

+

LIFO.counter

 + +

LIFO.lid

 +

Class id string for output to DCS log file.

+

LIFO.pointer

 + +

LIFO.stackbyid

 + +

LIFO.stackbypointer

 + +

LIFO.uniquecounter

 + +

LIFO.version

 +

Version of LiFo

+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from BASEDescription

LIFO.ClassID

 +

The ID number of the class.

+

LIFO.ClassName

 +

The name of the class.

+

LIFO.ClassNameAndID

 +

The name of the class concatenated with the ID number of the class.

+

LIFO:ClearState(Object, StateName)

 +

Clear the state of an object.

+

LIFO:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

 +

Creation of a Birth Event.

+

LIFO:CreateEventCrash(EventTime, Initiator)

 +

Creation of a Crash Event.

+

LIFO:CreateEventDead(EventTime, Initiator)

 +

Creation of a Dead Event.

+

LIFO:CreateEventPlayerEnterAircraft(PlayerUnit)

 +

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

+

LIFO:CreateEventRemoveUnit(EventTime, Initiator)

 +

Creation of a Remove Unit Event.

+

LIFO:CreateEventTakeoff(EventTime, Initiator)

 +

Creation of a Takeoff Event.

+

LIFO:E(Arguments)

 +

Log an exception which will be traced always.

+

LIFO:EventDispatcher()

 +

Returns the event dispatcher

+

LIFO:EventRemoveAll()

 +

Remove all subscribed events

+

LIFO:F(Arguments)

 +

Trace a function call.

+

LIFO:F2(Arguments)

 +

Trace a function call level 2.

+

LIFO:F3(Arguments)

 +

Trace a function call level 3.

+

LIFO:GetClassID()

 +

Get the ClassID of the class instance.

+

LIFO:GetClassName()

 +

Get the ClassName of the class instance.

+

LIFO:GetClassNameAndID()

 +

Get the ClassName + ClassID of the class instance.

+

LIFO:GetEventPriority()

 +

Get the Class Event processing Priority.

+

LIFO:GetParent(Child, FromClass)

 +

This is the worker method to retrieve the Parent class.

+

LIFO:GetState(Object, Key)

 +

Get a Value given a Key from the Object.

+

LIFO:HandleEvent(EventID, EventFunction)

 +

Subscribe to a DCS Event.

+

LIFO:I(Arguments)

 +

Log an information which will be traced always.

+

LIFO:Inherit(Child, Parent)

 +

This is the worker method to inherit from a parent class.

+

LIFO:IsInstanceOf(ClassName)

 +

This is the worker method to check if an object is an (sub)instance of a class.

+

LIFO:IsTrace()

 +

Enquires if tracing is on (for the class).

+

LIFO:New()

 +

BASE constructor.

+

LIFO:OnEvent(EventData)

 +

Occurs when an object is completely destroyed.

+

LIFO:OnEventBDA(EventData)

 +

BDA.

+

LIFO:OnEventBaseCaptured(EventData)

 +

Occurs when a ground unit captures either an airbase or a farp.

+

LIFO:OnEventBirth(EventData)

 +

Occurs when any object is spawned into the mission.

+

LIFO:OnEventCrash(EventData)

 +

Occurs when any aircraft crashes into the ground and is completely destroyed.

+

LIFO:OnEventDead(EventData)

 +

Occurs when an object is dead.

+

LIFO:OnEventDetailedFailure(EventData)

 +

Unknown precisely what creates this event, likely tied into newer damage model.

+

LIFO:OnEventDiscardChairAfterEjection(EventData)

 +

Discard chair after ejection.

+

LIFO:OnEventEjection(EventData)

 +

Occurs when a pilot ejects from an aircraft +initiator : The unit that has ejected

+

LIFO:OnEventEngineShutdown(EventData)

 +

Occurs when any aircraft shuts down its engines.

+

LIFO:OnEventEngineStartup(EventData)

 +

Occurs when any aircraft starts its engines.

+

LIFO:OnEventHit(EventData)

 +

Occurs whenever an object is hit by a weapon.

+

LIFO:OnEventHumanFailure(EventData)

 +

Occurs when any system fails on a human controlled aircraft.

+

LIFO:OnEventKill(EventData)

 +

Occurs on the death of a unit.

+

LIFO:OnEventLand(EventData)

 +

Occurs when an aircraft lands at an airbase, farp or ship +initiator : The unit that has landed.

+

LIFO:OnEventLandingAfterEjection(EventData)

 +

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

+

LIFO:OnEventLandingQualityMark(EventData)

 +

Landing quality mark.

+

LIFO:OnEventMarkAdded(EventData)

 +

Occurs when a new mark was added.

+

LIFO:OnEventMarkChange(EventData)

 +

Occurs when a mark text was changed.

+

LIFO:OnEventMarkRemoved(EventData)

 +

Occurs when a mark was removed.

+

LIFO:OnEventMissionEnd(EventData)

 +

Occurs when a mission ends.

+

LIFO:OnEventMissionStart(EventData)

 +

Occurs when a mission starts.

+

LIFO:OnEventParatrooperLanding(EventData)

 +

Weapon add.

+

LIFO:OnEventPilotDead(EventData)

 +

Occurs when the pilot of an aircraft is killed.

+

LIFO:OnEventPlayerEnterAircraft(EventData)

 +

Occurs when a player enters a slot and takes control of an aircraft.

+

LIFO:OnEventPlayerEnterUnit(EventData)

 +

Occurs when any player assumes direct control of a unit.

+

LIFO:OnEventPlayerLeaveUnit(EventData)

 +

Occurs when any player relieves control of a unit to the AI.

+

LIFO:OnEventRefueling(EventData)

 +

Occurs when an aircraft connects with a tanker and begins taking on fuel.

+

LIFO:OnEventRefuelingStop(EventData)

 +

Occurs when an aircraft is finished taking fuel.

+

LIFO:OnEventScore(EventData)

 +

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

+

LIFO:OnEventShootingEnd(EventData)

 +

Occurs when any unit stops firing its weapon.

+

LIFO:OnEventShootingStart(EventData)

 +

Occurs when any unit begins firing a weapon that has a high rate of fire.

+

LIFO:OnEventShot(EventData)

 +

Occurs whenever any unit in a mission fires a weapon.

+

LIFO:OnEventTakeoff(EventData)

 +

Occurs when an aircraft takes off from an airbase, farp, or ship.

+

LIFO:OnEventTriggerZone(EventData)

 +

Trigger zone.

+

LIFO:OnEventUnitLost(EventData)

 +

Occurs when the game thinks an object is destroyed.

+

LIFO:ScheduleOnce(Start, SchedulerFunction, ...)

 +

Schedule a new time event.

+

LIFO:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

 +

Schedule a new time event.

+

LIFO:ScheduleStop(SchedulerFunction)

 +

Stops the Schedule.

+

LIFO.Scheduler

 + +

LIFO:SetEventPriority(EventPriority)

 +

Set the Class Event processing Priority.

+

LIFO:SetState(Object, Key, Value)

 +

Set a state or property of the Object given a Key and a Value.

+

LIFO:T(Arguments)

 +

Trace a function logic level 1.

+

LIFO:T2(Arguments)

 +

Trace a function logic level 2.

+

LIFO:T3(Arguments)

 +

Trace a function logic level 3.

+

LIFO:TraceAll(TraceAll)

 +

Trace all methods in MOOSE

+

LIFO:TraceClass(Class)

 +

Set tracing for a class

+

LIFO:TraceClassMethod(Class, Method)

 +

Set tracing for a specific method of class

+

LIFO:TraceLevel(Level)

 +

Set trace level

+

LIFO:TraceOff()

 +

Set trace off.

+

LIFO:TraceOn()

 +

Set trace on.

+

LIFO:TraceOnOff(TraceOnOff)

 +

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.

+

LIFO:UnHandleEvent(EventID)

 +

UnSubscribe to a DCS event.

+

LIFO._

 + +

LIFO:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function call.

+

LIFO:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function logic.

+

LIFO.__

 + +

LIFO:onEvent(event)

 + +
+
+ +

Type LIFO.IDEntry

+
+ LIFO.IDEntry +
+
+ + + + + + + + + + + + + + + + + +
Fields and Methods inherited from LIFO.IDEntryDescription

LIFO.IDEntry.data

 + +

LIFO.IDEntry.pointer

 + +

LIFO.IDEntry.uniqueID

 + +
+
+ +

Type Utils.FiFo

+
+
+
+ +
+

Type FIFO

+
+
+ +

FIFO class.

+ +
+

Field(s)

+
+
+
+ + #string +FIFO.ClassName + +

Name of the class.

+ +
+ +
+
+
+ + #number +FIFO.counter + + + +
+ +
+
+
+ + #string +FIFO.lid + +

Class id string for output to DCS log file.

+ +
+ +
+
+
+ + #number +FIFO.pointer + + + +
+ +
+
+
+ + #table +FIFO.stackbyid + + + +
+ +
+
+
+ + #table +FIFO.stackbypointer + + + +
+ +
+
+
+ + #number +FIFO.uniquecounter + + + +
+ +
+
+
+ + #string +FIFO.version + +

Version of FiFo

+ +
+ +
+
+

Function(s)

+
+
+ +
+

FIFO:Clear()

+
+ +

Empty FIFO Stack

+ +
+
+

Defined in:

+
+

FIFO

+
+

Return value:

+
+
+

#FIFO:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:Count()

+
+ +

FIFO Get stack size

+ +
+
+

Defined in:

+
+

FIFO

+
+

Return value:

+
+
+

#number:

+
+
+ +

size

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:Flatten()

+
+ +

FIFO Housekeeping

+ +
+
+

Defined in:

+
+

FIFO

+
+

Return value:

+
+
+

#FIFO:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:Flush()

+
+ +

FIFO Print stacks to dcs.log

+ +
+
+

Defined in:

+
+

FIFO

+
+

Return value:

+
+
+

#FIFO:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:ForEach(IteratorFunction, Arg, Function, FunctionArguments)

+
+ +

Iterate the FIFO and call an iterator function for the given FIFO data, providing the object for each element of the stack and optional parameters.

+ +
+
+

Defined in:

+
+

FIFO

+
+

Parameters:

+
+
+

+ #function + IteratorFunction +

+
+
+ +

The function that will be called.

+ +
+
+
+
+

+ #table + Arg +

+
+
+ +

(Optional) Further Arguments of the IteratorFunction.

+ +
+
+
+
+

+ #function + Function +

+
+
+ +

(Optional) A function returning a #boolean true/false. Only if true, the IteratorFunction is called.

+ +
+
+
+
+

+ #table + FunctionArguments +

+
+
+ +

(Optional) Function arguments.

+ +
+
+

Return value:

+
+
+

#FIFO:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:GetDataTable()

+
+ +

FIFO Get table of data entries

+ +
+
+

Defined in:

+
+

FIFO

+
+

Return value:

+
+
+

#table:

+
+
+ +

Raw table indexed [1] to [n] of object entries - might be empty!

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:GetIDStack()

+
+ +

FIFO Get the data stack by UniqueID

+ +
+
+

Defined in:

+
+

FIFO

+
+

Return value:

+
+
+

#table:

+
+
+ +

Table of #FIFO.IDEntry entries

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:GetIDStackSorted()

+
+ +

FIFO Get table of UniqueIDs sorted smallest to largest

+ +
+
+

Defined in:

+
+

FIFO

+
+

Return value:

+
+
+

#table:

+
+
+ +

Table with index [1] to [n] of UniqueID entries

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:GetPointerStack()

+
+ +

FIFO Get the data stack by pointer

+ +
+
+

Defined in:

+
+

FIFO

+
+

Return value:

+
+
+

#table:

+
+
+ +

Table of #FIFO.IDEntry entries

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:GetSize()

+
+ +

FIFO Get stack size

+ +
+
+

Defined in:

+
+

FIFO

+
+

Return value:

+
+
+

#number:

+
+
+ +

size

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:GetSortedDataTable()

+
+ +

FIFO Get sorted table of data entries by UniqueIDs (must be numerical UniqueIDs only!)

+ +
+
+

Defined in:

+
+

FIFO

+
+

Return value:

+
+
+

#table:

+
+
+ +

Table indexed [1] to [n] of sorted object entries - might be empty!

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:HasUniqueID(UniqueID)

+
+ +

FIFO Check if a certain UniqeID exists

+ +
+
+

Defined in:

+
+

FIFO

+
+

Parameter:

+
+
+

+ UniqueID +

+
+
+

+
+
+

Return value:

+
+
+

#boolean:

+
+
+ +

exists

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:IsEmpty()

+
+ +

FIFO Check Stack is empty

+ +
+
+

Defined in:

+
+

FIFO

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

empty

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:IsNotEmpty()

+
+ +

FIFO Check Stack is NOT empty

+ +
+
+

Defined in:

+
+

FIFO

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

notempty

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:New()

+
+ +

Instantiate a new FIFO Stack

+ +
+
+

Defined in:

+
+

FIFO

+
+

Return value:

+
+
+

#FIFO:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:Pull()

+
+ +

FIFO Pull Object from Stack

+ +
+
+

Defined in:

+
+

FIFO

+
+

Return value:

+
+
+

#table:

+
+
+ +

Object or nil if stack is empty

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:PullByID(UniqueID)

+
+ +

FIFO Pull Object from Stack by UniqueID

+ +
+
+

Defined in:

+
+

FIFO

+
+

Parameter:

+
+
+

+ UniqueID +

+
+
+

+
+
+

Return value:

+
+
+

#table:

+
+
+ +

Object or nil if stack is empty

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:PullByPointer(Pointer)

+
+ +

FIFO Pull Object from Stack by Pointer

+ +
+
+

Defined in:

+
+

FIFO

+
+

Parameter:

+
+
+

+ #number + Pointer +

+
+
+

+
+
+

Return value:

+
+
+

#table:

+
+
+ +

Object or nil if stack is empty

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:Push(Object, UniqueID)

+
+ +

FIFO Push Object to Stack

+ +
+
+

Defined in:

+
+

FIFO

+
+

Parameters:

+
+
+

+ #table + Object +

+
+
+

+
+
+
+
+

+ #string + UniqueID +

+
+
+ +

(optional) - will default to current pointer + 1. Note - if you intend to use FIFO:GetIDStackSorted() keep the UniqueID numerical!

+ +
+
+

Return value:

+
+
+

#FIFO:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:ReadByID(UniqueID)

+
+ +

FIFO Read, not Pull, Object from Stack by UniqueID

+ +
+
+

Defined in:

+
+

FIFO

+
+

Parameter:

+
+
+

+ #number + UniqueID +

+
+
+

+
+
+

Return value:

+
+
+

#table:

+
+
+ +

Object data or nil if stack is empty or ID does not exist

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:ReadByPointer(Pointer)

+
+ +

FIFO Read, not Pull, Object from Stack by Pointer

+ +
+
+

Defined in:

+
+

FIFO

+
+

Parameter:

+
+
+

+ #number + Pointer +

+
+
+

+
+
+

Return value:

+
+
+

#table:

+
+
+ +

Object or nil if stack is empty or pointer does not exist

+ +
+
+
+ +
+
+ +
+

Field(s)

+
+
+
+ + #string +FIFO.ClassName + +

Name of the class.

+ +
+ +
+
+
+ + #number +FIFO.counter + + + +
+ +
+
+
+ + #string +FIFO.lid + +

Class id string for output to DCS log file.

+ +
+ +
+
+
+ + #number +FIFO.pointer + + + +
+ +
+
+
+ + #table +FIFO.stackbyid + + + +
+ +
+
+
+ + #table +FIFO.stackbypointer + + + +
+ +
+
+
+ + #number +FIFO.uniquecounter + + + +
+ +
+
+
+ + #string +FIFO.version + +

Version of FiFo

+ +
+ +
+
+

Function(s)

+
+
+ +
+

FIFO:ClearState(Object, StateName)

+
+ +

Clear the state of an object.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Object +

+
+
+ +

The object that holds the Value set by the Key.

+ +
+
+
+
+

+ StateName +

+
+
+ +

The key that is should be cleared.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

+
+ +

Creation of a Birth Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

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 +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

FIFO:CreateEventCrash(EventTime, Initiator)

+
+ +

Creation of a Crash Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:CreateEventDead(EventTime, Initiator)

+
+ +

Creation of a Dead Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:CreateEventPlayerEnterAircraft(PlayerUnit)

+
+ +

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Wrapper.Unit#UNIT + PlayerUnit +

+
+
+ +

The aircraft unit the player entered.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:CreateEventRemoveUnit(EventTime, Initiator)

+
+ +

Creation of a Remove Unit Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:CreateEventTakeoff(EventTime, Initiator)

+
+ +

Creation of a Takeoff Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:E(Arguments)

+
+ +

Log an exception which will be traced always.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:EventDispatcher()

+
+ +

Returns the event dispatcher

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

Core.Event#EVENT:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

FIFO:EventRemoveAll()

+
+ +

Remove all subscribed events

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

FIFO:F(Arguments)

+
+ +

Trace a function call.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:F2(Arguments)

+
+ +

Trace a function call level 2.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:F3(Arguments)

+
+ +

Trace a function call level 3.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:GetClassID()

+
+ +

Get the ClassID of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassID of the class instance.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:GetClassName()

+
+ +

Get the ClassName of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassName of the class instance.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:GetClassNameAndID()

+
+ +

Get the ClassName + ClassID of the class instance.

+ + +

The ClassName + ClassID is formatted as '%s#%09d'.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassName + ClassID of the class instance.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:GetEventPriority()

+
+ +

Get the Class 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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The Event processing Priority.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:GetParent(Child, FromClass)

+
+ +

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()
+
+ + + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #BASE + Child +

+
+
+ +

This is the Child class from which the Parent class needs to be retrieved.

+ +
+
+
+
+

+ #BASE + FromClass +

+
+
+ +

(Optional) The class from which to get the parent.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

FIFO:GetState(Object, Key)

+
+ +

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:

+
+

Core.Base#BASE

+
+

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.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:HandleEvent(EventID, EventFunction)

+
+ +

Subscribe to a DCS Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Core.Event#EVENTS + EventID +

+
+
+ +

Event ID.

+ +
+
+
+
+

+ #function + EventFunction +

+
+
+ +

(optional) The function to be called when the event occurs for the unit.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

FIFO:I(Arguments)

+
+ +

Log an information which will be traced always.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:Inherit(Child, Parent)

+
+ +

This is the worker method to inherit from a parent class.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Child +

+
+
+ +

is the Child class that inherits.

+ +
+
+
+
+

+ #BASE + Parent +

+
+
+ +

is the Parent class that the Child inherits from.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ +

Child

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:IsInstanceOf(ClassName)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ ClassName +

+
+
+ +

is the name of the class or the class itself to run the check against

+ +
+
+

Return value:

+
+
+

#boolean:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

FIFO:IsTrace()

+
+ +

Enquires if tracing is on (for the class).

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#boolean:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

FIFO:New()

+
+ +

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
+
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEvent(EventData)

+
+ +

Occurs when an object is completely destroyed.

+ + +

initiator : The unit that is was destroyed.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventBDA(EventData)

+
+ +

BDA.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventBaseCaptured(EventData)

+
+ +

Occurs when a ground unit captures either an airbase or a farp.

+ + +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventBirth(EventData)

+
+ +

Occurs when any object is spawned into the mission.

+ + +

initiator : The unit that was spawned.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventCrash(EventData)

+
+ +

Occurs when any aircraft crashes into the ground and is completely destroyed.

+ + +

initiator : The unit that has crashed.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventDead(EventData)

+
+ +

Occurs when an object is dead.

+ + +

initiator : The unit that is dead.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventDetailedFailure(EventData)

+
+ +

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.
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventDiscardChairAfterEjection(EventData)

+
+ +

Discard chair after ejection.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventEjection(EventData)

+
+ +

Occurs when a pilot ejects from an aircraft +initiator : The unit that has ejected

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventEngineShutdown(EventData)

+
+ +

Occurs when any aircraft shuts down its engines.

+ + +

initiator : The unit that is stopping its engines..

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventEngineStartup(EventData)

+
+ +

Occurs when any aircraft starts its engines.

+ + +

initiator : The unit that is starting its engines..

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventHit(EventData)

+
+ +

Occurs whenever an object is hit by a weapon.

+ + +

initiator : The unit object the fired the weapon. +weapon: Weapon object that hit the target. +target: The Object that was hit.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventHumanFailure(EventData)

+
+ +

Occurs when any system fails on a human controlled aircraft.

+ + +

initiator : The unit that had the failure.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventKill(EventData)

+
+ +

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.

+ +
    +
  • initiator: The unit that killed the target.
    • +
  • target: Target Object
    • +
  • weapon: Weapon Object
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventLand(EventData)

+
+ +

Occurs when an 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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventLandingAfterEjection(EventData)

+
+ +

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.

+ +
    +
  • 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.
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventLandingQualityMark(EventData)

+
+ +

Landing quality mark.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventMarkAdded(EventData)

+
+ +

Occurs when a new mark was added.

+ + +

MarkID: ID of the mark.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventMarkChange(EventData)

+
+ +

Occurs when a mark text was changed.

+ + +

MarkID: ID of the mark.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventMarkRemoved(EventData)

+
+ +

Occurs when a mark was removed.

+ + +

MarkID: ID of the mark.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventMissionEnd(EventData)

+
+ +

Occurs when a mission ends.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventMissionStart(EventData)

+
+ +

Occurs when a mission starts.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventParatrooperLanding(EventData)

+
+ +

Weapon add.

+ + +

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventPilotDead(EventData)

+
+ +

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. +initiator : The unit that the pilot has died in.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventPlayerEnterAircraft(EventData)

+
+ +

Occurs when a player enters a slot and takes control of an aircraft.

+ + +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventPlayerEnterUnit(EventData)

+
+ +

Occurs when any player assumes direct control of a unit.

+ + +

initiator : The unit that is being taken control of.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventPlayerLeaveUnit(EventData)

+
+ +

Occurs when any player relieves control of a unit to the AI.

+ + +

initiator : The unit that the player left.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventRefueling(EventData)

+
+ +

Occurs when an aircraft connects with a tanker and begins taking on fuel.

+ + +

initiator : The unit that is receiving fuel.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventRefuelingStop(EventData)

+
+ +

Occurs when an aircraft is finished taking fuel.

+ + +

initiator : The unit that was receiving fuel.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventScore(EventData)

+
+ +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventShootingEnd(EventData)

+
+ +

Occurs when any unit stops firing its weapon.

+ + +

Event will always correspond with a shooting start event. +initiator : The unit that was doing the shooting.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventShootingStart(EventData)

+
+ +

Occurs when any unit begins firing a weapon that has a high rate of fire.

+ + +

Most common with aircraft cannons (GAU-8), auto cannons, and machine guns. +initiator : The unit that is doing the shooting. +target: The unit that is being targeted.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventShot(EventData)

+
+ +

Occurs whenever any unit in a mission fires a weapon.

+ + +

But not any machine gun or auto cannon based weapon, those are handled by EVENT.ShootingStart.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventTakeoff(EventData)

+
+ +

Occurs when an aircraft takes off from an airbase, farp, or ship.

+ + +

initiator : The unit that took off. +place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventTriggerZone(EventData)

+
+ +

Trigger zone.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:OnEventUnitLost(EventData)

+
+ +

Occurs when the game thinks an object is destroyed.

+ + + +
    +
  • initiator: The unit that is was destroyed.
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:ScheduleOnce(Start, SchedulerFunction, ...)

+
+ +

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:

+
+

Core.Base#BASE

+
+

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:

+
+
+

#number:

+
+
+ +

The ScheduleID of the planned schedule.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

+
+ +

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:

+
+

Core.Base#BASE

+
+

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:

+
+
+

#number:

+
+
+ +

The ScheduleID of the planned schedule.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:ScheduleStop(SchedulerFunction)

+
+ +

Stops the Schedule.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #function + SchedulerFunction +

+
+
+ +

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:SetEventPriority(EventPriority)

+
+ +

Set the Class 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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #number + EventPriority +

+
+
+ +

The Event processing Priority.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:SetState(Object, Key, Value)

+
+ +

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:

+
+

Core.Base#BASE

+
+

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.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:T(Arguments)

+
+ +

Trace a function logic level 1.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:T2(Arguments)

+
+ +

Trace a function logic level 2.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:T3(Arguments)

+
+ +

Trace a function logic level 3.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:TraceAll(TraceAll)

+
+ +

Trace all methods in MOOSE

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #boolean + TraceAll +

+
+
+ +

true = trace all methods in MOOSE.

+ +
+
+
+ +
+
+ +
+ +
+

FIFO:TraceClass(Class)

+
+ +

Set tracing for a class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #string + Class +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

FIFO:TraceClassMethod(Class, Method)

+
+ +

Set tracing for a specific method of class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #string + Class +

+
+
+

+
+
+
+
+

+ #string + Method +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

FIFO:TraceLevel(Level)

+
+ +

Set trace level

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #number + Level +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

FIFO:TraceOff()

+
+ +

Set trace off.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

+ 
-- Switch the tracing Off
+BASE:TraceOff()
+ +
+ +
+
+ +
+ +
+

FIFO:TraceOn()

+
+ +

Set trace on.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

+ 
-- Switch the tracing On
+BASE:TraceOn()
+ +
+ +
+
+ +
+ +
+

FIFO:TraceOnOff(TraceOnOff)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #boolean + TraceOnOff +

+
+
+ +

Switch the tracing on or off.

+ +
+
+

Usage:

+ 

+  -- Switch the tracing On
+  BASE:TraceOnOff( true )
+
+  -- Switch the tracing Off
+  BASE:TraceOnOff( false )
+
+ +
+ +
+
+ +
+ +
+

FIFO:UnHandleEvent(EventID)

+
+ +

UnSubscribe to a DCS event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTS + EventID +

+
+
+ +

Event ID.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

FIFO:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+
+ +

Trace a function call.

+ + +

This function is private.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

FIFO:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+
+ +

Trace a function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

FIFO:onEvent(event)

+
+ + + + +

TODO: Complete DCS#Event structure. +- The main event handling function... This function captures all events generated for the class. + @param #BASE self + @param DCS#Event event

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ event +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

Type FIFO.IDEntry

+
+
+
+

Field(s)

+
+
+
+ + #table +FIFO.IDEntry.data + + + +
+ +
+
+
+ + #number +FIFO.IDEntry.pointer + + + +
+ +
+
+
+ + #table +FIFO.IDEntry.uniqueID + + + +
+ +
+
+

Function(s)

+
+
+ +
+

Type LIFO

+
+
+ +

LIFO class.

+ +
+

Field(s)

+
+
+
+ + #string +LIFO.ClassName + +

Name of the class.

+ +
+ +
+
+
+ + #number +LIFO.counter + + + +
+ +
+
+
+ + #string +LIFO.lid + +

Class id string for output to DCS log file.

+ +
+ +
+
+
+ + #number +LIFO.pointer + + + +
+ +
+
+
+ + #table +LIFO.stackbyid + + + +
+ +
+
+
+ + #table +LIFO.stackbypointer + + + +
+ +
+
+
+ + #number +LIFO.uniquecounter + + + +
+ +
+
+
+ + #string +LIFO.version + +

Version of LiFo

+ +
+ +
+
+

Function(s)

+
+
+ +
+

LIFO:Clear()

+
+ +

Empty LIFO Stack

+ +
+
+

Defined in:

+
+

LIFO

+
+

Return value:

+
+
+

#LIFO:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:Count()

+
+ +

LIFO Get stack size

+ +
+
+

Defined in:

+
+

LIFO

+
+

Return value:

+
+
+

#number:

+
+
+ +

size

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:Flatten()

+
+ +

LIFO Housekeeping

+ +
+
+

Defined in:

+
+

LIFO

+
+

Return value:

+
+
+

#LIFO:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:Flush()

+
+ +

LIFO Print stacks to dcs.log

+ +
+
+

Defined in:

+
+

LIFO

+
+

Return value:

+
+
+

#LIFO:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:ForEach(IteratorFunction, Arg, Function, FunctionArguments)

+
+ +

Iterate the LIFO and call an iterator function for the given LIFO data, providing the object for each element of the stack and optional parameters.

+ +
+
+

Defined in:

+
+

LIFO

+
+

Parameters:

+
+
+

+ #function + IteratorFunction +

+
+
+ +

The function that will be called.

+ +
+
+
+
+

+ #table + Arg +

+
+
+ +

(Optional) Further Arguments of the IteratorFunction.

+ +
+
+
+
+

+ #function + Function +

+
+
+ +

(Optional) A function returning a #boolean true/false. Only if true, the IteratorFunction is called.

+ +
+
+
+
+

+ #table + FunctionArguments +

+
+
+ +

(Optional) Function arguments.

+ +
+
+

Return value:

+
+
+

#LIFO:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:GetDataTable()

+
+ +

LIFO Get table of data entries

+ +
+
+

Defined in:

+
+

LIFO

+
+

Return value:

+
+
+

#table:

+
+
+ +

Raw table indexed [1] to [n] of object entries - might be empty!

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:GetIDStack()

+
+ +

LIFO Get the data stack by UniqueID

+ +
+
+

Defined in:

+
+

LIFO

+
+

Return value:

+
+
+

#table:

+
+
+ +

Table of #LIFO.IDEntry entries

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:GetIDStackSorted()

+
+ +

LIFO Get table of UniqueIDs sorted smallest to largest

+ +
+
+

Defined in:

+
+

LIFO

+
+

Return value:

+
+
+

#table:

+
+
+ +

Table of #LIFO.IDEntry entries

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:GetPointerStack()

+
+ +

LIFO Get the data stack by pointer

+ +
+
+

Defined in:

+
+

LIFO

+
+

Return value:

+
+
+

#table:

+
+
+ +

Table of #LIFO.IDEntry entries

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:GetSize()

+
+ +

LIFO Get stack size

+ +
+
+

Defined in:

+
+

LIFO

+
+

Return value:

+
+
+

#number:

+
+
+ +

size

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:GetSortedDataTable()

+
+ +

LIFO Get sorted table of data entries by UniqueIDs (must be numerical UniqueIDs only!)

+ +
+
+

Defined in:

+
+

LIFO

+
+

Return value:

+
+
+

#table:

+
+
+ +

Table indexed [1] to [n] of sorted object entries - might be empty!

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:HasUniqueID(UniqueID)

+
+ +

LIFO Check if a certain UniqeID exists

+ +
+
+

Defined in:

+
+

LIFO

+
+

Parameter:

+
+
+

+ UniqueID +

+
+
+

+
+
+

Return value:

+
+
+

#boolean:

+
+
+ +

exists

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:IsEmpty()

+
+ +

LIFO Check Stack is empty

+ +
+
+

Defined in:

+
+

LIFO

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

empty

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:IsNotEmpty()

+
+ +

LIFO Check Stack is NOT empty

+ +
+
+

Defined in:

+
+

LIFO

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

notempty

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:New()

+
+ +

Instantiate a new LIFO Stack

+ +
+
+

Defined in:

+
+

LIFO

+
+

Return value:

+
+
+

#LIFO:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:Pull()

+
+ +

LIFO Pull Object from Stack

+ +
+
+

Defined in:

+
+

LIFO

+
+

Return value:

+
+
+

#table:

+
+
+ +

Object or nil if stack is empty

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:PullByID(UniqueID)

+
+ +

LIFO Pull Object from Stack by UniqueID

+ +
+
+

Defined in:

+
+

LIFO

+
+

Parameter:

+
+
+

+ UniqueID +

+
+
+

+
+
+

Return value:

+
+
+

#table:

+
+
+ +

Object or nil if stack is empty

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:PullByPointer(Pointer)

+
+ +

LIFO Pull Object from Stack by Pointer

+ +
+
+

Defined in:

+
+

LIFO

+
+

Parameter:

+
+
+

+ #number + Pointer +

+
+
+

+
+
+

Return value:

+
+
+

#table:

+
+
+ +

Object or nil if stack is empty

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:Push(Object, UniqueID)

+
+ +

LIFO Push Object to Stack

+ +
+
+

Defined in:

+
+

LIFO

+
+

Parameters:

+
+
+

+ #table + Object +

+
+
+

+
+
+
+
+

+ #string + UniqueID +

+
+
+ +

(optional) - will default to current pointer + 1

+ +
+
+

Return value:

+
+
+

#LIFO:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:ReadByID(UniqueID)

+
+ +

LIFO Read, not Pull, Object from Stack by UniqueID

+ +
+
+

Defined in:

+
+

LIFO

+
+

Parameter:

+
+
+

+ #number + UniqueID +

+
+
+

+
+
+

Return value:

+
+
+

#table:

+
+
+ +

Object or nil if stack is empty or ID does not exist

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:ReadByPointer(Pointer)

+
+ +

LIFO Read, not Pull, Object from Stack by Pointer

+ +
+
+

Defined in:

+
+

LIFO

+
+

Parameter:

+
+
+

+ #number + Pointer +

+
+
+

+
+
+

Return value:

+
+
+

#table:

+
+
+ +

Object or nil if stack is empty or pointer does not exist

+ +
+
+
+ +
+
+ +
+

Field(s)

+
+
+
+ + #string +LIFO.ClassName + +

Name of the class.

+ +
+ +
+
+
+ + #number +LIFO.counter + + + +
+ +
+
+
+ + #string +LIFO.lid + +

Class id string for output to DCS log file.

+ +
+ +
+
+
+ + #number +LIFO.pointer + + + +
+ +
+
+
+ + #table +LIFO.stackbyid + + + +
+ +
+
+
+ + #table +LIFO.stackbypointer + + + +
+ +
+
+
+ + #number +LIFO.uniquecounter + + + +
+ +
+
+
+ + #string +LIFO.version + +

Version of LiFo

+ +
+ +
+
+

Function(s)

+
+
+ +
+

LIFO:ClearState(Object, StateName)

+
+ +

Clear the state of an object.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Object +

+
+
+ +

The object that holds the Value set by the Key.

+ +
+
+
+
+

+ StateName +

+
+
+ +

The key that is should be cleared.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

+
+ +

Creation of a Birth Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

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 +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

LIFO:CreateEventCrash(EventTime, Initiator)

+
+ +

Creation of a Crash Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:CreateEventDead(EventTime, Initiator)

+
+ +

Creation of a Dead Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:CreateEventPlayerEnterAircraft(PlayerUnit)

+
+ +

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Wrapper.Unit#UNIT + PlayerUnit +

+
+
+ +

The aircraft unit the player entered.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:CreateEventRemoveUnit(EventTime, Initiator)

+
+ +

Creation of a Remove Unit Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:CreateEventTakeoff(EventTime, Initiator)

+
+ +

Creation of a Takeoff Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:E(Arguments)

+
+ +

Log an exception which will be traced always.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:EventDispatcher()

+
+ +

Returns the event dispatcher

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

Core.Event#EVENT:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

LIFO:EventRemoveAll()

+
+ +

Remove all subscribed events

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

LIFO:F(Arguments)

+
+ +

Trace a function call.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:F2(Arguments)

+
+ +

Trace a function call level 2.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:F3(Arguments)

+
+ +

Trace a function call level 3.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:GetClassID()

+
+ +

Get the ClassID of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassID of the class instance.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:GetClassName()

+
+ +

Get the ClassName of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassName of the class instance.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:GetClassNameAndID()

+
+ +

Get the ClassName + ClassID of the class instance.

+ + +

The ClassName + ClassID is formatted as '%s#%09d'.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassName + ClassID of the class instance.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:GetEventPriority()

+
+ +

Get the Class 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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The Event processing Priority.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:GetParent(Child, FromClass)

+
+ +

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()
+
+ + + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #BASE + Child +

+
+
+ +

This is the Child class from which the Parent class needs to be retrieved.

+ +
+
+
+
+

+ #BASE + FromClass +

+
+
+ +

(Optional) The class from which to get the parent.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

LIFO:GetState(Object, Key)

+
+ +

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:

+
+

Core.Base#BASE

+
+

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.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:HandleEvent(EventID, EventFunction)

+
+ +

Subscribe to a DCS Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Core.Event#EVENTS + EventID +

+
+
+ +

Event ID.

+ +
+
+
+
+

+ #function + EventFunction +

+
+
+ +

(optional) The function to be called when the event occurs for the unit.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

LIFO:I(Arguments)

+
+ +

Log an information which will be traced always.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:Inherit(Child, Parent)

+
+ +

This is the worker method to inherit from a parent class.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Child +

+
+
+ +

is the Child class that inherits.

+ +
+
+
+
+

+ #BASE + Parent +

+
+
+ +

is the Parent class that the Child inherits from.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ +

Child

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:IsInstanceOf(ClassName)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ ClassName +

+
+
+ +

is the name of the class or the class itself to run the check against

+ +
+
+

Return value:

+
+
+

#boolean:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

LIFO:IsTrace()

+
+ +

Enquires if tracing is on (for the class).

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#boolean:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

LIFO:New()

+
+ +

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
+
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEvent(EventData)

+
+ +

Occurs when an object is completely destroyed.

+ + +

initiator : The unit that is was destroyed.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventBDA(EventData)

+
+ +

BDA.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventBaseCaptured(EventData)

+
+ +

Occurs when a ground unit captures either an airbase or a farp.

+ + +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventBirth(EventData)

+
+ +

Occurs when any object is spawned into the mission.

+ + +

initiator : The unit that was spawned.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventCrash(EventData)

+
+ +

Occurs when any aircraft crashes into the ground and is completely destroyed.

+ + +

initiator : The unit that has crashed.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventDead(EventData)

+
+ +

Occurs when an object is dead.

+ + +

initiator : The unit that is dead.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventDetailedFailure(EventData)

+
+ +

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.
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventDiscardChairAfterEjection(EventData)

+
+ +

Discard chair after ejection.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventEjection(EventData)

+
+ +

Occurs when a pilot ejects from an aircraft +initiator : The unit that has ejected

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventEngineShutdown(EventData)

+
+ +

Occurs when any aircraft shuts down its engines.

+ + +

initiator : The unit that is stopping its engines..

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventEngineStartup(EventData)

+
+ +

Occurs when any aircraft starts its engines.

+ + +

initiator : The unit that is starting its engines..

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventHit(EventData)

+
+ +

Occurs whenever an object is hit by a weapon.

+ + +

initiator : The unit object the fired the weapon. +weapon: Weapon object that hit the target. +target: The Object that was hit.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventHumanFailure(EventData)

+
+ +

Occurs when any system fails on a human controlled aircraft.

+ + +

initiator : The unit that had the failure.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventKill(EventData)

+
+ +

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.

+ +
    +
  • initiator: The unit that killed the target.
    • +
  • target: Target Object
    • +
  • weapon: Weapon Object
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventLand(EventData)

+
+ +

Occurs when an 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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventLandingAfterEjection(EventData)

+
+ +

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.

+ +
    +
  • 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.
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventLandingQualityMark(EventData)

+
+ +

Landing quality mark.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventMarkAdded(EventData)

+
+ +

Occurs when a new mark was added.

+ + +

MarkID: ID of the mark.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventMarkChange(EventData)

+
+ +

Occurs when a mark text was changed.

+ + +

MarkID: ID of the mark.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventMarkRemoved(EventData)

+
+ +

Occurs when a mark was removed.

+ + +

MarkID: ID of the mark.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventMissionEnd(EventData)

+
+ +

Occurs when a mission ends.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventMissionStart(EventData)

+
+ +

Occurs when a mission starts.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventParatrooperLanding(EventData)

+
+ +

Weapon add.

+ + +

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventPilotDead(EventData)

+
+ +

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. +initiator : The unit that the pilot has died in.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventPlayerEnterAircraft(EventData)

+
+ +

Occurs when a player enters a slot and takes control of an aircraft.

+ + +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventPlayerEnterUnit(EventData)

+
+ +

Occurs when any player assumes direct control of a unit.

+ + +

initiator : The unit that is being taken control of.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventPlayerLeaveUnit(EventData)

+
+ +

Occurs when any player relieves control of a unit to the AI.

+ + +

initiator : The unit that the player left.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventRefueling(EventData)

+
+ +

Occurs when an aircraft connects with a tanker and begins taking on fuel.

+ + +

initiator : The unit that is receiving fuel.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventRefuelingStop(EventData)

+
+ +

Occurs when an aircraft is finished taking fuel.

+ + +

initiator : The unit that was receiving fuel.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventScore(EventData)

+
+ +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventShootingEnd(EventData)

+
+ +

Occurs when any unit stops firing its weapon.

+ + +

Event will always correspond with a shooting start event. +initiator : The unit that was doing the shooting.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventShootingStart(EventData)

+
+ +

Occurs when any unit begins firing a weapon that has a high rate of fire.

+ + +

Most common with aircraft cannons (GAU-8), auto cannons, and machine guns. +initiator : The unit that is doing the shooting. +target: The unit that is being targeted.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventShot(EventData)

+
+ +

Occurs whenever any unit in a mission fires a weapon.

+ + +

But not any machine gun or auto cannon based weapon, those are handled by EVENT.ShootingStart.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventTakeoff(EventData)

+
+ +

Occurs when an aircraft takes off from an airbase, farp, or ship.

+ + +

initiator : The unit that took off. +place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventTriggerZone(EventData)

+
+ +

Trigger zone.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:OnEventUnitLost(EventData)

+
+ +

Occurs when the game thinks an object is destroyed.

+ + + +
    +
  • initiator: The unit that is was destroyed.
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:ScheduleOnce(Start, SchedulerFunction, ...)

+
+ +

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:

+
+

Core.Base#BASE

+
+

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:

+
+
+

#number:

+
+
+ +

The ScheduleID of the planned schedule.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

+
+ +

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:

+
+

Core.Base#BASE

+
+

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:

+
+
+

#number:

+
+
+ +

The ScheduleID of the planned schedule.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:ScheduleStop(SchedulerFunction)

+
+ +

Stops the Schedule.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #function + SchedulerFunction +

+
+
+ +

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:SetEventPriority(EventPriority)

+
+ +

Set the Class 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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #number + EventPriority +

+
+
+ +

The Event processing Priority.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:SetState(Object, Key, Value)

+
+ +

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:

+
+

Core.Base#BASE

+
+

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.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:T(Arguments)

+
+ +

Trace a function logic level 1.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:T2(Arguments)

+
+ +

Trace a function logic level 2.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:T3(Arguments)

+
+ +

Trace a function logic level 3.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:TraceAll(TraceAll)

+
+ +

Trace all methods in MOOSE

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #boolean + TraceAll +

+
+
+ +

true = trace all methods in MOOSE.

+ +
+
+
+ +
+
+ +
+ +
+

LIFO:TraceClass(Class)

+
+ +

Set tracing for a class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #string + Class +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

LIFO:TraceClassMethod(Class, Method)

+
+ +

Set tracing for a specific method of class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #string + Class +

+
+
+

+
+
+
+
+

+ #string + Method +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

LIFO:TraceLevel(Level)

+
+ +

Set trace level

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #number + Level +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

LIFO:TraceOff()

+
+ +

Set trace off.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

+ 
-- Switch the tracing Off
+BASE:TraceOff()
+ +
+ +
+
+ +
+ +
+

LIFO:TraceOn()

+
+ +

Set trace on.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

+ 
-- Switch the tracing On
+BASE:TraceOn()
+ +
+ +
+
+ +
+ +
+

LIFO:TraceOnOff(TraceOnOff)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #boolean + TraceOnOff +

+
+
+ +

Switch the tracing on or off.

+ +
+
+

Usage:

+ 

+  -- Switch the tracing On
+  BASE:TraceOnOff( true )
+
+  -- Switch the tracing Off
+  BASE:TraceOnOff( false )
+
+ +
+ +
+
+ +
+ +
+

LIFO:UnHandleEvent(EventID)

+
+ +

UnSubscribe to a DCS event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTS + EventID +

+
+
+ +

Event ID.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ + + +
+
+
+ +
+
+ +
+ +
+

LIFO:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+
+ +

Trace a function call.

+ + +

This function is private.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

LIFO:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+
+ +

Trace a function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

LIFO:onEvent(event)

+
+ + + + +

TODO: Complete DCS#Event structure. +- The main event handling function... This function captures all events generated for the class. + @param #BASE self + @param DCS#Event event

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ event +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

Type LIFO.IDEntry

+
+
+
+

Field(s)

+
+
+
+ + #table +LIFO.IDEntry.data + + + +
+ +
+
+
+ + #number +LIFO.IDEntry.pointer + + + +
+ +
+
+
+ + #table +LIFO.IDEntry.uniqueID + + + +
+ +
+
+

Function(s)

+
+
+ +
+
+ + +
+ + + + diff --git a/Documentation/Utils.STTS.html b/Documentation/Utils.STTS.html index 8ac685a71..965900dbe 100644 --- a/Documentation/Utils.STTS.html +++ b/Documentation/Utils.STTS.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Utils.html b/Documentation/Utils.html index b90eff785..ad119353c 100644 --- a/Documentation/Utils.html +++ b/Documentation/Utils.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -1571,27 +1582,6 @@ Controls a network of short range air/missile defense groups.

- - - -
- - - - - -

Global FIFO

 - -
-
-
-
- - #FIFO -FIFO - - -
@@ -1613,27 +1603,6 @@ Controls a network of short range air/missile defense groups.

- - - -
- - - - - -

Global LIFO

 - -
-
-
-
- - #LIFO -LIFO - - -
@@ -1891,711 +1860,6 @@ Controls a network of short range air/missile defense groups.

DCSMAP.TheChannel

The Channel map.

- - - - - -

Type FIFO

-
- FIFO -, extends Core.Base#BASE -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from FIFODescription

FIFO.ClassName

 -

Name of the class.

-

FIFO:Flatten()

 -

FIFO Housekeeping

-

FIFO:Flush()

 -

FIFO Print stacks to dcs.log

-

FIFO:GetIDStack()

 -

FIFO Get the data stack by UniqueID

-

FIFO:GetIDStackSorted()

 -

FIFO Get table of UniqueIDs sorthed smallest to largest

-

FIFO:GetPointerStack()

 -

FIFO Get the data stack by pointer

-

FIFO:GetSize()

 -

FIFO Get stack size

-

FIFO:HasUniqueID(UniqueID)

 -

FIFO Check if a certain UniqeID exists

-

FIFO:IsEmpty()

 -

FIFO Check Stack is empty

-

FIFO:IsNotEmpty()

 -

FIFO Check Stack is NOT empty

-

FIFO:New()

 -

Instantiate a new FIFO Stack

-

FIFO:Pull()

 -

FIFO Pull Object from Stack

-

FIFO:PullByID(UniqueID)

 -

FIFO Pull Object from Stack by UniqueID

-

FIFO:PullByPointer(Pointer)

 -

FIFO Pull Object from Stack by Pointer

-

FIFO:Push(Object, UniqueID)

 -

FIFO Push Object to Stack

-

FIFO.counter

 - -

FIFO.lid

 -

Class id string for output to DCS log file.

-

FIFO.pointer

 - -

FIFO.stackbyid

 - -

FIFO.stackbypointer

 - -

FIFO.uniquecounter

 - -

FIFO.version

 -

Version of FiFo

-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from BASEDescription

FIFO.ClassID

 -

The ID number of the class.

-

FIFO.ClassName

 -

The name of the class.

-

FIFO.ClassNameAndID

 -

The name of the class concatenated with the ID number of the class.

-

FIFO:ClearState(Object, StateName)

 -

Clear the state of an object.

-

FIFO:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

 -

Creation of a Birth Event.

-

FIFO:CreateEventCrash(EventTime, Initiator)

 -

Creation of a Crash Event.

-

FIFO:CreateEventDead(EventTime, Initiator)

 -

Creation of a Dead Event.

-

FIFO:CreateEventPlayerEnterAircraft(PlayerUnit)

 -

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

-

FIFO:CreateEventRemoveUnit(EventTime, Initiator)

 -

Creation of a Remove Unit Event.

-

FIFO:CreateEventTakeoff(EventTime, Initiator)

 -

Creation of a Takeoff Event.

-

FIFO:E(Arguments)

 -

Log an exception which will be traced always.

-

FIFO:EventDispatcher()

 -

Returns the event dispatcher

-

FIFO:EventRemoveAll()

 -

Remove all subscribed events

-

FIFO:F(Arguments)

 -

Trace a function call.

-

FIFO:F2(Arguments)

 -

Trace a function call level 2.

-

FIFO:F3(Arguments)

 -

Trace a function call level 3.

-

FIFO:GetClassID()

 -

Get the ClassID of the class instance.

-

FIFO:GetClassName()

 -

Get the ClassName of the class instance.

-

FIFO:GetClassNameAndID()

 -

Get the ClassName + ClassID of the class instance.

-

FIFO:GetEventPriority()

 -

Get the Class Event processing Priority.

-

FIFO:GetParent(Child, FromClass)

 -

This is the worker method to retrieve the Parent class.

-

FIFO:GetState(Object, Key)

 -

Get a Value given a Key from the Object.

-

FIFO:HandleEvent(EventID, EventFunction)

 -

Subscribe to a DCS Event.

-

FIFO:I(Arguments)

 -

Log an information which will be traced always.

-

FIFO:Inherit(Child, Parent)

 -

This is the worker method to inherit from a parent class.

-

FIFO:IsInstanceOf(ClassName)

 -

This is the worker method to check if an object is an (sub)instance of a class.

-

FIFO:IsTrace()

 -

Enquires if tracing is on (for the class).

-

FIFO:New()

 -

BASE constructor.

-

FIFO:OnEvent(EventData)

 -

Occurs when an object is completely destroyed.

-

FIFO:OnEventBDA(EventData)

 -

BDA.

-

FIFO:OnEventBaseCaptured(EventData)

 -

Occurs when a ground unit captures either an airbase or a farp.

-

FIFO:OnEventBirth(EventData)

 -

Occurs when any object is spawned into the mission.

-

FIFO:OnEventCrash(EventData)

 -

Occurs when any aircraft crashes into the ground and is completely destroyed.

-

FIFO:OnEventDead(EventData)

 -

Occurs when an object is dead.

-

FIFO:OnEventDetailedFailure(EventData)

 -

Unknown precisely what creates this event, likely tied into newer damage model.

-

FIFO:OnEventDiscardChairAfterEjection(EventData)

 -

Discard chair after ejection.

-

FIFO:OnEventEjection(EventData)

 -

Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

-

FIFO:OnEventEngineShutdown(EventData)

 -

Occurs when any aircraft shuts down its engines.

-

FIFO:OnEventEngineStartup(EventData)

 -

Occurs when any aircraft starts its engines.

-

FIFO:OnEventHit(EventData)

 -

Occurs whenever an object is hit by a weapon.

-

FIFO:OnEventHumanFailure(EventData)

 -

Occurs when any system fails on a human controlled aircraft.

-

FIFO:OnEventKill(EventData)

 -

Occurs on the death of a unit.

-

FIFO:OnEventLand(EventData)

 -

Occurs when an aircraft lands at an airbase, farp or ship -initiator : The unit that has landed.

-

FIFO:OnEventLandingAfterEjection(EventData)

 -

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

-

FIFO:OnEventLandingQualityMark(EventData)

 -

Landing quality mark.

-

FIFO:OnEventMarkAdded(EventData)

 -

Occurs when a new mark was added.

-

FIFO:OnEventMarkChange(EventData)

 -

Occurs when a mark text was changed.

-

FIFO:OnEventMarkRemoved(EventData)

 -

Occurs when a mark was removed.

-

FIFO:OnEventMissionEnd(EventData)

 -

Occurs when a mission ends.

-

FIFO:OnEventMissionStart(EventData)

 -

Occurs when a mission starts.

-

FIFO:OnEventParatrooperLanding(EventData)

 -

Weapon add.

-

FIFO:OnEventPilotDead(EventData)

 -

Occurs when the pilot of an aircraft is killed.

-

FIFO:OnEventPlayerEnterAircraft(EventData)

 -

Occurs when a player enters a slot and takes control of an aircraft.

-

FIFO:OnEventPlayerEnterUnit(EventData)

 -

Occurs when any player assumes direct control of a unit.

-

FIFO:OnEventPlayerLeaveUnit(EventData)

 -

Occurs when any player relieves control of a unit to the AI.

-

FIFO:OnEventRefueling(EventData)

 -

Occurs when an aircraft connects with a tanker and begins taking on fuel.

-

FIFO:OnEventRefuelingStop(EventData)

 -

Occurs when an aircraft is finished taking fuel.

-

FIFO:OnEventScore(EventData)

 -

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

-

FIFO:OnEventShootingEnd(EventData)

 -

Occurs when any unit stops firing its weapon.

-

FIFO:OnEventShootingStart(EventData)

 -

Occurs when any unit begins firing a weapon that has a high rate of fire.

-

FIFO:OnEventShot(EventData)

 -

Occurs whenever any unit in a mission fires a weapon.

-

FIFO:OnEventTakeoff(EventData)

 -

Occurs when an aircraft takes off from an airbase, farp, or ship.

-

FIFO:OnEventTriggerZone(EventData)

 -

Trigger zone.

-

FIFO:OnEventUnitLost(EventData)

 -

Occurs when the game thinks an object is destroyed.

-

FIFO:ScheduleOnce(Start, SchedulerFunction, ...)

 -

Schedule a new time event.

-

FIFO:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

 -

Schedule a new time event.

-

FIFO:ScheduleStop(SchedulerFunction)

 -

Stops the Schedule.

-

FIFO.Scheduler

 - -

FIFO:SetEventPriority(EventPriority)

 -

Set the Class Event processing Priority.

-

FIFO:SetState(Object, Key, Value)

 -

Set a state or property of the Object given a Key and a Value.

-

FIFO:T(Arguments)

 -

Trace a function logic level 1.

-

FIFO:T2(Arguments)

 -

Trace a function logic level 2.

-

FIFO:T3(Arguments)

 -

Trace a function logic level 3.

-

FIFO:TraceAll(TraceAll)

 -

Trace all methods in MOOSE

-

FIFO:TraceClass(Class)

 -

Set tracing for a class

-

FIFO:TraceClassMethod(Class, Method)

 -

Set tracing for a specific method of class

-

FIFO:TraceLevel(Level)

 -

Set trace level

-

FIFO:TraceOff()

 -

Set trace off.

-

FIFO:TraceOn()

 -

Set trace on.

-

FIFO:TraceOnOff(TraceOnOff)

 -

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.

-

FIFO:UnHandleEvent(EventID)

 -

UnSubscribe to a DCS event.

-

FIFO._

 - -

FIFO:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 -

Trace a function call.

-

FIFO:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 -

Trace a function logic.

-

FIFO.__

 - -

FIFO:onEvent(event)

 - -
-
- -

Type FIFO.IDEntry

-
- FIFO.IDEntry -
-
- - - - - - - - - - - - - - - -
Fields and Methods inherited from FIFO.IDEntryDescription

FIFO.IDEntry.data

 - -

FIFO.IDEntry.pointer

 - -

FIFO.IDEntry.uniqueID

 -
@@ -2633,711 +1897,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

FLARECOLOR.Yellow

- - - -
- -

Type LIFO

-
- LIFO -, extends Core.Base#BASE -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from LIFODescription

LIFO.ClassName

 -

Name of the class.

-

LIFO:Flatten()

 -

LIFO Housekeeping

-

LIFO:Flush()

 -

LIFO Print stacks to dcs.log

-

LIFO:GetIDStack()

 -

LIFO Get the data stack by UniqueID

-

LIFO:GetIDStackSorted()

 -

LIFO Get table of UniqueIDs sorthed smallest to largest

-

LIFO:GetPointerStack()

 -

LIFO Get the data stack by pointer

-

LIFO:GetSize()

 -

LIFO Get stack size

-

LIFO:HasUniqueID(UniqueID)

 -

LIFO Check if a certain UniqeID exists

-

LIFO:IsEmpty()

 -

LIFO Check Stack is empty

-

LIFO:IsNotEmpty()

 -

LIFO Check Stack is NOT empty

-

LIFO:New()

 -

Instantiate a new LIFO Stack

-

LIFO:Pull()

 -

LIFO Pull Object from Stack

-

LIFO:PullByID(UniqueID)

 -

LIFO Pull Object from Stack by UniqueID

-

LIFO:PullByPointer(Pointer)

 -

LIFO Pull Object from Stack by Pointer

-

LIFO:Push(Object, UniqueID)

 -

LIFO Push Object to Stack

-

LIFO.counter

 - -

LIFO.lid

 -

Class id string for output to DCS log file.

-

LIFO.pointer

 - -

LIFO.stackbyid

 - -

LIFO.stackbypointer

 - -

LIFO.uniquecounter

 - -

LIFO.version

 -

Version of LiFo

-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from BASEDescription

LIFO.ClassID

 -

The ID number of the class.

-

LIFO.ClassName

 -

The name of the class.

-

LIFO.ClassNameAndID

 -

The name of the class concatenated with the ID number of the class.

-

LIFO:ClearState(Object, StateName)

 -

Clear the state of an object.

-

LIFO:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

 -

Creation of a Birth Event.

-

LIFO:CreateEventCrash(EventTime, Initiator)

 -

Creation of a Crash Event.

-

LIFO:CreateEventDead(EventTime, Initiator)

 -

Creation of a Dead Event.

-

LIFO:CreateEventPlayerEnterAircraft(PlayerUnit)

 -

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

-

LIFO:CreateEventRemoveUnit(EventTime, Initiator)

 -

Creation of a Remove Unit Event.

-

LIFO:CreateEventTakeoff(EventTime, Initiator)

 -

Creation of a Takeoff Event.

-

LIFO:E(Arguments)

 -

Log an exception which will be traced always.

-

LIFO:EventDispatcher()

 -

Returns the event dispatcher

-

LIFO:EventRemoveAll()

 -

Remove all subscribed events

-

LIFO:F(Arguments)

 -

Trace a function call.

-

LIFO:F2(Arguments)

 -

Trace a function call level 2.

-

LIFO:F3(Arguments)

 -

Trace a function call level 3.

-

LIFO:GetClassID()

 -

Get the ClassID of the class instance.

-

LIFO:GetClassName()

 -

Get the ClassName of the class instance.

-

LIFO:GetClassNameAndID()

 -

Get the ClassName + ClassID of the class instance.

-

LIFO:GetEventPriority()

 -

Get the Class Event processing Priority.

-

LIFO:GetParent(Child, FromClass)

 -

This is the worker method to retrieve the Parent class.

-

LIFO:GetState(Object, Key)

 -

Get a Value given a Key from the Object.

-

LIFO:HandleEvent(EventID, EventFunction)

 -

Subscribe to a DCS Event.

-

LIFO:I(Arguments)

 -

Log an information which will be traced always.

-

LIFO:Inherit(Child, Parent)

 -

This is the worker method to inherit from a parent class.

-

LIFO:IsInstanceOf(ClassName)

 -

This is the worker method to check if an object is an (sub)instance of a class.

-

LIFO:IsTrace()

 -

Enquires if tracing is on (for the class).

-

LIFO:New()

 -

BASE constructor.

-

LIFO:OnEvent(EventData)

 -

Occurs when an object is completely destroyed.

-

LIFO:OnEventBDA(EventData)

 -

BDA.

-

LIFO:OnEventBaseCaptured(EventData)

 -

Occurs when a ground unit captures either an airbase or a farp.

-

LIFO:OnEventBirth(EventData)

 -

Occurs when any object is spawned into the mission.

-

LIFO:OnEventCrash(EventData)

 -

Occurs when any aircraft crashes into the ground and is completely destroyed.

-

LIFO:OnEventDead(EventData)

 -

Occurs when an object is dead.

-

LIFO:OnEventDetailedFailure(EventData)

 -

Unknown precisely what creates this event, likely tied into newer damage model.

-

LIFO:OnEventDiscardChairAfterEjection(EventData)

 -

Discard chair after ejection.

-

LIFO:OnEventEjection(EventData)

 -

Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

-

LIFO:OnEventEngineShutdown(EventData)

 -

Occurs when any aircraft shuts down its engines.

-

LIFO:OnEventEngineStartup(EventData)

 -

Occurs when any aircraft starts its engines.

-

LIFO:OnEventHit(EventData)

 -

Occurs whenever an object is hit by a weapon.

-

LIFO:OnEventHumanFailure(EventData)

 -

Occurs when any system fails on a human controlled aircraft.

-

LIFO:OnEventKill(EventData)

 -

Occurs on the death of a unit.

-

LIFO:OnEventLand(EventData)

 -

Occurs when an aircraft lands at an airbase, farp or ship -initiator : The unit that has landed.

-

LIFO:OnEventLandingAfterEjection(EventData)

 -

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

-

LIFO:OnEventLandingQualityMark(EventData)

 -

Landing quality mark.

-

LIFO:OnEventMarkAdded(EventData)

 -

Occurs when a new mark was added.

-

LIFO:OnEventMarkChange(EventData)

 -

Occurs when a mark text was changed.

-

LIFO:OnEventMarkRemoved(EventData)

 -

Occurs when a mark was removed.

-

LIFO:OnEventMissionEnd(EventData)

 -

Occurs when a mission ends.

-

LIFO:OnEventMissionStart(EventData)

 -

Occurs when a mission starts.

-

LIFO:OnEventParatrooperLanding(EventData)

 -

Weapon add.

-

LIFO:OnEventPilotDead(EventData)

 -

Occurs when the pilot of an aircraft is killed.

-

LIFO:OnEventPlayerEnterAircraft(EventData)

 -

Occurs when a player enters a slot and takes control of an aircraft.

-

LIFO:OnEventPlayerEnterUnit(EventData)

 -

Occurs when any player assumes direct control of a unit.

-

LIFO:OnEventPlayerLeaveUnit(EventData)

 -

Occurs when any player relieves control of a unit to the AI.

-

LIFO:OnEventRefueling(EventData)

 -

Occurs when an aircraft connects with a tanker and begins taking on fuel.

-

LIFO:OnEventRefuelingStop(EventData)

 -

Occurs when an aircraft is finished taking fuel.

-

LIFO:OnEventScore(EventData)

 -

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

-

LIFO:OnEventShootingEnd(EventData)

 -

Occurs when any unit stops firing its weapon.

-

LIFO:OnEventShootingStart(EventData)

 -

Occurs when any unit begins firing a weapon that has a high rate of fire.

-

LIFO:OnEventShot(EventData)

 -

Occurs whenever any unit in a mission fires a weapon.

-

LIFO:OnEventTakeoff(EventData)

 -

Occurs when an aircraft takes off from an airbase, farp, or ship.

-

LIFO:OnEventTriggerZone(EventData)

 -

Trigger zone.

-

LIFO:OnEventUnitLost(EventData)

 -

Occurs when the game thinks an object is destroyed.

-

LIFO:ScheduleOnce(Start, SchedulerFunction, ...)

 -

Schedule a new time event.

-

LIFO:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

 -

Schedule a new time event.

-

LIFO:ScheduleStop(SchedulerFunction)

 -

Stops the Schedule.

-

LIFO.Scheduler

 - -

LIFO:SetEventPriority(EventPriority)

 -

Set the Class Event processing Priority.

-

LIFO:SetState(Object, Key, Value)

 -

Set a state or property of the Object given a Key and a Value.

-

LIFO:T(Arguments)

 -

Trace a function logic level 1.

-

LIFO:T2(Arguments)

 -

Trace a function logic level 2.

-

LIFO:T3(Arguments)

 -

Trace a function logic level 3.

-

LIFO:TraceAll(TraceAll)

 -

Trace all methods in MOOSE

-

LIFO:TraceClass(Class)

 -

Set tracing for a class

-

LIFO:TraceClassMethod(Class, Method)

 -

Set tracing for a specific method of class

-

LIFO:TraceLevel(Level)

 -

Set trace level

-

LIFO:TraceOff()

 -

Set trace off.

-

LIFO:TraceOn()

 -

Set trace on.

-

LIFO:TraceOnOff(TraceOnOff)

 -

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.

-

LIFO:UnHandleEvent(EventID)

 -

UnSubscribe to a DCS event.

-

LIFO._

 - -

LIFO:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 -

Trace a function call.

-

LIFO:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 -

Trace a function logic.

-

LIFO.__

 - -

LIFO:onEvent(event)

 - -
-
- -

Type LIFO.IDEntry

-
- LIFO.IDEntry -
-
- - - - - - - - - - - - - - - -
Fields and Methods inherited from LIFO.IDEntryDescription

LIFO.IDEntry.data

 - -

LIFO.IDEntry.pointer

 - -

LIFO.IDEntry.uniqueID

 -
@@ -3574,6 +2133,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

UTILS.GetRandomTableElement(t, replace)

Get a random element of a table.

+ + + +

UTILS.GetReportingName(Typename)

+ +

Get the NATO reporting name of a unit type name

@@ -4402,3936 +2967,6 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte

The Channel map.

-
- - -
-

Function(s)

-
- - - -

Type FIFO

-
-
- -

FIFO class.

- -
-

Field(s)

-
-
-
- - #string -FIFO.ClassName - -

Name of the class.

- -
- -
-
-
- - #number -FIFO.counter - - - -
- -
-
-
- - #string -FIFO.lid - -

Class id string for output to DCS log file.

- -
- -
-
-
- - #number -FIFO.pointer - - - -
- -
-
-
- - #table -FIFO.stackbyid - - - -
- -
-
-
- - #table -FIFO.stackbypointer - - - -
- -
-
-
- - #string -FIFO.version - -

Version of FiFo

- -
- -
-
-

Function(s)

-
-
- -
-

FIFO:Flatten()

-
- -

FIFO Housekeeping

- -
-
-

Defined in:

-
-

FIFO

-
-

Return value:

-
-
-

#FIFO:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

FIFO:Flush()

-
- -

FIFO Print stacks to dcs.log

- -
-
-

Defined in:

-
-

FIFO

-
-

Return value:

-
-
-

#FIFO:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

FIFO:GetIDStack()

-
- -

FIFO Get the data stack by UniqueID

- -
-
-

Defined in:

-
-

FIFO

-
-

Return value:

-
-
-

#table:

-
-
- -

Table of #FIFO.IDEntry entries

- -
-
-
- -
-
- -
- -
-

FIFO:GetIDStackSorted()

-
- -

FIFO Get table of UniqueIDs sorthed smallest to largest

- -
-
-

Defined in:

-
-

FIFO

-
-

Return value:

-
-
-

#table:

-
-
- -

Table of #FIFO.IDEntry entries

- -
-
-
- -
-
- -
- -
-

FIFO:GetPointerStack()

-
- -

FIFO Get the data stack by pointer

- -
-
-

Defined in:

-
-

FIFO

-
-

Return value:

-
-
-

#table:

-
-
- -

Table of #FIFO.IDEntry entries

- -
-
-
- -
-
- -
- -
-

FIFO:GetSize()

-
- -

FIFO Get stack size

- -
-
-

Defined in:

-
-

FIFO

-
-

Return value:

-
-
-

#number:

-
-
- -

size

- -
-
-
- -
-
- -
- -
-

FIFO:HasUniqueID(UniqueID)

-
- -

FIFO Check if a certain UniqeID exists

- -
-
-

Defined in:

-
-

FIFO

-
-

Parameter:

-
-
-

- UniqueID -

-
-
-

-
-
-

Return value:

-
-
-

#boolean:

-
-
- -

exists

- -
-
-
- -
-
- -
- -
-

FIFO:IsEmpty()

-
- -

FIFO Check Stack is empty

- -
-
-

Defined in:

-
-

FIFO

-
-

Return value:

-
-
-

#boolean:

-
-
- -

empty

- -
-
-
- -
-
- -
- -
-

FIFO:IsNotEmpty()

-
- -

FIFO Check Stack is NOT empty

- -
-
-

Defined in:

-
-

FIFO

-
-

Return value:

-
-
-

#boolean:

-
-
- -

notempty

- -
-
-
- -
-
- -
- -
-

FIFO:New()

-
- -

Instantiate a new FIFO Stack

- -
-
-

Defined in:

-
-

FIFO

-
-

Return value:

-
-
-

#FIFO:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

FIFO:Pull()

-
- -

FIFO Pull Object from Stack

- -
-
-

Defined in:

-
-

FIFO

-
-

Return value:

-
-
-

#table:

-
-
- -

Object or nil if stack is empty

- -
-
-
- -
-
- -
- -
-

FIFO:PullByID(UniqueID)

-
- -

FIFO Pull Object from Stack by UniqueID

- -
-
-

Defined in:

-
-

FIFO

-
-

Parameter:

-
-
-

- UniqueID -

-
-
-

-
-
-

Return value:

-
-
-

#table:

-
-
- -

Object or nil if stack is empty

- -
-
-
- -
-
- -
- -
-

FIFO:PullByPointer(Pointer)

-
- -

FIFO Pull Object from Stack by Pointer

- -
-
-

Defined in:

-
-

FIFO

-
-

Parameter:

-
-
-

- #number - Pointer -

-
-
-

-
-
-

Return value:

-
-
-

#table:

-
-
- -

Object or nil if stack is empty

- -
-
-
- -
-
- -
- -
-

FIFO:Push(Object, UniqueID)

-
- -

FIFO Push Object to Stack

- -
-
-

Defined in:

-
-

FIFO

-
-

Parameters:

-
-
-

- #table - Object -

-
-
-

-
-
-
-
-

- #string - UniqueID -

-
-
- -

(optional) - will default to current pointer + 1

- -
-
-

Return value:

-
-
-

#FIFO:

-
-
- -

self

- -
-
-
- -
-
- -
-

Field(s)

-
-
-
- - #string -FIFO.ClassName - -

Name of the class.

- -
- -
-
-
- - #number -FIFO.counter - - - -
- -
-
-
- - #string -FIFO.lid - -

Class id string for output to DCS log file.

- -
- -
-
-
- - #number -FIFO.pointer - - - -
- -
-
-
- - #table -FIFO.stackbyid - - - -
- -
-
-
- - #table -FIFO.stackbypointer - - - -
- -
-
-
- - #string -FIFO.version - -

Version of FiFo

- -
- -
-
-

Function(s)

-
-
- -
-

FIFO:ClearState(Object, StateName)

-
- -

Clear the state of an object.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Object -

-
-
- -

The object that holds the Value set by the Key.

- -
-
-
-
-

- StateName -

-
-
- -

The key that is should be cleared.

- -
-
-
- -
-
- -
- -
-

FIFO:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

-
- -

Creation of a Birth Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

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 -

-
-
-

-
-
-
- -
-
- -
- -
-

FIFO:CreateEventCrash(EventTime, Initiator)

-
- -

Creation of a Crash Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- DCS#Time - EventTime -

-
-
- -

The time stamp of the event.

- -
-
-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

- -
-
-
- -
-
- -
- -
-

FIFO:CreateEventDead(EventTime, Initiator)

-
- -

Creation of a Dead Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- DCS#Time - EventTime -

-
-
- -

The time stamp of the event.

- -
-
-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

- -
-
-
- -
-
- -
- -
-

FIFO:CreateEventPlayerEnterAircraft(PlayerUnit)

-
- -

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Wrapper.Unit#UNIT - PlayerUnit -

-
-
- -

The aircraft unit the player entered.

- -
-
-
- -
-
- -
- -
-

FIFO:CreateEventRemoveUnit(EventTime, Initiator)

-
- -

Creation of a Remove Unit Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- DCS#Time - EventTime -

-
-
- -

The time stamp of the event.

- -
-
-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

- -
-
-
- -
-
- -
- -
-

FIFO:CreateEventTakeoff(EventTime, Initiator)

-
- -

Creation of a Takeoff Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- DCS#Time - EventTime -

-
-
- -

The time stamp of the event.

- -
-
-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

- -
-
-
- -
-
- -
- -
-

FIFO:E(Arguments)

-
- -

Log an exception which will be traced always.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

FIFO:EventDispatcher()

-
- -

Returns the event dispatcher

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

Core.Event#EVENT:

-
-
- - - -
-
-
- -
-
- -
- -
-

FIFO:EventRemoveAll()

-
- -

Remove all subscribed events

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

FIFO:F(Arguments)

-
- -

Trace a function call.

- - -

Must be at the beginning of the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

FIFO:F2(Arguments)

-
- -

Trace a function call level 2.

- - -

Must be at the beginning of the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

FIFO:F3(Arguments)

-
- -

Trace a function call level 3.

- - -

Must be at the beginning of the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

FIFO:GetClassID()

-
- -

Get the ClassID of the class instance.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassID of the class instance.

- -
-
-
- -
-
- -
- -
-

FIFO:GetClassName()

-
- -

Get the ClassName of the class instance.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassName of the class instance.

- -
-
-
- -
-
- -
- -
-

FIFO:GetClassNameAndID()

-
- -

Get the ClassName + ClassID of the class instance.

- - -

The ClassName + ClassID is formatted as '%s#%09d'.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassName + ClassID of the class instance.

- -
-
-
- -
-
- -
- -
-

FIFO:GetEventPriority()

-
- -

Get the Class 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.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#number:

-
-
- -

The Event processing Priority.

- -
-
-
- -
-
- -
- -
-

FIFO:GetParent(Child, FromClass)

-
- -

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()
-
- - - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- #BASE - Child -

-
-
- -

This is the Child class from which the Parent class needs to be retrieved.

- -
-
-
-
-

- #BASE - FromClass -

-
-
- -

(Optional) The class from which to get the parent.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

FIFO:GetState(Object, Key)

-
- -

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:

-
-

Core.Base#BASE

-
-

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.

- -
-
-
- -
-
- -
- -
-

FIFO:HandleEvent(EventID, EventFunction)

-
- -

Subscribe to a DCS Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Core.Event#EVENTS - EventID -

-
-
- -

Event ID.

- -
-
-
-
-

- #function - EventFunction -

-
-
- -

(optional) The function to be called when the event occurs for the unit.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

FIFO:I(Arguments)

-
- -

Log an information which will be traced always.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

FIFO:Inherit(Child, Parent)

-
- -

This is the worker method to inherit from a parent class.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Child -

-
-
- -

is the Child class that inherits.

- -
-
-
-
-

- #BASE - Parent -

-
-
- -

is the Parent class that the Child inherits from.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- -

Child

- -
-
-
- -
-
- -
- -
-

FIFO:IsInstanceOf(ClassName)

-
- -

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:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- ClassName -

-
-
- -

is the name of the class or the class itself to run the check against

- -
-
-

Return value:

-
-
-

#boolean:

-
-
- - - -
-
-
- -
-
- -
- -
-

FIFO:IsTrace()

-
- -

Enquires if tracing is on (for the class).

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#boolean:

-
-
- - - -
-
-
- -
-
- -
- -
-

FIFO:New()

-
- -

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
-
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

FIFO:OnEvent(EventData)

-
- -

Occurs when an object is completely destroyed.

- - -

initiator : The unit that is was destroyed.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventBDA(EventData)

-
- -

BDA.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventBaseCaptured(EventData)

-
- -

Occurs when a ground unit captures either an airbase or a farp.

- - -

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.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventBirth(EventData)

-
- -

Occurs when any object is spawned into the mission.

- - -

initiator : The unit that was spawned.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventCrash(EventData)

-
- -

Occurs when any aircraft crashes into the ground and is completely destroyed.

- - -

initiator : The unit that has crashed.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventDead(EventData)

-
- -

Occurs when an object is dead.

- - -

initiator : The unit that is dead.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventDetailedFailure(EventData)

-
- -

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.
    • -
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventDiscardChairAfterEjection(EventData)

-
- -

Discard chair after ejection.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventEjection(EventData)

-
- -

Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventEngineShutdown(EventData)

-
- -

Occurs when any aircraft shuts down its engines.

- - -

initiator : The unit that is stopping its engines..

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventEngineStartup(EventData)

-
- -

Occurs when any aircraft starts its engines.

- - -

initiator : The unit that is starting its engines..

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventHit(EventData)

-
- -

Occurs whenever an object is hit by a weapon.

- - -

initiator : The unit object the fired the weapon. -weapon: Weapon object that hit the target. -target: The Object that was hit.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventHumanFailure(EventData)

-
- -

Occurs when any system fails on a human controlled aircraft.

- - -

initiator : The unit that had the failure.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventKill(EventData)

-
- -

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.

- -
    -
  • initiator: The unit that killed the target.
    • -
  • target: Target Object
    • -
  • weapon: Weapon Object
    • -
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventLand(EventData)

-
- -

Occurs when an 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.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventLandingAfterEjection(EventData)

-
- -

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.

- -
    -
  • 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.
    • -
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventLandingQualityMark(EventData)

-
- -

Landing quality mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventMarkAdded(EventData)

-
- -

Occurs when a new mark was added.

- - -

MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventMarkChange(EventData)

-
- -

Occurs when a mark text was changed.

- - -

MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventMarkRemoved(EventData)

-
- -

Occurs when a mark was removed.

- - -

MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventMissionEnd(EventData)

-
- -

Occurs when a mission ends.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventMissionStart(EventData)

-
- -

Occurs when a mission starts.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventParatrooperLanding(EventData)

-
- -

Weapon add.

- - -

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventPilotDead(EventData)

-
- -

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. -initiator : The unit that the pilot has died in.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventPlayerEnterAircraft(EventData)

-
- -

Occurs when a player enters a slot and takes control of an aircraft.

- - -

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.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventPlayerEnterUnit(EventData)

-
- -

Occurs when any player assumes direct control of a unit.

- - -

initiator : The unit that is being taken control of.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventPlayerLeaveUnit(EventData)

-
- -

Occurs when any player relieves control of a unit to the AI.

- - -

initiator : The unit that the player left.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventRefueling(EventData)

-
- -

Occurs when an aircraft connects with a tanker and begins taking on fuel.

- - -

initiator : The unit that is receiving fuel.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventRefuelingStop(EventData)

-
- -

Occurs when an aircraft is finished taking fuel.

- - -

initiator : The unit that was receiving fuel.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventScore(EventData)

-
- -

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.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventShootingEnd(EventData)

-
- -

Occurs when any unit stops firing its weapon.

- - -

Event will always correspond with a shooting start event. -initiator : The unit that was doing the shooting.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventShootingStart(EventData)

-
- -

Occurs when any unit begins firing a weapon that has a high rate of fire.

- - -

Most common with aircraft cannons (GAU-8), auto cannons, and machine guns. -initiator : The unit that is doing the shooting. -target: The unit that is being targeted.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventShot(EventData)

-
- -

Occurs whenever any unit in a mission fires a weapon.

- - -

But not any machine gun or auto cannon based weapon, those are handled by EVENT.ShootingStart.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventTakeoff(EventData)

-
- -

Occurs when an aircraft takes off from an airbase, farp, or ship.

- - -

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

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventTriggerZone(EventData)

-
- -

Trigger zone.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:OnEventUnitLost(EventData)

-
- -

Occurs when the game thinks an object is destroyed.

- - - -
    -
  • initiator: The unit that is was destroyed.
    • -
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

FIFO:ScheduleOnce(Start, SchedulerFunction, ...)

-
- -

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:

-
-

Core.Base#BASE

-
-

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:

-
-
-

#number:

-
-
- -

The ScheduleID of the planned schedule.

- -
-
-
- -
-
- -
- -
-

FIFO:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

-
- -

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:

-
-

Core.Base#BASE

-
-

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:

-
-
-

#number:

-
-
- -

The ScheduleID of the planned schedule.

- -
-
-
- -
-
- -
- -
-

FIFO:ScheduleStop(SchedulerFunction)

-
- -

Stops the Schedule.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #function - SchedulerFunction -

-
-
- -

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

- -
-
-
- -
-
- -
- -
-

FIFO:SetEventPriority(EventPriority)

-
- -

Set the Class 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.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #number - EventPriority -

-
-
- -

The Event processing Priority.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

FIFO:SetState(Object, Key, Value)

-
- -

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:

-
-

Core.Base#BASE

-
-

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.

- -
-
-
- -
-
- -
- -
-

FIFO:T(Arguments)

-
- -

Trace a function logic level 1.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

FIFO:T2(Arguments)

-
- -

Trace a function logic level 2.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

FIFO:T3(Arguments)

-
- -

Trace a function logic level 3.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

FIFO:TraceAll(TraceAll)

-
- -

Trace all methods in MOOSE

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #boolean - TraceAll -

-
-
- -

true = trace all methods in MOOSE.

- -
-
-
- -
-
- -
- -
-

FIFO:TraceClass(Class)

-
- -

Set tracing for a class

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #string - Class -

-
-
-

-
-
-
- -
-
- -
- -
-

FIFO:TraceClassMethod(Class, Method)

-
- -

Set tracing for a specific method of class

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- #string - Class -

-
-
-

-
-
-
-
-

- #string - Method -

-
-
-

-
-
-
- -
-
- -
- -
-

FIFO:TraceLevel(Level)

-
- -

Set trace level

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #number - Level -

-
-
-

-
-
-
- -
-
- -
- -
-

FIFO:TraceOff()

-
- -

Set trace off.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Usage:

- 
-- Switch the tracing Off
-BASE:TraceOff()
- -
- -
-
- -
- -
-

FIFO:TraceOn()

-
- -

Set trace on.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Usage:

- 
-- Switch the tracing On
-BASE:TraceOn()
- -
- -
-
- -
- -
-

FIFO:TraceOnOff(TraceOnOff)

-
- -

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:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #boolean - TraceOnOff -

-
-
- -

Switch the tracing on or off.

- -
-
-

Usage:

- 

-  -- Switch the tracing On
-  BASE:TraceOnOff( true )
-
-  -- Switch the tracing Off
-  BASE:TraceOnOff( false )
-
- -
- -
-
- -
- -
-

FIFO:UnHandleEvent(EventID)

-
- -

UnSubscribe to a DCS event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTS - EventID -

-
-
- -

Event ID.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

FIFO:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

-
- -

Trace a function call.

- - -

This function is private.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
-
-

- DebugInfoCurrentParam -

-
-
-

-
-
-
-
-

- DebugInfoFromParam -

-
-
-

-
-
-
- -
-
- -
- -
-

FIFO:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

-
- -

Trace a function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
-
-

- DebugInfoCurrentParam -

-
-
-

-
-
-
-
-

- DebugInfoFromParam -

-
-
-

-
-
-
- -
-
- -
- -
-

FIFO:onEvent(event)

-
- - - - -

TODO: Complete DCS#Event structure. -- The main event handling function... This function captures all events generated for the class. - @param #BASE self - @param DCS#Event event

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- event -

-
-
-

-
-
-
- -
-
- -
- -
-

Type FIFO.IDEntry

-
-
-
-

Field(s)

-
-
-
- - #table -FIFO.IDEntry.data - - - -
- -
-
-
- - #number -FIFO.IDEntry.pointer - - - -
- -
-
-
- - #table -FIFO.IDEntry.uniqueID - - -
@@ -8350,3936 +2985,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

Function(s)

-
- -
-

Type LIFO

-
-
- -

LIFO class.

- -
-

Field(s)

-
-
-
- - #string -LIFO.ClassName - -

Name of the class.

- -
- -
-
-
- - #number -LIFO.counter - - - -
- -
-
-
- - #string -LIFO.lid - -

Class id string for output to DCS log file.

- -
- -
-
-
- - #number -LIFO.pointer - - - -
- -
-
-
- - #table -LIFO.stackbyid - - - -
- -
-
-
- - #table -LIFO.stackbypointer - - - -
- -
-
-
- - #string -LIFO.version - -

Version of LiFo

- -
- -
-
-

Function(s)

-
-
- -
-

LIFO:Flatten()

-
- -

LIFO Housekeeping

- -
-
-

Defined in:

-
-

LIFO

-
-

Return value:

-
-
-

#LIFO:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

LIFO:Flush()

-
- -

LIFO Print stacks to dcs.log

- -
-
-

Defined in:

-
-

LIFO

-
-

Return value:

-
-
-

#LIFO:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

LIFO:GetIDStack()

-
- -

LIFO Get the data stack by UniqueID

- -
-
-

Defined in:

-
-

LIFO

-
-

Return value:

-
-
-

#table:

-
-
- -

Table of #LIFO.IDEntry entries

- -
-
-
- -
-
- -
- -
-

LIFO:GetIDStackSorted()

-
- -

LIFO Get table of UniqueIDs sorthed smallest to largest

- -
-
-

Defined in:

-
-

LIFO

-
-

Return value:

-
-
-

#table:

-
-
- -

Table of #LIFO.IDEntry entries

- -
-
-
- -
-
- -
- -
-

LIFO:GetPointerStack()

-
- -

LIFO Get the data stack by pointer

- -
-
-

Defined in:

-
-

LIFO

-
-

Return value:

-
-
-

#table:

-
-
- -

Table of #LIFO.IDEntry entries

- -
-
-
- -
-
- -
- -
-

LIFO:GetSize()

-
- -

LIFO Get stack size

- -
-
-

Defined in:

-
-

LIFO

-
-

Return value:

-
-
-

#number:

-
-
- -

size

- -
-
-
- -
-
- -
- -
-

LIFO:HasUniqueID(UniqueID)

-
- -

LIFO Check if a certain UniqeID exists

- -
-
-

Defined in:

-
-

LIFO

-
-

Parameter:

-
-
-

- UniqueID -

-
-
-

-
-
-

Return value:

-
-
-

#boolean:

-
-
- -

exists

- -
-
-
- -
-
- -
- -
-

LIFO:IsEmpty()

-
- -

LIFO Check Stack is empty

- -
-
-

Defined in:

-
-

LIFO

-
-

Return value:

-
-
-

#boolean:

-
-
- -

empty

- -
-
-
- -
-
- -
- -
-

LIFO:IsNotEmpty()

-
- -

LIFO Check Stack is NOT empty

- -
-
-

Defined in:

-
-

LIFO

-
-

Return value:

-
-
-

#boolean:

-
-
- -

notempty

- -
-
-
- -
-
- -
- -
-

LIFO:New()

-
- -

Instantiate a new LIFO Stack

- -
-
-

Defined in:

-
-

LIFO

-
-

Return value:

-
-
-

#LIFO:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

LIFO:Pull()

-
- -

LIFO Pull Object from Stack

- -
-
-

Defined in:

-
-

LIFO

-
-

Return value:

-
-
-

#table:

-
-
- -

Object or nil if stack is empty

- -
-
-
- -
-
- -
- -
-

LIFO:PullByID(UniqueID)

-
- -

LIFO Pull Object from Stack by UniqueID

- -
-
-

Defined in:

-
-

LIFO

-
-

Parameter:

-
-
-

- UniqueID -

-
-
-

-
-
-

Return value:

-
-
-

#table:

-
-
- -

Object or nil if stack is empty

- -
-
-
- -
-
- -
- -
-

LIFO:PullByPointer(Pointer)

-
- -

LIFO Pull Object from Stack by Pointer

- -
-
-

Defined in:

-
-

LIFO

-
-

Parameter:

-
-
-

- #number - Pointer -

-
-
-

-
-
-

Return value:

-
-
-

#table:

-
-
- -

Object or nil if stack is empty

- -
-
-
- -
-
- -
- -
-

LIFO:Push(Object, UniqueID)

-
- -

LIFO Push Object to Stack

- -
-
-

Defined in:

-
-

LIFO

-
-

Parameters:

-
-
-

- #table - Object -

-
-
-

-
-
-
-
-

- #string - UniqueID -

-
-
- -

(optional) - will default to current pointer + 1

- -
-
-

Return value:

-
-
-

#LIFO:

-
-
- -

self

- -
-
-
- -
-
- -
-

Field(s)

-
-
-
- - #string -LIFO.ClassName - -

Name of the class.

- -
- -
-
-
- - #number -LIFO.counter - - - -
- -
-
-
- - #string -LIFO.lid - -

Class id string for output to DCS log file.

- -
- -
-
-
- - #number -LIFO.pointer - - - -
- -
-
-
- - #table -LIFO.stackbyid - - - -
- -
-
-
- - #table -LIFO.stackbypointer - - - -
- -
-
-
- - #string -LIFO.version - -

Version of LiFo

- -
- -
-
-

Function(s)

-
-
- -
-

LIFO:ClearState(Object, StateName)

-
- -

Clear the state of an object.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Object -

-
-
- -

The object that holds the Value set by the Key.

- -
-
-
-
-

- StateName -

-
-
- -

The key that is should be cleared.

- -
-
-
- -
-
- -
- -
-

LIFO:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

-
- -

Creation of a Birth Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

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 -

-
-
-

-
-
-
- -
-
- -
- -
-

LIFO:CreateEventCrash(EventTime, Initiator)

-
- -

Creation of a Crash Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- DCS#Time - EventTime -

-
-
- -

The time stamp of the event.

- -
-
-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

- -
-
-
- -
-
- -
- -
-

LIFO:CreateEventDead(EventTime, Initiator)

-
- -

Creation of a Dead Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- DCS#Time - EventTime -

-
-
- -

The time stamp of the event.

- -
-
-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

- -
-
-
- -
-
- -
- -
-

LIFO:CreateEventPlayerEnterAircraft(PlayerUnit)

-
- -

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Wrapper.Unit#UNIT - PlayerUnit -

-
-
- -

The aircraft unit the player entered.

- -
-
-
- -
-
- -
- -
-

LIFO:CreateEventRemoveUnit(EventTime, Initiator)

-
- -

Creation of a Remove Unit Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- DCS#Time - EventTime -

-
-
- -

The time stamp of the event.

- -
-
-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

- -
-
-
- -
-
- -
- -
-

LIFO:CreateEventTakeoff(EventTime, Initiator)

-
- -

Creation of a Takeoff Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- DCS#Time - EventTime -

-
-
- -

The time stamp of the event.

- -
-
-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

- -
-
-
- -
-
- -
- -
-

LIFO:E(Arguments)

-
- -

Log an exception which will be traced always.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

LIFO:EventDispatcher()

-
- -

Returns the event dispatcher

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

Core.Event#EVENT:

-
-
- - - -
-
-
- -
-
- -
- -
-

LIFO:EventRemoveAll()

-
- -

Remove all subscribed events

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

LIFO:F(Arguments)

-
- -

Trace a function call.

- - -

Must be at the beginning of the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

LIFO:F2(Arguments)

-
- -

Trace a function call level 2.

- - -

Must be at the beginning of the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

LIFO:F3(Arguments)

-
- -

Trace a function call level 3.

- - -

Must be at the beginning of the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

LIFO:GetClassID()

-
- -

Get the ClassID of the class instance.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassID of the class instance.

- -
-
-
- -
-
- -
- -
-

LIFO:GetClassName()

-
- -

Get the ClassName of the class instance.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassName of the class instance.

- -
-
-
- -
-
- -
- -
-

LIFO:GetClassNameAndID()

-
- -

Get the ClassName + ClassID of the class instance.

- - -

The ClassName + ClassID is formatted as '%s#%09d'.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassName + ClassID of the class instance.

- -
-
-
- -
-
- -
- -
-

LIFO:GetEventPriority()

-
- -

Get the Class 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.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#number:

-
-
- -

The Event processing Priority.

- -
-
-
- -
-
- -
- -
-

LIFO:GetParent(Child, FromClass)

-
- -

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()
-
- - - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- #BASE - Child -

-
-
- -

This is the Child class from which the Parent class needs to be retrieved.

- -
-
-
-
-

- #BASE - FromClass -

-
-
- -

(Optional) The class from which to get the parent.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

LIFO:GetState(Object, Key)

-
- -

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:

-
-

Core.Base#BASE

-
-

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.

- -
-
-
- -
-
- -
- -
-

LIFO:HandleEvent(EventID, EventFunction)

-
- -

Subscribe to a DCS Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Core.Event#EVENTS - EventID -

-
-
- -

Event ID.

- -
-
-
-
-

- #function - EventFunction -

-
-
- -

(optional) The function to be called when the event occurs for the unit.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

LIFO:I(Arguments)

-
- -

Log an information which will be traced always.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

LIFO:Inherit(Child, Parent)

-
- -

This is the worker method to inherit from a parent class.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Child -

-
-
- -

is the Child class that inherits.

- -
-
-
-
-

- #BASE - Parent -

-
-
- -

is the Parent class that the Child inherits from.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- -

Child

- -
-
-
- -
-
- -
- -
-

LIFO:IsInstanceOf(ClassName)

-
- -

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:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- ClassName -

-
-
- -

is the name of the class or the class itself to run the check against

- -
-
-

Return value:

-
-
-

#boolean:

-
-
- - - -
-
-
- -
-
- -
- -
-

LIFO:IsTrace()

-
- -

Enquires if tracing is on (for the class).

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#boolean:

-
-
- - - -
-
-
- -
-
- -
- -
-

LIFO:New()

-
- -

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
-
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

LIFO:OnEvent(EventData)

-
- -

Occurs when an object is completely destroyed.

- - -

initiator : The unit that is was destroyed.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventBDA(EventData)

-
- -

BDA.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventBaseCaptured(EventData)

-
- -

Occurs when a ground unit captures either an airbase or a farp.

- - -

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.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventBirth(EventData)

-
- -

Occurs when any object is spawned into the mission.

- - -

initiator : The unit that was spawned.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventCrash(EventData)

-
- -

Occurs when any aircraft crashes into the ground and is completely destroyed.

- - -

initiator : The unit that has crashed.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventDead(EventData)

-
- -

Occurs when an object is dead.

- - -

initiator : The unit that is dead.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventDetailedFailure(EventData)

-
- -

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.
    • -
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventDiscardChairAfterEjection(EventData)

-
- -

Discard chair after ejection.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventEjection(EventData)

-
- -

Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventEngineShutdown(EventData)

-
- -

Occurs when any aircraft shuts down its engines.

- - -

initiator : The unit that is stopping its engines..

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventEngineStartup(EventData)

-
- -

Occurs when any aircraft starts its engines.

- - -

initiator : The unit that is starting its engines..

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventHit(EventData)

-
- -

Occurs whenever an object is hit by a weapon.

- - -

initiator : The unit object the fired the weapon. -weapon: Weapon object that hit the target. -target: The Object that was hit.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventHumanFailure(EventData)

-
- -

Occurs when any system fails on a human controlled aircraft.

- - -

initiator : The unit that had the failure.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventKill(EventData)

-
- -

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.

- -
    -
  • initiator: The unit that killed the target.
    • -
  • target: Target Object
    • -
  • weapon: Weapon Object
    • -
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventLand(EventData)

-
- -

Occurs when an 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.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventLandingAfterEjection(EventData)

-
- -

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.

- -
    -
  • 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.
    • -
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventLandingQualityMark(EventData)

-
- -

Landing quality mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventMarkAdded(EventData)

-
- -

Occurs when a new mark was added.

- - -

MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventMarkChange(EventData)

-
- -

Occurs when a mark text was changed.

- - -

MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventMarkRemoved(EventData)

-
- -

Occurs when a mark was removed.

- - -

MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventMissionEnd(EventData)

-
- -

Occurs when a mission ends.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventMissionStart(EventData)

-
- -

Occurs when a mission starts.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventParatrooperLanding(EventData)

-
- -

Weapon add.

- - -

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventPilotDead(EventData)

-
- -

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. -initiator : The unit that the pilot has died in.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventPlayerEnterAircraft(EventData)

-
- -

Occurs when a player enters a slot and takes control of an aircraft.

- - -

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.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventPlayerEnterUnit(EventData)

-
- -

Occurs when any player assumes direct control of a unit.

- - -

initiator : The unit that is being taken control of.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventPlayerLeaveUnit(EventData)

-
- -

Occurs when any player relieves control of a unit to the AI.

- - -

initiator : The unit that the player left.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventRefueling(EventData)

-
- -

Occurs when an aircraft connects with a tanker and begins taking on fuel.

- - -

initiator : The unit that is receiving fuel.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventRefuelingStop(EventData)

-
- -

Occurs when an aircraft is finished taking fuel.

- - -

initiator : The unit that was receiving fuel.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventScore(EventData)

-
- -

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.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventShootingEnd(EventData)

-
- -

Occurs when any unit stops firing its weapon.

- - -

Event will always correspond with a shooting start event. -initiator : The unit that was doing the shooting.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventShootingStart(EventData)

-
- -

Occurs when any unit begins firing a weapon that has a high rate of fire.

- - -

Most common with aircraft cannons (GAU-8), auto cannons, and machine guns. -initiator : The unit that is doing the shooting. -target: The unit that is being targeted.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventShot(EventData)

-
- -

Occurs whenever any unit in a mission fires a weapon.

- - -

But not any machine gun or auto cannon based weapon, those are handled by EVENT.ShootingStart.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventTakeoff(EventData)

-
- -

Occurs when an aircraft takes off from an airbase, farp, or ship.

- - -

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

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventTriggerZone(EventData)

-
- -

Trigger zone.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:OnEventUnitLost(EventData)

-
- -

Occurs when the game thinks an object is destroyed.

- - - -
    -
  • initiator: The unit that is was destroyed.
    • -
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

LIFO:ScheduleOnce(Start, SchedulerFunction, ...)

-
- -

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:

-
-

Core.Base#BASE

-
-

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:

-
-
-

#number:

-
-
- -

The ScheduleID of the planned schedule.

- -
-
-
- -
-
- -
- -
-

LIFO:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

-
- -

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:

-
-

Core.Base#BASE

-
-

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:

-
-
-

#number:

-
-
- -

The ScheduleID of the planned schedule.

- -
-
-
- -
-
- -
- -
-

LIFO:ScheduleStop(SchedulerFunction)

-
- -

Stops the Schedule.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #function - SchedulerFunction -

-
-
- -

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

- -
-
-
- -
-
- -
- -
-

LIFO:SetEventPriority(EventPriority)

-
- -

Set the Class 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.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #number - EventPriority -

-
-
- -

The Event processing Priority.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

LIFO:SetState(Object, Key, Value)

-
- -

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:

-
-

Core.Base#BASE

-
-

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.

- -
-
-
- -
-
- -
- -
-

LIFO:T(Arguments)

-
- -

Trace a function logic level 1.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

LIFO:T2(Arguments)

-
- -

Trace a function logic level 2.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

LIFO:T3(Arguments)

-
- -

Trace a function logic level 3.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
- -
-
- -
- -
-

LIFO:TraceAll(TraceAll)

-
- -

Trace all methods in MOOSE

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #boolean - TraceAll -

-
-
- -

true = trace all methods in MOOSE.

- -
-
-
- -
-
- -
- -
-

LIFO:TraceClass(Class)

-
- -

Set tracing for a class

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #string - Class -

-
-
-

-
-
-
- -
-
- -
- -
-

LIFO:TraceClassMethod(Class, Method)

-
- -

Set tracing for a specific method of class

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- #string - Class -

-
-
-

-
-
-
-
-

- #string - Method -

-
-
-

-
-
-
- -
-
- -
- -
-

LIFO:TraceLevel(Level)

-
- -

Set trace level

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #number - Level -

-
-
-

-
-
-
- -
-
- -
- -
-

LIFO:TraceOff()

-
- -

Set trace off.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Usage:

- 
-- Switch the tracing Off
-BASE:TraceOff()
- -
- -
-
- -
- -
-

LIFO:TraceOn()

-
- -

Set trace on.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Usage:

- 
-- Switch the tracing On
-BASE:TraceOn()
- -
- -
-
- -
- -
-

LIFO:TraceOnOff(TraceOnOff)

-
- -

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:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #boolean - TraceOnOff -

-
-
- -

Switch the tracing on or off.

- -
-
-

Usage:

- 

-  -- Switch the tracing On
-  BASE:TraceOnOff( true )
-
-  -- Switch the tracing Off
-  BASE:TraceOnOff( false )
-
- -
- -
-
- -
- -
-

LIFO:UnHandleEvent(EventID)

-
- -

UnSubscribe to a DCS event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTS - EventID -

-
-
- -

Event ID.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

LIFO:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

-
- -

Trace a function call.

- - -

This function is private.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
-
-

- DebugInfoCurrentParam -

-
-
-

-
-
-
-
-

- DebugInfoFromParam -

-
-
-

-
-
-
- -
-
- -
- -
-

LIFO:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

-
- -

Trace a function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
-
-

- DebugInfoCurrentParam -

-
-
-

-
-
-
-
-

- DebugInfoFromParam -

-
-
-

-
-
-
- -
-
- -
- -
-

LIFO:onEvent(event)

-
- - - - -

TODO: Complete DCS#Event structure. -- The main event handling function... This function captures all events generated for the class. - @param #BASE self - @param DCS#Event event

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- event -

-
-
-

-
-
-
- -
-
- -
- -
-

Type LIFO.IDEntry

-
-
-
-

Field(s)

-
-
-
- - #table -LIFO.IDEntry.data - - - -
- -
-
-
- - #number -LIFO.IDEntry.pointer - - - -
- -
-
-
- - #table -LIFO.IDEntry.uniqueID - - - -
- -
-
-

Function(s)

-
@@ -13572,6 +4277,50 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +
+ +
+

UTILS.GetReportingName(Typename)

+
+ +

Get the NATO reporting name of a unit type name

+ +
+
+

Defined in:

+
+

UTILS

+
+

Parameter:

+
+
+

+ #number + Typename +

+
+
+ +

The type name.

+ +
+
+

Return value:

+
+
+

#string:

+
+
+ +

The Reporting name or "Bogey".

+ +
+
+
+
@@ -16081,7 +6830,7 @@ The data will be a simple comma separated list of name and state etc, with one h

Split string at seperators.

-

C.f. http://stackoverflow.com/questions/1426954/split-string-in-lua

+

C.f. split-string-in-lua.

diff --git a/Documentation/Wrapper.Airbase.html b/Documentation/Wrapper.Airbase.html index fdc2bd293..630dcecc4 100644 --- a/Documentation/Wrapper.Airbase.html +++ b/Documentation/Wrapper.Airbase.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+
+ +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Wrapper.Client.html b/Documentation/Wrapper.Client.html index c5cdda6ed..3cc77a0a7 100644 --- a/Documentation/Wrapper.Client.html +++ b/Documentation/Wrapper.Client.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -1911,6 +1922,12 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return

CLIENT:GetLifeRelative()

Returns the unit's relative health.

+ + + +

CLIENT:GetNatoReportingName()

+ +

[AIRPLANE] Get the NATO reporting name of a UNIT.

@@ -2041,6 +2058,12 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return

CLIENT:IsAlive()

Returns if the Unit is alive.

+ + + +

CLIENT:IsAmmoSupply()

+ +

Check if the unit can supply ammo.

@@ -2059,6 +2082,12 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return

CLIENT:IsFriendly(FriendlyCoalition)

Returns if the unit is a friendly unit.

+ + + +

CLIENT:IsFuelSupply()

+ +

Check if the unit can supply fuel.

@@ -4243,7 +4272,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Alive.

+

Alive2.

@@ -5357,7 +5386,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Alive.

+

Alive2.

@@ -6079,6 +6108,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+ +
+

CLIENT:GetNatoReportingName()

+
+ +

[AIRPLANE] Get the NATO reporting name of a UNIT.

+ + +

Currently airplanes only!

+ +
+
+

Defined in:

+
+

Wrapper.Unit#UNIT

+
+

Return value:

+
+
+

#string:

+
+
+ +

NatoReportingName or "Bogey" if unknown.

+ +
+
+
+
@@ -6915,6 +6977,48 @@ If the Unit is alive but not active, false is returned.

+ + + +
+ +
+

CLIENT:IsAmmoSupply()

+
+ +

Check if the unit can supply ammo.

+ + +

Currently, we have

+ + + +

This list needs to be extended, if DCS adds other units capable of supplying ammo.

+ + +
+
+

Defined in:

+
+

Wrapper.Unit#UNIT

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, unit can supply ammo.

+ +
+
+
+
@@ -7031,6 +7135,49 @@ If the Unit is alive but not active, false is returned.

+ + + +
+ +
+

CLIENT:IsFuelSupply()

+
+ +

Check if the unit can supply fuel.

+ + +

Currently, we have

+ + + +

This list needs to be extended, if DCS adds other units capable of supplying fuel.

+ + +
+
+

Defined in:

+
+

Wrapper.Unit#UNIT

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, unit can supply fuel.

+ +
+
+
+
@@ -7621,7 +7768,7 @@ If the Unit is alive but not active, false is returned.

-

Alive.

+

Alive2.

@@ -16310,7 +16457,7 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of -

Alive.

+

Alive2.

@@ -19969,7 +20116,7 @@ Coordinates are dependent on the position of the maps origin.

-

Alive.

+

Alive2.

@@ -20643,7 +20790,7 @@ If the Identifiable is alive, true is returned.

-

Alive.

+

Alive2.

@@ -20923,7 +21070,7 @@ If the Identifiable is alive, true is returned.

-

Alive.

+

Alive2.

diff --git a/Documentation/Wrapper.Controllable.html b/Documentation/Wrapper.Controllable.html index 65e63e00b..e49bf7340 100644 --- a/Documentation/Wrapper.Controllable.html +++ b/Documentation/Wrapper.Controllable.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index 1ab53e1ee..28a765656 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+ + +
+
+
+ Image +

Utils.FiFo

+
+

+

UTILS - ClassicFiFo Stack.

@@ -1927,6 +1938,12 @@ amount of fuel in the group.

GROUP:GetMinHeight()

Returns the current minimum height of the group.

+ + + +

GROUP:GetNatoReportingName()

+ +

[AIRPLANE] Get the NATO reporting name (platform, e.g.

@@ -5089,7 +5106,7 @@ To raise these events, provide the GenerateEvent parameter.

-

If true, a crash or dead event for each unit is generated. If false, if no event is triggered. If nil, a RemoveUnit event is triggered.

+

If true, a crash [AIR] or dead [GROUND] event for each unit is generated. If false, if no event is triggered. If nil, a RemoveUnit event is triggered.

@@ -5879,15 +5896,15 @@ amount of fuel in the group.

-

The fuel state of the unit with the least amount of fuel

+

The fuel state of the unit with the least amount of fuel.

-

#Unit:

+

Wrapper.Unit#UNIT:

-

reference to #Unit object for further processing

+

reference to #Unit object for further processing.

@@ -5910,24 +5927,16 @@ amount of fuel in the group.

GROUP

-

Return values:

+

Return value:

-
-

#number:

-
-
- -

mean heading of the GROUP

+
+

#number:

+
+
+ +

Mean heading of the GROUP in degrees or #nil The first UNIT is not existing or alive.

-
-
-

#nil:

-
-
- -

The first UNIT is not existing or alive.

- -
+
@@ -6147,6 +6156,39 @@ amount of fuel in the group.

+ + + +
+ +
+

GROUP:GetNatoReportingName()

+
+ +

[AIRPLANE] Get the NATO reporting name (platform, e.g.

+ + +

"Flanker") of a GROUP (note - first unit the group). "Bogey" if not found. Currently airplanes only!

+ +
+
+

Defined in:

+
+

GROUP

+
+

Return value:

+
+
+

#string:

+
+
+ +

NatoReportingName or "Bogey" if unknown.

+ +
+
+
+
@@ -6369,27 +6411,21 @@ amount of fuel in the group.

-

+ +

Radius in meters.

+
-

Return values:

+

Return value:

-
-

DCS#Vec3:

-
-
- -

The random 3D point vector around the first UNIT of the GROUP.

+
+

DCS#Vec3:

+
+
+ +

The random 3D point vector around the first UNIT of the GROUP or #nil The GROUP is invalid or empty.

-
-
-

#nil:

-
-
- -

The GROUP is invalid or empty

- -
+

Usage:


@@ -6863,24 +6899,16 @@ amount of fuel in the group.

    

 
GROUP

 

-    
Return values:

+    
Return value:

     

-        

-          
DCS#Vec3:

-        

-        

-          
-
The velocity Vec3 vector

+      

+        
DCS#Vec3:

+      

+      

+        
+
The velocity Vec3 vector or #nil if the GROUP is not existing or alive.  

 
-        

-        

-          
#nil:

-        

-        

-          
-
The GROUP is not existing or alive.  

-
-        

+      

     

 
 
diff --git a/Documentation/Wrapper.Identifiable.html b/Documentation/Wrapper.Identifiable.html
index 643026742..7284a9b9b 100644
--- a/Documentation/Wrapper.Identifiable.html
+++ b/Documentation/Wrapper.Identifiable.html
@@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

          
          

 
This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+                
+     
+     

+       

+         

+           Image
+           
Utils.FiFo

+         

+         

+
 UTILS - ClassicFiFo Stack.

 

        
         
      

diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html
index 29be84504..c4f5590bc 100644
--- a/Documentation/Wrapper.Marker.html
+++ b/Documentation/Wrapper.Marker.html
@@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

          
          

 
This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+                
+     
+     

+       

+         

+           Image
+           
Utils.FiFo

+         

+         

+
 UTILS - ClassicFiFo Stack.

 

        
         
      

diff --git a/Documentation/Wrapper.Object.html b/Documentation/Wrapper.Object.html
index 0e6b107cc..cf25f9867 100644
--- a/Documentation/Wrapper.Object.html
+++ b/Documentation/Wrapper.Object.html
@@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

          
          

 
This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+                
+     
+     

+       

+         

+           Image
+           
Utils.FiFo

+         

+         

+
 UTILS - ClassicFiFo Stack.

 

        
         
      

diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html
index f3544e87e..b0c3aa872 100644
--- a/Documentation/Wrapper.Positionable.html
+++ b/Documentation/Wrapper.Positionable.html
@@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

          
          

 
This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+                
+     
+     

+       

+         

+           Image
+           
Utils.FiFo

+         

+         

+
 UTILS - ClassicFiFo Stack.

 

        
         
      

diff --git a/Documentation/Wrapper.Scenery.html b/Documentation/Wrapper.Scenery.html
index f54ae5201..41db3a48d 100644
--- a/Documentation/Wrapper.Scenery.html
+++ b/Documentation/Wrapper.Scenery.html
@@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

          
          

 
This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+                
+     
+     

+       

+         

+           Image
+           
Utils.FiFo

+         

+         

+
 UTILS - ClassicFiFo Stack.

 

        
         
      

diff --git a/Documentation/Wrapper.Static.html b/Documentation/Wrapper.Static.html
index 478ae83fb..93d64cced 100644
--- a/Documentation/Wrapper.Static.html
+++ b/Documentation/Wrapper.Static.html
@@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

          
          

 
This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+                
+     
+     

+       

+         

+           Image
+           
Utils.FiFo

+         

+         

+
 UTILS - ClassicFiFo Stack.

 

        
         
      

diff --git a/Documentation/Wrapper.Unit.html b/Documentation/Wrapper.Unit.html
index 1e7950b81..e6153902f 100644
--- a/Documentation/Wrapper.Unit.html
+++ b/Documentation/Wrapper.Unit.html
@@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

          
          

 
This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+                
+     
+     

+       

+         

+           Image
+           
Utils.FiFo

+         

+         

+
 UTILS - ClassicFiFo Stack.

 

        
         
      

@@ -1721,6 +1732,12 @@ If you want to obtain the complete 3D position including orient
             
UNIT:GetLifeRelative()

             
 
Returns the unit's relative health.

+
+          
+          
+            
UNIT:GetNatoReportingName()

+            
+
 [AIRPLANE] Get the NATO reporting name of a UNIT.

 
           
           
@@ -1851,6 +1868,12 @@ If you want to obtain the complete 3D position including orient
             
UNIT:IsAlive()

             
 
Returns if the Unit is alive.

+
+          
+          
+            
UNIT:IsAmmoSupply()

+            
+
Check if the unit can supply ammo.

 
           
           
@@ -1869,6 +1892,12 @@ If you want to obtain the complete 3D position including orient
             
UNIT:IsFriendly(FriendlyCoalition)

             
 
Returns if the unit is a friendly unit.

+
+          
+          
+            
UNIT:IsFuelSupply()

+            
+
Check if the unit can supply fuel.

 
           
           
@@ -4679,6 +4708,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
     
 
 
+
+
+
+        

+
+

+
UNIT:GetNatoReportingName()

+

+    
+
 [AIRPLANE] Get the NATO reporting name of a UNIT.

+
+    
+
Currently airplanes only!

+
+

+  

+   
Defined in:

+   

+
UNIT

+

+    
Return value:

+    

+      

+        
#string:

+      

+      

+        
+
NatoReportingName or "Bogey" if unknown.

+
+      

+    

+

+
 

 

 
@@ -5515,6 +5577,48 @@ If the Unit is alive but not active, false is returned.  

     
 
 
+
+
+
+        

+
+

+
UNIT:IsAmmoSupply()

+

+    
+
Check if the unit can supply ammo.

+
+    
+
Currently, we have

+
+
    
+    
  • M 818
    • 
+    
  • Ural-375
    • 
+    
  • ZIL-135
    • 
+

+
+
This list needs to be extended, if DCS adds other units capable of supplying ammo.

+
+
+

+  

+   
Defined in:

+   

+
UNIT

+

+    
Return value:

+    

+      

+        
#boolean:

+      

+      

+        
+
If true, unit can supply ammo.

+
+      

+    

+

+
 

 

 
@@ -5631,6 +5735,49 @@ If the Unit is alive but not active, false is returned.  

     
 
 
+
+
+
+        

+
+

+
UNIT:IsFuelSupply()

+

+    
+
Check if the unit can supply fuel.

+
+    
+
Currently, we have

+
+
    
+    
  • M978 HEMTT Tanker
    • 
+    
  • ATMZ-5
    • 
+    
  • ATMZ-10
    • 
+    
  • ATZ-5
    • 
+

+
+
This list needs to be extended, if DCS adds other units capable of supplying fuel.

+
+
+

+  

+   
Defined in:

+   

+
UNIT

+

+    
Return value:

+    

+      

+        
#boolean:

+      

+      

+        
+
If true, unit can supply fuel.

+
+      

+    

+

+
 

 

 
diff --git a/Documentation/index.html b/Documentation/index.html
index 52b497c40..80d87b005 100644
--- a/Documentation/index.html
+++ b/Documentation/index.html
@@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

          
          

 
This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+                
+     
+     

+       

+         

+           Image
+           
Utils.FiFo

+         

+         

+
 UTILS - ClassicFiFo Stack.

 

        
         
      

@@ -2911,6 +2922,18 @@ Controls a network of short range air/missile defense groups.

             
Utils

             

 
This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+          
+                 
+    
+        

+          

+            Image
+          

+          

+            
Utils.FiFo

+            

+
 UTILS - ClassicFiFo Stack.

 

           

         
         
diff --git a/Documentation/routines.html b/Documentation/routines.html
index d5b27227e..183dd1ef8 100644
--- a/Documentation/routines.html
+++ b/Documentation/routines.html
@@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.

          
          

 
This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.

+

+                
+     
+     

+       

+         

+           Image
+           
Utils.FiFo

+         

+         

+
 UTILS - ClassicFiFo Stack.