From d0acd2ee4b0f51bd54b6163dd0c9f61d2ae28996 Mon Sep 17 00:00:00 2001 From: MooseBotter Date: Mon, 6 Jan 2025 13:22:34 +0000 Subject: [PATCH] Auto commit by GitHub Actions Workflow --- Documentation/AI.AI_A2A_Cap.html | 11 - Documentation/AI.AI_A2A_Dispatcher.html | 31 +- 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.html | 99 - Documentation/AI.AI_Air_Dispatcher.html | 55 - 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_CAS.html | 11 - Documentation/AI.AI_Cargo.html | 13 +- Documentation/AI.AI_Cargo_APC.html | 11 - Documentation/AI.AI_Cargo_Airplane.html | 47 - 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_Escort.html | 11 - Documentation/AI.AI_Escort_Dispatcher.html | 11 - .../AI.AI_Escort_Dispatcher_Request.html | 11 - Documentation/AI.AI_Escort_Request.html | 11 - Documentation/AI.AI_Formation.html | 11 - Documentation/AI.AI_Patrol.html | 23 +- Documentation/Actions.Act_Account.html | 11 - Documentation/Actions.Act_Assign.html | 11 - Documentation/Actions.Act_Assist.html | 11 - Documentation/Actions.Act_Route.html | 11 - Documentation/Cargo.Cargo.html | 22 - Documentation/Cargo.CargoCrate.html | 11 - Documentation/Cargo.CargoGroup.html | 14 - Documentation/Cargo.CargoSlingload.html | 11 - Documentation/Cargo.CargoUnit.html | 55 +- Documentation/Core.Astar.html | 11 - Documentation/Core.Base.html | 11 - Documentation/Core.Beacon.html | 11 - Documentation/Core.Condition.html | 11 - Documentation/Core.Database.html | 11 - Documentation/Core.Event.html | 11 - Documentation/Core.Fsm.html | 15 +- Documentation/Core.Goal.html | 11 - Documentation/Core.MarkerOps_Base.html | 11 - Documentation/Core.Menu.html | 11 - Documentation/Core.Message.html | 11 - Documentation/Core.Pathline.html | 11 - Documentation/Core.Point.html | 22 - Documentation/Core.Report.html | 11 - Documentation/Core.ScheduleDispatcher.html | 11 - Documentation/Core.Scheduler.html | 11 - Documentation/Core.Set.html | 11 - Documentation/Core.Settings.html | 41 +- Documentation/Core.Spawn.html | 14795 ---------------- Documentation/Core.SpawnStatic.html | 99 +- Documentation/Core.Spot.html | 11 - Documentation/Core.TextAndSound.html | 11 - Documentation/Core.Timer.html | 11 - Documentation/Core.UserFlag.html | 11 - Documentation/Core.Velocity.html | 11 - Documentation/Core.Zone.html | 11 - Documentation/Core.Zone_Detection.html | 11 - Documentation/DCS.html | 11 - Documentation/Functional.ATC_Ground.html | 21 +- Documentation/Functional.Artillery.html | 11 - Documentation/Functional.CleanUp.html | 11 - Documentation/Functional.ClientWatch.html | 11 - Documentation/Functional.Designate.html | 22 - Documentation/Functional.Detection.html | 77 +- Documentation/Functional.DetectionZones.html | 11 - Documentation/Functional.Escort.html | 11 - Documentation/Functional.Fox.html | 11 - Documentation/Functional.Mantis.html | 183 +- Documentation/Functional.MissileTrainer.html | 11 - Documentation/Functional.Movement.html | 11 - Documentation/Functional.PseudoATC.html | 11 - Documentation/Functional.RAT.html | 13477 -------------- Documentation/Functional.Range.html | 11 - Documentation/Functional.Scoring.html | 41 +- 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.ATIS.html | 11 - Documentation/Ops.Airboss.html | 91 +- Documentation/Ops.CSAR.html | 17 +- Documentation/Ops.CTLD.html | 306 +- Documentation/Ops.RecoveryTanker.html | 11 - Documentation/Ops.RescueHelo.html | 11 - Documentation/Shapes.CUBE.html | 11 - Documentation/Shapes.LINE.html | 11 - Documentation/Shapes.OVAL.html | 11 - Documentation/Shapes.POLYGON.html | 11 - Documentation/Shapes.SHAPE_BASE.html | 11 - Documentation/Shapes.TRIANGLE.html | 11 - Documentation/Sound.Radio.html | 11 - Documentation/Sound.RadioQueue.html | 11 - Documentation/Sound.RadioSpeech.html | 11 - Documentation/Sound.SRS.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 | 11 - Documentation/Tasking.TaskInfo.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 | 24 +- .../Tasking.Task_Capture_Dispatcher.html | 11 - Documentation/Tasking.Task_Capture_Zone.html | 11 - Documentation/Tasking.Task_Cargo_CSAR.html | 11 - .../Tasking.Task_Cargo_Dispatcher.html | 231 - .../Tasking.Task_Cargo_Transport.html | 11 - Documentation/Tasking.Task_Manager.html | 11 - Documentation/Utilities.Enums.html | 11 - Documentation/Utilities.FiFo.html | 33 +- Documentation/Utilities.Profiler.html | 11 - Documentation/Utilities.STTS.html | 11 - Documentation/Utilities.Socket.html | 11 - Documentation/Utilities.Templates.html | 11 - Documentation/Utilities.Utils.html | 11 - Documentation/Wrapper.Airbase.html | 11 - Documentation/Wrapper.Client.html | 11 - Documentation/Wrapper.Controllable.html | 66 +- Documentation/Wrapper.DynamicCargo.html | 11 - Documentation/Wrapper.Group.html | 11 - Documentation/Wrapper.Identifiable.html | 11 - Documentation/Wrapper.Marker.html | 77 +- Documentation/Wrapper.Net.html | 11 - Documentation/Wrapper.Object.html | 11 - Documentation/Wrapper.Positionable.html | 11 - Documentation/Wrapper.Scenery.html | 11 - Documentation/Wrapper.Static.html | 11 - Documentation/Wrapper.Storage.html | 11 - Documentation/Wrapper.Unit.html | 11 - Documentation/Wrapper.Weapon.html | 11 - Documentation/index.html | 23 - 151 files changed, 636 insertions(+), 30810 deletions(-) delete mode 100644 Documentation/Core.Spawn.html diff --git a/Documentation/AI.AI_A2A_Cap.html b/Documentation/AI.AI_A2A_Cap.html index 7b6b32643..940a256e5 100644 --- a/Documentation/AI.AI_A2A_Cap.html +++ b/Documentation/AI.AI_A2A_Cap.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_A2A_Dispatcher.html b/Documentation/AI.AI_A2A_Dispatcher.html index cfd039859..322fea86a 100644 --- a/Documentation/AI.AI_A2A_Dispatcher.html +++ b/Documentation/AI.AI_A2A_Dispatcher.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -5034,14 +5023,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + AI_A2A_DISPATCHER.SetSendPlayerMessages - -

Flash messages to player

-
@@ -11701,14 +11687,11 @@ They will lock the parking spot.

- #boolean + AI_A2A_DISPATCHER.SetSendPlayerMessages - -

Flash messages to player

-
@@ -12966,14 +12949,11 @@ They will lock the parking spot.

- #boolean + AI_A2A_DISPATCHER.SetSendPlayerMessages - -

Flash messages to player

-
@@ -14533,14 +14513,11 @@ They will lock the parking spot.

- #boolean + AI_A2A_DISPATCHER.SetSendPlayerMessages - -

Flash messages to player

-
diff --git a/Documentation/AI.AI_A2A_Gci.html b/Documentation/AI.AI_A2A_Gci.html index 9ff93da6d..d35a11552 100644 --- a/Documentation/AI.AI_A2A_Gci.html +++ b/Documentation/AI.AI_A2A_Gci.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_A2A_Patrol.html b/Documentation/AI.AI_A2A_Patrol.html index 62cd46c34..6c58c4302 100644 --- a/Documentation/AI.AI_A2A_Patrol.html +++ b/Documentation/AI.AI_A2A_Patrol.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_A2G_BAI.html b/Documentation/AI.AI_A2G_BAI.html index fef268518..73e8edefb 100644 --- a/Documentation/AI.AI_A2G_BAI.html +++ b/Documentation/AI.AI_A2G_BAI.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_A2G_CAS.html b/Documentation/AI.AI_A2G_CAS.html index a309ebc2f..aefab0275 100644 --- a/Documentation/AI.AI_A2G_CAS.html +++ b/Documentation/AI.AI_A2G_CAS.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html index 0b9bc6829..e40a70319 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -4903,6 +4892,17 @@ 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 + + +
@@ -13454,6 +13454,17 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_A2G_DISPATCHER.DefenderPatrolIndex + + +
@@ -16408,6 +16430,17 @@ 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 e3f541a75..d515ab762 100644 --- a/Documentation/AI.AI_A2G_SEAD.html +++ b/Documentation/AI.AI_A2G_SEAD.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_Air.html b/Documentation/AI.AI_Air.html index a735aee0b..4d970ce68 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -3347,28 +3336,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #number -AI_AIR.RTBSpeedMaxFactor - - - -
- -
-
-
- - #number -AI_AIR.RTBSpeedMinFactor - - -
@@ -6222,28 +6189,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.RTBSpeedMaxFactor - - - -
- -
-
-
- - #number -AI_AIR.RTBSpeedMinFactor - - -
@@ -6980,28 +6925,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.RTBSpeedMaxFactor - - - -
- -
-
-
- - #number -AI_AIR.RTBSpeedMinFactor - - -
@@ -8626,28 +8549,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.RTBSpeedMaxFactor - - - -
- -
-
-
- - #number -AI_AIR.RTBSpeedMinFactor - - -
diff --git a/Documentation/AI.AI_Air_Dispatcher.html b/Documentation/AI.AI_Air_Dispatcher.html index 7d7eba9b7..9d174a281 100644 --- a/Documentation/AI.AI_Air_Dispatcher.html +++ b/Documentation/AI.AI_Air_Dispatcher.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -4663,17 +4652,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 - - -
@@ -9993,17 +9971,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
@@ -12947,17 +12903,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_Engage.html b/Documentation/AI.AI_Air_Engage.html index 841b89c8e..f014bc513 100644 --- a/Documentation/AI.AI_Air_Engage.html +++ b/Documentation/AI.AI_Air_Engage.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_Air_Patrol.html b/Documentation/AI.AI_Air_Patrol.html index a6c3c052d..115deeb46 100644 --- a/Documentation/AI.AI_Air_Patrol.html +++ b/Documentation/AI.AI_Air_Patrol.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_Air_Squadron.html b/Documentation/AI.AI_Air_Squadron.html index 3c90988a5..3d011b325 100644 --- a/Documentation/AI.AI_Air_Squadron.html +++ b/Documentation/AI.AI_Air_Squadron.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_BAI.html b/Documentation/AI.AI_BAI.html index 0ea6c2e3b..8fc0615e5 100644 --- a/Documentation/AI.AI_BAI.html +++ b/Documentation/AI.AI_BAI.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_Balancer.html b/Documentation/AI.AI_Balancer.html index b99972674..bed100771 100644 --- a/Documentation/AI.AI_Balancer.html +++ b/Documentation/AI.AI_Balancer.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_CAP.html b/Documentation/AI.AI_CAP.html index e320f98fd..fb27a90b3 100644 --- a/Documentation/AI.AI_CAP.html +++ b/Documentation/AI.AI_CAP.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_CAS.html b/Documentation/AI.AI_CAS.html index a9240f2d8..2946afdee 100644 --- a/Documentation/AI.AI_CAS.html +++ b/Documentation/AI.AI_CAS.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html index e1a9199ca..c3966b6a1 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -1973,7 +1962,7 @@ Therefore, this class is considered to be deprecated

- + Wrapper.Group#GROUP AI_CARGO.CargoCarrier diff --git a/Documentation/AI.AI_Cargo_APC.html b/Documentation/AI.AI_Cargo_APC.html index a451467be..c4407f4f8 100644 --- a/Documentation/AI.AI_Cargo_APC.html +++ b/Documentation/AI.AI_Cargo_APC.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

-
- -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index a60f38278..807ef06e4 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

- diff --git a/Documentation/AI.AI_Cargo_Dispatcher.html b/Documentation/AI.AI_Cargo_Dispatcher.html index 38fe509bd..80a945dc2 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher.html +++ b/Documentation/AI.AI_Cargo_Dispatcher.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_APC.html b/Documentation/AI.AI_Cargo_Dispatcher_APC.html index 077de1546..5aca6c8f8 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_APC.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_APC.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html b/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html index e84b010bf..98e78b69a 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html b/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html index 8ba5320dc..a526f9829 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_Ship.html b/Documentation/AI.AI_Cargo_Dispatcher_Ship.html index d32c6c81f..71ab6331b 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_Ship.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_Ship.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_Cargo_Helicopter.html b/Documentation/AI.AI_Cargo_Helicopter.html index 7181ab477..a19994adf 100644 --- a/Documentation/AI.AI_Cargo_Helicopter.html +++ b/Documentation/AI.AI_Cargo_Helicopter.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -3070,28 +3059,22 @@ 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

-
@@ -4994,28 +4977,22 @@ Adjust if necessary.
- #number + AI_CARGO_HELICOPTER.landingheight - -

meter

-
- #number + AI_CARGO_HELICOPTER.landingspeed - -

kph

-
@@ -5670,28 +5647,22 @@ Adjust if necessary.
- #number + AI_CARGO_HELICOPTER.landingheight - -

meter

-
- #number + AI_CARGO_HELICOPTER.landingspeed - -

kph

-
@@ -7234,28 +7205,22 @@ 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 c85b7f96e..0d38a39f8 100644 --- a/Documentation/AI.AI_Cargo_Ship.html +++ b/Documentation/AI.AI_Cargo_Ship.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_Escort.html b/Documentation/AI.AI_Escort.html index f68cd02a3..c6d754053 100644 --- a/Documentation/AI.AI_Escort.html +++ b/Documentation/AI.AI_Escort.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_Escort_Dispatcher.html b/Documentation/AI.AI_Escort_Dispatcher.html index ff5932b16..7947342a4 100644 --- a/Documentation/AI.AI_Escort_Dispatcher.html +++ b/Documentation/AI.AI_Escort_Dispatcher.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_Escort_Dispatcher_Request.html b/Documentation/AI.AI_Escort_Dispatcher_Request.html index aae2b3a1b..4e4ccec8b 100644 --- a/Documentation/AI.AI_Escort_Dispatcher_Request.html +++ b/Documentation/AI.AI_Escort_Dispatcher_Request.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_Escort_Request.html b/Documentation/AI.AI_Escort_Request.html index 80bf4ea42..0d661770b 100644 --- a/Documentation/AI.AI_Escort_Request.html +++ b/Documentation/AI.AI_Escort_Request.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_Formation.html b/Documentation/AI.AI_Formation.html index 1b740cff7..a62c856dd 100644 --- a/Documentation/AI.AI_Formation.html +++ b/Documentation/AI.AI_Formation.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/AI.AI_Patrol.html b/Documentation/AI.AI_Patrol.html index ebc7500b7..1f54f0a7d 100644 --- a/Documentation/AI.AI_Patrol.html +++ b/Documentation/AI.AI_Patrol.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

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

This table contains the targets detected during patrol.

+ @@ -6688,6 +6680,9 @@ The default interval is 30 seconds.

+ +

This table contains the targets detected during patrol.

+ @@ -7432,6 +7427,9 @@ The default interval is 30 seconds.

+ +

This table contains the targets detected during patrol.

+ @@ -9064,6 +9062,9 @@ The default interval is 30 seconds.

+ +

This table contains the targets detected during patrol.

+ diff --git a/Documentation/Actions.Act_Account.html b/Documentation/Actions.Act_Account.html index 744709165..b1c5e74be 100644 --- a/Documentation/Actions.Act_Account.html +++ b/Documentation/Actions.Act_Account.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Actions.Act_Assign.html b/Documentation/Actions.Act_Assign.html index a7d711905..96d0165d3 100644 --- a/Documentation/Actions.Act_Assign.html +++ b/Documentation/Actions.Act_Assign.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Actions.Act_Assist.html b/Documentation/Actions.Act_Assist.html index d1c385587..578872d48 100644 --- a/Documentation/Actions.Act_Assist.html +++ b/Documentation/Actions.Act_Assist.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Actions.Act_Route.html b/Documentation/Actions.Act_Route.html index fa04e1b6d..a7f87fdeb 100644 --- a/Documentation/Actions.Act_Route.html +++ b/Documentation/Actions.Act_Route.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Cargo.Cargo.html b/Documentation/Cargo.Cargo.html index 1f363c654..62c2f85ac 100644 --- a/Documentation/Cargo.Cargo.html +++ b/Documentation/Cargo.Cargo.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -2918,17 +2907,6 @@ All derived classes from CARGO follow the same state machine, expose the same ca - - - -
-
- - -CARGO.Weight - - -
diff --git a/Documentation/Cargo.CargoCrate.html b/Documentation/Cargo.CargoCrate.html index 67b8b830f..9b4910e32 100644 --- a/Documentation/Cargo.CargoCrate.html +++ b/Documentation/Cargo.CargoCrate.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index e3f5b146d..3c7b71160 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -2034,9 +2023,6 @@ Therefore, this class is considered to be deprecated

- -

Then we register the new group in the database

- diff --git a/Documentation/Cargo.CargoSlingload.html b/Documentation/Cargo.CargoSlingload.html index d902ed83c..f94799e2e 100644 --- a/Documentation/Cargo.CargoSlingload.html +++ b/Documentation/Cargo.CargoSlingload.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index 0f419fe2c..d017d919e 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -1914,6 +1903,17 @@ Therefore, this class is considered to be deprecated

+CARGO_UNIT.CargoCarrier + + + +
+ + +
+
+ + CARGO_UNIT.CargoInAir @@ -1932,17 +1932,6 @@ Therefore, this class is considered to be deprecated

Set cargo object.

-
- -
-
-
- - #number -CARGO_UNIT.RunCount - - -
@@ -2629,6 +2618,17 @@ Therefore, this class is considered to be deprecated

+CARGO_UNIT.CargoCarrier + + + +
+ + +
+
+ + CARGO_UNIT.CargoInAir @@ -2647,17 +2647,6 @@ Therefore, this class is considered to be deprecated

Set cargo object.

-
- -
-
-
- - #number -CARGO_UNIT.RunCount - - -
diff --git a/Documentation/Core.Astar.html b/Documentation/Core.Astar.html index ac799f4b5..225e5dba1 100644 --- a/Documentation/Core.Astar.html +++ b/Documentation/Core.Astar.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Core.Base.html b/Documentation/Core.Base.html index 37e06eb2a..815846d89 100644 --- a/Documentation/Core.Base.html +++ b/Documentation/Core.Base.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Core.Beacon.html b/Documentation/Core.Beacon.html index 9f3752fa9..b43868286 100644 --- a/Documentation/Core.Beacon.html +++ b/Documentation/Core.Beacon.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Core.Condition.html b/Documentation/Core.Condition.html index a56e08618..849956d2f 100644 --- a/Documentation/Core.Condition.html +++ b/Documentation/Core.Condition.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Core.Database.html b/Documentation/Core.Database.html index bfc571f96..5666dc163 100644 --- a/Documentation/Core.Database.html +++ b/Documentation/Core.Database.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Core.Event.html b/Documentation/Core.Event.html index 52aeb458d..03665971c 100644 --- a/Documentation/Core.Event.html +++ b/Documentation/Core.Event.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html index 9610f3e4d..21d67c47f 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -6117,7 +6106,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string FSM._StartState @@ -7716,7 +7705,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string FSM._StartState diff --git a/Documentation/Core.Goal.html b/Documentation/Core.Goal.html index 203f14cc1..1a7e145e3 100644 --- a/Documentation/Core.Goal.html +++ b/Documentation/Core.Goal.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

-
-
-
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Core.MarkerOps_Base.html b/Documentation/Core.MarkerOps_Base.html index 4ad96b166..391b25376 100644 --- a/Documentation/Core.MarkerOps_Base.html +++ b/Documentation/Core.MarkerOps_Base.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Core.Menu.html b/Documentation/Core.Menu.html index 3dfc6af49..388ca0727 100644 --- a/Documentation/Core.Menu.html +++ b/Documentation/Core.Menu.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Core.Message.html b/Documentation/Core.Message.html index 1552a334c..416fda67a 100644 --- a/Documentation/Core.Message.html +++ b/Documentation/Core.Message.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Core.Pathline.html b/Documentation/Core.Pathline.html index f61ad482e..e67830792 100644 --- a/Documentation/Core.Pathline.html +++ b/Documentation/Core.Pathline.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html index 4067b0b4d..1b9c9769b 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -17399,17 +17388,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
-POINT_VEC2.x - - - -
- - -
-
- - POINT_VEC2.z diff --git a/Documentation/Core.Report.html b/Documentation/Core.Report.html index 5042dd685..56cd9de55 100644 --- a/Documentation/Core.Report.html +++ b/Documentation/Core.Report.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

-
- -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Core.ScheduleDispatcher.html b/Documentation/Core.ScheduleDispatcher.html index f91591b21..d3a2f513b 100644 --- a/Documentation/Core.ScheduleDispatcher.html +++ b/Documentation/Core.ScheduleDispatcher.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Core.Scheduler.html b/Documentation/Core.Scheduler.html index 4ce4c3850..e098c728f 100644 --- a/Documentation/Core.Scheduler.html +++ b/Documentation/Core.Scheduler.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Core.Set.html b/Documentation/Core.Set.html index 9a1cd3380..adacf663c 100644 --- a/Documentation/Core.Set.html +++ b/Documentation/Core.Set.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index 9d30aad47..1893b1687 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -3012,7 +3001,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + SETTINGS.A2ASystem @@ -3023,7 +3012,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + SETTINGS.A2GSystem @@ -3072,6 +3061,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SETTINGS.PlayerMenu + + +
@@ -5169,7 +5169,7 @@ It is advised to use this method at the start of the mission.

- #string + SETTINGS.A2ASystem @@ -5180,7 +5180,7 @@ It is advised to use this method at the start of the mission.

- #string + SETTINGS.A2GSystem @@ -5229,6 +5229,17 @@ It is advised to use this method at the start of the mission.

+
+ +
+
+
+ + +SETTINGS.PlayerMenu + + +
diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html deleted file mode 100644 index 1ccded6ea..000000000 --- a/Documentation/Core.Spawn.html +++ /dev/null @@ -1,14795 +0,0 @@ - - - - - - - - - - - - - - - - - - -
-

- -

-
-
- - -Banner Image -
-
-

Module Core.Spawn

-
-
- -

Core - Spawn dynamically new groups of units in running missions.

- - - -
- -

Features:

- -
    -
  • Spawn new groups in running missions.
    • -
  • Schedule spawning of new groups.
    • -
  • Put limits on the amount of groups that can be spawned, and the amount of units that can be alive at the same time.
    • -
  • Randomize the spawning location between different zones.
    • -
  • Randomize the initial positions within the zones.
    • -
  • Spawn in array formation.
    • -
  • Spawn uncontrolled (for planes or helicopters only).
    • -
  • Clean up inactive helicopters that "crashed".
    • -
  • Place a hook to capture a spawn event, and tailor with customer code.
    • -
  • Spawn late activated.
    • -
  • Spawn with or without an initial delay.
    • -
  • Respawn after landing, on the runway or at the ramp after engine shutdown.
    • -
  • Spawn with custom heading, both for a group formation and for the units in the group.
    • -
  • Spawn with different skills.
    • -
  • Spawn with different liveries.
    • -
  • Spawn with an inner and outer radius to set the initial position.
    • -
  • Spawn with a randomize route.
    • -
  • Spawn with a randomized template.
    • -
  • Spawn with a randomized start points on a route.
    • -
  • Spawn with an alternative name.
    • -
  • Spawn and keep the unit names.
    • -
  • Spawn with a different coalition and country.
    • -
  • Enquiry methods to check on spawn status.
    • -
- -
- -

Demo Missions

- -
- -

YouTube Playlist

- -
- -

Author: FlightControl

-

Contributions: A lot of people within this community!

- -
- - -
-

Global(s)

-
- - - - - -

Global SPAWN

 -

Allows to spawn dynamically new Wrapper.Groups.

-
-
-
-
- - #SPAWN -SPAWN - -

Allows to spawn dynamically new Wrapper.Groups.

- - - -

Each SPAWN object needs to be have related template groups setup in the Mission Editor (ME), -which is a normal group with the Late Activation flag set. -This template group will never be activated in your mission. -SPAWN uses that template group to reference to all the characteristics -(air, ground, livery, unit composition, formation, skill level etc) of each new group to be spawned.

- -

Therefore, when creating a SPAWN object, the SPAWN.New and SPAWN.NewWithAlias require -the name of the template group to be given as a string to those constructor methods.

- -

Initialization settings can be applied on the SPAWN object, -which modify the behavior or the way groups are spawned. -These initialization methods have the prefix Init. -There are also spawn methods with the prefix Spawn and will spawn new groups in various ways.

- -

IMPORTANT! The methods with prefix Init must be used before any methods with prefix Spawn method are used, or unexpected results may appear!!!

- -

Because SPAWN can spawn multiple groups of a template group, -SPAWN has an internal index that keeps track -which was the latest group that was spawned.

- -

Limits can be set on how many groups can be spawn in each SPAWN object, -using the method SPAWN.InitLimit. SPAWN has 2 kind of limits:

- -
    -
  • The maximum amount of Wrapper.Units that can be alive at the same time...
    • -
  • The maximum amount of Wrapper.Groups that can be spawned... This is more of a resource-type of limit.
    • -
- -

When new groups get spawned using the Spawn methods, -it will be evaluated whether any limits have been reached. -When no spawn limit is reached, a new group will be created by the spawning methods, -and the internal index will be increased with 1.

- -

These limits ensure that your mission does not accidentally get flooded with spawned groups. -Additionally, it also guarantees that independent of the group composition, -at any time, the most optimal amount of groups are alive in your mission. -For example, if your template group has a group composition of 10 units, and you specify a limit of 100 units alive at the same time, -with unlimited resources = :InitLimit( 100, 0 ) and 10 groups are alive, but two groups have only one unit alive in the group, -then a sequent Spawn(Scheduled) will allow a new group to be spawned!!!

- -

IMPORTANT!! If a limit has been reached, it is possible that a Spawn method returns nil, meaning, no Wrapper.Group had been spawned!!!

- -

Spawned groups get the same name as the name of the template group. -Spawned units in those groups keep by default the same name as the name of the template group. -However, because multiple groups and units are created from the template group, -a suffix is added to each spawned group and unit.

- -

Newly spawned groups will get the following naming structure at run-time:

- -
    -
  1. Spawned groups will have the name GroupName#nnn, where GroupName is the name of the template group, - and nnn is a counter from 0 to 999.
    2. -
  2. Spawned units will have the name GroupName#nnn-uu, - where uu is a counter from 0 to 99 for each new spawned unit belonging to the group.
    3. -
- -

That being said, there is a way to keep the same unit names! -The method SPAWN.InitKeepUnitNames() will keep the same unit names as defined within the template group, thus:

- -
    -
  1. Spawned units will have the name UnitName#nnn-uu, - where UnitName is the unit name as defined in the template group*, - and uu is a **counter from 0 to 99 for each new spawned unit belonging to the group.
    2. -
- -

Some additional notes that need to be considered!!:

- -
    -
  • templates are actually groups defined within the mission editor, with the flag "Late Activation" set. - As such, these groups are never used within the mission, but are used by the #SPAWN module.
    • -
  • It is important to defined BEFORE you spawn new groups, - a proper initialization of the SPAWN instance is done with the options you want to use.
    • -
  • When designing a mission, NEVER name groups using a "#" within the name of the group Spawn template(s), - or the SPAWN module logic won't work anymore.
    • -
- -

SPAWN construction methods

- -

Create a new SPAWN object with the SPAWN.New() or the SPAWN.NewWithAlias() methods:

- -
    -
  • SPAWN.New(): Creates a new SPAWN object taking the name of the group that represents the GROUP template (definition).
    • -
  • SPAWN.NewWithAlias(): Creates a new SPAWN object taking the name of the group that represents the GROUP template (definition), and gives each spawned Wrapper.Group an different name.
    • -
- -

It is important to understand how the SPAWN class works internally. The SPAWN object created will contain internally a list of groups that will be spawned and that are already spawned. -The initialization methods will modify this list of groups so that when a group gets spawned, ALL information is already prepared when spawning. This is done for performance reasons. -So in principle, the group list will contain all parameters and configurations after initialization, and when groups get actually spawned, this spawning can be done quickly and efficient.

- -

SPAWN Initialization methods

- -

A spawn object will behave differently based on the usage of initialization methods, which all start with the Init prefix:

- -

Unit Names

- -
    -
  • SPAWN.InitKeepUnitNames(): Keeps the unit names as defined within the mission editor, but note that anything after a # mark is ignored, and any spaces before and after the resulting name are removed. IMPORTANT! This method MUST be the first used after :New !!!
    • -
- -

Route randomization

- - - -

Group composition randomization

- -
    -
  • SPAWN.InitRandomizeTemplate(): Randomize the group templates so that when a new group is spawned, a random group template is selected from one of the templates defined.
    • -
- -

Uncontrolled

- - - -

Array formation

- -
    -
  • SPAWN.InitArray(): Make groups visible before they are actually activated, and order these groups like a battalion in an array.
    • -
- -

Group initial position - if wanted different from template position, for use with e.g. SPAWN.SpawnScheduled().

- - - -

Set the positions of a group's units to absolute positions, or relative positions to unit No. 1

- - - -

Position randomization

- - - -

Enable / Disable AI when spawning a new Wrapper.Group

- - - -

Limit scheduled spawning

- -
    -
  • SPAWN.InitLimit(): Limits the amount of groups that can be alive at the same time and that can be dynamically spawned.
    • -
- -

Delay initial scheduled spawn

- - - -

Repeat spawned Wrapper.Groups upon landing

- - - -

Link-16 Datalink STN and SADL IDs (limited at the moment to F15/16/18/AWACS/Tanker/B1B, but not the F15E for clients, SADL A10CII only)

- -
    -
  • SPAWN.InitSTN(): Set the STN of the first unit in the group. All other units will have consecutive STNs, provided they have not been used yet.
    • -
  • SPAWN.InitSADL(): Set the SADL of the first unit in the group. All other units will have consecutive SADLs, provided they have not been used yet.
    • -
- -

Callsigns

- - - -

Speed

- - - -

SPAWN Spawn methods

- -

Groups can be spawned at different times and methods:

- -

Single spawning methods

- - - -

Note that SPAWN.Spawn and SPAWN.ReSpawn return a Wrapper.Group#GROUP.New object, that contains a reference to the DCSGroup object. -You can use the Wrapper.Group#GROUP object to do further actions with the DCSGroup.

- -

Scheduled spawning methods

- - - -

Retrieve alive GROUPs spawned by the SPAWN object

- -

The SPAWN class administers which GROUPS it has reserved (in stock) or has created during mission execution. -Every time a SPAWN object spawns a new GROUP object, a reference to the GROUP object is added to an internal table of GROUPS. -SPAWN provides methods to iterate through that internal GROUP object reference table:

- -
    -
  • SPAWN.GetFirstAliveGroup(): Will find the first alive GROUP it has spawned, and return the alive GROUP object and the first Index where the first alive GROUP object has been found.
    • -
  • SPAWN.GetNextAliveGroup(): Will find the next alive GROUP object from a given Index, and return a reference to the alive GROUP object and the next Index where the alive GROUP has been found.
    • -
  • SPAWN.GetLastAliveGroup(): Will find the last alive GROUP object, and will return a reference to the last live GROUP object and the last Index where the last alive GROUP object has been found.
    • -
- -

You can use the methods SPAWN.GetFirstAliveGroup() and sequently SPAWN.GetNextAliveGroup() to iterate through the alive GROUPS within the SPAWN object, and to actions... See the respective methods for an example. -The method SPAWN.GetGroupFromIndex() will return the GROUP object reference from the given Index, dead or alive...

- -

Spawned cleaning of inactive groups

- -

Sometimes, it will occur during a mission run-time, that ground or especially air objects get damaged, and will while being damaged stop their activities, while remaining alive. -In such cases, the SPAWN object will just sit there and wait until that group gets destroyed, but most of the time it won't, -and it may occur that no new groups are or can be spawned as limits are reached. -To prevent this, a SPAWN.InitCleanUp() initialization method has been defined that will silently monitor the status of each spawned group. -Once a group has a velocity = 0, and has been waiting for a defined interval, that group will be cleaned or removed from run-time. -There is a catch however :-) If a damaged group has returned to an airbase within the coalition, that group will not be considered as "lost"... -In such a case, when the inactive group is cleaned, a new group will Re-spawned automatically. -This models AI that has successfully returned to their airbase, to restart their combat activities. -Check the SPAWN.InitCleanUp() for further info.

- -

Catch the Wrapper.Group Spawn Event in a callback function!

- -

When using the SPAWN.SpawnScheduleds are created following the spawn time interval parameters. -When a new Wrapper.Group is spawned, you maybe want to execute actions with that group spawned at the spawn event. -The SPAWN class supports this functionality through the method SPAWN.OnSpawnGroup( *function( SpawnedGroup ) end * ), -which takes a function as a parameter that you can define locally. -Whenever a new Wrapper.Group is spawned, the given function is called, and the Wrapper.Group that was just spawned, is given as a parameter. -As a result, your spawn event handling function requires one parameter to be declared, which will contain the spawned Wrapper.Group object. -A coding example is provided at the description of the SPAWN.OnSpawnGroup( *function( SpawnedGroup ) end * ) method.

- -

Delay the initial spawning

- -

When using the SPAWN.SpawnScheduled -immediately when :SpawnScheduled() is initiated. The methods SPAWN.InitDelayOnOff() and SPAWN.InitDelayOn() can be used to -activate a delay before the first Wrapper.Group is spawned. For completeness, a method SPAWN.InitDelayOff() is also available, that -can be used to switch off the initial delay. Because there is no delay by default, this method would only be used when a -SPAWN.SpawnScheduleStop() ; SPAWN.SpawnScheduleStart() sequence would have been used.

- - -
- -
-

Type(s)

-

Type SPAWN

-
- SPAWN -, extends Core.Base#BASE -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from SPAWNDescription

SPAWN.AIOnOff

 - -

SPAWN.AliveUnits

 - -

SPAWN.ClassName

 - -

SPAWN.CleanUpScheduler

 - -

SPAWN.DelayOnOff

 - -

SPAWN:GetCoordinate()

 -

Get the Coordinate of the Group that is Late Activated as the template for the SPAWN object.

-

SPAWN:GetFirstAliveGroup()

 -

Will find the first alive Wrapper.Group it has spawned, and return the alive Wrapper.Group object and the first Index where the first alive Wrapper.Group object has been found.

-

SPAWN:GetGroupFromIndex(SpawnIndex)

 -

Get the group from an index.

-

SPAWN:GetLastAliveGroup()

 -

Will find the last alive Wrapper.Group object, and will return a reference to the last live Wrapper.Group object and the last Index where the last alive Wrapper.Group object has been found.

-

SPAWN:GetNextAliveGroup(SpawnIndexStart)

 -

Will find the next alive Wrapper.Group object from a given Index, and return a reference to the alive Wrapper.Group object and the next Index where the alive Wrapper.Group has been found.

-

SPAWN:GetSpawnIndexFromGroup(SpawnGroup)

 -

Get the index from a given group.

-

SPAWN:InitAIOff()

 -

Turns the AI Off for the Wrapper.Group when spawning.

-

SPAWN:InitAIOn()

 -

Turns the AI On for the Wrapper.Group when spawning.

-

SPAWN:InitAIOnOff(AIOnOff)

 -

Turns the AI On or Off for the Wrapper.Group when spawning.

-

SPAWN:InitAirbase(AirbaseName, Takeoff, TerminalType)

 -

Set spawns to happen at a particular airbase.

-

SPAWN:InitArray(SpawnAngle, SpawnWidth, SpawnDeltaX, SpawnDeltaY)

 -

Makes the groups visible before start (like a battalion).

-

SPAWN:InitCallSign(ID, Name, Minor, Major)

 -

[BLUE AIR only!] This method sets a specific callsign for a spawned group.

-

SPAWN:InitCategory(Category)

 -

Sets category ID of the group.

-

SPAWN:InitCleanUp(SpawnCleanUpInterval)

 -

Delete groups that have not moved for X seconds - AIR ONLY!!! -DO NOT USE ON GROUPS THAT DO NOT MOVE OR YOUR SERVER WILL BURN IN HELL (Pikes - April 2020) -When groups are still alive and have become inactive due to damage and are unable to contribute anything, then this group will be removed at defined intervals in seconds.

-

SPAWN:InitCoalition(Coalition)

 -

Sets the coalition of the spawned group.

-

SPAWN:InitCountry(Country)

 -

Sets the country of the spawn group.

-

SPAWN:InitDelayOff()

 -

Turns the Delay Off for the Wrapper.Group when spawning.

-

SPAWN:InitDelayOn()

 -

Turns the Delay On for the Wrapper.Group when spawning with #SpawnScheduled().

-

SPAWN:InitDelayOnOff(DelayOnOff)

 - -

SPAWN:InitGroupHeading(HeadingMin, HeadingMax, unitVar)

 -

Defines the heading of the overall formation of the new spawned group.

-

SPAWN:InitGrouping(Grouping)

 -

When spawning a new group, make the grouping of the units according the InitGrouping setting.

-

SPAWN:InitHeading(HeadingMin, HeadingMax)

 -

Defines the Heading for the new spawned units.

-

SPAWN:InitHiddenOnMFD()

 -

Hide the group on MFDs (visible to game master slots!).

-

SPAWN:InitHiddenOnMap(OnOff)

 -

Hide the group on the map view (visible to game master slots!).

-

SPAWN:InitHiddenOnPlanner()

 -

Hide the group on planner (visible to game master slots!).

-

SPAWN:InitKeepUnitNames(KeepUnitNames)

 -

Keeps the unit names as defined within the mission editor, -but note that anything after a # mark is ignored, -and any spaces before and after the resulting name are removed.

-

SPAWN:InitLateActivated(LateActivated)

 -

Flags that the spawned groups must be spawned late activated.

-

SPAWN:InitLimit(SpawnMaxUnitsAlive, SpawnMaxGroups)

 -

Stops any more repeat spawns from happening once the UNIT count of Alive units, spawned by the same SPAWN object, exceeds the first parameter.

-

SPAWN:InitLivery(Livery)

 -

Sets livery of the group.

-

SPAWN:InitModex(modex, prefix, postfix)

 -

Sets the modex of the first unit of the group.

-

SPAWN:InitPositionCoordinate(Coordinate)

 -

This method sets a spawn position for the group that is different from the location of the template.

-

SPAWN:InitPositionVec2(Vec2)

 -

This method sets a spawn position for the group that is different from the location of the template.

-

SPAWN:InitRadioCommsOnOff(switch)

 -

Sets the radio communication on or off.

-

SPAWN:InitRadioFrequency(frequency)

 -

Sets the radio frequency of the group.

-

SPAWN:InitRadioModulation(modulation)

 -

Set radio modulation.

-

SPAWN:InitRandomizeCallsign()

 -

[AIR/Fighter only!] This method randomizes the callsign for a new group.

-

SPAWN:InitRandomizePosition(RandomizePosition, OuterRadius, InnerRadius)

 -

Randomizes the position of Wrapper.Groups that are spawned within a radius band, given an Outer and Inner radius, from the point that the spawn happens.

-

SPAWN:InitRandomizeRoute(SpawnStartPoint, SpawnEndPoint, SpawnRadius, SpawnHeight)

 -

Randomizes the defined route of the SpawnTemplatePrefix group in the ME.

-

SPAWN:InitRandomizeTemplate(SpawnTemplatePrefixTable)

 -

This method is rather complicated to understand.

-

SPAWN:InitRandomizeTemplatePrefixes(SpawnTemplatePrefixes)

 -

Randomize templates to be used as the unit representatives for the Spawned group, defined by specifying the prefix names.

-

SPAWN:InitRandomizeTemplateSet(SpawnTemplateSet)

 -

Randomize templates to be used as the unit representatives for the Spawned group, defined using a SET_GROUP object.

-

SPAWN:InitRandomizeUnits(RandomizeUnits, OuterRadius, InnerRadius)

 -

Randomizes the UNITs that are spawned within a radius band given an Outer and Inner radius.

-

SPAWN:InitRandomizeZones(SpawnZoneTable)

 -

This method provides the functionality to randomize the spawning of the Groups at a given list of zones of different types.

-

SPAWN:InitRepeat()

 -

For planes and helicopters, when these groups go home and land on their home airbases and FARPs, they normally would taxi to the parking spot, shut-down their engines and wait forever until the Group is removed by the runtime environment.

-

SPAWN:InitRepeatOnEngineShutDown()

 -

Respawn after landing when its engines have shut down.

-

SPAWN:InitRepeatOnLanding()

 -

Respawn group after landing.

-

SPAWN:InitSADL(Octal)

 -

[Airplane - A10-C II only] Set the SADL TN starting number of the Group; each unit of the spawned group will have a consecutive SADL set.

-

SPAWN:InitSTN(Octal)

 -

[Airplane - F15/16/18/AWACS/B1B/Tanker only] Set the STN Link16 starting number of the Group; each unit of the spawned group will have a consecutive STN set.

-

SPAWN:InitSetUnitAbsolutePositions(Positions)

 -

Spawn the UNITs of this group with individual absolute positions and individual headings.

-

SPAWN:InitSetUnitRelativePositions(Positions)

 -

Spawn the UNITs of this group with individual relative positions to unit #1 and individual headings.

-

SPAWN:InitSkill(Skill)

 -

Sets skill of the group.

-

SPAWN.InitSpeed

 - -

SPAWN:InitSpeedKnots(Knots)

 -

[Airplane] Set the initial speed on spawning in knots.

-

SPAWN:InitSpeedKph(KPH)

 -

[Airplane] Set the initial speed on spawning in kilometers per hour.

-

SPAWN:InitSpeedMps(MPS)

 -

[Airplane] Set the initial speed on spawning in meters per second.

-

SPAWN:InitUnControlled(UnControlled)

 -

(AIR) Will spawn a plane group in UnControlled or Controlled mode...

-

SPAWN.LateActivated

 - -

SPAWN.MaxAliveGroups

 - -

SPAWN.MaxAliveUnits

 - -

SPAWN:New(SpawnTemplatePrefix)

 -

Creates the main object to spawn a Wrapper.Group defined in the DCS ME.

-

SPAWN:NewFromTemplate(SpawnTemplate, SpawnTemplatePrefix, SpawnAliasPrefix, NoMooseNamingPostfix)

 -

Creates a new SPAWN instance to create new groups based on the provided template.

-

SPAWN:NewWithAlias(SpawnTemplatePrefix, SpawnAliasPrefix)

 -

Creates a new SPAWN instance to create new groups based on the defined template and using a new alias for each new group.

-

SPAWN:OnSpawnGroup(SpawnCallBackFunction, SpawnFunctionArguments, ...)

 -

Allows to place a CallFunction hook when a new group spawns.

-

SPAWN:ParkAircraft(SpawnAirbase, TerminalType, Parkingdata, SpawnIndex)

 -

Will park a group at an Wrapper.Airbase.

- -

SPAWN:ParkAtAirbase(SpawnAirbase, TerminalType, Parkingdata)

 -

Will park a group at an Wrapper.Airbase.

-

SPAWN:ReSpawn(SpawnIndex)

 -

Will re-spawn a group based on a given index.

-

SPAWN.Repeat

 - -

SPAWN.RepeatOnEngineShutDown

 - -

SPAWN.RepeatOnLanding

 - -

SPAWN:SetSpawnIndex(SpawnIndex)

 -

Set the spawn index to a specified index number.

-

SPAWN:Spawn()

 -

Will spawn a group based on the internal index.

-

SPAWN.SpawnAliasPrefix

 - -

SPAWN.SpawnAliasPrefixEscaped

 - -

SPAWN:SpawnAtAirbase(SpawnAirbase, Takeoff, TakeoffAltitude, TerminalType, EmergencyAirSpawn, Parkingdata)

 -

Will spawn a group at an Wrapper.Airbase.

-

SPAWN:SpawnAtParkingSpot(Airbase, Spots, Takeoff)

 -

Spawn a group on an Wrapper.Airbase at a specific parking spot.

-

SPAWN.SpawnCleanUpInterval

 - -

SPAWN.SpawnCleanUpTimeStamps

 - -

SPAWN.SpawnCount

 - -

SPAWN:SpawnFromCoordinate(Coordinate, SpawnIndex)

 -

Will spawn a group from a Coordinate in 3D space.

-

SPAWN.SpawnFromNewPosition

 - -

SPAWN:SpawnFromPointVec2(PointVec2, MinHeight, MaxHeight, SpawnIndex)

 -

Will spawn a group from a POINT_VEC2 in 3D space.

-

SPAWN:SpawnFromPointVec3(PointVec3, SpawnIndex)

 -

Will spawn a group from a PointVec3 in 3D space.

-

SPAWN:SpawnFromStatic(HostStatic, MinHeight, MaxHeight, SpawnIndex)

 -

Will spawn a group from a hosting static.

-

SPAWN:SpawnFromUnit(HostUnit, MinHeight, MaxHeight, SpawnIndex)

 -

Will spawn a group from a hosting unit.

-

SPAWN:SpawnFromVec2(Vec2, MinHeight, MaxHeight, SpawnIndex)

 -

Will spawn a group from a Vec2 in 3D space.

-

SPAWN:SpawnFromVec3(Vec3, SpawnIndex)

 -

Will spawn a group from a Vec3 in 3D space.

-

SPAWN.SpawnFunctionArguments

 - -

SPAWN.SpawnFunctionHook

 - -

SPAWN:SpawnGroupName(SpawnIndex)

 -

Will return the SpawnGroupName either with with a specific count number or without any count.

-

SPAWN.SpawnGrouping

 - -

SPAWN.SpawnGroups

 - -

SPAWN.SpawnHiddenOnMFD

 - -

SPAWN.SpawnHiddenOnMap

 - -

SPAWN.SpawnHiddenOnPlanner

 - -

SPAWN.SpawnHookScheduler

 - -

SPAWN:SpawnInZone(Zone, RandomizeGroup, MinHeight, MaxHeight, SpawnIndex)

 -

Will spawn a Group within a given Core.Zone.

-

SPAWN.SpawnIndex

 - -

SPAWN.SpawnInitAirbase

 - -

SPAWN.SpawnInitCallSign

 - -

SPAWN.SpawnInitCallSignID

 - -

SPAWN.SpawnInitCallSignMajor

 - -

SPAWN.SpawnInitCallSignMinor

 - -

SPAWN.SpawnInitCallSignName

 - -

SPAWN.SpawnInitCategory

 - -

SPAWN.SpawnInitCoalition

 - -

SPAWN.SpawnInitCountry

 - -

SPAWN.SpawnInitFreq

 - -

SPAWN.SpawnInitGroupHeadingMax

 - -

SPAWN.SpawnInitGroupHeadingMin

 - -

SPAWN.SpawnInitGroupUnitVar

 - -

SPAWN.SpawnInitHeadingMax

 - -

SPAWN.SpawnInitHeadingMin

 - -

SPAWN.SpawnInitKeepUnitNames

 - -

SPAWN.SpawnInitLimit

 - -

SPAWN.SpawnInitLivery

 - -

SPAWN.SpawnInitModex

 - -

SPAWN.SpawnInitModexPostfix

 - -

SPAWN.SpawnInitModexPrefix

 - -

SPAWN.SpawnInitModu

 - -

SPAWN.SpawnInitPosition

 - -

SPAWN.SpawnInitRadio

 - -

SPAWN.SpawnInitSADL

 - -

SPAWN.SpawnInitSTN

 - -

SPAWN.SpawnInitSkill

 - -

SPAWN.SpawnInitTakeoff

 - -

SPAWN.SpawnInitTerminalType

 - -

SPAWN.SpawnInnerRadius

 - -

SPAWN.SpawnIsScheduled

 - -

SPAWN.SpawnMaxGroups

 - -

SPAWN.SpawnMaxUnitsAlive

 - -

SPAWN.SpawnOuterRadius

 - -

SPAWN.SpawnRandomCallsign

 - -

SPAWN.SpawnRandomize

 - -

SPAWN.SpawnRandomizePosition

 - -

SPAWN.SpawnRandomizePositionInnerRadius

 - -

SPAWN.SpawnRandomizePositionOuterRadius

 - -

SPAWN.SpawnRandomizeRoute

 - -

SPAWN.SpawnRandomizeRouteEndPoint

 - -

SPAWN.SpawnRandomizeRouteHeight

 - -

SPAWN.SpawnRandomizeRouteRadius

 - -

SPAWN.SpawnRandomizeRouteStartPoint

 - -

SPAWN.SpawnRandomizeTemplate

 - -

SPAWN.SpawnRandomizeUnits

 - -

SPAWN.SpawnRandomizeZones

 - -

SPAWN:SpawnScheduleStart()

 -

Will re-start the spawning scheduler.

-

SPAWN:SpawnScheduleStop()

 -

Will stop the scheduled spawning scheduler.

-

SPAWN:SpawnScheduled(SpawnTime, SpawnTimeVariation, WithDelay)

 -

Spawns new groups at varying time intervals.

-

SPAWN.SpawnScheduler

 - -

SPAWN.SpawnTemplate

 - -

SPAWN.SpawnTemplatePrefix

 - -

SPAWN.SpawnTemplatePrefixEscaped

 - -

SPAWN.SpawnTemplatePrefixTable

 - -

SPAWN.SpawnUnControlled

 - -

SPAWN.SpawnUnitsWithAbsolutePositions

 - -

SPAWN.SpawnUnitsWithRelativePositions

 - -

SPAWN.SpawnVisible

 - -

SPAWN:SpawnWithIndex(SpawnIndex, NoBirth)

 -

Will spawn a group with a specified index number.

-

SPAWN.SpawnZoneTable

 - -

SPAWN:StopRepeat()

 -

Stop the SPAWN InitRepeat function (EVENT handler for takeoff, land and engine shutdown)

-

SPAWN.Takeoff

 - -

SPAWN.TweakedTemplate

 - -

SPAWN.UnControlled

 - -

SPAWN.UnitsAbsolutePositions

 - -

SPAWN.UnitsRelativePositions

 - -

SPAWN:_CountAliveUnits()

 - -

SPAWN:_GetGroupCategoryID(SpawnPrefix)

 -

Gets the CategoryID of the Group with the given SpawnPrefix

-

SPAWN:_GetGroupCoalitionID(SpawnPrefix)

 -

Gets the CoalitionID of the Group with the given SpawnPrefix

-

SPAWN:_GetGroupCountryID(SpawnPrefix)

 -

Gets the CountryID of the Group with the given SpawnPrefix

-

SPAWN:_GetLastIndex()

 -

Return the last maximum index that can be used.

-

SPAWN:_GetPrefixFromGroup(SpawnGroup)

 -

Return the prefix of a SpawnUnit.

-

SPAWN:_GetPrefixFromGroupName(SpawnGroupName)

 -

Return the prefix of a spawned group.

-

SPAWN:_GetSpawnIndex(SpawnIndex)

 -

Get the next index of the groups to be spawned.

-

SPAWN:_GetTemplate(SpawnTemplatePrefix)

 -

Gets the Group Template from the ME environment definition.

-

SPAWN:_InitializeSpawnGroups(SpawnIndex)

 -

Initalize the SpawnGroups collection.

-

SPAWN:_OnBirth(EventData)

 - -

SPAWN:_OnDeadOrCrash(EventData)

 - -

SPAWN:_OnEngineShutDown(EventData)

 -

Will detect AIR Units shutting down their engines ...

-

SPAWN:_OnLand(EventData)

 -

Will detect AIR Units landing...

-

SPAWN:_OnTakeOff(EventData)

 -

Will detect AIR Units taking off...

-

SPAWN:_Prepare(SpawnTemplatePrefix, SpawnIndex)

 -

Prepares the new Group Template.

-

SPAWN:_RandomizeRoute(SpawnIndex)

 -

Private method randomizing the routes.

-

SPAWN:_RandomizeTemplate(SpawnIndex)

 -

Private method that randomizes the template of the group.

-

SPAWN:_RandomizeZones(SpawnIndex)

 -

Private method that randomizes the Core.Zones where the Group will be spawned.

-

SPAWN:_Scheduler()

 -

This function is called automatically by the Spawning scheduler.

-

SPAWN:_SetInitialPosition(SpawnIndex)

 -

Private method that sets the DCS#Vec2 where the Group will be spawned.

-

SPAWN:_SpawnCleanUpScheduler()

 -

Schedules the CleanUp of Groups

-

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

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

SPAWN.ClassID

 -

The ID number of the class.

-

SPAWN.ClassName

 -

The name of the class.

-

SPAWN.ClassNameAndID

 -

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

-

SPAWN:ClearState(Object, StateName)

 -

Clear the state of an object.

-

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

 -

Creation of a Birth Event.

-

SPAWN:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

 -

Creation of a Crash Event.

-

SPAWN:CreateEventDead(EventTime, Initiator, IniObjectCategory)

 -

Creation of a Dead Event.

-

SPAWN:CreateEventDynamicCargoLoaded(DynamicCargo)

 -

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

-

SPAWN:CreateEventDynamicCargoRemoved(DynamicCargo)

 -

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

-

SPAWN:CreateEventDynamicCargoUnloaded(DynamicCargo)

 -

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

-

SPAWN:CreateEventNewDynamicCargo(DynamicCargo)

 -

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

-

SPAWN:CreateEventPlayerEnterAircraft(PlayerUnit)

 -

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

-

SPAWN:CreateEventRemoveUnit(EventTime, Initiator)

 -

Creation of a Remove Unit Event.

-

SPAWN:CreateEventTakeoff(EventTime, Initiator)

 -

Creation of a Takeoff Event.

-

SPAWN:CreateEventUnitLost(EventTime, Initiator)

 -

Creation of a Crash Event.

-

SPAWN:E(Arguments)

 -

Log an exception which will be traced always.

-

SPAWN:EventDispatcher()

 -

Returns the event dispatcher

-

SPAWN:EventRemoveAll()

 -

Remove all subscribed events

-

SPAWN:F(Arguments)

 -

Trace a function call.

-

SPAWN:F2(Arguments)

 -

Trace a function call level 2.

-

SPAWN:F3(Arguments)

 -

Trace a function call level 3.

-

SPAWN:GetClassID()

 -

Get the ClassID of the class instance.

-

SPAWN:GetClassName()

 -

Get the ClassName of the class instance.

-

SPAWN:GetClassNameAndID()

 -

Get the ClassName + ClassID of the class instance.

-

SPAWN:GetEventPriority()

 -

Get the Class Core.Event processing Priority.

-

SPAWN:GetParent(Child, FromClass)

 -

This is the worker method to retrieve the Parent class.

-

SPAWN:GetState(Object, Key)

 -

Get a Value given a Key from the Object.

-

SPAWN:HandleEvent(EventID, EventFunction)

 -

Subscribe to a DCS Event.

-

SPAWN:I(Arguments)

 -

Log an information which will be traced always.

-

SPAWN:Inherit(Child, Parent)

 -

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

-

SPAWN:IsInstanceOf(ClassName)

 -

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

-

SPAWN:IsTrace()

 -

Enquires if tracing is on (for the class).

-

SPAWN:New()

 -

BASE constructor.

-

SPAWN:OnEvent(EventData)

 -

Occurs when an Event for an object is triggered.

-

SPAWN:OnEventBDA(EventData)

 -

BDA.

-

SPAWN:OnEventBaseCaptured(EventData)

 -

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

-

SPAWN:OnEventBirth(EventData)

 -

Occurs when any object is spawned into the mission.

-

SPAWN:OnEventCrash(EventData)

 -

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

-

SPAWN:OnEventDead(EventData)

 -

Occurs when an object is dead.

-

SPAWN:OnEventDetailedFailure(EventData)

 -

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

-

SPAWN:OnEventDiscardChairAfterEjection(EventData)

 -

Discard chair after ejection.

-

SPAWN:OnEventDynamicCargoLoaded(EventData)

 -

Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.

-

SPAWN:OnEventDynamicCargoRemoved(EventData)

 -

Occurs when a dynamic cargo crate is removed.

-

SPAWN:OnEventDynamicCargoUnloaded(EventData)

 -

Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.

-

SPAWN:OnEventEjection(EventData)

 -

Occurs when a pilot ejects from an aircraft -Have a look at the class Core.Event#EVENT as these are just the prototypes.

-

SPAWN:OnEventEngineShutdown(EventData)

 -

Occurs when any aircraft shuts down its engines.

-

SPAWN:OnEventEngineStartup(EventData)

 -

Occurs when any aircraft starts its engines.

-

SPAWN:OnEventHit(EventData)

 -

Occurs whenever an object is hit by a weapon.

-

SPAWN:OnEventHumanFailure(EventData)

 -

Occurs when any system fails on a human controlled aircraft.

-

SPAWN:OnEventKill(EventData)

 -

Occurs on the death of a unit.

-

SPAWN:OnEventLand(EventData)

 -

Occurs when an aircraft lands at an airbase, farp or ship -Have a look at the class Core.Event#EVENT as these are just the prototypes.

-

SPAWN:OnEventLandingAfterEjection(EventData)

 -

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

-

SPAWN:OnEventLandingQualityMark(EventData)

 -

Landing quality mark.

-

SPAWN:OnEventMarkAdded(EventData)

 -

Occurs when a new mark was added.

-

SPAWN:OnEventMarkChange(EventData)

 -

Occurs when a mark text was changed.

-

SPAWN:OnEventMarkRemoved(EventData)

 -

Occurs when a mark was removed.

-

SPAWN:OnEventMissionEnd(EventData)

 -

Occurs when a mission ends -Have a look at the class Core.Event#EVENT as these are just the prototypes.

-

SPAWN:OnEventMissionStart(EventData)

 -

Occurs when a mission starts -Have a look at the class Core.Event#EVENT as these are just the prototypes.

-

SPAWN:OnEventNewDynamicCargo(EventData)

 -

Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.

-

SPAWN:OnEventParatrooperLanding(EventData)

 -

Weapon add.

-

SPAWN:OnEventPilotDead(EventData)

 -

Occurs when the pilot of an aircraft is killed.

-

SPAWN:OnEventPlayerEnterAircraft(EventData)

 -

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

-

SPAWN:OnEventPlayerEnterUnit(EventData)

 -

Occurs when any player assumes direct control of a unit.

-

SPAWN:OnEventPlayerLeaveUnit(EventData)

 -

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

-

SPAWN:OnEventRefueling(EventData)

 -

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

-

SPAWN:OnEventRefuelingStop(EventData)

 -

Occurs when an aircraft is finished taking fuel.

-

SPAWN:OnEventScore(EventData)

 -

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

-

SPAWN:OnEventShootingEnd(EventData)

 -

Occurs when any unit stops firing its weapon.

-

SPAWN:OnEventShootingStart(EventData)

 -

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

-

SPAWN:OnEventShot(EventData)

 -

Occurs whenever any unit in a mission fires a weapon.

-

SPAWN:OnEventTakeoff(EventData)

 -

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

-

SPAWN:OnEventTriggerZone(EventData)

 -

Trigger zone.

-

SPAWN:OnEventUnitLost(EventData)

 -

Occurs when the game thinks an object is destroyed.

-

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

 -

Schedule a new time event.

-

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

 -

Schedule a new time event.

-

SPAWN:ScheduleStop(SchedulerID)

 -

Stops the Schedule.

-

SPAWN.Scheduler

 -

The scheduler object.

-

SPAWN:SetEventPriority(EventPriority)

 -

Set the Class Core.Event processing Priority.

-

SPAWN:SetState(Object, Key, Value)

 -

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

-

SPAWN:T(Arguments)

 -

Trace a function logic level 1.

-

SPAWN:T2(Arguments)

 -

Trace a function logic level 2.

-

SPAWN:T3(Arguments)

 -

Trace a function logic level 3.

-

SPAWN:TraceAll(TraceAll)

 -

Trace all methods in MOOSE

-

SPAWN:TraceClass(Class)

 -

Set tracing for a class

-

SPAWN:TraceClassMethod(Class, Method)

 -

Set tracing for a specific method of class

-

SPAWN:TraceLevel(Level)

 -

Set trace level

-

SPAWN:TraceOff()

 -

Set trace off.

-

SPAWN:TraceOn()

 -

Set trace on.

-

SPAWN: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.

-

SPAWN:UnHandleEvent(EventID)

 -

UnSubscribe to a DCS event.

-

SPAWN._

 - -

SPAWN:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 -

Trace a function call.

-

SPAWN:_Serialize(Arguments)

 -

(Internal) Serialize arguments

-

SPAWN:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 -

Trace a function logic.

-

SPAWN.__

 - -

SPAWN:onEvent(event)

 -

The main event handling function...

-
-
- -

Type SPAWN.Takeoff

-
- SPAWN.Takeoff -
-
- - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from SPAWN.TakeoffDescription

SPAWN.Takeoff.Air

 -

Take off happens in air.

-

SPAWN.Takeoff.Cold

 -

Spawn at parking with engines off.

-

SPAWN.Takeoff.Hot

 -

Spawn at parking with engines on.

-

SPAWN.Takeoff.Runway

 -

Spawn on runway. Does not work in MP!

-
-
- -

Type Core.Spawn

-
-
-
- -
-

Type SPAWN

-
-
- -

SPAWN Class

- -
-

Field(s)

-
-
-
- - #boolean -SPAWN.AIOnOff - - - - -

The AI is on by default when spawning a group.

- -
- -
-
-
- - #number -SPAWN.AliveUnits - - - -
- -
-
-
- - -SPAWN.CleanUpScheduler - - - -
- -
-
-
- - #boolean -SPAWN.DelayOnOff - - - - -

No initial delay when spawning the first group.

- -
- -
-
-
- - -SPAWN.InitSpeed - - - -
- -
-
-
- - #number -SPAWN.MaxAliveGroups - - - -
- -
-
-
- - #number -SPAWN.MaxAliveUnits - - - -
- -
-
-
- - #boolean -SPAWN.Repeat - - - - -

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

- -
- -
-
-
- - #boolean -SPAWN.RepeatOnEngineShutDown - - - -
- -
-
-
- - #boolean -SPAWN.RepeatOnLanding - - - -
- -
-
-
- - #string -SPAWN.SpawnAliasPrefix - - - -
- -
-
-
- - -SPAWN.SpawnAliasPrefixEscaped - - - -
- -
-
-
- - -SPAWN.SpawnCleanUpInterval - - - -
- -
-
-
- - #table -SPAWN.SpawnCleanUpTimeStamps - - - -
- -
-
-
- - #number -SPAWN.SpawnCount - - - - -

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

- -
- -
-
-
- - #boolean -SPAWN.SpawnFromNewPosition - - - -
- -
-
-
- - #table -SPAWN.SpawnFunctionArguments - - - -
- -
-
-
- - -SPAWN.SpawnFunctionHook - - - -
- -
-
-
- - #table -SPAWN.SpawnGroups - - - - -

Array containing the descriptions of each Group to be Spawned.

- -
- -
-
-
- - #boolean -SPAWN.SpawnHiddenOnMFD - - - -
- -
-
-
- - #boolean -SPAWN.SpawnHiddenOnPlanner - - - -
- -
-
-
- - -SPAWN.SpawnHookScheduler - - - -
- -
-
-
- - #number -SPAWN.SpawnIndex - - - -
- -
-
-
- - #boolean -SPAWN.SpawnInitCallSign - - - -
- -
-
-
- - -SPAWN.SpawnInitCallSignName - - - -
- -
-
-
- - -SPAWN.SpawnInitCategory - - - -
- -
-
-
- - -SPAWN.SpawnInitCoalition - - - -
- -
-
-
- - -SPAWN.SpawnInitCountry - - - -
- -
-
-
- - -SPAWN.SpawnInitGroupHeadingMax - - - -
- -
-
-
- - -SPAWN.SpawnInitGroupHeadingMin - - - -
- -
-
-
- - -SPAWN.SpawnInitGroupUnitVar - - - -
- -
-
-
- - -SPAWN.SpawnInitHeadingMax - - - -
- -
-
-
- - -SPAWN.SpawnInitHeadingMin - - - -
- -
-
-
- - #boolean -SPAWN.SpawnInitKeepUnitNames - - - - -

Overwrite unit names by default with group name.

- -
- -
-
-
- - #boolean -SPAWN.SpawnInitLimit - - - -
- -
-
-
- - -SPAWN.SpawnInitPosition - - - - -

self:T2( { self.SpawnTemplatePrefix, Vec2} )

- -
- -
-
-
- - -SPAWN.SpawnInitSADL - - - - -

we arrived here seeing that self.SpawnInitSADL == nil, but now that we have a SADL (num), we also need to set it to self.SpawnInitSADL in case - we need to get the next SADL from _DATABASE, or else UTILS.OctalToDecimal() will fail in GetNextSADL

- -
- -
-
-
- - -SPAWN.SpawnInitTerminalType - - - -
- -
-
-
- - #boolean -SPAWN.SpawnIsScheduled - - - - -

Reflects if the spawning for this SpawnTemplatePrefix is going to be scheduled or not.

- -
- -
-
-
- - -SPAWN.SpawnMaxGroups - - - - -

The maximum amount of groups that can be spawned.

- -
- -
-
-
- - -SPAWN.SpawnMaxUnitsAlive - - - - -

The maximum amount of groups that can be alive of SpawnTemplatePrefix at the same time.

- -
- -
-
-
- - #boolean -SPAWN.SpawnRandomCallsign - - - -
- -
-
-
- - #boolean -SPAWN.SpawnRandomize - - - - -

Sets the randomization flag of new Spawned units to false.

- -
- -
-
-
- - #boolean -SPAWN.SpawnRandomizeRoute - - - -
- -
- - - - -
-
- - #boolean -SPAWN.SpawnRandomizeTemplate - - - -
- -
-
-
- - #boolean -SPAWN.SpawnRandomizeZones - - - -
- -
-
-
- - -SPAWN.SpawnScheduler - - - -
- -
-
-
- - -SPAWN.SpawnTemplate - - - - -

Contains the template structure for a Group Spawn from the Mission Editor. Note that this group must have lateActivation always on!!!

- -
- -
-
-
- - #string -SPAWN.SpawnTemplatePrefix - - - -
- -
- -
-
- - -SPAWN.SpawnTemplatePrefixTable - - - -
- -
-
-
- - #boolean -SPAWN.SpawnUnControlled - - - -
- -
-
-
- - #boolean -SPAWN.SpawnUnitsWithAbsolutePositions - - - -
- -
-
-
- - #boolean -SPAWN.SpawnUnitsWithRelativePositions - - - -
- -
-
-
- - #boolean -SPAWN.SpawnVisible - - - - -

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

- -
- -
- -
-
- - #SPAWN.Takeoff -SPAWN.Takeoff - - - -
- -
-
-
- - #boolean -SPAWN.TweakedTemplate - - - - -

Check if the user is using self made template.

- -
- -
-
-
- - #boolean -SPAWN.UnControlled - - - - -

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

- -
- -
-
-
- - -SPAWN.UnitsAbsolutePositions - - - -
- -
-
-
- - -SPAWN.UnitsRelativePositions - - - -
- -
-
-

Function(s)

-
-
- -
-

SPAWN:GetCoordinate()

-
- -

Get the Coordinate of the Group that is Late Activated as the template for the SPAWN object.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Return value:

-
-
-

Core.Point#COORDINATE:

-
-
- -

The Coordinate

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

SPAWN:GetFirstAliveGroup()

-
- -

Will find the first alive Wrapper.Group it has spawned, and return the alive Wrapper.Group object and the first Index where the first alive Wrapper.Group object has been found.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Return values:

-
-
-

Wrapper.Group#GROUP, #number:

-
-
- -

The Wrapper.Group object found, the new Index where the group was found.

- -
-
-

#nil, #nil:

-
-
- -

When no group is found, #nil is returned.

- -
-
-

Usage:

- 

-  -- Find the first alive @{Wrapper.Group} object of the SpawnPlanes SPAWN object @{Wrapper.Group} collection that it has spawned during the mission.
-  local GroupPlane, Index = SpawnPlanes:GetFirstAliveGroup()
-  while GroupPlane ~= nil do
-    -- Do actions with the GroupPlane object.
-    GroupPlane, Index = SpawnPlanes:GetNextAliveGroup( Index )
-  end
-
- -
- -
-
- -
- -
-

SPAWN:GetGroupFromIndex(SpawnIndex)

-
- -

Get the group from an index.

- - -

Returns the group from the SpawnGroups list. -If no index is given, it will return the first group in the list.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #number - SpawnIndex -

-
-
- -

The index of the group to return.

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

self

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

SPAWN:GetLastAliveGroup()

-
- -

Will find the last alive Wrapper.Group object, and will return a reference to the last live Wrapper.Group object and the last Index where the last alive Wrapper.Group object has been found.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Return values:

-
-
-

Wrapper.Group#GROUP, #number:

-
-
- -

The last alive Wrapper.Group object found, the last Index where the last alive Wrapper.Group object was found.

- -
-
-

#nil, #nil:

-
-
- -

When no alive Wrapper.Group object is found, #nil is returned.

- -
-
-

Usage:

- 

-  -- Find the last alive @{Wrapper.Group} object of the SpawnPlanes SPAWN object @{Wrapper.Group} collection that it has spawned during the mission.
-  local GroupPlane, Index = SpawnPlanes:GetLastAliveGroup()
-  if GroupPlane then -- GroupPlane can be nil!!!
-    -- Do actions with the GroupPlane object.
-  end
-
- -
- -
-
- -
- -
-

SPAWN:GetNextAliveGroup(SpawnIndexStart)

-
- -

Will find the next alive Wrapper.Group object from a given Index, and return a reference to the alive Wrapper.Group object and the next Index where the alive Wrapper.Group has been found.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #number - SpawnIndexStart -

-
-
- -

A Index holding the start position to search from. This method can also be used to find the first alive Wrapper.Group object from the given Index.

- -
-
-

Return values:

-
-
-

Wrapper.Group#GROUP, #number:

-
-
- -

The next alive Wrapper.Group object found, the next Index where the next alive Wrapper.Group object was found.

- -
-
-

#nil, #nil:

-
-
- -

When no alive Wrapper.Group object is found from the start Index position, #nil is returned.

- -
-
-

Usage:

- 

-  -- Find the first alive @{Wrapper.Group} object of the SpawnPlanes SPAWN object @{Wrapper.Group} collection that it has spawned during the mission.
-  local GroupPlane, Index = SpawnPlanes:GetFirstAliveGroup()
-  while GroupPlane ~= nil do
-    -- Do actions with the GroupPlane object.
-    GroupPlane, Index = SpawnPlanes:GetNextAliveGroup( Index )
-  end
-
- -
- -
-
- -
- -
-

SPAWN:GetSpawnIndexFromGroup(SpawnGroup)

-
- -

Get the index from a given group.

- - -

The function will search the name of the group for a #, and will return the number behind the #-mark.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- SpawnGroup -

-
-
-

-
-
-
- -
-
- -
- -
-

SPAWN:InitAIOff()

-
- -

Turns the AI Off for the Wrapper.Group when spawning.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

The SPAWN object

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

SPAWN:InitAIOn()

-
- -

Turns the AI On for the Wrapper.Group when spawning.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

The SPAWN object

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

SPAWN:InitAIOnOff(AIOnOff)

-
- -

Turns the AI On or Off for the Wrapper.Group when spawning.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #boolean - AIOnOff -

-
-
- -

A value of true sets the AI On, a value of false sets the AI Off.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

The SPAWN object

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

SPAWN:InitAirbase(AirbaseName, Takeoff, TerminalType)

-
- -

Set spawns to happen at a particular airbase.

- - -

Only for aircraft, of course.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- #string - AirbaseName -

-
-
- -

Name of the airbase.

- -
-
-
-
-

- #number - Takeoff -

-
-
- -

(Optional) Takeoff type. Can be SPAWN.Takeoff.Hot (default), SPAWN.Takeoff.Cold or SPAWN.Takeoff.Runway.

- -
-
-
-
-

- #number - TerminalType -

-
-
- -

(Optional) The terminal type.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:InitArray(SpawnAngle, SpawnWidth, SpawnDeltaX, SpawnDeltaY)

-
- -

Makes the groups visible before start (like a battalion).

- - -

The method will take the position of the group as the first position in the array. -CAUTION: this directive will NOT work with OnSpawnGroup function.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- #number - SpawnAngle -

-
-
- -

The angle in degrees how the groups and each unit of the group will be positioned.

- -
-
-
-
-

- #number - SpawnWidth -

-
-
- -

The amount of Groups that will be positioned on the X axis.

- -
-
-
-
-

- #number - SpawnDeltaX -

-
-
- -

The space between each Group on the X-axis.

- -
-
-
-
-

- #number - SpawnDeltaY -

-
-
- -

The space between each Group on the Y-axis.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 

-  -- Define an array of Groups.
-  Spawn_BE_Ground = SPAWN:New( 'BE Ground' )
-                         :InitLimit( 2, 24 )
-                         :InitArray( 90, 10, 100, 50 )
-
- -
- -
-
- -
- -
-

SPAWN:InitCallSign(ID, Name, Minor, Major)

-
- -

[BLUE AIR only!] This method sets a specific callsign for a spawned group.

- - -

Use for a group with one unit only!

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- #number - ID -

-
-
- -

ID of the callsign enumerator, e.g. CALLSIGN.Tanker.Texaco - - resulting in e.g. Texaco-2-1

- -
-
-
-
-

- #string - Name -

-
-
- -

Name of this callsign as it cannot be determined from the ID because of the dependency on the task type of the plane, and the plane type. E.g. "Texaco"

- -
-
-
-
-

- #number - Minor -

-
-
- -

Minor number, i.e. the unit number within the group, e.g 2 - resulting in e.g. Texaco-2-1

- -
-
-
-
-

- #number - Major -

-
-
- -

Major number, i.e. the group number of this name, e.g. 1 - resulting in e.g. Texaco-2-1

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:InitCategory(Category)

-
- -

Sets category ID of the group.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #number - Category -

-
-
- -

Category id.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:InitCleanUp(SpawnCleanUpInterval)

-
- -

Delete groups that have not moved for X seconds - AIR ONLY!!! -DO NOT USE ON GROUPS THAT DO NOT MOVE OR YOUR SERVER WILL BURN IN HELL (Pikes - April 2020) -When groups are still alive and have become inactive due to damage and are unable to contribute anything, then this group will be removed at defined intervals in seconds.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #string - SpawnCleanUpInterval -

-
-
- -

The interval to check for inactive groups within seconds.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 

-  Spawn_Helicopter:InitCleanUp( 20 )  -- CleanUp the spawning of the helicopters every 20 seconds when they become inactive.
-
- -
- -
-
- -
- -
-

SPAWN:InitCoalition(Coalition)

-
- -

Sets the coalition of the spawned group.

- - -

Note that it might be necessary to also set the country explicitly!

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- DCS#coalition.side - Coalition -

-
-
- -

Coalition of the group as number of enumerator:

- - - -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:InitCountry(Country)

-
- -

Sets the country of the spawn group.

- - -

Note that the country determines the coalition of the group depending on which country is defined to be on which side for each specific mission!

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #number - Country -

-
-
- -

Country id as number or enumerator:

- - - - -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:InitDelayOff()

-
- -

Turns the Delay Off for the Wrapper.Group when spawning.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

The SPAWN object

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

SPAWN:InitDelayOn()

-
- -

Turns the Delay On for the Wrapper.Group when spawning with #SpawnScheduled().

- - -

In effect then the 1st group will only be spawned -after the number of seconds given in SpawnScheduled as arguments, and not immediately.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

The SPAWN object

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

SPAWN:InitDelayOnOff(DelayOnOff)

-
- - - -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- DelayOnOff -

-
-
-

-
-
-
- -
-
- -
- -
-

SPAWN:InitGroupHeading(HeadingMin, HeadingMax, unitVar)

-
- -

Defines the heading of the overall formation of the new spawned group.

- - -

The heading can be given as one fixed degree, or can be randomized between minimum and maximum degrees. -The Group's formation as laid out in its template will be rotated around the first unit in the group -Group individual units facings will rotate to match. If InitHeading is also applied to this SPAWN then that will take precedence for individual unit facings. -Note that InitGroupHeading does not rotate the groups route; only its initial facing!

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- #number - HeadingMin -

-
-
- -

The minimum or fixed heading in degrees.

- -
-
-
-
-

- #number - HeadingMax -

-
-
- -

(optional) The maximum heading in degrees. This there is no maximum heading, then the heading for the group will be HeadingMin.

- -
-
-
-
-

- #number - unitVar -

-
-
- -

(optional) Individual units within the group will have their heading randomized by +/- unitVar degrees. Default is zero.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 

-mySpawner = SPAWN:New( ... )
-
-  -- Spawn the Group with the formation rotated +100 degrees around unit #1, compared to the mission template.
-  mySpawner:InitGroupHeading( 100 )
-
-  -- Spawn the Group with the formation rotated units between +100 and +150 degrees around unit #1, compared to the mission template, and with individual units varying by +/- 10 degrees from their templated facing.
-  mySpawner:InitGroupHeading( 100, 150, 10 )
-
-  -- Spawn the Group with the formation rotated -60 degrees around unit #1, compared to the mission template, but with all units facing due north regardless of how they were laid out in the template.
-  mySpawner:InitGroupHeading(-60):InitHeading(0)
-  -- or
-  mySpawner:InitHeading(0):InitGroupHeading(-60)
-
- -
- -
-
- -
- -
-

SPAWN:InitGrouping(Grouping)

-
- -

When spawning a new group, make the grouping of the units according the InitGrouping setting.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #number - Grouping -

-
-
- -

Indicates the maximum amount of units in the group.

- -
-
-

Return value:

-
-
-

#SPAWN:

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

SPAWN:InitHeading(HeadingMin, HeadingMax)

-
- -

Defines the Heading for the new spawned units.

- - -

The heading can be given as one fixed degree, or can be randomized between minimum and maximum degrees.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- #number - HeadingMin -

-
-
- -

The minimum or fixed heading in degrees.

- -
-
-
-
-

- #number - HeadingMax -

-
-
- -

(optional) The maximum heading in degrees. This there is no maximum heading, then the heading will be fixed for all units using minimum heading.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 

-  Spawn = SPAWN:New( ... )
-
-  -- Spawn the units pointing to 100 degrees.
-  Spawn:InitHeading( 100 )
-
-  -- Spawn the units pointing between 100 and 150 degrees.
-  Spawn:InitHeading( 100, 150 )
-
- -
- -
-
- -
- -
-

SPAWN:InitHiddenOnMFD()

-
- -

Hide the group on MFDs (visible to game master slots!).

- -
-
-

Defined in:

-
-

SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

The SPAWN object

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

SPAWN:InitHiddenOnMap(OnOff)

-
- -

Hide the group on the map view (visible to game master slots!).

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #boolean - OnOff -

-
-
- -

Defaults to true

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

The SPAWN object

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

SPAWN:InitHiddenOnPlanner()

-
- -

Hide the group on planner (visible to game master slots!).

- -
-
-

Defined in:

-
-

SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

The SPAWN object

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

SPAWN:InitKeepUnitNames(KeepUnitNames)

-
- -

Keeps the unit names as defined within the mission editor, -but note that anything after a # mark is ignored, -and any spaces before and after the resulting name are removed.

- - -

IMPORTANT! This method MUST be the first used after :New !!!

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #boolean - KeepUnitNames -

-
-
- -

(optional) If true, the unit names are kept, false or not provided create new unit names.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:InitLateActivated(LateActivated)

-
- -

Flags that the spawned groups must be spawned late activated.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #boolean - LateActivated -

-
-
- -

(optional) If true, the spawned groups are late activated.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:InitLimit(SpawnMaxUnitsAlive, SpawnMaxGroups)

-
- -

Stops any more repeat spawns from happening once the UNIT count of Alive units, spawned by the same SPAWN object, exceeds the first parameter.

- - -

Also can stop spawns from happening once a total GROUP still alive is met. -Exceptionally powerful when combined with SpawnSchedule for Respawning. -Note that this method is exceptionally important to balance the performance of the mission. Depending on the machine etc, a mission can only process a maximum amount of units. -If the time interval must be short, but there should not be more Units or Groups alive than a maximum amount of units, then this method should be used... -When a SPAWN.New is executed and the limit of the amount of units alive is reached, then no new spawn will happen of the group, until some of these units of the spawn object will be destroyed.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- #number - SpawnMaxUnitsAlive -

-
-
- -

The maximum amount of units that can be alive at runtime.

- -
-
-
-
-

- #number - SpawnMaxGroups -

-
-
- -

The maximum amount of groups that can be spawned. When the limit is reached, then no more actual spawns will happen of the group. -This parameter is useful to define a maximum amount of airplanes, ground troops, helicopters, ships etc within a supply area. -This parameter accepts the value 0, which defines that there are no maximum group limits, but there are limits on the maximum of units that can be alive at the same time.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 

-  -- NATO helicopters engaging in the battle field.
-  -- This helicopter group consists of one Unit. So, this group will SPAWN maximum 2 groups simultaneously within the DCSRTE.
-  -- There will be maximum 24 groups spawned during the whole mission lifetime. 
-  Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitLimit( 2, 24 )
-
- -
- -
-
- -
- -
-

SPAWN:InitLivery(Livery)

-
- -

Sets livery of the group.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #string - Livery -

-
-
- -

Livery name. Note that this is not necessarily the same name as displayed in the mission editor.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:InitModex(modex, prefix, postfix)

-
- -

Sets the modex of the first unit of the group.

- - -

If more units are in the group, the number is increased by one with every unit.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- #number - modex -

-
-
- -

Modex of the first unit.

- -
-
-
-
-

- #string - prefix -

-
-
- -

(optional) String to prefix to modex, e.g. for French AdA Modex, eg. -L-102 then "-L-" would be the prefix.

- -
-
-
-
-

- #string - postfix -

-
-
- -

(optional) String to postfix to modex, example tbd.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:InitPositionCoordinate(Coordinate)

-
- -

This method sets a spawn position for the group that is different from the location of the template.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- Core.Point#COORDINATE - Coordinate -

-
-
- -

The position to spawn from

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:InitPositionVec2(Vec2)

-
- -

This method sets a spawn position for the group that is different from the location of the template.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- DCS#Vec2 - Vec2 -

-
-
- -

The position to spawn from

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:InitRadioCommsOnOff(switch)

-
- -

Sets the radio communication on or off.

- - -

Same as checking/unchecking the COMM box in the mission editor.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #number - switch -

-
-
- -

If true (or nil), enables the radio communication. If false, disables the radio for the spawned group.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:InitRadioFrequency(frequency)

-
- -

Sets the radio frequency of the group.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #number - frequency -

-
-
- -

The frequency in MHz.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:InitRadioModulation(modulation)

-
- -

Set radio modulation.

- - -

Default is AM.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #string - modulation -

-
-
- -

Either "FM" or "AM". If no value is given, modulation is set to AM.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:InitRandomizeCallsign()

-
- -

[AIR/Fighter only!] This method randomizes the callsign for a new group.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:InitRandomizePosition(RandomizePosition, OuterRadius, InnerRadius)

-
- -

Randomizes the position of Wrapper.Groups that are spawned within a radius band, given an Outer and Inner radius, from the point that the spawn happens.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- #boolean - RandomizePosition -

-
-
- -

If true, SPAWN will perform the randomization of the Wrapper.Groups position between a given outer and inner radius.

- -
-
-
-
-

- DCS#Distance - OuterRadius -

-
-
- -

(optional) The outer radius in meters where the new group will be spawned.

- -
-
-
-
-

- DCS#Distance - InnerRadius -

-
-
- -

(optional) The inner radius in meters where the new group will NOT be spawned.

- -
-
-

Return value:

-
-
-

#SPAWN:

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

SPAWN:InitRandomizeRoute(SpawnStartPoint, SpawnEndPoint, SpawnRadius, SpawnHeight)

-
- -

Randomizes the defined route of the SpawnTemplatePrefix group in the ME.

- - -

This is very useful to define extra variation of the behavior of groups.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- #number - SpawnStartPoint -

-
-
- -

is the waypoint where the randomization begins. -Note that the StartPoint = 0 equaling the point where the group is spawned.

- -
-
-
-
-

- #number - SpawnEndPoint -

-
-
- -

is the waypoint where the randomization ends counting backwards. -This parameter is useful to avoid randomization to end at a waypoint earlier than the last waypoint on the route.

- -
-
-
-
-

- #number - SpawnRadius -

-
-
- -

is the radius in meters in which the randomization of the new waypoints, with the original waypoint of the original template located in the middle ...

- -
-
-
-
-

- #number - SpawnHeight -

-
-
- -

(optional) Specifies the additional height in meters that can be added to the base height specified at each waypoint in the ME.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- - - -
-
-

Usage:

- 

-  -- NATO helicopters engaging in the battle field.
-  -- The KA-50 has waypoints Start point ( =0 or SP ), 1, 2, 3, 4, End point (= 5 or DP).
-  -- Waypoints 2 and 3 will only be randomized. The others will remain on their original position with each new spawn of the helicopter.
-  -- The randomization of waypoint 2 and 3 will take place within a radius of 2000 meters.
-  Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitRandomizeRoute( 2, 2, 2000 )
-
- -
- -
-
- -
- -
-

SPAWN:InitRandomizeTemplate(SpawnTemplatePrefixTable)

-
- -

This method is rather complicated to understand.

- - -

But I'll try to explain. -This method becomes useful when you need to spawn groups with random templates of groups defined within the mission editor, -but they will all follow the same Template route and have the same prefix name. -In other words, this method randomizes between a defined set of groups the template to be used for each new spawn of a group.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #list<#string> - SpawnTemplatePrefixTable -

-
-
- -

A table with the names of the groups defined within the mission editor, from which one will be chosen when a new group will be spawned.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- - - -
-
-

Usage:

- 

-  -- NATO Tank Platoons invading Gori.
-  -- Choose between 13 different 'US Tank Platoon' configurations for each new SPAWN the Group to be spawned for the
-  -- 'US Tank Platoon Left', 'US Tank Platoon Middle' and 'US Tank Platoon Right' SpawnTemplatePrefixes.
-  -- Each new SPAWN will randomize the route, with a defined time interval of 200 seconds with 40% time variation (randomization) and
-  -- with a limit set of maximum 12 Units alive simultaneously  and 150 Groups to be spawned during the whole mission.
-  Spawn_US_Platoon = { 'US Tank Platoon 1', 'US Tank Platoon 2', 'US Tank Platoon 3', 'US Tank Platoon 4', 'US Tank Platoon 5',
-                       'US Tank Platoon 6', 'US Tank Platoon 7', 'US Tank Platoon 8', 'US Tank Platoon 9', 'US Tank Platoon 10',
-                       'US Tank Platoon 11', 'US Tank Platoon 12', 'US Tank Platoon 13' }
-  Spawn_US_Platoon_Left = SPAWN:New( 'US Tank Platoon Left' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplate( Spawn_US_Platoon ):InitRandomizeRoute( 3, 3, 2000 )
-  Spawn_US_Platoon_Middle = SPAWN:New( 'US Tank Platoon Middle' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplate( Spawn_US_Platoon ):InitRandomizeRoute( 3, 3, 2000 )
-  Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplate( Spawn_US_Platoon ):InitRandomizeRoute( 3, 3, 2000 )
- -
- -
-
- -
- -
-

SPAWN:InitRandomizeTemplatePrefixes(SpawnTemplatePrefixes)

-
- -

Randomize templates to be used as the unit representatives for the Spawned group, defined by specifying the prefix names.

- - -

This method becomes useful when you need to spawn groups with random templates of groups defined within the mission editor, -but they will all follow the same Template route and have the same prefix name. -In other words, this method randomizes between a defined set of groups the template to be used for each new spawn of a group.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #string - SpawnTemplatePrefixes -

-
-
- -

A string or a list of string that contains the prefixes of the groups that are possible unit representatives of the group to be spawned.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- - - -
-
-

Usage:

- 

- -- NATO Tank Platoons invading Gori.
-
-  -- Choose between different 'US Tank Platoon Templates' configurations to be spawned for the
-  -- 'US Tank Platoon Left', 'US Tank Platoon Middle' and 'US Tank Platoon Right' SPAWN objects.
-
-  -- Each new SPAWN will randomize the route, with a defined time interval of 200 seconds with 40% time variation (randomization) and
-  -- with a limit set of maximum 12 Units alive simultaneously  and 150 Groups to be spawned during the whole mission.
-
-  Spawn_US_Platoon_Left = SPAWN:New( 'US Tank Platoon Left' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplatePrefixes( "US Tank Platoon Templates" ):InitRandomizeRoute( 3, 3, 2000 )
-  Spawn_US_Platoon_Middle = SPAWN:New( 'US Tank Platoon Middle' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplatePrefixes( "US Tank Platoon Templates" ):InitRandomizeRoute( 3, 3, 2000 )
-  Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplatePrefixes( "US Tank Platoon Templates" ):InitRandomizeRoute( 3, 3, 2000 )
-
- -
- -
-
- -
- -
-

SPAWN:InitRandomizeTemplateSet(SpawnTemplateSet)

-
- -

Randomize templates to be used as the unit representatives for the Spawned group, defined using a SET_GROUP object.

- - -

This method becomes useful when you need to spawn groups with random templates of groups defined within the mission editor, -but they will all follow the same Template route and have the same prefix name. -In other words, this method randomizes between a defined set of groups the template to be used for each new spawn of a group.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- Core.Set#SET_GROUP - SpawnTemplateSet -

-
-
- -

A SET_GROUP object set, that contains the groups that are possible unit representatives of the group to be spawned.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- - - -
-
-

Usage:

- 

-  -- NATO Tank Platoons invading Gori.
-
-  -- Choose between different 'US Tank Platoon Template' configurations to be spawned for the
-  -- 'US Tank Platoon Left', 'US Tank Platoon Middle' and 'US Tank Platoon Right' SPAWN objects.
-
-  -- Each new SPAWN will randomize the route, with a defined time interval of 200 seconds with 40% time variation (randomization) and
-  -- with a limit set of maximum 12 Units alive simultaneously  and 150 Groups to be spawned during the whole mission.
-
-  Spawn_US_PlatoonSet = SET_GROUP:New():FilterPrefixes( "US Tank Platoon Templates" ):FilterOnce()
-
-  -- Now use the Spawn_US_PlatoonSet to define the templates using InitRandomizeTemplateSet.
-  Spawn_US_Platoon_Left = SPAWN:New( 'US Tank Platoon Left' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 )
-  Spawn_US_Platoon_Middle = SPAWN:New( 'US Tank Platoon Middle' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 )
-  Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 )
-
- -
- -
-
- -
- -
-

SPAWN:InitRandomizeUnits(RandomizeUnits, OuterRadius, InnerRadius)

-
- -

Randomizes the UNITs that are spawned within a radius band given an Outer and Inner radius.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- #boolean - RandomizeUnits -

-
-
- -

If true, SPAWN will perform the randomization of the Wrapper.Unit#UNITs position within the group between a given outer and inner radius.

- -
-
-
-
-

- DCS#Distance - OuterRadius -

-
-
- -

(optional) The outer radius in meters where the new group will be spawned.

- -
-
-
-
-

- DCS#Distance - InnerRadius -

-
-
- -

(optional) The inner radius in meters where the new group will NOT be spawned.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- - - -
-
-

Usage:

- 

-  -- NATO helicopters engaging in the battle field.
-  -- UNIT positions of this group will be randomized around the base unit #1 in a circle of 50 to 500 meters.
-  Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitRandomizeUnits( true, 500, 50 )
-
- -
- -
-
- -
- -
-

SPAWN:InitRandomizeZones(SpawnZoneTable)

-
- -

This method provides the functionality to randomize the spawning of the Groups at a given list of zones of different types.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #table - SpawnZoneTable -

-
-
- -

A table with Core.Zone objects. If this table is given, then each spawn will be executed within the given list of Core.Zones objects.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 

-   -- Create a zone table of the 2 zones.
-   ZoneTable = { ZONE:New( "Zone1" ), ZONE:New( "Zone2" ) }
-
-   Spawn_Vehicle_1 = SPAWN:New( "Spawn Vehicle 1" )
-                          :InitLimit( 10, 10 )
-                          :InitRandomizeRoute( 1, 1, 200 )
-                          :InitRandomizeZones( ZoneTable )
-                          :SpawnScheduled( 5, .5 )
-
- -
- -
-
- -
- -
-

SPAWN:InitRepeat()

-
- -

For planes and helicopters, when these groups go home and land on their home airbases and FARPs, they normally would taxi to the parking spot, shut-down their engines and wait forever until the Group is removed by the runtime environment.

- - -

This method is used to re-spawn automatically (so no extra call is needed anymore) the same group after it has landed. -This will enable a spawned group to be re-spawned after it lands, until it is destroyed... -Note: When the group is respawned, it will re-spawn from the original airbase where it took off. -So ensure that the routes for groups that respawn, always return to the original airbase, or players may get confused ...

- -
-
-

Defined in:

-
-

SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 

-  -- RU Su-34 - AI Ship Attack
-  -- Re-SPAWN the Group(s) after each landing and Engine Shut-Down automatically.
-  SpawnRU_SU34 = SPAWN:New( 'Su-34' )
-                      :Schedule( 2, 3, 1800, 0.4 )
-                      :SpawnUncontrolled()
-                      :InitRandomizeRoute( 1, 1, 3000 )
-                      :InitRepeatOnEngineShutDown()
-
- -
- -
-
- -
- -
-

SPAWN:InitRepeatOnEngineShutDown()

-
- -

Respawn after landing when its engines have shut down.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 

-  -- RU Su-34 - AI Ship Attack
-  -- Re-SPAWN the Group(s) after each landing and Engine Shut-Down automatically.
-  SpawnRU_SU34 = SPAWN:New( 'Su-34' )
-                      :SpawnUncontrolled()
-                      :InitRandomizeRoute( 1, 1, 3000 )
-                      :InitRepeatOnEngineShutDown()
-                      :Spawn()
- -
- -
-
- -
- -
-

SPAWN:InitRepeatOnLanding()

-
- -

Respawn group after landing.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 

-  -- RU Su-34 - AI Ship Attack
-  -- Re-SPAWN the Group(s) after each landing and Engine Shut-Down automatically.
-  SpawnRU_SU34 = SPAWN:New( 'Su-34' )
-                      :InitRandomizeRoute( 1, 1, 3000 )
-                      :InitRepeatOnLanding()
-                      :Spawn()
-
- -
- -
-
- -
- -
-

SPAWN:InitSADL(Octal)

-
- -

[Airplane - A10-C II only] Set the SADL TN starting number of the Group; each unit of the spawned group will have a consecutive SADL set.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #number - Octal -

-
-
- -

The octal number (digits 1..7, max 4 digits, i.e. 1..7777) to set the SADL to. Every SADL needs to be unique!

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:InitSTN(Octal)

-
- -

[Airplane - F15/16/18/AWACS/B1B/Tanker only] Set the STN Link16 starting number of the Group; each unit of the spawned group will have a consecutive STN set.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #number - Octal -

-
-
- -

The octal number (digits 1..7, max 5 digits, i.e. 1..77777) to set the STN to. Every STN needs to be unique!

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:InitSetUnitAbsolutePositions(Positions)

-
- -

Spawn the UNITs of this group with individual absolute positions and individual headings.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #table - Positions -

-
-
- -

Table of positions, needs to one entry per unit in the group(!). The table contains one table each for each unit, with x,y, and optionally z -absolute positions, and optionally an individual heading.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- - - -
-
-

Usage:

- 

-  -- NATO helicopter group of three units engaging in the battle field.
-  local Positions = { [1] = {x = 0, y = 0, heading = 0}, [2] = {x = 50, y = 50, heading = 90}, [3] = {x = -50, y = 50, heading = 180} }
-  Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitSetUnitAbsolutePositions(Positions)
-
- -
- -
-
- -
- -
-

SPAWN:InitSetUnitRelativePositions(Positions)

-
- -

Spawn the UNITs of this group with individual relative positions to unit #1 and individual headings.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #table - Positions -

-
-
- -

Table of positions, needs to one entry per unit in the group(!). The table contains one table each for each unit, with x,y, and optionally z -relative positions, and optionally an individual heading.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- - - -
-
-

Usage:

- 

-  -- NATO helicopter group of three units engaging in the battle field.
-  local Positions = { [1] = {x = 0, y = 0, heading = 0}, [2] = {x = 50, y = 50, heading = 90}, [3] = {x = -50, y = 50, heading = 180} }
-  Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitSetUnitRelativePositions(Positions)
-
- -
- -
-
- -
- -
-

SPAWN:InitSkill(Skill)

-
- -

Sets skill of the group.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #string - Skill -

-
-
- -

Skill, possible values "Average", "Good", "High", "Excellent" or "Random".

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:InitSpeedKnots(Knots)

-
- -

[Airplane] Set the initial speed on spawning in knots.

- - -

Useful when spawning in-air only.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #number - Knots -

-
-
- -

The speed in knots to use.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:InitSpeedKph(KPH)

-
- -

[Airplane] Set the initial speed on spawning in kilometers per hour.

- - -

Useful when spawning in-air only.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #number - KPH -

-
-
- -

The speed in KPH to use.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:InitSpeedMps(MPS)

-
- -

[Airplane] Set the initial speed on spawning in meters per second.

- - -

Useful when spawning in-air only.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #number - MPS -

-
-
- -

The speed in MPS to use.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:InitUnControlled(UnControlled)

-
- -

(AIR) Will spawn a plane group in UnControlled or Controlled mode...

- - -

This will be similar to the uncontrolled flag setting in the ME. -You can use UnControlled mode to simulate planes startup and ready for take-off but aren't moving (yet). -ReSpawn the plane in Controlled mode, and the plane will move...

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #boolean - UnControlled -

-
-
- -

true if UnControlled, false if Controlled.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:New(SpawnTemplatePrefix)

-
- -

Creates the main object to spawn a Wrapper.Group defined in the DCS ME.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #string - SpawnTemplatePrefix -

-
-
- -

is the name of the Group in the ME that defines the Template. Each new group will have the name starting with SpawnTemplatePrefix.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- - - -
-
-

Usages:

-
    - 
  • -- NATO helicopters engaging in the battle field.
-Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' )
    • - 
  • local Plane = SPAWN:New( "Plane" ) -- Creates a new local variable that can initiate new planes with the name "Plane#ddd" using the template "Plane" as defined within the ME.
    • -
- -
- -
-
- -
- -
-

SPAWN:NewFromTemplate(SpawnTemplate, SpawnTemplatePrefix, SpawnAliasPrefix, NoMooseNamingPostfix)

-
- -

Creates a new SPAWN instance to create new groups based on the provided template.

- - -

This will also register the template for future use.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- #table - SpawnTemplate -

-
-
- -

is the Template of the Group. This must be a valid Group Template structure - see Hoggit Wiki!

- -
-
-
-
-

- #string - SpawnTemplatePrefix -

-
-
- -

[Mandatory] is the name of the template and the prefix of the GROUP on spawn. The name in the template will be overwritten!

- -
-
-
-
-

- #string - SpawnAliasPrefix -

-
-
- -

[Optional] is the prefix that will be given to the GROUP on spawn.

- -
-
-
-
-

- #boolean - NoMooseNamingPostfix -

-
-
- -

[Optional] If true, skip the Moose naming additions (like groupname#001-01) - but you need to ensure yourself no duplicate group names exist!

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 
-- Spawn a P51 Mustang from scratch
-local ttemp =  
-  {
-      ["modulation"] = 0,
-      ["tasks"] = 
-      {
-      }, -- end of ["tasks"]
-      ["task"] = "Reconnaissance",
-      ["uncontrolled"] = false,
-      ["route"] = 
-      {
-          ["points"] = 
-          {
-              [1] = 
-              {
-                  ["alt"] = 2000,
-                  ["action"] = "Turning Point",
-                  ["alt_type"] = "BARO",
-                  ["speed"] = 125,
-                  ["task"] = 
-                  {
-                      ["id"] = "ComboTask",
-                      ["params"] = 
-                      {
-                          ["tasks"] = 
-                          {
-                          }, -- end of ["tasks"]
-                      }, -- end of ["params"]
-                  }, -- end of ["task"]
-                  ["type"] = "Turning Point",
-                  ["ETA"] = 0,
-                  ["ETA_locked"] = true,
-                  ["y"] = 666285.71428571,
-                  ["x"] = -312000,
-                  ["formation_template"] = "",
-                  ["speed_locked"] = true,
-              }, -- end of [1]
-          }, -- end of ["points"]
-      }, -- end of ["route"]
-      ["groupId"] = 1,
-      ["hidden"] = false,
-      ["units"] = 
-      {
-          [1] = 
-          {
-              ["alt"] = 2000,
-              ["alt_type"] = "BARO",
-              ["livery_id"] = "USAF 364th FS",
-              ["skill"] = "High",
-              ["speed"] = 125,
-              ["type"] = "TF-51D",
-              ["unitId"] = 1,
-              ["psi"] = 0,
-              ["y"] = 666285.71428571,
-              ["x"] = -312000,
-              ["name"] = "P51-1-1",
-              ["payload"] = 
-              {
-                  ["pylons"] = 
-                  {
-                  }, -- end of ["pylons"]
-                  ["fuel"] = 340.68,
-                  ["flare"] = 0,
-                  ["chaff"] = 0,
-                  ["gun"] = 100,
-              }, -- end of ["payload"]
-              ["heading"] = 0,
-              ["callsign"] = 
-              {
-                  [1] = 1,
-                  [2] = 1,
-                  ["name"] = "Enfield11",
-                  [3] = 1,
-              }, -- end of ["callsign"]
-              ["onboard_num"] = "010",
-          }, -- end of [1]
-      }, -- end of ["units"]
-      ["y"] = 666285.71428571,
-      ["x"] = -312000,
-      ["name"] = "P51",
-      ["communication"] = true,
-      ["start_time"] = 0,
-      ["frequency"] = 124,
-  } 
-
-
-local mustang = SPAWN:NewFromTemplate(ttemp,"P51D")
--- you MUST set the next three:
-mustang:InitCountry(country.id.FRANCE)
-mustang:InitCategory(Group.Category.AIRPLANE)
-mustang:InitCoalition(coalition.side.BLUE)
-mustang:OnSpawnGroup(
-  function(grp)
-    MESSAGE:New("Group Spawned: "..grp:GetName(),15,"SPAWN"):ToAll()
-  end
-)
-mustang:Spawn()
-
- -
- -
-
- -
- -
-

SPAWN:NewWithAlias(SpawnTemplatePrefix, SpawnAliasPrefix)

-
- -

Creates a new SPAWN instance to create new groups based on the defined template and using a new alias for each new group.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- #string - SpawnTemplatePrefix -

-
-
- -

is the name of the Group in the ME that defines the Template.

- -
-
-
-
-

- #string - SpawnAliasPrefix -

-
-
- -

is the name that will be given to the Group at runtime.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usages:

-
    - 
  • -- NATO helicopters engaging in the battle field.
-Spawn_BE_KA50 = SPAWN:NewWithAlias( 'BE KA-50@RAMP-Ground Defense', 'Helicopter Attacking a City' )
    • - 
  • local PlaneWithAlias = SPAWN:NewWithAlias( "Plane", "Bomber" ) -- Creates a new local variable that can instantiate new planes with the name "Bomber#ddd" using the template "Plane" as defined within the ME.
    • -
- -
- -
-
- -
- -
-

SPAWN:OnSpawnGroup(SpawnCallBackFunction, SpawnFunctionArguments, ...)

-
- -

Allows to place a CallFunction hook when a new group spawns.

- - -

The provided method will be called when a new group is spawned, including its given parameters. -The first parameter of the SpawnFunction is the Wrapper.Group#GROUP that was spawned.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- #function - SpawnCallBackFunction -

-
-
- -

The function to be called when a group spawns.

- -
-
-
-
-

- SpawnFunctionArguments -

-
-
- -

A random amount of arguments to be provided to the function when the group spawns.

- -
-
-
-
-

- ... -

-
-
-

-
-
-

Return value:

-
-
-

#SPAWN:

-
-
- - - -
-
-

Usage:

- 

-   -- Declare SpawnObject and call a function when a new Group is spawned.
-   local SpawnObject = SPAWN:New( "SpawnObject" )
-                            :InitLimit( 2, 10 )
-                            :OnSpawnGroup( function( SpawnGroup )
-                                SpawnGroup:E( "I am spawned" )
-                                end
-                              )
-                            :SpawnScheduled( 300, 0.3 )
-
- -
- -
-
- -
- -
-

SPAWN:ParkAircraft(SpawnAirbase, TerminalType, Parkingdata, SpawnIndex)

-
- -

Will park a group at an Wrapper.Airbase.

- - -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- Wrapper.Airbase#AIRBASE - SpawnAirbase -

-
-
- -

The Wrapper.Airbase where to spawn the group.

- -
-
-
-
-

- Wrapper.Airbase#AIRBASE.TerminalType - TerminalType -

-
-
- -

(optional) The terminal type the aircraft should be spawned at. See Wrapper.Airbase#AIRBASE.TerminalType.

- -
-
-
-
-

- #table - Parkingdata -

-
-
- -

(optional) Table holding the coordinates and terminal ids for all units of the group. Spawning will be forced to happen at exactily these spots!

- -
-
-
-
-

- SpawnIndex -

-
-
-

-
-
-

Return value:

-
-
-

#nil:

-
-
- -

Nothing is returned!

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

SPAWN:ParkAtAirbase(SpawnAirbase, TerminalType, Parkingdata)

-
- -

Will park a group at an Wrapper.Airbase.

- - -

This method is mostly advisable to be used if you want to simulate parking units at an airbase and be visible. -Note that each point in the route assigned to the spawning group is reset to the point of the spawn.

- -

All groups that are in the spawn collection and that are alive, and not in the air, are parked.

- -

The Wrapper.Airbase#AIRBASE object must refer to a valid airbase known in the sim. -You can use the following enumerations to search for the pre-defined airbases on the current known maps of DCS:

- - - -

Use the method Wrapper.Airbase#AIRBASE.FindByName() to retrieve the airbase object. -The known AIRBASE objects are automatically imported at mission start by MOOSE. -Therefore, there isn't any New() constructor defined for AIRBASE objects.

- -

Ships and FARPs are added within the mission, and are therefore not known. -For these AIRBASE objects, there isn't an Wrapper.Airbase#AIRBASE enumeration defined. -You need to provide the exact name of the airbase as the parameter to the Wrapper.Airbase#AIRBASE.FindByName() method!

- - -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- Wrapper.Airbase#AIRBASE - SpawnAirbase -

-
-
- -

The Wrapper.Airbase where to spawn the group.

- -
-
-
-
-

- Wrapper.Airbase#AIRBASE.TerminalType - TerminalType -

-
-
- -

(optional) The terminal type the aircraft should be spawned at. See Wrapper.Airbase#AIRBASE.TerminalType.

- -
-
-
-
-

- #table - Parkingdata -

-
-
- -

(optional) Table holding the coordinates and terminal ids for all units of the group. Spawning will be forced to happen at exactily these spots!

- -
-
-

Return value:

-
-
-

#nil:

-
-
- -

Nothing is returned!

- -
-
-

Usage:

- 
  Spawn_Plane = SPAWN:New( "Plane" )
-  Spawn_Plane:ParkAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ) )
-
-  Spawn_Heli = SPAWN:New( "Heli")
-
-  Spawn_Heli:ParkAtAirbase( AIRBASE:FindByName( "FARP Cold" ) )
-
-  Spawn_Heli:ParkAtAirbase( AIRBASE:FindByName( "Carrier" ) )
-
-  Spawn_Plane:ParkAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), AIRBASE.TerminalType.OpenBig )
-
- -
- -
-
- -
- -
-

SPAWN:ReSpawn(SpawnIndex)

-
- -

Will re-spawn a group based on a given index.

- - -

Note: This method uses the global _DATABASE object (an instance of Core.Database#DATABASE), which contains ALL initial and new spawned objects in MOOSE.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #string - SpawnIndex -

-
-
- -

The index of the group to be spawned.

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

The group that was spawned. You can use this group for further actions.

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

SPAWN:SetSpawnIndex(SpawnIndex)

-
- -

Set the spawn index to a specified index number.

- - -

This method can be used to "reset" the spawn counter to a specific index number. -This will actually enable a respawn of groups from the specific index.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #string - SpawnIndex -

-
-
- -

The index of the group from where the spawning will start again. The default value would be 0, which means a complete reset of the spawnindex.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:Spawn()

-
- -

Will spawn a group based on the internal index.

- - -

Note: This method uses the global _DATABASE object (an instance of Core.Database#DATABASE), which contains ALL initial and new spawned objects in MOOSE.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

The group that was spawned. You can use this group for further actions.

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

SPAWN:SpawnAtAirbase(SpawnAirbase, Takeoff, TakeoffAltitude, TerminalType, EmergencyAirSpawn, Parkingdata)

-
- -

Will spawn a group at an Wrapper.Airbase.

- - -

This method is mostly advisable to be used if you want to simulate spawning units at an airbase. -Note that each point in the route assigned to the spawning group is reset to the point of the spawn. -You can use the returned group to further define the route to be followed.

- -

The Wrapper.Airbase#AIRBASE object must refer to a valid airbase known in the sim. -You can use the following enumerations to search for the pre-defined airbases on the current known maps of DCS:

- - - -

Use the method Wrapper.Airbase#AIRBASE.FindByName() to retrieve the airbase object. -The known AIRBASE objects are automatically imported at mission start by MOOSE. -Therefore, there isn't any New() constructor defined for AIRBASE objects.

- -

Ships and FARPs are added within the mission, and are therefore not known. -For these AIRBASE objects, there isn't an Wrapper.Airbase#AIRBASE enumeration defined. -You need to provide the exact name of the airbase as the parameter to the Wrapper.Airbase#AIRBASE.FindByName() method!

- - -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- Wrapper.Airbase#AIRBASE - SpawnAirbase -

-
-
- -

The Wrapper.Airbase where to spawn the group.

- -
-
-
-
-

- #SPAWN.Takeoff - Takeoff -

-
-
- -

(optional) The location and takeoff method. Default is Hot.

- -
-
-
-
-

- #number - TakeoffAltitude -

-
-
- -

(optional) The altitude above the ground.

- -
-
-
-
-

- Wrapper.Airbase#AIRBASE.TerminalType - TerminalType -

-
-
- -

(optional) The terminal type the aircraft should be spawned at. See Wrapper.Airbase#AIRBASE.TerminalType.

- -
-
-
-
-

- #boolean - EmergencyAirSpawn -

-
-
- -

(optional) If true (default), groups are spawned in air if there is no parking spot at the airbase. If false, nothing is spawned if no parking spot is available.

- -
-
-
-
-

- #table - Parkingdata -

-
-
- -

(optional) Table holding the coordinates and terminal ids for all units of the group. Spawning will be forced to happen at exactly these spots!

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

The group that was spawned or nil when nothing was spawned.

- -
-
-

Usage:

- 

-  Spawn_Plane = SPAWN:New( "Plane" )
-  Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), SPAWN.Takeoff.Cold )
-  Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), SPAWN.Takeoff.Hot )
-  Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), SPAWN.Takeoff.Runway )
-
-  Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( "Carrier" ), SPAWN.Takeoff.Cold )
-
-  Spawn_Heli = SPAWN:New( "Heli")
-
-  Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "FARP Cold" ), SPAWN.Takeoff.Cold )
-  Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "FARP Hot" ), SPAWN.Takeoff.Hot )
-  Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "FARP Runway" ), SPAWN.Takeoff.Runway )
-  Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "FARP Air" ), SPAWN.Takeoff.Air )
-
-  Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "Carrier" ), SPAWN.Takeoff.Cold )
-
-  Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), SPAWN.Takeoff.Cold, nil, AIRBASE.TerminalType.OpenBig )
-
- -
- -
-
- -
- -
-

SPAWN:SpawnAtParkingSpot(Airbase, Spots, Takeoff)

-
- -

Spawn a group on an Wrapper.Airbase at a specific parking spot.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- Wrapper.Airbase#AIRBASE - Airbase -

-
-
- -

The Wrapper.Airbase where to spawn the group.

- -
-
-
-
-

- #table - Spots -

-
-
- -

Table of parking spot IDs. Note that these in general are different from the numbering in the mission editor!

- -
-
-
-
-

- #SPAWN.Takeoff - Takeoff -

-
-
- -

(Optional) Takeoff type, i.e. either SPAWN.Takeoff.Cold or SPAWN.Takeoff.Hot. Default is Hot.

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

The group that was spawned or nil when nothing was spawned.

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

SPAWN:SpawnFromCoordinate(Coordinate, SpawnIndex)

-
- -

Will spawn a group from a Coordinate in 3D space.

- - -

This method is mostly advisable to be used if you want to simulate spawning units in the air, like helicopters or airplanes. -Note that each point in the route assigned to the spawning group is reset to the point of the spawn. -You can use the returned group to further define the route to be followed.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- Core.Point#Coordinate - Coordinate -

-
-
- -

The Coordinate coordinates where to spawn the group.

- -
-
-
-
-

- #number - SpawnIndex -

-
-
- -

(optional) The index which group to spawn within the given zone.

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

that was spawned or #nil if nothing was spawned.

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

SPAWN:SpawnFromPointVec2(PointVec2, MinHeight, MaxHeight, SpawnIndex)

-
- -

Will spawn a group from a POINT_VEC2 in 3D space.

- - -

This method is mostly advisable to be used if you want to simulate spawning groups on the ground from air units, like vehicles. -Note that each point in the route assigned to the spawning group is reset to the point of the spawn. -You can use the returned group to further define the route to be followed.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- Core.Point#POINT_VEC2 - PointVec2 -

-
-
- -

The PointVec2 coordinates where to spawn the group.

- -
-
-
-
-

- #number - MinHeight -

-
-
- -

(optional) The minimum height to spawn an airborne group into the zone.

- -
-
-
-
-

- #number - MaxHeight -

-
-
- -

(optional) The maximum height to spawn an airborne group into the zone.

- -
-
-
-
-

- #number - SpawnIndex -

-
-
- -

(optional) The index which group to spawn within the given zone.

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

that was spawned or #nil if nothing was spawned.

- -
-
-

Usage:

- 

-  local SpawnPointVec2 = ZONE:New( ZoneName ):GetPointVec2() 
-
-  -- Spawn at the zone center position at the height specified in the ME of the group template!
-  SpawnAirplanes:SpawnFromPointVec2( SpawnPointVec2 )
-
-  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
-  SpawnAirplanes:SpawnFromPointVec2( SpawnPointVec2, 2000, 4000 )
-
- -
- -
-
- -
- -
-

SPAWN:SpawnFromPointVec3(PointVec3, SpawnIndex)

-
- -

Will spawn a group from a PointVec3 in 3D space.

- - -

This method is mostly advisable to be used if you want to simulate spawning units in the air, like helicopters or airplanes. -Note that each point in the route assigned to the spawning group is reset to the point of the spawn. -You can use the returned group to further define the route to be followed.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- Core.Point#POINT_VEC3 - PointVec3 -

-
-
- -

The PointVec3 coordinates where to spawn the group.

- -
-
-
-
-

- #number - SpawnIndex -

-
-
- -

(optional) The index which group to spawn within the given zone.

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

that was spawned or #nil if nothing was spawned.

- -
-
-

Usage:

- 

-  local SpawnPointVec3 = ZONE:New( ZoneName ):GetPointVec3( 2000 ) -- Get the center of the ZONE object at 2000 meters from the ground.
-
-  -- Spawn at the zone center position at 2000 meters from the ground!
-  SpawnAirplanes:SpawnFromPointVec3( SpawnPointVec3 )
-
- -
- -
-
- -
- -
-

SPAWN:SpawnFromStatic(HostStatic, MinHeight, MaxHeight, SpawnIndex)

-
- -

Will spawn a group from a hosting static.

- - -

This method is mostly advisable to be used if you want to simulate spawning from buldings and structures (static buildings). -You can use the returned group to further define the route to be followed.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- Wrapper.Static#STATIC - HostStatic -

-
-
- -

The static dropping or unloading the group.

- -
-
-
-
-

- #number - MinHeight -

-
-
- -

(optional) The minimum height to spawn an airborne group into the zone.

- -
-
-
-
-

- #number - MaxHeight -

-
-
- -

(optional) The maximum height to spawn an airborne group into the zone.

- -
-
-
-
-

- #number - SpawnIndex -

-
-
- -

(optional) The index which group to spawn within the given zone.

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

that was spawned or #nil if nothing was spawned.

- -
-
-

Usage:

- 

-  local SpawnStatic = STATIC:FindByName( StaticName )
-
-  -- Spawn from the static position at the height specified in the ME of the group template!
-  SpawnAirplanes:SpawnFromStatic( SpawnStatic )
-
-  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
-  SpawnAirplanes:SpawnFromStatic( SpawnStatic, 2000, 4000 )
-
- -
- -
-
- -
- -
-

SPAWN:SpawnFromUnit(HostUnit, MinHeight, MaxHeight, SpawnIndex)

-
- -

Will spawn a group from a hosting unit.

- - -

This method is mostly advisable to be used if you want to simulate spawning from air units, like helicopters, which are dropping infantry into a defined Landing Zone. -Note that each point in the route assigned to the spawning group is reset to the point of the spawn. -You can use the returned group to further define the route to be followed.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- Wrapper.Unit#UNIT - HostUnit -

-
-
- -

The air or ground unit dropping or unloading the group.

- -
-
-
-
-

- #number - MinHeight -

-
-
- -

(optional) The minimum height to spawn an airborne group into the zone.

- -
-
-
-
-

- #number - MaxHeight -

-
-
- -

(optional) The maximum height to spawn an airborne group into the zone.

- -
-
-
-
-

- #number - SpawnIndex -

-
-
- -

(optional) The index which group to spawn within the given zone.

- -
-
-

Return values:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

that was spawned.

- -
-
-

#nil:

-
-
- -

Nothing was spawned.

- -
-
-

Usage:

- 

-  local SpawnStatic = STATIC:FindByName( StaticName )
-
-  -- Spawn from the static position at the height specified in the ME of the group template!
-  SpawnAirplanes:SpawnFromUnit( SpawnStatic )
-
-  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
-  SpawnAirplanes:SpawnFromUnit( SpawnStatic, 2000, 4000 )
-
- -
- -
-
- -
- -
-

SPAWN:SpawnFromVec2(Vec2, MinHeight, MaxHeight, SpawnIndex)

-
- -

Will spawn a group from a Vec2 in 3D space.

- - -

This method is mostly advisable to be used if you want to simulate spawning groups on the ground from air units, like vehicles. -Note that each point in the route assigned to the spawning group is reset to the point of the spawn. -You can use the returned group to further define the route to be followed.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- DCS#Vec2 - Vec2 -

-
-
- -

The Vec2 coordinates where to spawn the group.

- -
-
-
-
-

- #number - MinHeight -

-
-
- -

(optional) The minimum height to spawn an airborne group into the zone.

- -
-
-
-
-

- #number - MaxHeight -

-
-
- -

(optional) The maximum height to spawn an airborne group into the zone.

- -
-
-
-
-

- #number - SpawnIndex -

-
-
- -

(optional) The index which group to spawn within the given zone.

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

that was spawned or #nil if nothing was spawned.

- -
-
-

Usage:

- 

-  local SpawnVec2 = ZONE:New( ZoneName ):GetVec2()
-
-  -- Spawn at the zone center position at the height specified in the ME of the group template!
-  SpawnAirplanes:SpawnFromVec2( SpawnVec2 )
-
-  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
-  SpawnAirplanes:SpawnFromVec2( SpawnVec2, 2000, 4000 )
-
- -
- -
-
- -
- -
-

SPAWN:SpawnFromVec3(Vec3, SpawnIndex)

-
- -

Will spawn a group from a Vec3 in 3D space.

- - -

This method is mostly advisable to be used if you want to simulate spawning units in the air, like helicopters or airplanes. -Note that each point in the route assigned to the spawning group is reset to the point of the spawn. -You can use the returned group to further define the route to be followed.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- DCS#Vec3 - Vec3 -

-
-
- -

The Vec3 coordinates where to spawn the group.

- -
-
-
-
-

- #number - SpawnIndex -

-
-
- -

(optional) The index which group to spawn within the given zone.

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

that was spawned or #nil if nothing was spawned.

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

SPAWN:SpawnGroupName(SpawnIndex)

-
- -

Will return the SpawnGroupName either with with a specific count number or without any count.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #number - SpawnIndex -

-
-
- -

Is the number of the Group that is to be spawned.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

SpawnGroupName

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

SPAWN:SpawnInZone(Zone, RandomizeGroup, MinHeight, MaxHeight, SpawnIndex)

-
- -

Will spawn a Group within a given Core.Zone.

- - -

The Core.Zone can be of any type derived from Core.Zone#ZONE_BASE. -Once the Wrapper.Group is spawned within the zone, the Wrapper.Group will continue on its route. -The first waypoint (where the group is spawned) is replaced with the zone location coordinates.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- Core.Zone#ZONE - Zone -

-
-
- -

The zone where the group is to be spawned.

- -
-
-
-
-

- #boolean - RandomizeGroup -

-
-
- -

(optional) Randomization of the Wrapper.Group position in the zone.

- -
-
-
-
-

- #number - MinHeight -

-
-
- -

(optional) The minimum height to spawn an airborne group into the zone.

- -
-
-
-
-

- #number - MaxHeight -

-
-
- -

(optional) The maximum height to spawn an airborne group into the zone.

- -
-
-
-
-

- #number - SpawnIndex -

-
-
- -

(optional) The index which group to spawn within the given zone.

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

that was spawned or #nil if nothing was spawned.

- -
-
-

Usage:

- 

-  local SpawnZone = ZONE:New( ZoneName )
-
-  -- Spawn at the zone center position at the height specified in the ME of the group template!
-  SpawnAirplanes:SpawnInZone( SpawnZone )
-
-  -- Spawn in the zone at a random position at the height specified in the Me of the group template.
-  SpawnAirplanes:SpawnInZone( SpawnZone, true )
-
-  -- Spawn in the zone at a random position at the height randomized between 2000 and 4000 meters.
-  SpawnAirplanes:SpawnInZone( SpawnZone, true, 2000, 4000 )
-
-  -- Spawn at the zone center position at the height randomized between 2000 and 4000 meters.
-  SpawnAirplanes:SpawnInZone( SpawnZone, false, 2000, 4000 )
-
-  -- Spawn at the zone center position at the height randomized between 2000 and 4000 meters.
-  SpawnAirplanes:SpawnInZone( SpawnZone, nil, 2000, 4000 )
-
- -
- -
-
- -
- -
-

SPAWN:SpawnScheduleStart()

-
- -

Will re-start the spawning scheduler.

- - -

Note: This method is only required to be called when the schedule was stopped.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Return value:

-
-
-

#SPAWN:

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

SPAWN:SpawnScheduleStop()

-
- -

Will stop the scheduled spawning scheduler.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Return value:

-
-
-

#SPAWN:

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

SPAWN:SpawnScheduled(SpawnTime, SpawnTimeVariation, WithDelay)

-
- -

Spawns new groups at varying time intervals.

- - -

This is useful if you want to have continuity within your missions of certain (AI) groups to be present (alive) within your missions. -WARNING - Setting a very low SpawnTime heavily impacts your mission performance and CPU time, it is NOT useful to check the alive state of an object every split second! Be reasonable and stay at 15 seconds and above!

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- #number - SpawnTime -

-
-
- -

The time interval defined in seconds between each new spawn of new groups.

- -
-
-
-
-

- #number - SpawnTimeVariation -

-
-
- -

The variation to be applied on the defined time interval between each new spawn. -The variation is a number between 0 and 1, representing the % of variation to be applied on the time interval.

- -
-
-
-
-

- #boolean - WithDelay -

-
-
- -

Do not spawn the first group immediately, but delay the spawn as per the calculation below. -Effectively the same as #InitDelayOn().

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 
-- NATO helicopters engaging in the battle field.
--- The time interval is set to SPAWN new helicopters between each 600 seconds, with a time variation of 50%.
--- The time variation in this case will be between 450 seconds and 750 seconds.
--- This is calculated as follows:
---      Low limit:   600 * ( 1 - 0.5 / 2 ) = 450
---      High limit:  600 * ( 1 + 0.5 / 2 ) = 750
--- Between these two values, a random amount of seconds will be chosen for each new spawn of the helicopters.
-Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):SpawnScheduled( 600, 0.5 )
- -
- -
-
- -
- -
-

SPAWN:SpawnWithIndex(SpawnIndex, NoBirth)

-
- -

Will spawn a group with a specified index number.

- - -

Note: This method uses the global _DATABASE object (an instance of Core.Database#DATABASE), which contains ALL initial and new spawned objects in MOOSE.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- #string - SpawnIndex -

-
-
- -

The index of the group to be spawned.

- -
-
-
-
-

- NoBirth -

-
-
-

-
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

The group that was spawned. You can use this group for further actions.

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

SPAWN:StopRepeat()

-
- -

Stop the SPAWN InitRepeat function (EVENT handler for takeoff, land and engine shutdown)

- -
-
-

Defined in:

-
-

SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 
         local spawn = SPAWN:New("Template Group")
-           :InitRepeatOnEngineShutDown()
-         local plane = spawn:Spawn() -- it is important that we keep the SPAWN object and do not overwrite it with the resulting GROUP object by just calling :Spawn()
-         
-         -- later on
-         spawn:StopRepeat()
- -
- -
-
- -
- -
-

SPAWN:_CountAliveUnits()

-
- - - -
-
-

Defined in:

-
-

SPAWN

-
-

Return value:

-
-
-

#number:

-
-
- -

count

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

SPAWN:_GetGroupCategoryID(SpawnPrefix)

-
- -

Gets the CategoryID of the Group with the given SpawnPrefix

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- SpawnPrefix -

-
-
-

-
-
-
- -
-
- -
- -
-

SPAWN:_GetGroupCoalitionID(SpawnPrefix)

-
- -

Gets the CoalitionID of the Group with the given SpawnPrefix

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- SpawnPrefix -

-
-
-

-
-
-
- -
-
- -
- -
-

SPAWN:_GetGroupCountryID(SpawnPrefix)

-
- -

Gets the CountryID of the Group with the given SpawnPrefix

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- SpawnPrefix -

-
-
-

-
-
-
- -
-
- -
- -
-

SPAWN:_GetLastIndex()

-
- -

Return the last maximum index that can be used.

- -
-
-

Defined in:

-
-

SPAWN

-
-
- -
-
- -
- -
-

SPAWN:_GetPrefixFromGroup(SpawnGroup)

-
- -

Return the prefix of a SpawnUnit.

- - -

The method will search for a #-mark, and will return the text before the #-mark. -It will return nil of no prefix was found.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- Wrapper.Group#GROUP - SpawnGroup -

-
-
- -

The GROUP object.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The prefix or #nil if nothing was found.

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

SPAWN:_GetPrefixFromGroupName(SpawnGroupName)

-
- -

Return the prefix of a spawned group.

- - -

The method will search for a #-mark, and will return the text before the #-mark. It will return nil of no prefix was found.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #string - SpawnGroupName -

-
-
- -

The name of the spawned group.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The prefix or #nil if nothing was found.

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

SPAWN:_GetSpawnIndex(SpawnIndex)

-
- -

Get the next index of the groups to be spawned.

- - -

This method is complicated, as it is used at several spaces.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #number - SpawnIndex -

-
-
- -

Spawn index.

- -
-
-

Return value:

-
-
-

#number:

-
-
- -

self.SpawnIndex

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

SPAWN:_GetTemplate(SpawnTemplatePrefix)

-
- -

Gets the Group Template from the ME environment definition.

- - -

Note: This method uses the global _DATABASE object (an instance of Core.Database#DATABASE), which contains ALL initial and new spawned objects in MOOSE.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #string - SpawnTemplatePrefix -

-
-
-

-
-
-

Return value:

-
-
-
-
- -

@SPAWN self

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

SPAWN:_InitializeSpawnGroups(SpawnIndex)

-
- -

Initalize the SpawnGroups collection.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- SpawnIndex -

-
-
-

-
-
-
- -
-
- -
- -
-

SPAWN:_OnBirth(EventData)

-
- - - - -

@param #SPAWN self - @param Core.Event#EVENTDATA EventData

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- EventData -

-
-
-

-
-
-
- -
-
- -
- -
-

SPAWN:_OnDeadOrCrash(EventData)

-
- - - -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
-

-
-
-
- -
-
- -
- -
-

SPAWN:_OnEngineShutDown(EventData)

-
- -

Will detect AIR Units shutting down their engines ...

- - -

When the event takes place, and the method #InitRepeatOnEngineShutDown was called, the spawned Group will Re-SPAWN. -But only when the Unit was registered to have landed.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
-

-
-
-
- -
-
- -
- -
-

SPAWN:_OnLand(EventData)

-
- -

Will detect AIR Units landing...

- - -

When the event takes place, the spawned Group is registered as landed. -This is needed to ensure that Re-SPAWNing is only done for landed AIR Groups.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
-

-
-
-
- -
-
- -
- -
-

SPAWN:_OnTakeOff(EventData)

-
- -

Will detect AIR Units taking off...

- - -

When the event takes place, the spawned Group is registered as airborne... -This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
-

-
-
-
- -
-
- -
- -
-

SPAWN:_Prepare(SpawnTemplatePrefix, SpawnIndex)

-
- -

Prepares the new Group Template.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- #string - SpawnTemplatePrefix -

-
-
-

-
-
-
-
-

- #number - SpawnIndex -

-
-
-

-
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:_RandomizeRoute(SpawnIndex)

-
- -

Private method randomizing the routes.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #number - SpawnIndex -

-
-
- -

The index of the group to be spawned.

- -
-
-

Return value:

-
-
-

#SPAWN:

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

SPAWN:_RandomizeTemplate(SpawnIndex)

-
- -

Private method that randomizes the template of the group.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #number - SpawnIndex -

-
-
-

-
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:_RandomizeZones(SpawnIndex)

-
- -

Private method that randomizes the Core.Zones where the Group will be spawned.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #number - SpawnIndex -

-
-
-

-
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:_Scheduler()

-
- -

This function is called automatically by the Spawning scheduler.

- - -

It is the internal worker method SPAWNing new Groups on the defined time intervals.

- -
-
-

Defined in:

-
-

SPAWN

-
-
- -
-
- -
- -
-

SPAWN:_SetInitialPosition(SpawnIndex)

-
- -

Private method that sets the DCS#Vec2 where the Group will be spawned.

- -
-
-

Defined in:

-
-

SPAWN

-
-

Parameter:

-
-
-

- #number - SpawnIndex -

-
-
-

-
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

SPAWN:_SpawnCleanUpScheduler()

-
- -

Schedules the CleanUp of Groups

- -
-
-

Defined in:

-
-

SPAWN

-
-

Return value:

-
-
-

#boolean:

-
-
- -

True = Continue Scheduler

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

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

-
- - - -
-
-

Defined in:

-
-

SPAWN

-
-

Parameters:

-
-
-

- SpawnIndex -

-
-
-

-
-
-
-
-

- SpawnRootX -

-
-
-

-
-
-
-
-

- SpawnRootY -

-
-
-

-
-
-
-
-

- SpawnX -

-
-
-

-
-
-
-
-

- SpawnY -

-
-
-

-
-
-
-
-

- SpawnAngle -

-
-
-

-
-
-
- -
-
- -
-

Field(s)

-
-
-
- - #boolean -SPAWN.AIOnOff - - - - -

The AI is on by default when spawning a group.

- -
- -
-
-
- - #number -SPAWN.AliveUnits - - - -
- -
-
-
- - -SPAWN.CleanUpScheduler - - - -
- -
-
-
- - #boolean -SPAWN.DelayOnOff - - - - -

No initial delay when spawning the first group.

- -
- -
-
-
- - -SPAWN.InitSpeed - - - -
- -
-
-
- - #number -SPAWN.MaxAliveGroups - - - -
- -
-
-
- - #number -SPAWN.MaxAliveUnits - - - -
- -
-
-
- - #boolean -SPAWN.Repeat - - - - -

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

- -
- -
-
-
- - #boolean -SPAWN.RepeatOnEngineShutDown - - - -
- -
-
-
- - #boolean -SPAWN.RepeatOnLanding - - - -
- -
-
-
- - #string -SPAWN.SpawnAliasPrefix - - - -
- -
-
-
- - -SPAWN.SpawnAliasPrefixEscaped - - - -
- -
-
-
- - -SPAWN.SpawnCleanUpInterval - - - -
- -
-
-
- - #table -SPAWN.SpawnCleanUpTimeStamps - - - -
- -
-
-
- - #number -SPAWN.SpawnCount - - - - -

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

- -
- -
-
-
- - #boolean -SPAWN.SpawnFromNewPosition - - - -
- -
-
-
- - #table -SPAWN.SpawnFunctionArguments - - - -
- -
-
-
- - -SPAWN.SpawnFunctionHook - - - -
- -
-
-
- - #table -SPAWN.SpawnGroups - - - - -

Array containing the descriptions of each Group to be Spawned.

- -
- -
-
-
- - #boolean -SPAWN.SpawnHiddenOnMFD - - - -
- -
-
-
- - #boolean -SPAWN.SpawnHiddenOnPlanner - - - -
- -
-
-
- - -SPAWN.SpawnHookScheduler - - - -
- -
-
-
- - #number -SPAWN.SpawnIndex - - - -
- -
-
-
- - #boolean -SPAWN.SpawnInitCallSign - - - -
- -
-
-
- - -SPAWN.SpawnInitCallSignName - - - -
- -
-
-
- - -SPAWN.SpawnInitCategory - - - -
- -
-
-
- - -SPAWN.SpawnInitCoalition - - - -
- -
-
-
- - -SPAWN.SpawnInitCountry - - - -
- -
-
-
- - -SPAWN.SpawnInitGroupHeadingMax - - - -
- -
-
-
- - -SPAWN.SpawnInitGroupHeadingMin - - - -
- -
-
-
- - -SPAWN.SpawnInitGroupUnitVar - - - -
- -
-
-
- - -SPAWN.SpawnInitHeadingMax - - - -
- -
-
-
- - -SPAWN.SpawnInitHeadingMin - - - -
- -
-
-
- - #boolean -SPAWN.SpawnInitKeepUnitNames - - - - -

Overwrite unit names by default with group name.

- -
- -
-
-
- - #boolean -SPAWN.SpawnInitLimit - - - -
- -
-
-
- - -SPAWN.SpawnInitPosition - - - - -

self:T2( { self.SpawnTemplatePrefix, Vec2} )

- -
- -
-
-
- - -SPAWN.SpawnInitSADL - - - - -

we arrived here seeing that self.SpawnInitSADL == nil, but now that we have a SADL (num), we also need to set it to self.SpawnInitSADL in case - we need to get the next SADL from _DATABASE, or else UTILS.OctalToDecimal() will fail in GetNextSADL

- -
- -
-
-
- - -SPAWN.SpawnInitTerminalType - - - -
- -
-
-
- - #boolean -SPAWN.SpawnIsScheduled - - - - -

Reflects if the spawning for this SpawnTemplatePrefix is going to be scheduled or not.

- -
- -
-
-
- - -SPAWN.SpawnMaxGroups - - - - -

The maximum amount of groups that can be spawned.

- -
- -
-
-
- - -SPAWN.SpawnMaxUnitsAlive - - - - -

The maximum amount of groups that can be alive of SpawnTemplatePrefix at the same time.

- -
- -
-
-
- - #boolean -SPAWN.SpawnRandomCallsign - - - -
- -
-
-
- - #boolean -SPAWN.SpawnRandomize - - - - -

Sets the randomization flag of new Spawned units to false.

- -
- -
-
-
- - #boolean -SPAWN.SpawnRandomizeRoute - - - -
- -
- - - - -
-
- - #boolean -SPAWN.SpawnRandomizeTemplate - - - -
- -
-
-
- - #boolean -SPAWN.SpawnRandomizeZones - - - -
- -
-
-
- - -SPAWN.SpawnScheduler - - - -
- -
-
-
- - -SPAWN.SpawnTemplate - - - - -

Contains the template structure for a Group Spawn from the Mission Editor. Note that this group must have lateActivation always on!!!

- -
- -
-
-
- - #string -SPAWN.SpawnTemplatePrefix - - - -
- -
- -
-
- - -SPAWN.SpawnTemplatePrefixTable - - - -
- -
-
-
- - #boolean -SPAWN.SpawnUnControlled - - - -
- -
-
-
- - #boolean -SPAWN.SpawnUnitsWithAbsolutePositions - - - -
- -
-
-
- - #boolean -SPAWN.SpawnUnitsWithRelativePositions - - - -
- -
-
-
- - #boolean -SPAWN.SpawnVisible - - - - -

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

- -
- -
- -
-
- - #SPAWN.Takeoff -SPAWN.Takeoff - - - -
- -
-
-
- - #boolean -SPAWN.TweakedTemplate - - - - -

Check if the user is using self made template.

- -
- -
-
-
- - #boolean -SPAWN.UnControlled - - - - -

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

- -
- -
-
-
- - -SPAWN.UnitsAbsolutePositions - - - -
- -
-
-
- - -SPAWN.UnitsRelativePositions - - - -
- -
-
-

Function(s)

-
-
- -
-

SPAWN: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.

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

SPAWN: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 -

-
-
-

-
-
-
- -
-
- -
- -
-

SPAWN:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

-
- -

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.

- -
-
-
-
-

- IniObjectCategory -

-
-
-

-
-
-
- -
-
- -
- -
-

SPAWN:CreateEventDead(EventTime, Initiator, IniObjectCategory)

-
- -

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.

- -
-
-
-
-

- IniObjectCategory -

-
-
-

-
-
-
- -
-
- -
- -
-

SPAWN:CreateEventDynamicCargoLoaded(DynamicCargo)

-
- -

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Wrapper.DynamicCargo#DYNAMICCARGO - DynamicCargo -

-
-
- -

the dynamic cargo object

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

SPAWN:CreateEventDynamicCargoRemoved(DynamicCargo)

-
- -

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Wrapper.DynamicCargo#DYNAMICCARGO - DynamicCargo -

-
-
- -

the dynamic cargo object

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

SPAWN:CreateEventDynamicCargoUnloaded(DynamicCargo)

-
- -

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Wrapper.DynamicCargo#DYNAMICCARGO - DynamicCargo -

-
-
- -

the dynamic cargo object

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

SPAWN:CreateEventNewDynamicCargo(DynamicCargo)

-
- -

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Wrapper.DynamicCargo#DYNAMICCARGO - DynamicCargo -

-
-
- -

the dynamic cargo object

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

SPAWN: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.

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

SPAWN: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.

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

SPAWN: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.

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

SPAWN:CreateEventUnitLost(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.

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

SPAWN: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.

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

SPAWN:EventDispatcher()

-
- -

Returns the event dispatcher

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

Core.Event#EVENT:

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

SPAWN:EventRemoveAll()

-
- -

Remove all subscribed events

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#BASE:

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

SPAWN: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.

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

SPAWN: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.

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

SPAWN: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.

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

SPAWN:GetClassID()

-
- -

Get the ClassID of the class instance.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassID of the class instance.

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

SPAWN:GetClassName()

-
- -

Get the ClassName of the class instance.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassName of the class instance.

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

SPAWN: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.

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

SPAWN:GetEventPriority()

-
- -

Get the Class Core.Event processing Priority.

- - -

The Event processing Priority is a number from 1 to 10, -reflecting the order of the classes subscribed to the Event to be processed.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#number:

-
-
- -

The Core.Event processing Priority.

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

SPAWN: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:

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

SPAWN: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.

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

SPAWN: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:

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

SPAWN: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.

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

SPAWN: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

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

SPAWN: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:

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

SPAWN:IsTrace()

-
- -

Enquires if tracing is on (for the class).

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#boolean:

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

SPAWN: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:

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

SPAWN:OnEvent(EventData)

-
- -

Occurs when an Event for an object is triggered.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that triggered the event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventBDA(EventData)

-
- -

BDA.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventBaseCaptured(EventData)

-
- -

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

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that captured the base -place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventBirth(EventData)

-
- -

Occurs when any object is spawned into the mission.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that was spawned

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventCrash(EventData)

-
- -

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

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that has crashed

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventDead(EventData)

-
- -

Occurs when an object is dead.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is dead.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN: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.

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

SPAWN:OnEventDiscardChairAfterEjection(EventData)

-
- -

Discard chair after ejection.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventDynamicCargoLoaded(EventData)

-
- -

Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.

- - -

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventDynamicCargoRemoved(EventData)

-
- -

Occurs when a dynamic cargo crate is removed.

- - -

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventDynamicCargoUnloaded(EventData)

-
- -

Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.

- - -

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventEjection(EventData)

-
- -

Occurs when a pilot ejects from an aircraft -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- - -

initiator : The unit that has ejected

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventEngineShutdown(EventData)

-
- -

Occurs when any aircraft shuts down its engines.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is stopping its engines.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventEngineStartup(EventData)

-
- -

Occurs when any aircraft starts its engines.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is starting its engines.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventHit(EventData)

-
- -

Occurs whenever an object is hit by a weapon.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit object the fired the weapon -weapon: Weapon object that hit the target -target: The Object that was hit.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventHumanFailure(EventData)

-
- -

Occurs when any system fails on a human controlled aircraft.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that had the failure

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN: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. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

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

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventLand(EventData)

-
- -

Occurs when an aircraft lands at an airbase, farp or ship -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- - -

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

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN: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. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
    -
  • initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
    • -
  • place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
    • -
  • subplace: is always 0 for unknown reasons.
    • -
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventLandingQualityMark(EventData)

-
- -

Landing quality mark.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventMarkAdded(EventData)

-
- -

Occurs when a new mark was added.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventMarkChange(EventData)

-
- -

Occurs when a mark text was changed.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventMarkRemoved(EventData)

-
- -

Occurs when a mark was removed.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventMissionEnd(EventData)

-
- -

Occurs when a mission ends -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventMissionStart(EventData)

-
- -

Occurs when a mission starts -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventNewDynamicCargo(EventData)

-
- -

Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.

- - -

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN: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. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN: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. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that the pilot has died in.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventPlayerEnterAircraft(EventData)

-
- -

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

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. -initiator : The unit that is being taken control of.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventPlayerEnterUnit(EventData)

-
- -

Occurs when any player assumes direct control of a unit.

- - -

Note - not Mulitplayer safe. Use PlayerEnterAircraft. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is being taken control of.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventPlayerLeaveUnit(EventData)

-
- -

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

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that the player left.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventRefueling(EventData)

-
- -

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

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is receiving fuel.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventRefuelingStop(EventData)

-
- -

Occurs when an aircraft is finished taking fuel.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that was receiving fuel.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN: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. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventShootingEnd(EventData)

-
- -

Occurs when any unit stops firing its weapon.

- - -

Event will always correspond with a shooting start event. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that was doing the shooting.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventShootingStart(EventData)

-
- -

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

- - -

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is doing the shooting. -target: The unit that is being targeted.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventShot(EventData)

-
- -

Occurs whenever any unit in a mission fires a weapon.

- - -

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventTakeoff(EventData)

-
- -

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

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that tookoff -place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventTriggerZone(EventData)

-
- -

Trigger zone.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN:OnEventUnitLost(EventData)

-
- -

Occurs when the game thinks an object is destroyed.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

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

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

SPAWN: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:

-
-
-

#string:

-
-
- -

The Schedule ID of the planned schedule.

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

SPAWN: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:

-
-
-

#string:

-
-
- -

The Schedule ID of the planned schedule.

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

SPAWN:ScheduleStop(SchedulerID)

-
- -

Stops the Schedule.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #string - SchedulerID -

-
-
- -

(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.

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

SPAWN:SetEventPriority(EventPriority)

-
- -

Set the Class Core.Event processing Priority.

- - -

The Event processing Priority is a number from 1 to 10, -reflecting the order of the classes subscribed to the Event to be processed.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #number - EventPriority -

-
-
- -

The Core.Event processing Priority.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- -

self

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

SPAWN: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.

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

SPAWN: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.

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

SPAWN: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.

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

SPAWN: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.

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

SPAWN:TraceAll(TraceAll)

-
- -

Trace all methods in MOOSE

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #boolean - TraceAll -

-
-
- -

true = trace all methods in MOOSE.

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

SPAWN:TraceClass(Class)

-
- -

Set tracing for a class

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #string - Class -

-
-
- -

Class name.

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

SPAWN:TraceClassMethod(Class, Method)

-
- -

Set tracing for a specific method of class

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- #string - Class -

-
-
- -

Class name.

- -
-
-
-
-

- #string - Method -

-
-
- -

Method.

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

SPAWN:TraceLevel(Level)

-
- -

Set trace level

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #number - Level -

-
-
-

-
-
-
- -
-
- -
- -
-

SPAWN:TraceOff()

-
- -

Set trace off.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Usage:

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

SPAWN:TraceOn()

-
- -

Set trace on.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Usage:

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

SPAWN: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 )
-
- -
- -
-
- -
- -
-

SPAWN:UnHandleEvent(EventID)

-
- -

UnSubscribe to a DCS event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTS - EventID -

-
-
- -

Event ID.

- -
-
-

Return value:

-
-
-

#BASE:

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

SPAWN:_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 -

-
-
-

-
-
-
- -
-
- -
- -
-

SPAWN:_Serialize(Arguments)

-
- -

(Internal) Serialize arguments

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #table - Arguments -

-
-
-

-
-
-

Return value:

-
-
-

#string:

-
-
- -

Text

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

SPAWN:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

-
- -

Trace a function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
-
-

- DebugInfoCurrentParam -

-
-
-

-
-
-
-
-

- DebugInfoFromParam -

-
-
-

-
-
-
- -
-
- -
- -
-

SPAWN:onEvent(event)

-
- -

The main event handling function...

- - -

This function captures all events generated for the class.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- DCS#Event - event -

-
-
-

-
-
-
- -
-
- -
- -
-

Type SPAWN.Takeoff

-
-
- -

Enumerator for spawns at airbases

- -
-

Field(s)

-
-
-
- - #number -SPAWN.Takeoff.Air - -

Take off happens in air.

- -
- -
-
-
- - #number -SPAWN.Takeoff.Cold - -

Spawn at parking with engines off.

- -
- -
-
-
- - #number -SPAWN.Takeoff.Hot - -

Spawn at parking with engines on.

- -
- -
-
-
- - #number -SPAWN.Takeoff.Runway - -

Spawn on runway. Does not work in MP!

- -
- -
-
-

Function(s)

-
-
- -
-
- - -
- - - - diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index 1bdfc9267..cbb3fcd42 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

-
-
-
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -2138,6 +2127,24 @@ such as position and heading.

SPAWNSTATIC:_SpawnStatic(Template, CountryID)

Spawns a new static using a given template.

+ + + +

SPAWNSTATIC.heliport_callsign_id

+ + + + + +

SPAWNSTATIC.heliport_frequency

+ + + + + +

SPAWNSTATIC.heliport_modulation

+ + @@ -3123,11 +3130,44 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table SPAWNSTATIC.TemplateStaticUnit +
+ +
+
+
+ + +SPAWNSTATIC.heliport_callsign_id + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_frequency + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_modulation + + +
@@ -4735,11 +4775,44 @@ Handy if you spawn from cargo statics which have resources already set.

- + #table SPAWNSTATIC.TemplateStaticUnit +
+ +
+
+
+ + +SPAWNSTATIC.heliport_callsign_id + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_frequency + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_modulation + + +
diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index 725fa9556..a7504a91e 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Core.TextAndSound.html b/Documentation/Core.TextAndSound.html index 4686f7038..d8e2bd76e 100644 --- a/Documentation/Core.TextAndSound.html +++ b/Documentation/Core.TextAndSound.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Core.Timer.html b/Documentation/Core.Timer.html index a7a3cc460..57c1ae570 100644 --- a/Documentation/Core.Timer.html +++ b/Documentation/Core.Timer.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Core.UserFlag.html b/Documentation/Core.UserFlag.html index f062db5a0..8cdd850ac 100644 --- a/Documentation/Core.UserFlag.html +++ b/Documentation/Core.UserFlag.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Core.Velocity.html b/Documentation/Core.Velocity.html index f08b386d5..fd38013f3 100644 --- a/Documentation/Core.Velocity.html +++ b/Documentation/Core.Velocity.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Core.Zone.html b/Documentation/Core.Zone.html index 4631c03b0..085f92bc4 100644 --- a/Documentation/Core.Zone.html +++ b/Documentation/Core.Zone.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Core.Zone_Detection.html b/Documentation/Core.Zone_Detection.html index 7564148a6..bc8c6bc44 100644 --- a/Documentation/Core.Zone_Detection.html +++ b/Documentation/Core.Zone_Detection.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/DCS.html b/Documentation/DCS.html index efd73a192..9a0cd7f76 100644 --- a/Documentation/DCS.html +++ b/Documentation/DCS.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Functional.ATC_Ground.html b/Documentation/Functional.ATC_Ground.html index 355b4ed48..45d18180e 100644 --- a/Documentation/Functional.ATC_Ground.html +++ b/Documentation/Functional.ATC_Ground.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -4089,7 +4078,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table ATC_GROUND.Airbases @@ -4105,9 +4094,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Kickspeed

-
@@ -4677,7 +4663,7 @@ An airbase can be specified to set the maximum kick speed for.

- + #table ATC_GROUND.Airbases @@ -4693,9 +4679,6 @@ An airbase can be specified to set the maximum kick speed for.

- -

Kickspeed

-
diff --git a/Documentation/Functional.Artillery.html b/Documentation/Functional.Artillery.html index 591e38da5..416e22a62 100644 --- a/Documentation/Functional.Artillery.html +++ b/Documentation/Functional.Artillery.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Functional.CleanUp.html b/Documentation/Functional.CleanUp.html index 5e5acaa2e..bc5851b48 100644 --- a/Documentation/Functional.CleanUp.html +++ b/Documentation/Functional.CleanUp.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Functional.ClientWatch.html b/Documentation/Functional.ClientWatch.html index 1fbb65bc1..433c143db 100644 --- a/Documentation/Functional.ClientWatch.html +++ b/Documentation/Functional.ClientWatch.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index 04ca01dd8..722092e8f 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -2668,17 +2657,6 @@ Use the method DESIGNATE.SetMission() to - - - -
-
- - -DESIGNATE.LaseDuration - - -
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index 18c3048d3..dae36273a 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -20000,6 +19989,28 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +
+
+ + #number +DETECTION_BASE.DetectedItemCount + + + +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -24754,6 +24765,28 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #number +DETECTION_BASE.DetectedItemCount + + + +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -26496,6 +26529,28 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #number +DETECTION_BASE.DetectedItemCount + + + +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
diff --git a/Documentation/Functional.DetectionZones.html b/Documentation/Functional.DetectionZones.html index 1c1c2a961..bc30e8a62 100644 --- a/Documentation/Functional.DetectionZones.html +++ b/Documentation/Functional.DetectionZones.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Functional.Escort.html b/Documentation/Functional.Escort.html index ef0c06281..27daaacb8 100644 --- a/Documentation/Functional.Escort.html +++ b/Documentation/Functional.Escort.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Functional.Fox.html b/Documentation/Functional.Fox.html index 20e729d23..e767c1a54 100644 --- a/Documentation/Functional.Fox.html +++ b/Documentation/Functional.Fox.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index 2da862cc9..e198db99f 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -4294,8 +4283,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- -MANTIS.AWACS_Prefix + #table +MANTIS.AcceptZones @@ -4332,6 +4321,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #table +MANTIS.ConflictZones + + +
@@ -4431,6 +4431,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The ME name of the HQ object

+ + + +
+
+ + #table +MANTIS.RejectZones + + +
@@ -4459,7 +4470,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table MANTIS.SAM_Table_Long @@ -4470,7 +4481,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table MANTIS.SAM_Table_Medium @@ -4481,7 +4492,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table MANTIS.SAM_Table_Short @@ -4638,8 +4649,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- -MANTIS.SkateZones + #number +MANTIS.SkateNumber @@ -4921,6 +4932,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Prefix for logging

+
+ +
+
+
+ + #number +MANTIS.maxclassic + + + +
+ +
+
+
+ + #number +MANTIS.maxlongrange + + + +
+ +
+
+
+ + #number +MANTIS.maxmidrange + + + +
+ +
+
+
+ + #number +MANTIS.maxshortrange + + +
@@ -4990,9 +5045,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

switch alarm state RED

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

self.SAMCheckRanges = {}

+
@@ -9018,8 +9073,8 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- -MANTIS.AWACS_Prefix + #table +MANTIS.AcceptZones @@ -9056,6 +9111,17 @@ E.g. `mymantis:SetAdvancedMode(true, 90)` +
+ +
+
+
+ + #table +MANTIS.ConflictZones + + +
@@ -9155,6 +9221,17 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

The ME name of the HQ object

+
+ +
+
+
+ + #table +MANTIS.RejectZones + + +
@@ -9183,7 +9260,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- + #table MANTIS.SAM_Table_Long @@ -9194,7 +9271,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- + #table MANTIS.SAM_Table_Medium @@ -9205,7 +9282,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- + #table MANTIS.SAM_Table_Short @@ -9362,8 +9439,8 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- -MANTIS.SkateZones + #number +MANTIS.SkateNumber @@ -9645,6 +9722,50 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

Prefix for logging

+
+ +
+
+
+ + #number +MANTIS.maxclassic + + + +
+ +
+
+
+ + #number +MANTIS.maxlongrange + + + +
+ +
+
+
+ + #number +MANTIS.maxmidrange + + + +
+ +
+
+
+ + #number +MANTIS.maxshortrange + + +
@@ -9714,9 +9835,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)` - -

switch alarm state RED

-
@@ -9728,6 +9846,9 @@ E.g. `mymantis:SetAdvancedMode(true, 90)` + +

self.SAMCheckRanges = {}

+
diff --git a/Documentation/Functional.MissileTrainer.html b/Documentation/Functional.MissileTrainer.html index d281b5a91..4b75e6c1b 100644 --- a/Documentation/Functional.MissileTrainer.html +++ b/Documentation/Functional.MissileTrainer.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

-
- -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Functional.Movement.html b/Documentation/Functional.Movement.html index 65d937d5d..a55861ab3 100644 --- a/Documentation/Functional.Movement.html +++ b/Documentation/Functional.Movement.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Functional.PseudoATC.html b/Documentation/Functional.PseudoATC.html index 7ce08cb9e..fcba0ffb3 100644 --- a/Documentation/Functional.PseudoATC.html +++ b/Documentation/Functional.PseudoATC.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Functional.RAT.html b/Documentation/Functional.RAT.html index 46d257f54..2906bd0d3 100644 --- a/Documentation/Functional.RAT.html +++ b/Documentation/Functional.RAT.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -2061,7 +2050,6 @@ manager:Stop(7200)
RAT , extends Core.Spawn#SPAWN -, extends Core.Base#BASE
@@ -3609,1761 +3597,6 @@ manager:Stop(7200) - -

RAT.wp

RAT waypoint type.

-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from SPAWNDescription

RAT.AIOnOff

 - -

RAT.AliveUnits

 - -

RAT.ClassName

 - -

RAT.CleanUpScheduler

 - -

RAT.DelayOnOff

 - -

RAT:GetCoordinate()

 -

Get the Coordinate of the Group that is Late Activated as the template for the SPAWN object.

-

RAT:GetFirstAliveGroup()

 -

Will find the first alive Wrapper.Group it has spawned, and return the alive Wrapper.Group object and the first Index where the first alive Wrapper.Group object has been found.

-

RAT:GetGroupFromIndex(SpawnIndex)

 -

Get the group from an index.

-

RAT:GetLastAliveGroup()

 -

Will find the last alive Wrapper.Group object, and will return a reference to the last live Wrapper.Group object and the last Index where the last alive Wrapper.Group object has been found.

-

RAT:GetNextAliveGroup(SpawnIndexStart)

 -

Will find the next alive Wrapper.Group object from a given Index, and return a reference to the alive Wrapper.Group object and the next Index where the alive Wrapper.Group has been found.

-

RAT:GetSpawnIndexFromGroup(SpawnGroup)

 -

Get the index from a given group.

-

RAT:InitAIOff()

 -

Turns the AI Off for the Wrapper.Group when spawning.

-

RAT:InitAIOn()

 -

Turns the AI On for the Wrapper.Group when spawning.

-

RAT:InitAIOnOff(AIOnOff)

 -

Turns the AI On or Off for the Wrapper.Group when spawning.

-

RAT:InitAirbase(AirbaseName, Takeoff, TerminalType)

 -

Set spawns to happen at a particular airbase.

-

RAT:InitArray(SpawnAngle, SpawnWidth, SpawnDeltaX, SpawnDeltaY)

 -

Makes the groups visible before start (like a battalion).

-

RAT:InitCallSign(ID, Name, Minor, Major)

 -

[BLUE AIR only!] This method sets a specific callsign for a spawned group.

-

RAT:InitCategory(Category)

 -

Sets category ID of the group.

-

RAT:InitCleanUp(SpawnCleanUpInterval)

 -

Delete groups that have not moved for X seconds - AIR ONLY!!! -DO NOT USE ON GROUPS THAT DO NOT MOVE OR YOUR SERVER WILL BURN IN HELL (Pikes - April 2020) -When groups are still alive and have become inactive due to damage and are unable to contribute anything, then this group will be removed at defined intervals in seconds.

-

RAT:InitCoalition(Coalition)

 -

Sets the coalition of the spawned group.

-

RAT:InitCountry(Country)

 -

Sets the country of the spawn group.

-

RAT:InitDelayOff()

 -

Turns the Delay Off for the Wrapper.Group when spawning.

-

RAT:InitDelayOn()

 -

Turns the Delay On for the Wrapper.Group when spawning with #SpawnScheduled().

-

RAT:InitDelayOnOff(DelayOnOff)

 - -

RAT:InitGroupHeading(HeadingMin, HeadingMax, unitVar)

 -

Defines the heading of the overall formation of the new spawned group.

-

RAT:InitGrouping(Grouping)

 -

When spawning a new group, make the grouping of the units according the InitGrouping setting.

-

RAT:InitHeading(HeadingMin, HeadingMax)

 -

Defines the Heading for the new spawned units.

-

RAT:InitHiddenOnMFD()

 -

Hide the group on MFDs (visible to game master slots!).

-

RAT:InitHiddenOnMap(OnOff)

 -

Hide the group on the map view (visible to game master slots!).

-

RAT:InitHiddenOnPlanner()

 -

Hide the group on planner (visible to game master slots!).

-

RAT:InitKeepUnitNames(KeepUnitNames)

 -

Keeps the unit names as defined within the mission editor, -but note that anything after a # mark is ignored, -and any spaces before and after the resulting name are removed.

-

RAT:InitLateActivated(LateActivated)

 -

Flags that the spawned groups must be spawned late activated.

-

RAT:InitLimit(SpawnMaxUnitsAlive, SpawnMaxGroups)

 -

Stops any more repeat spawns from happening once the UNIT count of Alive units, spawned by the same SPAWN object, exceeds the first parameter.

-

RAT:InitLivery(Livery)

 -

Sets livery of the group.

-

RAT:InitModex(modex, prefix, postfix)

 -

Sets the modex of the first unit of the group.

-

RAT:InitPositionCoordinate(Coordinate)

 -

This method sets a spawn position for the group that is different from the location of the template.

-

RAT:InitPositionVec2(Vec2)

 -

This method sets a spawn position for the group that is different from the location of the template.

-

RAT:InitRadioCommsOnOff(switch)

 -

Sets the radio communication on or off.

-

RAT:InitRadioFrequency(frequency)

 -

Sets the radio frequency of the group.

-

RAT:InitRadioModulation(modulation)

 -

Set radio modulation.

-

RAT:InitRandomizeCallsign()

 -

[AIR/Fighter only!] This method randomizes the callsign for a new group.

-

RAT:InitRandomizePosition(RandomizePosition, OuterRadius, InnerRadius)

 -

Randomizes the position of Wrapper.Groups that are spawned within a radius band, given an Outer and Inner radius, from the point that the spawn happens.

-

RAT:InitRandomizeRoute(SpawnStartPoint, SpawnEndPoint, SpawnRadius, SpawnHeight)

 -

Randomizes the defined route of the SpawnTemplatePrefix group in the ME.

-

RAT:InitRandomizeTemplate(SpawnTemplatePrefixTable)

 -

This method is rather complicated to understand.

-

RAT:InitRandomizeTemplatePrefixes(SpawnTemplatePrefixes)

 -

Randomize templates to be used as the unit representatives for the Spawned group, defined by specifying the prefix names.

-

RAT:InitRandomizeTemplateSet(SpawnTemplateSet)

 -

Randomize templates to be used as the unit representatives for the Spawned group, defined using a SET_GROUP object.

-

RAT:InitRandomizeUnits(RandomizeUnits, OuterRadius, InnerRadius)

 -

Randomizes the UNITs that are spawned within a radius band given an Outer and Inner radius.

-

RAT:InitRandomizeZones(SpawnZoneTable)

 -

This method provides the functionality to randomize the spawning of the Groups at a given list of zones of different types.

-

RAT:InitRepeat()

 -

For planes and helicopters, when these groups go home and land on their home airbases and FARPs, they normally would taxi to the parking spot, shut-down their engines and wait forever until the Group is removed by the runtime environment.

-

RAT:InitRepeatOnEngineShutDown()

 -

Respawn after landing when its engines have shut down.

-

RAT:InitRepeatOnLanding()

 -

Respawn group after landing.

-

RAT:InitSADL(Octal)

 -

[Airplane - A10-C II only] Set the SADL TN starting number of the Group; each unit of the spawned group will have a consecutive SADL set.

-

RAT:InitSTN(Octal)

 -

[Airplane - F15/16/18/AWACS/B1B/Tanker only] Set the STN Link16 starting number of the Group; each unit of the spawned group will have a consecutive STN set.

-

RAT:InitSetUnitAbsolutePositions(Positions)

 -

Spawn the UNITs of this group with individual absolute positions and individual headings.

-

RAT:InitSetUnitRelativePositions(Positions)

 -

Spawn the UNITs of this group with individual relative positions to unit #1 and individual headings.

-

RAT:InitSkill(Skill)

 -

Sets skill of the group.

-

RAT.InitSpeed

 - -

RAT:InitSpeedKnots(Knots)

 -

[Airplane] Set the initial speed on spawning in knots.

-

RAT:InitSpeedKph(KPH)

 -

[Airplane] Set the initial speed on spawning in kilometers per hour.

-

RAT:InitSpeedMps(MPS)

 -

[Airplane] Set the initial speed on spawning in meters per second.

-

RAT:InitUnControlled(UnControlled)

 -

(AIR) Will spawn a plane group in UnControlled or Controlled mode...

-

RAT.LateActivated

 - -

RAT.MaxAliveGroups

 - -

RAT.MaxAliveUnits

 - -

RAT:New(SpawnTemplatePrefix)

 -

Creates the main object to spawn a Wrapper.Group defined in the DCS ME.

-

RAT:NewFromTemplate(SpawnTemplate, SpawnTemplatePrefix, SpawnAliasPrefix, NoMooseNamingPostfix)

 -

Creates a new SPAWN instance to create new groups based on the provided template.

-

RAT:NewWithAlias(SpawnTemplatePrefix, SpawnAliasPrefix)

 -

Creates a new SPAWN instance to create new groups based on the defined template and using a new alias for each new group.

-

RAT:OnSpawnGroup(SpawnCallBackFunction, SpawnFunctionArguments, ...)

 -

Allows to place a CallFunction hook when a new group spawns.

-

RAT:ParkAircraft(SpawnAirbase, TerminalType, Parkingdata, SpawnIndex)

 -

Will park a group at an Wrapper.Airbase.

- -

RAT:ParkAtAirbase(SpawnAirbase, TerminalType, Parkingdata)

 -

Will park a group at an Wrapper.Airbase.

-

RAT:ReSpawn(SpawnIndex)

 -

Will re-spawn a group based on a given index.

-

RAT.Repeat

 - -

RAT.RepeatOnEngineShutDown

 - -

RAT.RepeatOnLanding

 - -

RAT:SetSpawnIndex(SpawnIndex)

 -

Set the spawn index to a specified index number.

-

RAT:Spawn()

 -

Will spawn a group based on the internal index.

-

RAT.SpawnAliasPrefix

 - -

RAT.SpawnAliasPrefixEscaped

 - -

RAT:SpawnAtAirbase(SpawnAirbase, Takeoff, TakeoffAltitude, TerminalType, EmergencyAirSpawn, Parkingdata)

 -

Will spawn a group at an Wrapper.Airbase.

-

RAT:SpawnAtParkingSpot(Airbase, Spots, Takeoff)

 -

Spawn a group on an Wrapper.Airbase at a specific parking spot.

-

RAT.SpawnCleanUpInterval

 - -

RAT.SpawnCleanUpTimeStamps

 - -

RAT.SpawnCount

 - -

RAT:SpawnFromCoordinate(Coordinate, SpawnIndex)

 -

Will spawn a group from a Coordinate in 3D space.

-

RAT.SpawnFromNewPosition

 - -

RAT:SpawnFromPointVec2(PointVec2, MinHeight, MaxHeight, SpawnIndex)

 -

Will spawn a group from a POINT_VEC2 in 3D space.

-

RAT:SpawnFromPointVec3(PointVec3, SpawnIndex)

 -

Will spawn a group from a PointVec3 in 3D space.

-

RAT:SpawnFromStatic(HostStatic, MinHeight, MaxHeight, SpawnIndex)

 -

Will spawn a group from a hosting static.

-

RAT:SpawnFromUnit(HostUnit, MinHeight, MaxHeight, SpawnIndex)

 -

Will spawn a group from a hosting unit.

-

RAT:SpawnFromVec2(Vec2, MinHeight, MaxHeight, SpawnIndex)

 -

Will spawn a group from a Vec2 in 3D space.

-

RAT:SpawnFromVec3(Vec3, SpawnIndex)

 -

Will spawn a group from a Vec3 in 3D space.

-

RAT.SpawnFunctionArguments

 - -

RAT.SpawnFunctionHook

 - -

RAT:SpawnGroupName(SpawnIndex)

 -

Will return the SpawnGroupName either with with a specific count number or without any count.

-

RAT.SpawnGrouping

 - -

RAT.SpawnGroups

 - -

RAT.SpawnHiddenOnMFD

 - -

RAT.SpawnHiddenOnMap

 - -

RAT.SpawnHiddenOnPlanner

 - -

RAT.SpawnHookScheduler

 - -

RAT:SpawnInZone(Zone, RandomizeGroup, MinHeight, MaxHeight, SpawnIndex)

 -

Will spawn a Group within a given Core.Zone.

-

RAT.SpawnIndex

 - -

RAT.SpawnInitAirbase

 - -

RAT.SpawnInitCallSign

 - -

RAT.SpawnInitCallSignID

 - -

RAT.SpawnInitCallSignMajor

 - -

RAT.SpawnInitCallSignMinor

 - -

RAT.SpawnInitCallSignName

 - -

RAT.SpawnInitCategory

 - -

RAT.SpawnInitCoalition

 - -

RAT.SpawnInitCountry

 - -

RAT.SpawnInitFreq

 - -

RAT.SpawnInitGroupHeadingMax

 - -

RAT.SpawnInitGroupHeadingMin

 - -

RAT.SpawnInitGroupUnitVar

 - -

RAT.SpawnInitHeadingMax

 - -

RAT.SpawnInitHeadingMin

 - -

RAT.SpawnInitKeepUnitNames

 - -

RAT.SpawnInitLimit

 - -

RAT.SpawnInitLivery

 - -

RAT.SpawnInitModex

 - -

RAT.SpawnInitModexPostfix

 - -

RAT.SpawnInitModexPrefix

 - -

RAT.SpawnInitModu

 - -

RAT.SpawnInitPosition

 - -

RAT.SpawnInitRadio

 - -

RAT.SpawnInitSADL

 - -

RAT.SpawnInitSTN

 - -

RAT.SpawnInitSkill

 - -

RAT.SpawnInitTakeoff

 - -

RAT.SpawnInitTerminalType

 - -

RAT.SpawnInnerRadius

 - -

RAT.SpawnIsScheduled

 - -

RAT.SpawnMaxGroups

 - -

RAT.SpawnMaxUnitsAlive

 - -

RAT.SpawnOuterRadius

 - -

RAT.SpawnRandomCallsign

 - -

RAT.SpawnRandomize

 - -

RAT.SpawnRandomizePosition

 - -

RAT.SpawnRandomizePositionInnerRadius

 - -

RAT.SpawnRandomizePositionOuterRadius

 - -

RAT.SpawnRandomizeRoute

 - -

RAT.SpawnRandomizeRouteEndPoint

 - -

RAT.SpawnRandomizeRouteHeight

 - -

RAT.SpawnRandomizeRouteRadius

 - -

RAT.SpawnRandomizeRouteStartPoint

 - -

RAT.SpawnRandomizeTemplate

 - -

RAT.SpawnRandomizeUnits

 - -

RAT.SpawnRandomizeZones

 - -

RAT:SpawnScheduleStart()

 -

Will re-start the spawning scheduler.

-

RAT:SpawnScheduleStop()

 -

Will stop the scheduled spawning scheduler.

-

RAT:SpawnScheduled(SpawnTime, SpawnTimeVariation, WithDelay)

 -

Spawns new groups at varying time intervals.

-

RAT.SpawnScheduler

 - -

RAT.SpawnTemplate

 - -

RAT.SpawnTemplatePrefix

 - -

RAT.SpawnTemplatePrefixEscaped

 - -

RAT.SpawnTemplatePrefixTable

 - -

RAT.SpawnUnControlled

 - -

RAT.SpawnUnitsWithAbsolutePositions

 - -

RAT.SpawnUnitsWithRelativePositions

 - -

RAT.SpawnVisible

 - -

RAT:SpawnWithIndex(SpawnIndex, NoBirth)

 -

Will spawn a group with a specified index number.

-

RAT.SpawnZoneTable

 - -

RAT:StopRepeat()

 -

Stop the SPAWN InitRepeat function (EVENT handler for takeoff, land and engine shutdown)

-

RAT.Takeoff

 - -

RAT.TweakedTemplate

 - -

RAT.UnControlled

 - -

RAT.UnitsAbsolutePositions

 - -

RAT.UnitsRelativePositions

 - -

RAT:_CountAliveUnits()

 - -

RAT:_GetGroupCategoryID(SpawnPrefix)

 -

Gets the CategoryID of the Group with the given SpawnPrefix

-

RAT:_GetGroupCoalitionID(SpawnPrefix)

 -

Gets the CoalitionID of the Group with the given SpawnPrefix

-

RAT:_GetGroupCountryID(SpawnPrefix)

 -

Gets the CountryID of the Group with the given SpawnPrefix

-

RAT:_GetLastIndex()

 -

Return the last maximum index that can be used.

-

RAT:_GetPrefixFromGroup(SpawnGroup)

 -

Return the prefix of a SpawnUnit.

-

RAT:_GetPrefixFromGroupName(SpawnGroupName)

 -

Return the prefix of a spawned group.

-

RAT:_GetSpawnIndex(SpawnIndex)

 -

Get the next index of the groups to be spawned.

-

RAT:_GetTemplate(SpawnTemplatePrefix)

 -

Gets the Group Template from the ME environment definition.

-

RAT:_InitializeSpawnGroups(SpawnIndex)

 -

Initalize the SpawnGroups collection.

-

RAT:_OnBirth(EventData)

 - -

RAT:_OnDeadOrCrash(EventData)

 - -

RAT:_OnEngineShutDown(EventData)

 -

Will detect AIR Units shutting down their engines ...

-

RAT:_OnLand(EventData)

 -

Will detect AIR Units landing...

-

RAT:_OnTakeOff(EventData)

 -

Will detect AIR Units taking off...

-

RAT:_Prepare(SpawnTemplatePrefix, SpawnIndex)

 -

Prepares the new Group Template.

-

RAT:_RandomizeRoute(SpawnIndex)

 -

Private method randomizing the routes.

-

RAT:_RandomizeTemplate(SpawnIndex)

 -

Private method that randomizes the template of the group.

-

RAT:_RandomizeZones(SpawnIndex)

 -

Private method that randomizes the Core.Zones where the Group will be spawned.

-

RAT:_Scheduler()

 -

This function is called automatically by the Spawning scheduler.

-

RAT:_SetInitialPosition(SpawnIndex)

 -

Private method that sets the DCS#Vec2 where the Group will be spawned.

-

RAT:_SpawnCleanUpScheduler()

 -

Schedules the CleanUp of Groups

-

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

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

RAT.ClassID

 -

The ID number of the class.

-

RAT.ClassName

 -

The name of the class.

-

RAT.ClassNameAndID

 -

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

-

RAT:ClearState(Object, StateName)

 -

Clear the state of an object.

-

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

 -

Creation of a Birth Event.

-

RAT:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

 -

Creation of a Crash Event.

-

RAT:CreateEventDead(EventTime, Initiator, IniObjectCategory)

 -

Creation of a Dead Event.

-

RAT:CreateEventDynamicCargoLoaded(DynamicCargo)

 -

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

-

RAT:CreateEventDynamicCargoRemoved(DynamicCargo)

 -

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

-

RAT:CreateEventDynamicCargoUnloaded(DynamicCargo)

 -

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

-

RAT:CreateEventNewDynamicCargo(DynamicCargo)

 -

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

-

RAT:CreateEventPlayerEnterAircraft(PlayerUnit)

 -

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

-

RAT:CreateEventRemoveUnit(EventTime, Initiator)

 -

Creation of a Remove Unit Event.

-

RAT:CreateEventTakeoff(EventTime, Initiator)

 -

Creation of a Takeoff Event.

-

RAT:CreateEventUnitLost(EventTime, Initiator)

 -

Creation of a Crash Event.

-

RAT:E(Arguments)

 -

Log an exception which will be traced always.

-

RAT:EventDispatcher()

 -

Returns the event dispatcher

-

RAT:EventRemoveAll()

 -

Remove all subscribed events

-

RAT:F(Arguments)

 -

Trace a function call.

-

RAT:F2(Arguments)

 -

Trace a function call level 2.

-

RAT:F3(Arguments)

 -

Trace a function call level 3.

-

RAT:GetClassID()

 -

Get the ClassID of the class instance.

-

RAT:GetClassName()

 -

Get the ClassName of the class instance.

-

RAT:GetClassNameAndID()

 -

Get the ClassName + ClassID of the class instance.

-

RAT:GetEventPriority()

 -

Get the Class Core.Event processing Priority.

-

RAT:GetParent(Child, FromClass)

 -

This is the worker method to retrieve the Parent class.

-

RAT:GetState(Object, Key)

 -

Get a Value given a Key from the Object.

-

RAT:HandleEvent(EventID, EventFunction)

 -

Subscribe to a DCS Event.

-

RAT:I(Arguments)

 -

Log an information which will be traced always.

-

RAT:Inherit(Child, Parent)

 -

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

-

RAT:IsInstanceOf(ClassName)

 -

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

-

RAT:IsTrace()

 -

Enquires if tracing is on (for the class).

-

RAT:New()

 -

BASE constructor.

-

RAT:OnEvent(EventData)

 -

Occurs when an Event for an object is triggered.

-

RAT:OnEventBDA(EventData)

 -

BDA.

-

RAT:OnEventBaseCaptured(EventData)

 -

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

-

RAT:OnEventBirth(EventData)

 -

Occurs when any object is spawned into the mission.

-

RAT:OnEventCrash(EventData)

 -

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

-

RAT:OnEventDead(EventData)

 -

Occurs when an object is dead.

-

RAT:OnEventDetailedFailure(EventData)

 -

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

-

RAT:OnEventDiscardChairAfterEjection(EventData)

 -

Discard chair after ejection.

-

RAT:OnEventDynamicCargoLoaded(EventData)

 -

Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.

-

RAT:OnEventDynamicCargoRemoved(EventData)

 -

Occurs when a dynamic cargo crate is removed.

-

RAT:OnEventDynamicCargoUnloaded(EventData)

 -

Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.

-

RAT:OnEventEjection(EventData)

 -

Occurs when a pilot ejects from an aircraft -Have a look at the class Core.Event#EVENT as these are just the prototypes.

-

RAT:OnEventEngineShutdown(EventData)

 -

Occurs when any aircraft shuts down its engines.

-

RAT:OnEventEngineStartup(EventData)

 -

Occurs when any aircraft starts its engines.

-

RAT:OnEventHit(EventData)

 -

Occurs whenever an object is hit by a weapon.

-

RAT:OnEventHumanFailure(EventData)

 -

Occurs when any system fails on a human controlled aircraft.

-

RAT:OnEventKill(EventData)

 -

Occurs on the death of a unit.

-

RAT:OnEventLand(EventData)

 -

Occurs when an aircraft lands at an airbase, farp or ship -Have a look at the class Core.Event#EVENT as these are just the prototypes.

-

RAT:OnEventLandingAfterEjection(EventData)

 -

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

-

RAT:OnEventLandingQualityMark(EventData)

 -

Landing quality mark.

-

RAT:OnEventMarkAdded(EventData)

 -

Occurs when a new mark was added.

-

RAT:OnEventMarkChange(EventData)

 -

Occurs when a mark text was changed.

-

RAT:OnEventMarkRemoved(EventData)

 -

Occurs when a mark was removed.

-

RAT:OnEventMissionEnd(EventData)

 -

Occurs when a mission ends -Have a look at the class Core.Event#EVENT as these are just the prototypes.

-

RAT:OnEventMissionStart(EventData)

 -

Occurs when a mission starts -Have a look at the class Core.Event#EVENT as these are just the prototypes.

-

RAT:OnEventNewDynamicCargo(EventData)

 -

Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.

-

RAT:OnEventParatrooperLanding(EventData)

 -

Weapon add.

-

RAT:OnEventPilotDead(EventData)

 -

Occurs when the pilot of an aircraft is killed.

-

RAT:OnEventPlayerEnterAircraft(EventData)

 -

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

-

RAT:OnEventPlayerEnterUnit(EventData)

 -

Occurs when any player assumes direct control of a unit.

-

RAT:OnEventPlayerLeaveUnit(EventData)

 -

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

-

RAT:OnEventRefueling(EventData)

 -

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

-

RAT:OnEventRefuelingStop(EventData)

 -

Occurs when an aircraft is finished taking fuel.

-

RAT:OnEventScore(EventData)

 -

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

-

RAT:OnEventShootingEnd(EventData)

 -

Occurs when any unit stops firing its weapon.

-

RAT:OnEventShootingStart(EventData)

 -

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

-

RAT:OnEventShot(EventData)

 -

Occurs whenever any unit in a mission fires a weapon.

-

RAT:OnEventTakeoff(EventData)

 -

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

-

RAT:OnEventTriggerZone(EventData)

 -

Trigger zone.

-

RAT:OnEventUnitLost(EventData)

 -

Occurs when the game thinks an object is destroyed.

-

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

 -

Schedule a new time event.

-

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

 -

Schedule a new time event.

-

RAT:ScheduleStop(SchedulerID)

 -

Stops the Schedule.

-

RAT.Scheduler

 -

The scheduler object.

-

RAT:SetEventPriority(EventPriority)

 -

Set the Class Core.Event processing Priority.

-

RAT:SetState(Object, Key, Value)

 -

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

-

RAT:T(Arguments)

 -

Trace a function logic level 1.

-

RAT:T2(Arguments)

 -

Trace a function logic level 2.

-

RAT:T3(Arguments)

 -

Trace a function logic level 3.

-

RAT:TraceAll(TraceAll)

 -

Trace all methods in MOOSE

-

RAT:TraceClass(Class)

 -

Set tracing for a class

-

RAT:TraceClassMethod(Class, Method)

 -

Set tracing for a specific method of class

-

RAT:TraceLevel(Level)

 -

Set trace level

-

RAT:TraceOff()

 -

Set trace off.

-

RAT:TraceOn()

 -

Set trace on.

-

RAT: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.

-

RAT:UnHandleEvent(EventID)

 -

UnSubscribe to a DCS event.

-

RAT._

 - -

RAT:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 -

Trace a function call.

-

RAT:_Serialize(Arguments)

 -

(Internal) Serialize arguments

-

RAT:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 -

Trace a function logic.

-

RAT.__

 - -

RAT:onEvent(event)

 -

The main event handling function...
@@ -14017,11716 +12250,6 @@ Initializes the ratcraft array and group menu.

-
-

Field(s)

-
-
-
- - #table -RAT.ATC - -

RAT ATC.

- -
- -
-
-
- - #boolean -RAT.ATCswitch - -

Enable/disable ATC if set to true/false.

- -
- -
-
-
- - #number -RAT.AlphaDescent - -

Default angle of descenti in degrees. A value of 3.6 follows the 3:1 rule of 3 miles of travel and 1000 ft descent.

- -
- -
-
-
- - #string -RAT.ClassName - -

Name of the Class.

- -
- -
-
-
- - #boolean -RAT.Debug - -

Turn debug messages on or off.

- -
- -
-
-
- - #number -RAT.FLcruise - -

Cruise altitude of aircraft. Default FL200 for planes and F005 for helos.

- -
- -
-
-
- - #number -RAT.FLmaxuser - -

Maximum flight level set by user.

- -
- -
-
-
- - #number -RAT.FLminuser - -

Minimum flight level set by user.

- -
- -
-
-
- - #number -RAT.FLuser - -

Flight level set by users explicitly.

- -
- -
-
-
- - #table -RAT.Menu - -

F10 menu items for this RAT object.

- -
- -
-
-
- - #string -RAT.MenuF10 - -

Main F10 menu.

- -
- -
-
-
- - #number -RAT.Ndeparture_Airports - -

Number of departure airports set via SetDeparture().

- -
- -
-
-
- - #number -RAT.Ndeparture_Zones - -

Number of departure zones set via SetDeparture.

- -
- -
-
-
- - #number -RAT.Ndestination_Airports - -

Number of destination airports set via SetDestination().

- -
- -
-
-
- - #number -RAT.Ndestination_Zones - -

Number of destination zones set via SetDestination().

- -
- -
-
-
- - #table -RAT.ROE - -

RAT rules of engagement.

- -
- -
-
-
- - #table -RAT.ROT - -

RAT reaction to threat.

- -
- -
-
-
- - #boolean -RAT.SpawnUnControlled - - - - -

This is used in the SPAWN:SpawnWithIndex() function. Some values are overwritten there!

- -
- -
-
-
- - #string -RAT.SubMenuName - -

Submenu name for RAT object.

- -
- -
-
-
- - #number -RAT.Tinactive - -

Time in seconds after which inactive units will be destroyed. Default is 300 seconds.

- -
- -
-
-
- - #number -RAT.Vclimb - -

Default climb rate in ft/min.

- -
- -
-
-
- - #number -RAT.Vcruisemax - -

Max cruise speed in m/s (250 m/s = 900 km/h = 486 kt) set by user.

- -
- -
-
-
- - #number -RAT.activate_delay - -

Delay in seconds before first uncontrolled group is activated. Default is 5 seconds.

- -
- -
-
-
- - #number -RAT.activate_delta - -

Time interval in seconds between activation of uncontrolled groups. Default is 5 seconds.

- -
- -
-
-
- - #number -RAT.activate_frand - -

Randomization factor of time interval (activate_delta) between activating uncontrolled groups. Default is 0.

- -
- -
-
-
- - #number -RAT.activate_max - -

Maximum number of uncontrolled aircraft, which will be activated at the same time. Default is 1.

- -
- -
-
-
- - #boolean -RAT.activate_uncontrolled - -

If true, uncontrolled are activated randomly after certain time intervals.

- -
- -
-
-
- - -RAT.actype - - - -
- -
-
-
- - #boolean -RAT.addfriendlydepartures - -

Add all friendly airports to departures.

- -
- -
-
-
- - #boolean -RAT.addfriendlydestinations - -

Add all friendly airports to destinations.

- -
- -
-
-
- - #table -RAT.aircraft - -

Table which holds the basic aircraft properties (speed, range, ...).

- -
- -
-
-
- - #table -RAT.airports - -

All airports of friedly coalitions.

- -
- -
-
-
- - #table -RAT.airports_map - -

All airports available on current map (Caucasus, Nevada, Normandy, ...).

- -
- -
-
-
- - #string -RAT.alias - -

Alias for spawned group.

- -
- -
-
-
- - #number -RAT.alive - -

Number of groups which are alive.

- -
- -
-
-
- - #table -RAT.cat - - - -
- -
-
-
- - #string -RAT.category - -

Category of aircarft: "plane" or "heli".

- -
- -
-
-
- - #boolean -RAT.checkonrunway - -

Aircraft are checked if they were accidentally spawned on the runway. Default is true.

- -
- -
-
-
- - #boolean -RAT.checkontop - -

Aircraft are checked if they were accidentally spawned on top of another unit. Default is true.

- -
- -
-
-
- - #table -RAT.coal - -

RAT friendly coalitions.

- -
- -
-
-
- - #number -RAT.coalition - -

Coalition of spawn group template.

- -
- -
-
-
- - #boolean -RAT.commute - -

Aircraft commute between departure and destination, i.e. when respawned the departure airport becomes the new destiation.

- -
- -
-
-
- - #boolean -RAT.continuejourney - -

Aircraft will continue their journey, i.e. get respawned at their destination with a new random destination.

- -
- -
-
-
- - #number -RAT.country - -

Country of spawn group template.

- -
- -
-
-
- - #table -RAT.ctable - -

Table with the valid coalitions from choice self.friendly.

- -
- -
-
-
- - Core.Zone#ZONE -RAT.departure_Azone - -

Zone containing the departure airports.

- -
- -
-
-
- - #table -RAT.departure_ports - -

Array containing the names of the destination airports or zones.

- -
- -
-
-
- - #boolean -RAT.despawnair - -

If true, aircraft are despawned when they reach their destination zone. Default.

- -
- -
-
-
- - Core.Zone#ZONE -RAT.destination_Azone - -

Zone containing the destination airports.

- -
- -
-
-
- - #table -RAT.destination_ports - -

Array containing the names of the destination airports or zones.

- -
- -
-
-
- - #boolean -RAT.destinationzone - -

Destination is a zone and not an airport.

- -
- -
-
-
- - #boolean -RAT.eplrs - -

If true, turn on EPLSR datalink for the RAT group.

- -
- -
-
-
- - #table -RAT.excluded_ports - -

Array containing the names of explicitly excluded airports.

- -
- -
-
-
- - #boolean -RAT.f10menu - -

If true, add an F10 radiomenu for RAT. Default is false.

- -
- -
-
-
- - #number -RAT.frequency - -

Radio frequency used by the RAT groups.

- -
- -
-
-
- - #string -RAT.friendly - -

Possible departure/destination airport: all=blue+red+neutral, same=spawn+neutral, spawnonly=spawn, blue=blue+neutral, blueonly=blue, red=red+neutral, redonly=red.

- -
- -
-
-
- - #number -RAT.groupsize - -

Number of aircraft in group.

- -
- -
-
-
- - #string -RAT.homebase - -

Home base for commute and return zone. Aircraft will always return to this base but otherwise travel in a star shaped way.

- -
- -
-
-
- - #string -RAT.id - -

Some ID to identify who we are in output of the DCS.log file.

- -
- -
-
-
- - #boolean -RAT.immortal - -

If true, aircraft are spawned as immortal.

- -
- -
-
-
- - #boolean -RAT.invisible - -

If true aircraft are set to invisible for other AI forces.

- -
- -
-
-
- - #number -RAT.landing - -

Landing type. Determines if we actually land at an airport or treat it as zone.

- -
- -
-
-
- - #string -RAT.livery - -

Livery of the aircraft set by user.

- -
- -
-
-
- - #number -RAT.markerid - -

Running number of placed markers on the F10 map.

- -
- -
-
-
- - #table -RAT.markerids - -

Array with marker IDs.

- -
- -
-
-
- - #number -RAT.maxdist - -

Max distance from departure to destination in meters. Default 5000 km.

- -
- -
-
-
- - #number -RAT.mindist - -

Min distance from departure to destination in meters. Default 5 km.

- -
- -
-
-
- - #string -RAT.modulation - -

Ratio modulation. Either "FM" or "AM".

- -
- -
-
-
- - #number -RAT.ngroups - -

Number of groups to be spawned in total.

- -
- -
-
-
- - #boolean -RAT.norespawn - -

Aircraft will not be respawned after they have finished their route.

- -
- -
-
-
- - #string -RAT.onboardnum - -

Sets the onboard number prefix. Same as setting "TAIL #" in the mission editor.

- -
- -
-
-
- - #number -RAT.onboardnum0 - -

(Optional) Starting value of the automatically appended numbering of aircraft within a flight. Default is 1.

- -
- -
-
-
- - #number -RAT.onrunwaymaxretry - -

Number of respawn retries (on ground) at other airports if a group gets accidentally spawned on the runway. Default is 3.

- -
- -
-
-
- - #number -RAT.onrunwayradius - -

Distance (in meters) from a runway spawn point until a unit is considered to have accidentally been spawned on a runway. Default is 75 m.

- -
- -
-
-
- - #number -RAT.ontopradius - -

Radius in meters until which a unit is considered to be on top of another. Default is 2 m.

- -
- -
-
-
- - #number -RAT.parkingscanradius - -

Radius in meters until which parking spots are scanned for obstacles like other units, statics or scenery.

- -
- -
-
-
- - #boolean -RAT.parkingscanscenery - -

If true, area around parking spots is scanned for scenery objects. Default is false.

- -
- -
-
-
- - #boolean -RAT.parkingverysafe - -

If true, parking spots are considered as non-free until a possible aircraft has left and taken off. Default false.

- -
- -
-
-
- - #boolean -RAT.placemarkers - -

Place markers of waypoints on F10 map.

- -
- -
-
-
- - #boolean -RAT.radio - -

If true/false disables radio messages from the RAT groups.

- -
- -
-
-
- - #boolean -RAT.random_departure - -

By default a random friendly airport is chosen as departure.

- -
- -
-
-
- - #boolean -RAT.random_destination - -

By default a random friendly airport is chosen as destination.

- -
- -
-
-
- - #table -RAT.ratcraft - -

Array with the spawned RAT aircraft.

- -
- -
-
-
- - #boolean -RAT.reportstatus - -

Aircraft report status.

- -
- -
-
-
- - #boolean -RAT.respawn_after_crash - -

Aircraft will be respawned after a crash, e.g. when they get shot down.

- -
- -
-
-
- - #boolean -RAT.respawn_after_takeoff - -

Aircraft will be respawned directly after take-off.

- -
- -
-
-
- - #boolean -RAT.respawn_at_landing - -

Respawn aircraft the moment they land rather than at engine shutdown.

- -
- -
-
-
- - #number -RAT.respawn_delay - -

Delay in seconds until a repawn happens.

- -
- -
-
-
- - #boolean -RAT.respawn_inair - -

Aircraft are allowed to spawned in air if they cannot be respawned on ground because there is not free parking spot. Default is true.

- -
- -
-
-
- - #table -RAT.return_zones - -

Array containing the names of the return zones.

- -
- -
-
-
- - #boolean -RAT.returnzone - -

Zone where aircraft will fly to before returning to their departure airport.

- -
- -
-
-
- - #string -RAT.roe - -

ROE of spawned groups, default is weapon hold (this is a peaceful class for civil aircraft or ferry missions). Possible: "hold", "return", "free".

- -
- -
-
-
- - #string -RAT.rot - -

ROT of spawned groups, default is no reaction. Possible: "noreaction", "passive", "evade".

- -
- -
-
-
- - #string -RAT.skill - -

Skill of AI.

- -
- -
-
-
- - #number -RAT.spawndelay - -

Delay time in seconds before first spawning happens.

- -
- -
-
-
- - #boolean -RAT.spawninitialized - -

If RAT:Spawn() was already called this RAT object is set to true to prevent users to call it again.

- -
- -
-
-
- - #number -RAT.spawninterval - -

Interval between spawning units/groups. Note that we add a randomization of 50%.

- -
- -
-
-
- - #boolean -RAT.starshape - -

If true, aircraft travel A-->B-->A-->C-->A-->D... for commute.

- -
- -
-
-
- - #table -RAT.status - -

RAT aircraft status.

- -
- -
-
-
- - #number -RAT.statusinterval - -

Intervall between status checks (and reports if enabled).

- -
- -
-
-
- - #number -RAT.takeoff - -

Takeoff type. 0=coldorhot.

- -
- -
-
-
- - Wrapper.Group#GROUP -RAT.templategroup - -

Group serving as template for the RAT aircraft.

- -
- -
-
-
- - Wrapper.Airbase#AIRBASE.TerminalType -RAT.termtype - -

Type of terminal to be used when spawning at an airbase.

- -
- -
-
-
- - #boolean -RAT.uncontrolled - -

If true aircraft are spawned in uncontrolled state and will only sit on their parking spots. They can later be activated.

- -
- -
-
-
- - #table -RAT.unit - -

RAT unit conversions.

- -
- -
-
-
- - #table -RAT.version - -

RAT version.

- -
- -
-
-
- - #table -RAT.waypointdescriptions - -

Table with strings for waypoint descriptions of markers.

- -
- -
-
-
- - #table -RAT.waypointstatus - -

Table with strings of waypoint status.

- -
- -
-
-
- - #table -RAT.wp - -

RAT waypoint type.

- -
- -
-
-

Function(s)

-
-
- -
-

RAT:GetCoordinate()

-
- -

Get the Coordinate of the Group that is Late Activated as the template for the SPAWN object.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Return value:

-
-
-

Core.Point#COORDINATE:

-
-
- -

The Coordinate

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

RAT:GetFirstAliveGroup()

-
- -

Will find the first alive Wrapper.Group it has spawned, and return the alive Wrapper.Group object and the first Index where the first alive Wrapper.Group object has been found.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Return values:

-
-
-

Wrapper.Group#GROUP, #number:

-
-
- -

The Wrapper.Group object found, the new Index where the group was found.

- -
-
-

#nil, #nil:

-
-
- -

When no group is found, #nil is returned.

- -
-
-

Usage:

- 

-  -- Find the first alive @{Wrapper.Group} object of the SpawnPlanes SPAWN object @{Wrapper.Group} collection that it has spawned during the mission.
-  local GroupPlane, Index = SpawnPlanes:GetFirstAliveGroup()
-  while GroupPlane ~= nil do
-    -- Do actions with the GroupPlane object.
-    GroupPlane, Index = SpawnPlanes:GetNextAliveGroup( Index )
-  end
-
- -
- -
-
- -
- -
-

RAT:GetGroupFromIndex(SpawnIndex)

-
- -

Get the group from an index.

- - -

Returns the group from the SpawnGroups list. -If no index is given, it will return the first group in the list.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #number - SpawnIndex -

-
-
- -

The index of the group to return.

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

self

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

RAT:GetLastAliveGroup()

-
- -

Will find the last alive Wrapper.Group object, and will return a reference to the last live Wrapper.Group object and the last Index where the last alive Wrapper.Group object has been found.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Return values:

-
-
-

Wrapper.Group#GROUP, #number:

-
-
- -

The last alive Wrapper.Group object found, the last Index where the last alive Wrapper.Group object was found.

- -
-
-

#nil, #nil:

-
-
- -

When no alive Wrapper.Group object is found, #nil is returned.

- -
-
-

Usage:

- 

-  -- Find the last alive @{Wrapper.Group} object of the SpawnPlanes SPAWN object @{Wrapper.Group} collection that it has spawned during the mission.
-  local GroupPlane, Index = SpawnPlanes:GetLastAliveGroup()
-  if GroupPlane then -- GroupPlane can be nil!!!
-    -- Do actions with the GroupPlane object.
-  end
-
- -
- -
-
- -
- -
-

RAT:GetNextAliveGroup(SpawnIndexStart)

-
- -

Will find the next alive Wrapper.Group object from a given Index, and return a reference to the alive Wrapper.Group object and the next Index where the alive Wrapper.Group has been found.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #number - SpawnIndexStart -

-
-
- -

A Index holding the start position to search from. This method can also be used to find the first alive Wrapper.Group object from the given Index.

- -
-
-

Return values:

-
-
-

Wrapper.Group#GROUP, #number:

-
-
- -

The next alive Wrapper.Group object found, the next Index where the next alive Wrapper.Group object was found.

- -
-
-

#nil, #nil:

-
-
- -

When no alive Wrapper.Group object is found from the start Index position, #nil is returned.

- -
-
-

Usage:

- 

-  -- Find the first alive @{Wrapper.Group} object of the SpawnPlanes SPAWN object @{Wrapper.Group} collection that it has spawned during the mission.
-  local GroupPlane, Index = SpawnPlanes:GetFirstAliveGroup()
-  while GroupPlane ~= nil do
-    -- Do actions with the GroupPlane object.
-    GroupPlane, Index = SpawnPlanes:GetNextAliveGroup( Index )
-  end
-
- -
- -
-
- -
- -
-

RAT:GetSpawnIndexFromGroup(SpawnGroup)

-
- -

Get the index from a given group.

- - -

The function will search the name of the group for a #, and will return the number behind the #-mark.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- SpawnGroup -

-
-
-

-
-
-
- -
-
- -
- -
-

RAT:InitAIOff()

-
- -

Turns the AI Off for the Wrapper.Group when spawning.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

The SPAWN object

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

RAT:InitAIOn()

-
- -

Turns the AI On for the Wrapper.Group when spawning.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

The SPAWN object

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

RAT:InitAIOnOff(AIOnOff)

-
- -

Turns the AI On or Off for the Wrapper.Group when spawning.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #boolean - AIOnOff -

-
-
- -

A value of true sets the AI On, a value of false sets the AI Off.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

The SPAWN object

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

RAT:InitAirbase(AirbaseName, Takeoff, TerminalType)

-
- -

Set spawns to happen at a particular airbase.

- - -

Only for aircraft, of course.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- #string - AirbaseName -

-
-
- -

Name of the airbase.

- -
-
-
-
-

- #number - Takeoff -

-
-
- -

(Optional) Takeoff type. Can be SPAWN.Takeoff.Hot (default), SPAWN.Takeoff.Cold or SPAWN.Takeoff.Runway.

- -
-
-
-
-

- #number - TerminalType -

-
-
- -

(Optional) The terminal type.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:InitArray(SpawnAngle, SpawnWidth, SpawnDeltaX, SpawnDeltaY)

-
- -

Makes the groups visible before start (like a battalion).

- - -

The method will take the position of the group as the first position in the array. -CAUTION: this directive will NOT work with OnSpawnGroup function.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- #number - SpawnAngle -

-
-
- -

The angle in degrees how the groups and each unit of the group will be positioned.

- -
-
-
-
-

- #number - SpawnWidth -

-
-
- -

The amount of Groups that will be positioned on the X axis.

- -
-
-
-
-

- #number - SpawnDeltaX -

-
-
- -

The space between each Group on the X-axis.

- -
-
-
-
-

- #number - SpawnDeltaY -

-
-
- -

The space between each Group on the Y-axis.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 

-  -- Define an array of Groups.
-  Spawn_BE_Ground = SPAWN:New( 'BE Ground' )
-                         :InitLimit( 2, 24 )
-                         :InitArray( 90, 10, 100, 50 )
-
- -
- -
-
- -
- -
-

RAT:InitCallSign(ID, Name, Minor, Major)

-
- -

[BLUE AIR only!] This method sets a specific callsign for a spawned group.

- - -

Use for a group with one unit only!

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- #number - ID -

-
-
- -

ID of the callsign enumerator, e.g. CALLSIGN.Tanker.Texaco - - resulting in e.g. Texaco-2-1

- -
-
-
-
-

- #string - Name -

-
-
- -

Name of this callsign as it cannot be determined from the ID because of the dependency on the task type of the plane, and the plane type. E.g. "Texaco"

- -
-
-
-
-

- #number - Minor -

-
-
- -

Minor number, i.e. the unit number within the group, e.g 2 - resulting in e.g. Texaco-2-1

- -
-
-
-
-

- #number - Major -

-
-
- -

Major number, i.e. the group number of this name, e.g. 1 - resulting in e.g. Texaco-2-1

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:InitCategory(Category)

-
- -

Sets category ID of the group.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #number - Category -

-
-
- -

Category id.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:InitCleanUp(SpawnCleanUpInterval)

-
- -

Delete groups that have not moved for X seconds - AIR ONLY!!! -DO NOT USE ON GROUPS THAT DO NOT MOVE OR YOUR SERVER WILL BURN IN HELL (Pikes - April 2020) -When groups are still alive and have become inactive due to damage and are unable to contribute anything, then this group will be removed at defined intervals in seconds.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #string - SpawnCleanUpInterval -

-
-
- -

The interval to check for inactive groups within seconds.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 

-  Spawn_Helicopter:InitCleanUp( 20 )  -- CleanUp the spawning of the helicopters every 20 seconds when they become inactive.
-
- -
- -
-
- -
- -
-

RAT:InitCoalition(Coalition)

-
- -

Sets the coalition of the spawned group.

- - -

Note that it might be necessary to also set the country explicitly!

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- DCS#coalition.side - Coalition -

-
-
- -

Coalition of the group as number of enumerator:

- - - -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:InitCountry(Country)

-
- -

Sets the country of the spawn group.

- - -

Note that the country determines the coalition of the group depending on which country is defined to be on which side for each specific mission!

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #number - Country -

-
-
- -

Country id as number or enumerator:

- - - - -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:InitDelayOff()

-
- -

Turns the Delay Off for the Wrapper.Group when spawning.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

The SPAWN object

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

RAT:InitDelayOn()

-
- -

Turns the Delay On for the Wrapper.Group when spawning with #SpawnScheduled().

- - -

In effect then the 1st group will only be spawned -after the number of seconds given in SpawnScheduled as arguments, and not immediately.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

The SPAWN object

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

RAT:InitDelayOnOff(DelayOnOff)

-
- - - -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- DelayOnOff -

-
-
-

-
-
-
- -
-
- -
- -
-

RAT:InitGroupHeading(HeadingMin, HeadingMax, unitVar)

-
- -

Defines the heading of the overall formation of the new spawned group.

- - -

The heading can be given as one fixed degree, or can be randomized between minimum and maximum degrees. -The Group's formation as laid out in its template will be rotated around the first unit in the group -Group individual units facings will rotate to match. If InitHeading is also applied to this SPAWN then that will take precedence for individual unit facings. -Note that InitGroupHeading does not rotate the groups route; only its initial facing!

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- #number - HeadingMin -

-
-
- -

The minimum or fixed heading in degrees.

- -
-
-
-
-

- #number - HeadingMax -

-
-
- -

(optional) The maximum heading in degrees. This there is no maximum heading, then the heading for the group will be HeadingMin.

- -
-
-
-
-

- #number - unitVar -

-
-
- -

(optional) Individual units within the group will have their heading randomized by +/- unitVar degrees. Default is zero.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 

-mySpawner = SPAWN:New( ... )
-
-  -- Spawn the Group with the formation rotated +100 degrees around unit #1, compared to the mission template.
-  mySpawner:InitGroupHeading( 100 )
-
-  -- Spawn the Group with the formation rotated units between +100 and +150 degrees around unit #1, compared to the mission template, and with individual units varying by +/- 10 degrees from their templated facing.
-  mySpawner:InitGroupHeading( 100, 150, 10 )
-
-  -- Spawn the Group with the formation rotated -60 degrees around unit #1, compared to the mission template, but with all units facing due north regardless of how they were laid out in the template.
-  mySpawner:InitGroupHeading(-60):InitHeading(0)
-  -- or
-  mySpawner:InitHeading(0):InitGroupHeading(-60)
-
- -
- -
-
- -
- -
-

RAT:InitGrouping(Grouping)

-
- -

When spawning a new group, make the grouping of the units according the InitGrouping setting.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #number - Grouping -

-
-
- -

Indicates the maximum amount of units in the group.

- -
-
-

Return value:

-
-
-

#SPAWN:

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

RAT:InitHeading(HeadingMin, HeadingMax)

-
- -

Defines the Heading for the new spawned units.

- - -

The heading can be given as one fixed degree, or can be randomized between minimum and maximum degrees.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- #number - HeadingMin -

-
-
- -

The minimum or fixed heading in degrees.

- -
-
-
-
-

- #number - HeadingMax -

-
-
- -

(optional) The maximum heading in degrees. This there is no maximum heading, then the heading will be fixed for all units using minimum heading.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 

-  Spawn = SPAWN:New( ... )
-
-  -- Spawn the units pointing to 100 degrees.
-  Spawn:InitHeading( 100 )
-
-  -- Spawn the units pointing between 100 and 150 degrees.
-  Spawn:InitHeading( 100, 150 )
-
- -
- -
-
- -
- -
-

RAT:InitHiddenOnMFD()

-
- -

Hide the group on MFDs (visible to game master slots!).

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

The SPAWN object

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

RAT:InitHiddenOnMap(OnOff)

-
- -

Hide the group on the map view (visible to game master slots!).

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #boolean - OnOff -

-
-
- -

Defaults to true

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

The SPAWN object

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

RAT:InitHiddenOnPlanner()

-
- -

Hide the group on planner (visible to game master slots!).

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

The SPAWN object

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

RAT:InitKeepUnitNames(KeepUnitNames)

-
- -

Keeps the unit names as defined within the mission editor, -but note that anything after a # mark is ignored, -and any spaces before and after the resulting name are removed.

- - -

IMPORTANT! This method MUST be the first used after :New !!!

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #boolean - KeepUnitNames -

-
-
- -

(optional) If true, the unit names are kept, false or not provided create new unit names.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:InitLateActivated(LateActivated)

-
- -

Flags that the spawned groups must be spawned late activated.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #boolean - LateActivated -

-
-
- -

(optional) If true, the spawned groups are late activated.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:InitLimit(SpawnMaxUnitsAlive, SpawnMaxGroups)

-
- -

Stops any more repeat spawns from happening once the UNIT count of Alive units, spawned by the same SPAWN object, exceeds the first parameter.

- - -

Also can stop spawns from happening once a total GROUP still alive is met. -Exceptionally powerful when combined with SpawnSchedule for Respawning. -Note that this method is exceptionally important to balance the performance of the mission. Depending on the machine etc, a mission can only process a maximum amount of units. -If the time interval must be short, but there should not be more Units or Groups alive than a maximum amount of units, then this method should be used... -When a SPAWN.New is executed and the limit of the amount of units alive is reached, then no new spawn will happen of the group, until some of these units of the spawn object will be destroyed.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- #number - SpawnMaxUnitsAlive -

-
-
- -

The maximum amount of units that can be alive at runtime.

- -
-
-
-
-

- #number - SpawnMaxGroups -

-
-
- -

The maximum amount of groups that can be spawned. When the limit is reached, then no more actual spawns will happen of the group. -This parameter is useful to define a maximum amount of airplanes, ground troops, helicopters, ships etc within a supply area. -This parameter accepts the value 0, which defines that there are no maximum group limits, but there are limits on the maximum of units that can be alive at the same time.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 

-  -- NATO helicopters engaging in the battle field.
-  -- This helicopter group consists of one Unit. So, this group will SPAWN maximum 2 groups simultaneously within the DCSRTE.
-  -- There will be maximum 24 groups spawned during the whole mission lifetime. 
-  Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitLimit( 2, 24 )
-
- -
- -
-
- -
- -
-

RAT:InitLivery(Livery)

-
- -

Sets livery of the group.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #string - Livery -

-
-
- -

Livery name. Note that this is not necessarily the same name as displayed in the mission editor.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:InitModex(modex, prefix, postfix)

-
- -

Sets the modex of the first unit of the group.

- - -

If more units are in the group, the number is increased by one with every unit.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- #number - modex -

-
-
- -

Modex of the first unit.

- -
-
-
-
-

- #string - prefix -

-
-
- -

(optional) String to prefix to modex, e.g. for French AdA Modex, eg. -L-102 then "-L-" would be the prefix.

- -
-
-
-
-

- #string - postfix -

-
-
- -

(optional) String to postfix to modex, example tbd.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:InitPositionCoordinate(Coordinate)

-
- -

This method sets a spawn position for the group that is different from the location of the template.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- Core.Point#COORDINATE - Coordinate -

-
-
- -

The position to spawn from

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:InitPositionVec2(Vec2)

-
- -

This method sets a spawn position for the group that is different from the location of the template.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- DCS#Vec2 - Vec2 -

-
-
- -

The position to spawn from

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:InitRadioCommsOnOff(switch)

-
- -

Sets the radio communication on or off.

- - -

Same as checking/unchecking the COMM box in the mission editor.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #number - switch -

-
-
- -

If true (or nil), enables the radio communication. If false, disables the radio for the spawned group.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:InitRadioFrequency(frequency)

-
- -

Sets the radio frequency of the group.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #number - frequency -

-
-
- -

The frequency in MHz.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:InitRadioModulation(modulation)

-
- -

Set radio modulation.

- - -

Default is AM.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #string - modulation -

-
-
- -

Either "FM" or "AM". If no value is given, modulation is set to AM.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:InitRandomizeCallsign()

-
- -

[AIR/Fighter only!] This method randomizes the callsign for a new group.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:InitRandomizePosition(RandomizePosition, OuterRadius, InnerRadius)

-
- -

Randomizes the position of Wrapper.Groups that are spawned within a radius band, given an Outer and Inner radius, from the point that the spawn happens.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- #boolean - RandomizePosition -

-
-
- -

If true, SPAWN will perform the randomization of the Wrapper.Groups position between a given outer and inner radius.

- -
-
-
-
-

- DCS#Distance - OuterRadius -

-
-
- -

(optional) The outer radius in meters where the new group will be spawned.

- -
-
-
-
-

- DCS#Distance - InnerRadius -

-
-
- -

(optional) The inner radius in meters where the new group will NOT be spawned.

- -
-
-

Return value:

-
-
-

#SPAWN:

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

RAT:InitRandomizeRoute(SpawnStartPoint, SpawnEndPoint, SpawnRadius, SpawnHeight)

-
- -

Randomizes the defined route of the SpawnTemplatePrefix group in the ME.

- - -

This is very useful to define extra variation of the behavior of groups.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- #number - SpawnStartPoint -

-
-
- -

is the waypoint where the randomization begins. -Note that the StartPoint = 0 equaling the point where the group is spawned.

- -
-
-
-
-

- #number - SpawnEndPoint -

-
-
- -

is the waypoint where the randomization ends counting backwards. -This parameter is useful to avoid randomization to end at a waypoint earlier than the last waypoint on the route.

- -
-
-
-
-

- #number - SpawnRadius -

-
-
- -

is the radius in meters in which the randomization of the new waypoints, with the original waypoint of the original template located in the middle ...

- -
-
-
-
-

- #number - SpawnHeight -

-
-
- -

(optional) Specifies the additional height in meters that can be added to the base height specified at each waypoint in the ME.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- - - -
-
-

Usage:

- 

-  -- NATO helicopters engaging in the battle field.
-  -- The KA-50 has waypoints Start point ( =0 or SP ), 1, 2, 3, 4, End point (= 5 or DP).
-  -- Waypoints 2 and 3 will only be randomized. The others will remain on their original position with each new spawn of the helicopter.
-  -- The randomization of waypoint 2 and 3 will take place within a radius of 2000 meters.
-  Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitRandomizeRoute( 2, 2, 2000 )
-
- -
- -
-
- -
- -
-

RAT:InitRandomizeTemplate(SpawnTemplatePrefixTable)

-
- -

This method is rather complicated to understand.

- - -

But I'll try to explain. -This method becomes useful when you need to spawn groups with random templates of groups defined within the mission editor, -but they will all follow the same Template route and have the same prefix name. -In other words, this method randomizes between a defined set of groups the template to be used for each new spawn of a group.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #list<#string> - SpawnTemplatePrefixTable -

-
-
- -

A table with the names of the groups defined within the mission editor, from which one will be chosen when a new group will be spawned.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- - - -
-
-

Usage:

- 

-  -- NATO Tank Platoons invading Gori.
-  -- Choose between 13 different 'US Tank Platoon' configurations for each new SPAWN the Group to be spawned for the
-  -- 'US Tank Platoon Left', 'US Tank Platoon Middle' and 'US Tank Platoon Right' SpawnTemplatePrefixes.
-  -- Each new SPAWN will randomize the route, with a defined time interval of 200 seconds with 40% time variation (randomization) and
-  -- with a limit set of maximum 12 Units alive simultaneously  and 150 Groups to be spawned during the whole mission.
-  Spawn_US_Platoon = { 'US Tank Platoon 1', 'US Tank Platoon 2', 'US Tank Platoon 3', 'US Tank Platoon 4', 'US Tank Platoon 5',
-                       'US Tank Platoon 6', 'US Tank Platoon 7', 'US Tank Platoon 8', 'US Tank Platoon 9', 'US Tank Platoon 10',
-                       'US Tank Platoon 11', 'US Tank Platoon 12', 'US Tank Platoon 13' }
-  Spawn_US_Platoon_Left = SPAWN:New( 'US Tank Platoon Left' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplate( Spawn_US_Platoon ):InitRandomizeRoute( 3, 3, 2000 )
-  Spawn_US_Platoon_Middle = SPAWN:New( 'US Tank Platoon Middle' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplate( Spawn_US_Platoon ):InitRandomizeRoute( 3, 3, 2000 )
-  Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplate( Spawn_US_Platoon ):InitRandomizeRoute( 3, 3, 2000 )
- -
- -
-
- -
- -
-

RAT:InitRandomizeTemplatePrefixes(SpawnTemplatePrefixes)

-
- -

Randomize templates to be used as the unit representatives for the Spawned group, defined by specifying the prefix names.

- - -

This method becomes useful when you need to spawn groups with random templates of groups defined within the mission editor, -but they will all follow the same Template route and have the same prefix name. -In other words, this method randomizes between a defined set of groups the template to be used for each new spawn of a group.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #string - SpawnTemplatePrefixes -

-
-
- -

A string or a list of string that contains the prefixes of the groups that are possible unit representatives of the group to be spawned.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- - - -
-
-

Usage:

- 

- -- NATO Tank Platoons invading Gori.
-
-  -- Choose between different 'US Tank Platoon Templates' configurations to be spawned for the
-  -- 'US Tank Platoon Left', 'US Tank Platoon Middle' and 'US Tank Platoon Right' SPAWN objects.
-
-  -- Each new SPAWN will randomize the route, with a defined time interval of 200 seconds with 40% time variation (randomization) and
-  -- with a limit set of maximum 12 Units alive simultaneously  and 150 Groups to be spawned during the whole mission.
-
-  Spawn_US_Platoon_Left = SPAWN:New( 'US Tank Platoon Left' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplatePrefixes( "US Tank Platoon Templates" ):InitRandomizeRoute( 3, 3, 2000 )
-  Spawn_US_Platoon_Middle = SPAWN:New( 'US Tank Platoon Middle' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplatePrefixes( "US Tank Platoon Templates" ):InitRandomizeRoute( 3, 3, 2000 )
-  Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplatePrefixes( "US Tank Platoon Templates" ):InitRandomizeRoute( 3, 3, 2000 )
-
- -
- -
-
- -
- -
-

RAT:InitRandomizeTemplateSet(SpawnTemplateSet)

-
- -

Randomize templates to be used as the unit representatives for the Spawned group, defined using a SET_GROUP object.

- - -

This method becomes useful when you need to spawn groups with random templates of groups defined within the mission editor, -but they will all follow the same Template route and have the same prefix name. -In other words, this method randomizes between a defined set of groups the template to be used for each new spawn of a group.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- Core.Set#SET_GROUP - SpawnTemplateSet -

-
-
- -

A SET_GROUP object set, that contains the groups that are possible unit representatives of the group to be spawned.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- - - -
-
-

Usage:

- 

-  -- NATO Tank Platoons invading Gori.
-
-  -- Choose between different 'US Tank Platoon Template' configurations to be spawned for the
-  -- 'US Tank Platoon Left', 'US Tank Platoon Middle' and 'US Tank Platoon Right' SPAWN objects.
-
-  -- Each new SPAWN will randomize the route, with a defined time interval of 200 seconds with 40% time variation (randomization) and
-  -- with a limit set of maximum 12 Units alive simultaneously  and 150 Groups to be spawned during the whole mission.
-
-  Spawn_US_PlatoonSet = SET_GROUP:New():FilterPrefixes( "US Tank Platoon Templates" ):FilterOnce()
-
-  -- Now use the Spawn_US_PlatoonSet to define the templates using InitRandomizeTemplateSet.
-  Spawn_US_Platoon_Left = SPAWN:New( 'US Tank Platoon Left' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 )
-  Spawn_US_Platoon_Middle = SPAWN:New( 'US Tank Platoon Middle' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 )
-  Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 )
-
- -
- -
-
- -
- -
-

RAT:InitRandomizeUnits(RandomizeUnits, OuterRadius, InnerRadius)

-
- -

Randomizes the UNITs that are spawned within a radius band given an Outer and Inner radius.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- #boolean - RandomizeUnits -

-
-
- -

If true, SPAWN will perform the randomization of the Wrapper.Unit#UNITs position within the group between a given outer and inner radius.

- -
-
-
-
-

- DCS#Distance - OuterRadius -

-
-
- -

(optional) The outer radius in meters where the new group will be spawned.

- -
-
-
-
-

- DCS#Distance - InnerRadius -

-
-
- -

(optional) The inner radius in meters where the new group will NOT be spawned.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- - - -
-
-

Usage:

- 

-  -- NATO helicopters engaging in the battle field.
-  -- UNIT positions of this group will be randomized around the base unit #1 in a circle of 50 to 500 meters.
-  Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitRandomizeUnits( true, 500, 50 )
-
- -
- -
-
- -
- -
-

RAT:InitRandomizeZones(SpawnZoneTable)

-
- -

This method provides the functionality to randomize the spawning of the Groups at a given list of zones of different types.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #table - SpawnZoneTable -

-
-
- -

A table with Core.Zone objects. If this table is given, then each spawn will be executed within the given list of Core.Zones objects.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 

-   -- Create a zone table of the 2 zones.
-   ZoneTable = { ZONE:New( "Zone1" ), ZONE:New( "Zone2" ) }
-
-   Spawn_Vehicle_1 = SPAWN:New( "Spawn Vehicle 1" )
-                          :InitLimit( 10, 10 )
-                          :InitRandomizeRoute( 1, 1, 200 )
-                          :InitRandomizeZones( ZoneTable )
-                          :SpawnScheduled( 5, .5 )
-
- -
- -
-
- -
- -
-

RAT:InitRepeat()

-
- -

For planes and helicopters, when these groups go home and land on their home airbases and FARPs, they normally would taxi to the parking spot, shut-down their engines and wait forever until the Group is removed by the runtime environment.

- - -

This method is used to re-spawn automatically (so no extra call is needed anymore) the same group after it has landed. -This will enable a spawned group to be re-spawned after it lands, until it is destroyed... -Note: When the group is respawned, it will re-spawn from the original airbase where it took off. -So ensure that the routes for groups that respawn, always return to the original airbase, or players may get confused ...

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 

-  -- RU Su-34 - AI Ship Attack
-  -- Re-SPAWN the Group(s) after each landing and Engine Shut-Down automatically.
-  SpawnRU_SU34 = SPAWN:New( 'Su-34' )
-                      :Schedule( 2, 3, 1800, 0.4 )
-                      :SpawnUncontrolled()
-                      :InitRandomizeRoute( 1, 1, 3000 )
-                      :InitRepeatOnEngineShutDown()
-
- -
- -
-
- -
- -
-

RAT:InitRepeatOnEngineShutDown()

-
- -

Respawn after landing when its engines have shut down.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 

-  -- RU Su-34 - AI Ship Attack
-  -- Re-SPAWN the Group(s) after each landing and Engine Shut-Down automatically.
-  SpawnRU_SU34 = SPAWN:New( 'Su-34' )
-                      :SpawnUncontrolled()
-                      :InitRandomizeRoute( 1, 1, 3000 )
-                      :InitRepeatOnEngineShutDown()
-                      :Spawn()
- -
- -
-
- -
- -
-

RAT:InitRepeatOnLanding()

-
- -

Respawn group after landing.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 

-  -- RU Su-34 - AI Ship Attack
-  -- Re-SPAWN the Group(s) after each landing and Engine Shut-Down automatically.
-  SpawnRU_SU34 = SPAWN:New( 'Su-34' )
-                      :InitRandomizeRoute( 1, 1, 3000 )
-                      :InitRepeatOnLanding()
-                      :Spawn()
-
- -
- -
-
- -
- -
-

RAT:InitSADL(Octal)

-
- -

[Airplane - A10-C II only] Set the SADL TN starting number of the Group; each unit of the spawned group will have a consecutive SADL set.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #number - Octal -

-
-
- -

The octal number (digits 1..7, max 4 digits, i.e. 1..7777) to set the SADL to. Every SADL needs to be unique!

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:InitSTN(Octal)

-
- -

[Airplane - F15/16/18/AWACS/B1B/Tanker only] Set the STN Link16 starting number of the Group; each unit of the spawned group will have a consecutive STN set.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #number - Octal -

-
-
- -

The octal number (digits 1..7, max 5 digits, i.e. 1..77777) to set the STN to. Every STN needs to be unique!

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:InitSetUnitAbsolutePositions(Positions)

-
- -

Spawn the UNITs of this group with individual absolute positions and individual headings.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #table - Positions -

-
-
- -

Table of positions, needs to one entry per unit in the group(!). The table contains one table each for each unit, with x,y, and optionally z -absolute positions, and optionally an individual heading.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- - - -
-
-

Usage:

- 

-  -- NATO helicopter group of three units engaging in the battle field.
-  local Positions = { [1] = {x = 0, y = 0, heading = 0}, [2] = {x = 50, y = 50, heading = 90}, [3] = {x = -50, y = 50, heading = 180} }
-  Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitSetUnitAbsolutePositions(Positions)
-
- -
- -
-
- -
- -
-

RAT:InitSetUnitRelativePositions(Positions)

-
- -

Spawn the UNITs of this group with individual relative positions to unit #1 and individual headings.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #table - Positions -

-
-
- -

Table of positions, needs to one entry per unit in the group(!). The table contains one table each for each unit, with x,y, and optionally z -relative positions, and optionally an individual heading.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- - - -
-
-

Usage:

- 

-  -- NATO helicopter group of three units engaging in the battle field.
-  local Positions = { [1] = {x = 0, y = 0, heading = 0}, [2] = {x = 50, y = 50, heading = 90}, [3] = {x = -50, y = 50, heading = 180} }
-  Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitSetUnitRelativePositions(Positions)
-
- -
- -
-
- -
- -
-

RAT:InitSkill(Skill)

-
- -

Sets skill of the group.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #string - Skill -

-
-
- -

Skill, possible values "Average", "Good", "High", "Excellent" or "Random".

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:InitSpeedKnots(Knots)

-
- -

[Airplane] Set the initial speed on spawning in knots.

- - -

Useful when spawning in-air only.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #number - Knots -

-
-
- -

The speed in knots to use.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:InitSpeedKph(KPH)

-
- -

[Airplane] Set the initial speed on spawning in kilometers per hour.

- - -

Useful when spawning in-air only.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #number - KPH -

-
-
- -

The speed in KPH to use.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:InitSpeedMps(MPS)

-
- -

[Airplane] Set the initial speed on spawning in meters per second.

- - -

Useful when spawning in-air only.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #number - MPS -

-
-
- -

The speed in MPS to use.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:InitUnControlled(UnControlled)

-
- -

(AIR) Will spawn a plane group in UnControlled or Controlled mode...

- - -

This will be similar to the uncontrolled flag setting in the ME. -You can use UnControlled mode to simulate planes startup and ready for take-off but aren't moving (yet). -ReSpawn the plane in Controlled mode, and the plane will move...

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #boolean - UnControlled -

-
-
- -

true if UnControlled, false if Controlled.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:New(SpawnTemplatePrefix)

-
- -

Creates the main object to spawn a Wrapper.Group defined in the DCS ME.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #string - SpawnTemplatePrefix -

-
-
- -

is the name of the Group in the ME that defines the Template. Each new group will have the name starting with SpawnTemplatePrefix.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- - - -
-
-

Usages:

-
    - 
  • -- NATO helicopters engaging in the battle field.
-Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' )
    • - 
  • local Plane = SPAWN:New( "Plane" ) -- Creates a new local variable that can initiate new planes with the name "Plane#ddd" using the template "Plane" as defined within the ME.
    • -
- -
- -
-
- -
- -
-

RAT:NewFromTemplate(SpawnTemplate, SpawnTemplatePrefix, SpawnAliasPrefix, NoMooseNamingPostfix)

-
- -

Creates a new SPAWN instance to create new groups based on the provided template.

- - -

This will also register the template for future use.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- #table - SpawnTemplate -

-
-
- -

is the Template of the Group. This must be a valid Group Template structure - see Hoggit Wiki!

- -
-
-
-
-

- #string - SpawnTemplatePrefix -

-
-
- -

[Mandatory] is the name of the template and the prefix of the GROUP on spawn. The name in the template will be overwritten!

- -
-
-
-
-

- #string - SpawnAliasPrefix -

-
-
- -

[Optional] is the prefix that will be given to the GROUP on spawn.

- -
-
-
-
-

- #boolean - NoMooseNamingPostfix -

-
-
- -

[Optional] If true, skip the Moose naming additions (like groupname#001-01) - but you need to ensure yourself no duplicate group names exist!

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 
-- Spawn a P51 Mustang from scratch
-local ttemp =  
-  {
-      ["modulation"] = 0,
-      ["tasks"] = 
-      {
-      }, -- end of ["tasks"]
-      ["task"] = "Reconnaissance",
-      ["uncontrolled"] = false,
-      ["route"] = 
-      {
-          ["points"] = 
-          {
-              [1] = 
-              {
-                  ["alt"] = 2000,
-                  ["action"] = "Turning Point",
-                  ["alt_type"] = "BARO",
-                  ["speed"] = 125,
-                  ["task"] = 
-                  {
-                      ["id"] = "ComboTask",
-                      ["params"] = 
-                      {
-                          ["tasks"] = 
-                          {
-                          }, -- end of ["tasks"]
-                      }, -- end of ["params"]
-                  }, -- end of ["task"]
-                  ["type"] = "Turning Point",
-                  ["ETA"] = 0,
-                  ["ETA_locked"] = true,
-                  ["y"] = 666285.71428571,
-                  ["x"] = -312000,
-                  ["formation_template"] = "",
-                  ["speed_locked"] = true,
-              }, -- end of [1]
-          }, -- end of ["points"]
-      }, -- end of ["route"]
-      ["groupId"] = 1,
-      ["hidden"] = false,
-      ["units"] = 
-      {
-          [1] = 
-          {
-              ["alt"] = 2000,
-              ["alt_type"] = "BARO",
-              ["livery_id"] = "USAF 364th FS",
-              ["skill"] = "High",
-              ["speed"] = 125,
-              ["type"] = "TF-51D",
-              ["unitId"] = 1,
-              ["psi"] = 0,
-              ["y"] = 666285.71428571,
-              ["x"] = -312000,
-              ["name"] = "P51-1-1",
-              ["payload"] = 
-              {
-                  ["pylons"] = 
-                  {
-                  }, -- end of ["pylons"]
-                  ["fuel"] = 340.68,
-                  ["flare"] = 0,
-                  ["chaff"] = 0,
-                  ["gun"] = 100,
-              }, -- end of ["payload"]
-              ["heading"] = 0,
-              ["callsign"] = 
-              {
-                  [1] = 1,
-                  [2] = 1,
-                  ["name"] = "Enfield11",
-                  [3] = 1,
-              }, -- end of ["callsign"]
-              ["onboard_num"] = "010",
-          }, -- end of [1]
-      }, -- end of ["units"]
-      ["y"] = 666285.71428571,
-      ["x"] = -312000,
-      ["name"] = "P51",
-      ["communication"] = true,
-      ["start_time"] = 0,
-      ["frequency"] = 124,
-  } 
-
-
-local mustang = SPAWN:NewFromTemplate(ttemp,"P51D")
--- you MUST set the next three:
-mustang:InitCountry(country.id.FRANCE)
-mustang:InitCategory(Group.Category.AIRPLANE)
-mustang:InitCoalition(coalition.side.BLUE)
-mustang:OnSpawnGroup(
-  function(grp)
-    MESSAGE:New("Group Spawned: "..grp:GetName(),15,"SPAWN"):ToAll()
-  end
-)
-mustang:Spawn()
-
- -
- -
-
- -
- -
-

RAT:NewWithAlias(SpawnTemplatePrefix, SpawnAliasPrefix)

-
- -

Creates a new SPAWN instance to create new groups based on the defined template and using a new alias for each new group.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- #string - SpawnTemplatePrefix -

-
-
- -

is the name of the Group in the ME that defines the Template.

- -
-
-
-
-

- #string - SpawnAliasPrefix -

-
-
- -

is the name that will be given to the Group at runtime.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usages:

-
    - 
  • -- NATO helicopters engaging in the battle field.
-Spawn_BE_KA50 = SPAWN:NewWithAlias( 'BE KA-50@RAMP-Ground Defense', 'Helicopter Attacking a City' )
    • - 
  • local PlaneWithAlias = SPAWN:NewWithAlias( "Plane", "Bomber" ) -- Creates a new local variable that can instantiate new planes with the name "Bomber#ddd" using the template "Plane" as defined within the ME.
    • -
- -
- -
-
- -
- -
-

RAT:OnSpawnGroup(SpawnCallBackFunction, SpawnFunctionArguments, ...)

-
- -

Allows to place a CallFunction hook when a new group spawns.

- - -

The provided method will be called when a new group is spawned, including its given parameters. -The first parameter of the SpawnFunction is the Wrapper.Group#GROUP that was spawned.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- #function - SpawnCallBackFunction -

-
-
- -

The function to be called when a group spawns.

- -
-
-
-
-

- SpawnFunctionArguments -

-
-
- -

A random amount of arguments to be provided to the function when the group spawns.

- -
-
-
-
-

- ... -

-
-
-

-
-
-

Return value:

-
-
-

#SPAWN:

-
-
- - - -
-
-

Usage:

- 

-   -- Declare SpawnObject and call a function when a new Group is spawned.
-   local SpawnObject = SPAWN:New( "SpawnObject" )
-                            :InitLimit( 2, 10 )
-                            :OnSpawnGroup( function( SpawnGroup )
-                                SpawnGroup:E( "I am spawned" )
-                                end
-                              )
-                            :SpawnScheduled( 300, 0.3 )
-
- -
- -
-
- -
- -
-

RAT:ParkAircraft(SpawnAirbase, TerminalType, Parkingdata, SpawnIndex)

-
- -

Will park a group at an Wrapper.Airbase.

- - -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- Wrapper.Airbase#AIRBASE - SpawnAirbase -

-
-
- -

The Wrapper.Airbase where to spawn the group.

- -
-
-
-
-

- Wrapper.Airbase#AIRBASE.TerminalType - TerminalType -

-
-
- -

(optional) The terminal type the aircraft should be spawned at. See Wrapper.Airbase#AIRBASE.TerminalType.

- -
-
-
-
-

- #table - Parkingdata -

-
-
- -

(optional) Table holding the coordinates and terminal ids for all units of the group. Spawning will be forced to happen at exactily these spots!

- -
-
-
-
-

- SpawnIndex -

-
-
-

-
-
-

Return value:

-
-
-

#nil:

-
-
- -

Nothing is returned!

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

RAT:ParkAtAirbase(SpawnAirbase, TerminalType, Parkingdata)

-
- -

Will park a group at an Wrapper.Airbase.

- - -

This method is mostly advisable to be used if you want to simulate parking units at an airbase and be visible. -Note that each point in the route assigned to the spawning group is reset to the point of the spawn.

- -

All groups that are in the spawn collection and that are alive, and not in the air, are parked.

- -

The Wrapper.Airbase#AIRBASE object must refer to a valid airbase known in the sim. -You can use the following enumerations to search for the pre-defined airbases on the current known maps of DCS:

- - - -

Use the method Wrapper.Airbase#AIRBASE.FindByName() to retrieve the airbase object. -The known AIRBASE objects are automatically imported at mission start by MOOSE. -Therefore, there isn't any New() constructor defined for AIRBASE objects.

- -

Ships and FARPs are added within the mission, and are therefore not known. -For these AIRBASE objects, there isn't an Wrapper.Airbase#AIRBASE enumeration defined. -You need to provide the exact name of the airbase as the parameter to the Wrapper.Airbase#AIRBASE.FindByName() method!

- - -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- Wrapper.Airbase#AIRBASE - SpawnAirbase -

-
-
- -

The Wrapper.Airbase where to spawn the group.

- -
-
-
-
-

- Wrapper.Airbase#AIRBASE.TerminalType - TerminalType -

-
-
- -

(optional) The terminal type the aircraft should be spawned at. See Wrapper.Airbase#AIRBASE.TerminalType.

- -
-
-
-
-

- #table - Parkingdata -

-
-
- -

(optional) Table holding the coordinates and terminal ids for all units of the group. Spawning will be forced to happen at exactily these spots!

- -
-
-

Return value:

-
-
-

#nil:

-
-
- -

Nothing is returned!

- -
-
-

Usage:

- 
  Spawn_Plane = SPAWN:New( "Plane" )
-  Spawn_Plane:ParkAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ) )
-
-  Spawn_Heli = SPAWN:New( "Heli")
-
-  Spawn_Heli:ParkAtAirbase( AIRBASE:FindByName( "FARP Cold" ) )
-
-  Spawn_Heli:ParkAtAirbase( AIRBASE:FindByName( "Carrier" ) )
-
-  Spawn_Plane:ParkAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), AIRBASE.TerminalType.OpenBig )
-
- -
- -
-
- -
- -
-

RAT:ReSpawn(SpawnIndex)

-
- -

Will re-spawn a group based on a given index.

- - -

Note: This method uses the global _DATABASE object (an instance of Core.Database#DATABASE), which contains ALL initial and new spawned objects in MOOSE.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #string - SpawnIndex -

-
-
- -

The index of the group to be spawned.

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

The group that was spawned. You can use this group for further actions.

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

RAT:SetSpawnIndex(SpawnIndex)

-
- -

Set the spawn index to a specified index number.

- - -

This method can be used to "reset" the spawn counter to a specific index number. -This will actually enable a respawn of groups from the specific index.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #string - SpawnIndex -

-
-
- -

The index of the group from where the spawning will start again. The default value would be 0, which means a complete reset of the spawnindex.

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:Spawn()

-
- -

Will spawn a group based on the internal index.

- - -

Note: This method uses the global _DATABASE object (an instance of Core.Database#DATABASE), which contains ALL initial and new spawned objects in MOOSE.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

The group that was spawned. You can use this group for further actions.

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

RAT:SpawnAtAirbase(SpawnAirbase, Takeoff, TakeoffAltitude, TerminalType, EmergencyAirSpawn, Parkingdata)

-
- -

Will spawn a group at an Wrapper.Airbase.

- - -

This method is mostly advisable to be used if you want to simulate spawning units at an airbase. -Note that each point in the route assigned to the spawning group is reset to the point of the spawn. -You can use the returned group to further define the route to be followed.

- -

The Wrapper.Airbase#AIRBASE object must refer to a valid airbase known in the sim. -You can use the following enumerations to search for the pre-defined airbases on the current known maps of DCS:

- - - -

Use the method Wrapper.Airbase#AIRBASE.FindByName() to retrieve the airbase object. -The known AIRBASE objects are automatically imported at mission start by MOOSE. -Therefore, there isn't any New() constructor defined for AIRBASE objects.

- -

Ships and FARPs are added within the mission, and are therefore not known. -For these AIRBASE objects, there isn't an Wrapper.Airbase#AIRBASE enumeration defined. -You need to provide the exact name of the airbase as the parameter to the Wrapper.Airbase#AIRBASE.FindByName() method!

- - -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- Wrapper.Airbase#AIRBASE - SpawnAirbase -

-
-
- -

The Wrapper.Airbase where to spawn the group.

- -
-
-
-
-

- #SPAWN.Takeoff - Takeoff -

-
-
- -

(optional) The location and takeoff method. Default is Hot.

- -
-
-
-
-

- #number - TakeoffAltitude -

-
-
- -

(optional) The altitude above the ground.

- -
-
-
-
-

- Wrapper.Airbase#AIRBASE.TerminalType - TerminalType -

-
-
- -

(optional) The terminal type the aircraft should be spawned at. See Wrapper.Airbase#AIRBASE.TerminalType.

- -
-
-
-
-

- #boolean - EmergencyAirSpawn -

-
-
- -

(optional) If true (default), groups are spawned in air if there is no parking spot at the airbase. If false, nothing is spawned if no parking spot is available.

- -
-
-
-
-

- #table - Parkingdata -

-
-
- -

(optional) Table holding the coordinates and terminal ids for all units of the group. Spawning will be forced to happen at exactly these spots!

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

The group that was spawned or nil when nothing was spawned.

- -
-
-

Usage:

- 

-  Spawn_Plane = SPAWN:New( "Plane" )
-  Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), SPAWN.Takeoff.Cold )
-  Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), SPAWN.Takeoff.Hot )
-  Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), SPAWN.Takeoff.Runway )
-
-  Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( "Carrier" ), SPAWN.Takeoff.Cold )
-
-  Spawn_Heli = SPAWN:New( "Heli")
-
-  Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "FARP Cold" ), SPAWN.Takeoff.Cold )
-  Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "FARP Hot" ), SPAWN.Takeoff.Hot )
-  Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "FARP Runway" ), SPAWN.Takeoff.Runway )
-  Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "FARP Air" ), SPAWN.Takeoff.Air )
-
-  Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "Carrier" ), SPAWN.Takeoff.Cold )
-
-  Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), SPAWN.Takeoff.Cold, nil, AIRBASE.TerminalType.OpenBig )
-
- -
- -
-
- -
- -
-

RAT:SpawnAtParkingSpot(Airbase, Spots, Takeoff)

-
- -

Spawn a group on an Wrapper.Airbase at a specific parking spot.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- Wrapper.Airbase#AIRBASE - Airbase -

-
-
- -

The Wrapper.Airbase where to spawn the group.

- -
-
-
-
-

- #table - Spots -

-
-
- -

Table of parking spot IDs. Note that these in general are different from the numbering in the mission editor!

- -
-
-
-
-

- #SPAWN.Takeoff - Takeoff -

-
-
- -

(Optional) Takeoff type, i.e. either SPAWN.Takeoff.Cold or SPAWN.Takeoff.Hot. Default is Hot.

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

The group that was spawned or nil when nothing was spawned.

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

RAT:SpawnFromCoordinate(Coordinate, SpawnIndex)

-
- -

Will spawn a group from a Coordinate in 3D space.

- - -

This method is mostly advisable to be used if you want to simulate spawning units in the air, like helicopters or airplanes. -Note that each point in the route assigned to the spawning group is reset to the point of the spawn. -You can use the returned group to further define the route to be followed.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- Core.Point#Coordinate - Coordinate -

-
-
- -

The Coordinate coordinates where to spawn the group.

- -
-
-
-
-

- #number - SpawnIndex -

-
-
- -

(optional) The index which group to spawn within the given zone.

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

that was spawned or #nil if nothing was spawned.

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

RAT:SpawnFromPointVec2(PointVec2, MinHeight, MaxHeight, SpawnIndex)

-
- -

Will spawn a group from a POINT_VEC2 in 3D space.

- - -

This method is mostly advisable to be used if you want to simulate spawning groups on the ground from air units, like vehicles. -Note that each point in the route assigned to the spawning group is reset to the point of the spawn. -You can use the returned group to further define the route to be followed.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- Core.Point#POINT_VEC2 - PointVec2 -

-
-
- -

The PointVec2 coordinates where to spawn the group.

- -
-
-
-
-

- #number - MinHeight -

-
-
- -

(optional) The minimum height to spawn an airborne group into the zone.

- -
-
-
-
-

- #number - MaxHeight -

-
-
- -

(optional) The maximum height to spawn an airborne group into the zone.

- -
-
-
-
-

- #number - SpawnIndex -

-
-
- -

(optional) The index which group to spawn within the given zone.

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

that was spawned or #nil if nothing was spawned.

- -
-
-

Usage:

- 

-  local SpawnPointVec2 = ZONE:New( ZoneName ):GetPointVec2() 
-
-  -- Spawn at the zone center position at the height specified in the ME of the group template!
-  SpawnAirplanes:SpawnFromPointVec2( SpawnPointVec2 )
-
-  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
-  SpawnAirplanes:SpawnFromPointVec2( SpawnPointVec2, 2000, 4000 )
-
- -
- -
-
- -
- -
-

RAT:SpawnFromPointVec3(PointVec3, SpawnIndex)

-
- -

Will spawn a group from a PointVec3 in 3D space.

- - -

This method is mostly advisable to be used if you want to simulate spawning units in the air, like helicopters or airplanes. -Note that each point in the route assigned to the spawning group is reset to the point of the spawn. -You can use the returned group to further define the route to be followed.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- Core.Point#POINT_VEC3 - PointVec3 -

-
-
- -

The PointVec3 coordinates where to spawn the group.

- -
-
-
-
-

- #number - SpawnIndex -

-
-
- -

(optional) The index which group to spawn within the given zone.

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

that was spawned or #nil if nothing was spawned.

- -
-
-

Usage:

- 

-  local SpawnPointVec3 = ZONE:New( ZoneName ):GetPointVec3( 2000 ) -- Get the center of the ZONE object at 2000 meters from the ground.
-
-  -- Spawn at the zone center position at 2000 meters from the ground!
-  SpawnAirplanes:SpawnFromPointVec3( SpawnPointVec3 )
-
- -
- -
-
- -
- -
-

RAT:SpawnFromStatic(HostStatic, MinHeight, MaxHeight, SpawnIndex)

-
- -

Will spawn a group from a hosting static.

- - -

This method is mostly advisable to be used if you want to simulate spawning from buldings and structures (static buildings). -You can use the returned group to further define the route to be followed.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- Wrapper.Static#STATIC - HostStatic -

-
-
- -

The static dropping or unloading the group.

- -
-
-
-
-

- #number - MinHeight -

-
-
- -

(optional) The minimum height to spawn an airborne group into the zone.

- -
-
-
-
-

- #number - MaxHeight -

-
-
- -

(optional) The maximum height to spawn an airborne group into the zone.

- -
-
-
-
-

- #number - SpawnIndex -

-
-
- -

(optional) The index which group to spawn within the given zone.

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

that was spawned or #nil if nothing was spawned.

- -
-
-

Usage:

- 

-  local SpawnStatic = STATIC:FindByName( StaticName )
-
-  -- Spawn from the static position at the height specified in the ME of the group template!
-  SpawnAirplanes:SpawnFromStatic( SpawnStatic )
-
-  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
-  SpawnAirplanes:SpawnFromStatic( SpawnStatic, 2000, 4000 )
-
- -
- -
-
- -
- -
-

RAT:SpawnFromUnit(HostUnit, MinHeight, MaxHeight, SpawnIndex)

-
- -

Will spawn a group from a hosting unit.

- - -

This method is mostly advisable to be used if you want to simulate spawning from air units, like helicopters, which are dropping infantry into a defined Landing Zone. -Note that each point in the route assigned to the spawning group is reset to the point of the spawn. -You can use the returned group to further define the route to be followed.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- Wrapper.Unit#UNIT - HostUnit -

-
-
- -

The air or ground unit dropping or unloading the group.

- -
-
-
-
-

- #number - MinHeight -

-
-
- -

(optional) The minimum height to spawn an airborne group into the zone.

- -
-
-
-
-

- #number - MaxHeight -

-
-
- -

(optional) The maximum height to spawn an airborne group into the zone.

- -
-
-
-
-

- #number - SpawnIndex -

-
-
- -

(optional) The index which group to spawn within the given zone.

- -
-
-

Return values:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

that was spawned.

- -
-
-

#nil:

-
-
- -

Nothing was spawned.

- -
-
-

Usage:

- 

-  local SpawnStatic = STATIC:FindByName( StaticName )
-
-  -- Spawn from the static position at the height specified in the ME of the group template!
-  SpawnAirplanes:SpawnFromUnit( SpawnStatic )
-
-  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
-  SpawnAirplanes:SpawnFromUnit( SpawnStatic, 2000, 4000 )
-
- -
- -
-
- -
- -
-

RAT:SpawnFromVec2(Vec2, MinHeight, MaxHeight, SpawnIndex)

-
- -

Will spawn a group from a Vec2 in 3D space.

- - -

This method is mostly advisable to be used if you want to simulate spawning groups on the ground from air units, like vehicles. -Note that each point in the route assigned to the spawning group is reset to the point of the spawn. -You can use the returned group to further define the route to be followed.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- DCS#Vec2 - Vec2 -

-
-
- -

The Vec2 coordinates where to spawn the group.

- -
-
-
-
-

- #number - MinHeight -

-
-
- -

(optional) The minimum height to spawn an airborne group into the zone.

- -
-
-
-
-

- #number - MaxHeight -

-
-
- -

(optional) The maximum height to spawn an airborne group into the zone.

- -
-
-
-
-

- #number - SpawnIndex -

-
-
- -

(optional) The index which group to spawn within the given zone.

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

that was spawned or #nil if nothing was spawned.

- -
-
-

Usage:

- 

-  local SpawnVec2 = ZONE:New( ZoneName ):GetVec2()
-
-  -- Spawn at the zone center position at the height specified in the ME of the group template!
-  SpawnAirplanes:SpawnFromVec2( SpawnVec2 )
-
-  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
-  SpawnAirplanes:SpawnFromVec2( SpawnVec2, 2000, 4000 )
-
- -
- -
-
- -
- -
-

RAT:SpawnFromVec3(Vec3, SpawnIndex)

-
- -

Will spawn a group from a Vec3 in 3D space.

- - -

This method is mostly advisable to be used if you want to simulate spawning units in the air, like helicopters or airplanes. -Note that each point in the route assigned to the spawning group is reset to the point of the spawn. -You can use the returned group to further define the route to be followed.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- DCS#Vec3 - Vec3 -

-
-
- -

The Vec3 coordinates where to spawn the group.

- -
-
-
-
-

- #number - SpawnIndex -

-
-
- -

(optional) The index which group to spawn within the given zone.

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

that was spawned or #nil if nothing was spawned.

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

RAT:SpawnGroupName(SpawnIndex)

-
- -

Will return the SpawnGroupName either with with a specific count number or without any count.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #number - SpawnIndex -

-
-
- -

Is the number of the Group that is to be spawned.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

SpawnGroupName

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

RAT:SpawnInZone(Zone, RandomizeGroup, MinHeight, MaxHeight, SpawnIndex)

-
- -

Will spawn a Group within a given Core.Zone.

- - -

The Core.Zone can be of any type derived from Core.Zone#ZONE_BASE. -Once the Wrapper.Group is spawned within the zone, the Wrapper.Group will continue on its route. -The first waypoint (where the group is spawned) is replaced with the zone location coordinates.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- Core.Zone#ZONE - Zone -

-
-
- -

The zone where the group is to be spawned.

- -
-
-
-
-

- #boolean - RandomizeGroup -

-
-
- -

(optional) Randomization of the Wrapper.Group position in the zone.

- -
-
-
-
-

- #number - MinHeight -

-
-
- -

(optional) The minimum height to spawn an airborne group into the zone.

- -
-
-
-
-

- #number - MaxHeight -

-
-
- -

(optional) The maximum height to spawn an airborne group into the zone.

- -
-
-
-
-

- #number - SpawnIndex -

-
-
- -

(optional) The index which group to spawn within the given zone.

- -
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

that was spawned or #nil if nothing was spawned.

- -
-
-

Usage:

- 

-  local SpawnZone = ZONE:New( ZoneName )
-
-  -- Spawn at the zone center position at the height specified in the ME of the group template!
-  SpawnAirplanes:SpawnInZone( SpawnZone )
-
-  -- Spawn in the zone at a random position at the height specified in the Me of the group template.
-  SpawnAirplanes:SpawnInZone( SpawnZone, true )
-
-  -- Spawn in the zone at a random position at the height randomized between 2000 and 4000 meters.
-  SpawnAirplanes:SpawnInZone( SpawnZone, true, 2000, 4000 )
-
-  -- Spawn at the zone center position at the height randomized between 2000 and 4000 meters.
-  SpawnAirplanes:SpawnInZone( SpawnZone, false, 2000, 4000 )
-
-  -- Spawn at the zone center position at the height randomized between 2000 and 4000 meters.
-  SpawnAirplanes:SpawnInZone( SpawnZone, nil, 2000, 4000 )
-
- -
- -
-
- -
- -
-

RAT:SpawnScheduleStart()

-
- -

Will re-start the spawning scheduler.

- - -

Note: This method is only required to be called when the schedule was stopped.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Return value:

-
-
-

#SPAWN:

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

RAT:SpawnScheduleStop()

-
- -

Will stop the scheduled spawning scheduler.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Return value:

-
-
-

#SPAWN:

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

RAT:SpawnScheduled(SpawnTime, SpawnTimeVariation, WithDelay)

-
- -

Spawns new groups at varying time intervals.

- - -

This is useful if you want to have continuity within your missions of certain (AI) groups to be present (alive) within your missions. -WARNING - Setting a very low SpawnTime heavily impacts your mission performance and CPU time, it is NOT useful to check the alive state of an object every split second! Be reasonable and stay at 15 seconds and above!

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- #number - SpawnTime -

-
-
- -

The time interval defined in seconds between each new spawn of new groups.

- -
-
-
-
-

- #number - SpawnTimeVariation -

-
-
- -

The variation to be applied on the defined time interval between each new spawn. -The variation is a number between 0 and 1, representing the % of variation to be applied on the time interval.

- -
-
-
-
-

- #boolean - WithDelay -

-
-
- -

Do not spawn the first group immediately, but delay the spawn as per the calculation below. -Effectively the same as #InitDelayOn().

- -
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 
-- NATO helicopters engaging in the battle field.
--- The time interval is set to SPAWN new helicopters between each 600 seconds, with a time variation of 50%.
--- The time variation in this case will be between 450 seconds and 750 seconds.
--- This is calculated as follows:
---      Low limit:   600 * ( 1 - 0.5 / 2 ) = 450
---      High limit:  600 * ( 1 + 0.5 / 2 ) = 750
--- Between these two values, a random amount of seconds will be chosen for each new spawn of the helicopters.
-Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):SpawnScheduled( 600, 0.5 )
- -
- -
-
- -
- -
-

RAT:SpawnWithIndex(SpawnIndex, NoBirth)

-
- -

Will spawn a group with a specified index number.

- - -

Note: This method uses the global _DATABASE object (an instance of Core.Database#DATABASE), which contains ALL initial and new spawned objects in MOOSE.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- #string - SpawnIndex -

-
-
- -

The index of the group to be spawned.

- -
-
-
-
-

- NoBirth -

-
-
-

-
-
-

Return value:

-
-
-

Wrapper.Group#GROUP:

-
-
- -

The group that was spawned. You can use this group for further actions.

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

RAT:StopRepeat()

-
- -

Stop the SPAWN InitRepeat function (EVENT handler for takeoff, land and engine shutdown)

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

- -
-
-

Usage:

- 
         local spawn = SPAWN:New("Template Group")
-           :InitRepeatOnEngineShutDown()
-         local plane = spawn:Spawn() -- it is important that we keep the SPAWN object and do not overwrite it with the resulting GROUP object by just calling :Spawn()
-         
-         -- later on
-         spawn:StopRepeat()
- -
- -
-
- -
- -
-

RAT:_CountAliveUnits()

-
- - - -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Return value:

-
-
-

#number:

-
-
- -

count

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

RAT:_GetGroupCategoryID(SpawnPrefix)

-
- -

Gets the CategoryID of the Group with the given SpawnPrefix

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- SpawnPrefix -

-
-
-

-
-
-
- -
-
- -
- -
-

RAT:_GetGroupCoalitionID(SpawnPrefix)

-
- -

Gets the CoalitionID of the Group with the given SpawnPrefix

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- SpawnPrefix -

-
-
-

-
-
-
- -
-
- -
- -
-

RAT:_GetGroupCountryID(SpawnPrefix)

-
- -

Gets the CountryID of the Group with the given SpawnPrefix

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- SpawnPrefix -

-
-
-

-
-
-
- -
-
- -
- -
-

RAT:_GetLastIndex()

-
- -

Return the last maximum index that can be used.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-
- -
-
- -
- -
-

RAT:_GetPrefixFromGroup(SpawnGroup)

-
- -

Return the prefix of a SpawnUnit.

- - -

The method will search for a #-mark, and will return the text before the #-mark. -It will return nil of no prefix was found.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- Wrapper.Group#GROUP - SpawnGroup -

-
-
- -

The GROUP object.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The prefix or #nil if nothing was found.

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

RAT:_GetPrefixFromGroupName(SpawnGroupName)

-
- -

Return the prefix of a spawned group.

- - -

The method will search for a #-mark, and will return the text before the #-mark. It will return nil of no prefix was found.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #string - SpawnGroupName -

-
-
- -

The name of the spawned group.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

The prefix or #nil if nothing was found.

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

RAT:_GetSpawnIndex(SpawnIndex)

-
- -

Get the next index of the groups to be spawned.

- - -

This method is complicated, as it is used at several spaces.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #number - SpawnIndex -

-
-
- -

Spawn index.

- -
-
-

Return value:

-
-
-

#number:

-
-
- -

self.SpawnIndex

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

RAT:_GetTemplate(SpawnTemplatePrefix)

-
- -

Gets the Group Template from the ME environment definition.

- - -

Note: This method uses the global _DATABASE object (an instance of Core.Database#DATABASE), which contains ALL initial and new spawned objects in MOOSE.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #string - SpawnTemplatePrefix -

-
-
-

-
-
-

Return value:

-
-
-
-
- -

@SPAWN self

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

RAT:_InitializeSpawnGroups(SpawnIndex)

-
- -

Initalize the SpawnGroups collection.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- SpawnIndex -

-
-
-

-
-
-
- -
-
- -
- -
-

RAT:_OnBirth(EventData)

-
- - - - -

@param #SPAWN self - @param Core.Event#EVENTDATA EventData

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- EventData -

-
-
-

-
-
-
- -
-
- -
- -
-

RAT:_OnDeadOrCrash(EventData)

-
- - - -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
-

-
-
-
- -
-
- -
- -
-

RAT:_OnEngineShutDown(EventData)

-
- -

Will detect AIR Units shutting down their engines ...

- - -

When the event takes place, and the method #InitRepeatOnEngineShutDown was called, the spawned Group will Re-SPAWN. -But only when the Unit was registered to have landed.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
-

-
-
-
- -
-
- -
- -
-

RAT:_OnLand(EventData)

-
- -

Will detect AIR Units landing...

- - -

When the event takes place, the spawned Group is registered as landed. -This is needed to ensure that Re-SPAWNing is only done for landed AIR Groups.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
-

-
-
-
- -
-
- -
- -
-

RAT:_OnTakeOff(EventData)

-
- -

Will detect AIR Units taking off...

- - -

When the event takes place, the spawned Group is registered as airborne... -This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
-

-
-
-
- -
-
- -
- -
-

RAT:_Prepare(SpawnTemplatePrefix, SpawnIndex)

-
- -

Prepares the new Group Template.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- #string - SpawnTemplatePrefix -

-
-
-

-
-
-
-
-

- #number - SpawnIndex -

-
-
-

-
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:_RandomizeRoute(SpawnIndex)

-
- -

Private method randomizing the routes.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #number - SpawnIndex -

-
-
- -

The index of the group to be spawned.

- -
-
-

Return value:

-
-
-

#SPAWN:

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

RAT:_RandomizeTemplate(SpawnIndex)

-
- -

Private method that randomizes the template of the group.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #number - SpawnIndex -

-
-
-

-
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:_RandomizeZones(SpawnIndex)

-
- -

Private method that randomizes the Core.Zones where the Group will be spawned.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #number - SpawnIndex -

-
-
-

-
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:_Scheduler()

-
- -

This function is called automatically by the Spawning scheduler.

- - -

It is the internal worker method SPAWNing new Groups on the defined time intervals.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-
- -
-
- -
- -
-

RAT:_SetInitialPosition(SpawnIndex)

-
- -

Private method that sets the DCS#Vec2 where the Group will be spawned.

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameter:

-
-
-

- #number - SpawnIndex -

-
-
-

-
-
-

Return value:

-
-
-

#SPAWN:

-
-
- -

self

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

RAT:_SpawnCleanUpScheduler()

-
- -

Schedules the CleanUp of Groups

- -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Return value:

-
-
-

#boolean:

-
-
- -

True = Continue Scheduler

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

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

-
- - - -
-
-

Defined in:

-
-

Core.Spawn#SPAWN

-
-

Parameters:

-
-
-

- SpawnIndex -

-
-
-

-
-
-
-
-

- SpawnRootX -

-
-
-

-
-
-
-
-

- SpawnRootY -

-
-
-

-
-
-
-
-

- SpawnX -

-
-
-

-
-
-
-
-

- SpawnY -

-
-
-

-
-
-
-
-

- SpawnAngle -

-
-
-

-
-
-
- -
-
- -
-

Field(s)

-
-
-
- - #table -RAT.ATC - -

RAT ATC.

- -
- -
-
-
- - #boolean -RAT.ATCswitch - -

Enable/disable ATC if set to true/false.

- -
- -
-
-
- - #number -RAT.AlphaDescent - -

Default angle of descenti in degrees. A value of 3.6 follows the 3:1 rule of 3 miles of travel and 1000 ft descent.

- -
- -
-
-
- - #string -RAT.ClassName - -

Name of the Class.

- -
- -
-
-
- - #boolean -RAT.Debug - -

Turn debug messages on or off.

- -
- -
-
-
- - #number -RAT.FLcruise - -

Cruise altitude of aircraft. Default FL200 for planes and F005 for helos.

- -
- -
-
-
- - #number -RAT.FLmaxuser - -

Maximum flight level set by user.

- -
- -
-
-
- - #number -RAT.FLminuser - -

Minimum flight level set by user.

- -
- -
-
-
- - #number -RAT.FLuser - -

Flight level set by users explicitly.

- -
- -
-
-
- - #table -RAT.Menu - -

F10 menu items for this RAT object.

- -
- -
-
-
- - #string -RAT.MenuF10 - -

Main F10 menu.

- -
- -
-
-
- - #number -RAT.Ndeparture_Airports - -

Number of departure airports set via SetDeparture().

- -
- -
-
-
- - #number -RAT.Ndeparture_Zones - -

Number of departure zones set via SetDeparture.

- -
- -
-
-
- - #number -RAT.Ndestination_Airports - -

Number of destination airports set via SetDestination().

- -
- -
-
-
- - #number -RAT.Ndestination_Zones - -

Number of destination zones set via SetDestination().

- -
- -
-
-
- - #table -RAT.ROE - -

RAT rules of engagement.

- -
- -
-
-
- - #table -RAT.ROT - -

RAT reaction to threat.

- -
- -
-
-
- - #boolean -RAT.SpawnUnControlled - - - - -

This is used in the SPAWN:SpawnWithIndex() function. Some values are overwritten there!

- -
- -
-
-
- - #string -RAT.SubMenuName - -

Submenu name for RAT object.

- -
- -
-
-
- - #number -RAT.Tinactive - -

Time in seconds after which inactive units will be destroyed. Default is 300 seconds.

- -
- -
-
-
- - #number -RAT.Vclimb - -

Default climb rate in ft/min.

- -
- -
-
-
- - #number -RAT.Vcruisemax - -

Max cruise speed in m/s (250 m/s = 900 km/h = 486 kt) set by user.

- -
- -
-
-
- - #number -RAT.activate_delay - -

Delay in seconds before first uncontrolled group is activated. Default is 5 seconds.

- -
- -
-
-
- - #number -RAT.activate_delta - -

Time interval in seconds between activation of uncontrolled groups. Default is 5 seconds.

- -
- -
-
-
- - #number -RAT.activate_frand - -

Randomization factor of time interval (activate_delta) between activating uncontrolled groups. Default is 0.

- -
- -
-
-
- - #number -RAT.activate_max - -

Maximum number of uncontrolled aircraft, which will be activated at the same time. Default is 1.

- -
- -
-
-
- - #boolean -RAT.activate_uncontrolled - -

If true, uncontrolled are activated randomly after certain time intervals.

- -
- -
-
-
- - -RAT.actype - - - -
- -
-
-
- - #boolean -RAT.addfriendlydepartures - -

Add all friendly airports to departures.

- -
- -
-
-
- - #boolean -RAT.addfriendlydestinations - -

Add all friendly airports to destinations.

- -
- -
-
-
- - #table -RAT.aircraft - -

Table which holds the basic aircraft properties (speed, range, ...).

- -
- -
-
-
- - #table -RAT.airports - -

All airports of friedly coalitions.

- -
- -
-
-
- - #table -RAT.airports_map - -

All airports available on current map (Caucasus, Nevada, Normandy, ...).

- -
- -
-
-
- - #string -RAT.alias - -

Alias for spawned group.

- -
- -
-
-
- - #number -RAT.alive - -

Number of groups which are alive.

- -
- -
-
-
- - #table -RAT.cat - - - -
- -
-
-
- - #string -RAT.category - -

Category of aircarft: "plane" or "heli".

- -
- -
-
-
- - #boolean -RAT.checkonrunway - -

Aircraft are checked if they were accidentally spawned on the runway. Default is true.

- -
- -
-
-
- - #boolean -RAT.checkontop - -

Aircraft are checked if they were accidentally spawned on top of another unit. Default is true.

- -
- -
-
-
- - #table -RAT.coal - -

RAT friendly coalitions.

- -
- -
-
-
- - #number -RAT.coalition - -

Coalition of spawn group template.

- -
- -
-
-
- - #boolean -RAT.commute - -

Aircraft commute between departure and destination, i.e. when respawned the departure airport becomes the new destiation.

- -
- -
-
-
- - #boolean -RAT.continuejourney - -

Aircraft will continue their journey, i.e. get respawned at their destination with a new random destination.

- -
- -
-
-
- - #number -RAT.country - -

Country of spawn group template.

- -
- -
-
-
- - #table -RAT.ctable - -

Table with the valid coalitions from choice self.friendly.

- -
- -
-
-
- - Core.Zone#ZONE -RAT.departure_Azone - -

Zone containing the departure airports.

- -
- -
-
-
- - #table -RAT.departure_ports - -

Array containing the names of the destination airports or zones.

- -
- -
-
-
- - #boolean -RAT.despawnair - -

If true, aircraft are despawned when they reach their destination zone. Default.

- -
- -
-
-
- - Core.Zone#ZONE -RAT.destination_Azone - -

Zone containing the destination airports.

- -
- -
-
-
- - #table -RAT.destination_ports - -

Array containing the names of the destination airports or zones.

- -
- -
-
-
- - #boolean -RAT.destinationzone - -

Destination is a zone and not an airport.

- -
- -
-
-
- - #boolean -RAT.eplrs - -

If true, turn on EPLSR datalink for the RAT group.

- -
- -
-
-
- - #table -RAT.excluded_ports - -

Array containing the names of explicitly excluded airports.

- -
- -
-
-
- - #boolean -RAT.f10menu - -

If true, add an F10 radiomenu for RAT. Default is false.

- -
- -
-
-
- - #number -RAT.frequency - -

Radio frequency used by the RAT groups.

- -
- -
-
-
- - #string -RAT.friendly - -

Possible departure/destination airport: all=blue+red+neutral, same=spawn+neutral, spawnonly=spawn, blue=blue+neutral, blueonly=blue, red=red+neutral, redonly=red.

- -
- -
-
-
- - #number -RAT.groupsize - -

Number of aircraft in group.

- -
- -
-
-
- - #string -RAT.homebase - -

Home base for commute and return zone. Aircraft will always return to this base but otherwise travel in a star shaped way.

- -
- -
-
-
- - #string -RAT.id - -

Some ID to identify who we are in output of the DCS.log file.

- -
- -
-
-
- - #boolean -RAT.immortal - -

If true, aircraft are spawned as immortal.

- -
- -
-
-
- - #boolean -RAT.invisible - -

If true aircraft are set to invisible for other AI forces.

- -
- -
-
-
- - #number -RAT.landing - -

Landing type. Determines if we actually land at an airport or treat it as zone.

- -
- -
-
-
- - #string -RAT.livery - -

Livery of the aircraft set by user.

- -
- -
-
-
- - #number -RAT.markerid - -

Running number of placed markers on the F10 map.

- -
- -
-
-
- - #table -RAT.markerids - -

Array with marker IDs.

- -
- -
-
-
- - #number -RAT.maxdist - -

Max distance from departure to destination in meters. Default 5000 km.

- -
- -
-
-
- - #number -RAT.mindist - -

Min distance from departure to destination in meters. Default 5 km.

- -
- -
-
-
- - #string -RAT.modulation - -

Ratio modulation. Either "FM" or "AM".

- -
- -
-
-
- - #number -RAT.ngroups - -

Number of groups to be spawned in total.

- -
- -
-
-
- - #boolean -RAT.norespawn - -

Aircraft will not be respawned after they have finished their route.

- -
- -
-
-
- - #string -RAT.onboardnum - -

Sets the onboard number prefix. Same as setting "TAIL #" in the mission editor.

- -
- -
-
-
- - #number -RAT.onboardnum0 - -

(Optional) Starting value of the automatically appended numbering of aircraft within a flight. Default is 1.

- -
- -
-
-
- - #number -RAT.onrunwaymaxretry - -

Number of respawn retries (on ground) at other airports if a group gets accidentally spawned on the runway. Default is 3.

- -
- -
-
-
- - #number -RAT.onrunwayradius - -

Distance (in meters) from a runway spawn point until a unit is considered to have accidentally been spawned on a runway. Default is 75 m.

- -
- -
-
-
- - #number -RAT.ontopradius - -

Radius in meters until which a unit is considered to be on top of another. Default is 2 m.

- -
- -
-
-
- - #number -RAT.parkingscanradius - -

Radius in meters until which parking spots are scanned for obstacles like other units, statics or scenery.

- -
- -
-
-
- - #boolean -RAT.parkingscanscenery - -

If true, area around parking spots is scanned for scenery objects. Default is false.

- -
- -
-
-
- - #boolean -RAT.parkingverysafe - -

If true, parking spots are considered as non-free until a possible aircraft has left and taken off. Default false.

- -
- -
-
-
- - #boolean -RAT.placemarkers - -

Place markers of waypoints on F10 map.

- -
- -
-
-
- - #boolean -RAT.radio - -

If true/false disables radio messages from the RAT groups.

- -
- -
-
-
- - #boolean -RAT.random_departure - -

By default a random friendly airport is chosen as departure.

- -
- -
-
-
- - #boolean -RAT.random_destination - -

By default a random friendly airport is chosen as destination.

- -
- -
-
-
- - #table -RAT.ratcraft - -

Array with the spawned RAT aircraft.

- -
- -
-
-
- - #boolean -RAT.reportstatus - -

Aircraft report status.

- -
- -
-
-
- - #boolean -RAT.respawn_after_crash - -

Aircraft will be respawned after a crash, e.g. when they get shot down.

- -
- -
-
-
- - #boolean -RAT.respawn_after_takeoff - -

Aircraft will be respawned directly after take-off.

- -
- -
-
-
- - #boolean -RAT.respawn_at_landing - -

Respawn aircraft the moment they land rather than at engine shutdown.

- -
- -
-
-
- - #number -RAT.respawn_delay - -

Delay in seconds until a repawn happens.

- -
- -
-
-
- - #boolean -RAT.respawn_inair - -

Aircraft are allowed to spawned in air if they cannot be respawned on ground because there is not free parking spot. Default is true.

- -
- -
-
-
- - #table -RAT.return_zones - -

Array containing the names of the return zones.

- -
- -
-
-
- - #boolean -RAT.returnzone - -

Zone where aircraft will fly to before returning to their departure airport.

- -
- -
-
-
- - #string -RAT.roe - -

ROE of spawned groups, default is weapon hold (this is a peaceful class for civil aircraft or ferry missions). Possible: "hold", "return", "free".

- -
- -
-
-
- - #string -RAT.rot - -

ROT of spawned groups, default is no reaction. Possible: "noreaction", "passive", "evade".

- -
- -
-
-
- - #string -RAT.skill - -

Skill of AI.

- -
- -
-
-
- - #number -RAT.spawndelay - -

Delay time in seconds before first spawning happens.

- -
- -
-
-
- - #boolean -RAT.spawninitialized - -

If RAT:Spawn() was already called this RAT object is set to true to prevent users to call it again.

- -
- -
-
-
- - #number -RAT.spawninterval - -

Interval between spawning units/groups. Note that we add a randomization of 50%.

- -
- -
-
-
- - #boolean -RAT.starshape - -

If true, aircraft travel A-->B-->A-->C-->A-->D... for commute.

- -
- -
-
-
- - #table -RAT.status - -

RAT aircraft status.

- -
- -
-
-
- - #number -RAT.statusinterval - -

Intervall between status checks (and reports if enabled).

- -
- -
-
-
- - #number -RAT.takeoff - -

Takeoff type. 0=coldorhot.

- -
- -
-
-
- - Wrapper.Group#GROUP -RAT.templategroup - -

Group serving as template for the RAT aircraft.

- -
- -
-
-
- - Wrapper.Airbase#AIRBASE.TerminalType -RAT.termtype - -

Type of terminal to be used when spawning at an airbase.

- -
- -
-
-
- - #boolean -RAT.uncontrolled - -

If true aircraft are spawned in uncontrolled state and will only sit on their parking spots. They can later be activated.

- -
- -
-
-
- - #table -RAT.unit - -

RAT unit conversions.

- -
- -
-
-
- - #table -RAT.version - -

RAT version.

- -
- -
-
-
- - #table -RAT.waypointdescriptions - -

Table with strings for waypoint descriptions of markers.

- -
- -
-
-
- - #table -RAT.waypointstatus - -

Table with strings of waypoint status.

- -
- -
-
-
- - #table -RAT.wp - -

RAT waypoint type.

- -
- -
-
-

Function(s)

-
-
- -
-

RAT: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.

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

RAT: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 -

-
-
-

-
-
-
- -
-
- -
- -
-

RAT:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

-
- -

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.

- -
-
-
-
-

- IniObjectCategory -

-
-
-

-
-
-
- -
-
- -
- -
-

RAT:CreateEventDead(EventTime, Initiator, IniObjectCategory)

-
- -

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.

- -
-
-
-
-

- IniObjectCategory -

-
-
-

-
-
-
- -
-
- -
- -
-

RAT:CreateEventDynamicCargoLoaded(DynamicCargo)

-
- -

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Wrapper.DynamicCargo#DYNAMICCARGO - DynamicCargo -

-
-
- -

the dynamic cargo object

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

RAT:CreateEventDynamicCargoRemoved(DynamicCargo)

-
- -

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Wrapper.DynamicCargo#DYNAMICCARGO - DynamicCargo -

-
-
- -

the dynamic cargo object

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

RAT:CreateEventDynamicCargoUnloaded(DynamicCargo)

-
- -

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Wrapper.DynamicCargo#DYNAMICCARGO - DynamicCargo -

-
-
- -

the dynamic cargo object

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

RAT:CreateEventNewDynamicCargo(DynamicCargo)

-
- -

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Wrapper.DynamicCargo#DYNAMICCARGO - DynamicCargo -

-
-
- -

the dynamic cargo object

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

RAT: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.

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

RAT: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.

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

RAT: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.

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

RAT:CreateEventUnitLost(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.

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

RAT: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.

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

RAT:EventDispatcher()

-
- -

Returns the event dispatcher

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

Core.Event#EVENT:

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

RAT:EventRemoveAll()

-
- -

Remove all subscribed events

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#BASE:

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

RAT: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.

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

RAT: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.

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

RAT: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.

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

RAT:GetClassID()

-
- -

Get the ClassID of the class instance.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassID of the class instance.

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

RAT:GetClassName()

-
- -

Get the ClassName of the class instance.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassName of the class instance.

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

RAT: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.

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

RAT:GetEventPriority()

-
- -

Get the Class Core.Event processing Priority.

- - -

The Event processing Priority is a number from 1 to 10, -reflecting the order of the classes subscribed to the Event to be processed.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#number:

-
-
- -

The Core.Event processing Priority.

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

RAT: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:

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

RAT: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.

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

RAT: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:

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

RAT: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.

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

RAT: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

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

RAT:IsInstanceOf(ClassName)

-
- -

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

- - - -

Examples:

- - - - -
-
-

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:

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

RAT:IsTrace()

-
- -

Enquires if tracing is on (for the class).

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#boolean:

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

RAT: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:

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

RAT:OnEvent(EventData)

-
- -

Occurs when an Event for an object is triggered.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that triggered the event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventBDA(EventData)

-
- -

BDA.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventBaseCaptured(EventData)

-
- -

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

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that captured the base -place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventBirth(EventData)

-
- -

Occurs when any object is spawned into the mission.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that was spawned

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventCrash(EventData)

-
- -

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

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that has crashed

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventDead(EventData)

-
- -

Occurs when an object is dead.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is dead.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventDetailedFailure(EventData)

-
- -

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

- - -

Will update this page when new information become available.

- - - - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventDiscardChairAfterEjection(EventData)

-
- -

Discard chair after ejection.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventDynamicCargoLoaded(EventData)

-
- -

Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.

- - -

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventDynamicCargoRemoved(EventData)

-
- -

Occurs when a dynamic cargo crate is removed.

- - -

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventDynamicCargoUnloaded(EventData)

-
- -

Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.

- - -

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventEjection(EventData)

-
- -

Occurs when a pilot ejects from an aircraft -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- - -

initiator : The unit that has ejected

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventEngineShutdown(EventData)

-
- -

Occurs when any aircraft shuts down its engines.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is stopping its engines.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventEngineStartup(EventData)

-
- -

Occurs when any aircraft starts its engines.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is starting its engines.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventHit(EventData)

-
- -

Occurs whenever an object is hit by a weapon.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit object the fired the weapon -weapon: Weapon object that hit the target -target: The Object that was hit.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventHumanFailure(EventData)

-
- -

Occurs when any system fails on a human controlled aircraft.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that had the failure

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT: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. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- - - - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventLand(EventData)

-
- -

Occurs when an aircraft lands at an airbase, farp or ship -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- - -

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

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT: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. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- - - - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventLandingQualityMark(EventData)

-
- -

Landing quality mark.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventMarkAdded(EventData)

-
- -

Occurs when a new mark was added.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventMarkChange(EventData)

-
- -

Occurs when a mark text was changed.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventMarkRemoved(EventData)

-
- -

Occurs when a mark was removed.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventMissionEnd(EventData)

-
- -

Occurs when a mission ends -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventMissionStart(EventData)

-
- -

Occurs when a mission starts -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventNewDynamicCargo(EventData)

-
- -

Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.

- - -

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT: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. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT: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. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that the pilot has died in.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventPlayerEnterAircraft(EventData)

-
- -

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

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. -initiator : The unit that is being taken control of.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventPlayerEnterUnit(EventData)

-
- -

Occurs when any player assumes direct control of a unit.

- - -

Note - not Mulitplayer safe. Use PlayerEnterAircraft. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is being taken control of.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventPlayerLeaveUnit(EventData)

-
- -

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

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that the player left.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventRefueling(EventData)

-
- -

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

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is receiving fuel.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventRefuelingStop(EventData)

-
- -

Occurs when an aircraft is finished taking fuel.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that was receiving fuel.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT: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. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventShootingEnd(EventData)

-
- -

Occurs when any unit stops firing its weapon.

- - -

Event will always correspond with a shooting start event. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that was doing the shooting.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventShootingStart(EventData)

-
- -

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

- - -

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is doing the shooting. -target: The unit that is being targeted.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventShot(EventData)

-
- -

Occurs whenever any unit in a mission fires a weapon.

- - -

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventTakeoff(EventData)

-
- -

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

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that tookoff -place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventTriggerZone(EventData)

-
- -

Trigger zone.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT:OnEventUnitLost(EventData)

-
- -

Occurs when the game thinks an object is destroyed.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- - - - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

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

RAT: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:

-
-
-

#string:

-
-
- -

The Schedule ID of the planned schedule.

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

RAT: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:

-
-
-

#string:

-
-
- -

The Schedule ID of the planned schedule.

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

RAT:ScheduleStop(SchedulerID)

-
- -

Stops the Schedule.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #string - SchedulerID -

-
-
- -

(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.

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

RAT:SetEventPriority(EventPriority)

-
- -

Set the Class Core.Event processing Priority.

- - -

The Event processing Priority is a number from 1 to 10, -reflecting the order of the classes subscribed to the Event to be processed.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #number - EventPriority -

-
-
- -

The Core.Event processing Priority.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- -

self

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

RAT: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.

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

RAT: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.

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

RAT: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.

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

RAT: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.

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

RAT:TraceAll(TraceAll)

-
- -

Trace all methods in MOOSE

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #boolean - TraceAll -

-
-
- -

true = trace all methods in MOOSE.

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

RAT:TraceClass(Class)

-
- -

Set tracing for a class

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #string - Class -

-
-
- -

Class name.

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

RAT:TraceClassMethod(Class, Method)

-
- -

Set tracing for a specific method of class

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- #string - Class -

-
-
- -

Class name.

- -
-
-
-
-

- #string - Method -

-
-
- -

Method.

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

RAT:TraceLevel(Level)

-
- -

Set trace level

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #number - Level -

-
-
-

-
-
-
- -
-
- -
- -
-

RAT:TraceOff()

-
- -

Set trace off.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Usage:

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

RAT:TraceOn()

-
- -

Set trace on.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Usage:

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

RAT: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 )
-
- -
- -
-
- -
- -
-

RAT:UnHandleEvent(EventID)

-
- -

UnSubscribe to a DCS event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTS - EventID -

-
-
- -

Event ID.

- -
-
-

Return value:

-
-
-

#BASE:

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

RAT:_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 -

-
-
-

-
-
-
- -
-
- -
- -
-

RAT:_Serialize(Arguments)

-
- -

(Internal) Serialize arguments

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #table - Arguments -

-
-
-

-
-
-

Return value:

-
-
-

#string:

-
-
- -

Text

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

RAT:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

-
- -

Trace a function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
-
-

- DebugInfoCurrentParam -

-
-
-

-
-
-
-
-

- DebugInfoFromParam -

-
-
-

-
-
-
- -
-
- -
- -
-

RAT:onEvent(event)

-
- -

The main event handling function...

- - -

This function captures all events generated for the class.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- DCS#Event - event -

-
-
-

-
-
-
- -
-
- diff --git a/Documentation/Functional.Range.html b/Documentation/Functional.Range.html index d2d5b9949..543c2d413 100644 --- a/Documentation/Functional.Range.html +++ b/Documentation/Functional.Range.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Functional.Scoring.html b/Documentation/Functional.Scoring.html index 32b2b461c..81b7aa49e 100644 --- a/Documentation/Functional.Scoring.html +++ b/Documentation/Functional.Scoring.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -3065,17 +3054,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-SCORING.AutoSave - - - -
- - -
-
- - SCORING.AutoSavePath @@ -3276,7 +3254,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SCORING.penaltyoncoalitionchange @@ -3287,7 +3265,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SCORING.penaltyonfratricide @@ -5999,17 +5977,6 @@ The scale magnifies the scores given to the players.

-SCORING.AutoSave - - - -
- -
-
-
- - SCORING.AutoSavePath @@ -6210,7 +6177,7 @@ The scale magnifies the scores given to the players.

- + #boolean SCORING.penaltyoncoalitionchange @@ -6221,7 +6188,7 @@ The scale magnifies the scores given to the players.

- + #boolean SCORING.penaltyonfratricide diff --git a/Documentation/Functional.Sead.html b/Documentation/Functional.Sead.html index 21e2ed953..4393566b6 100644 --- a/Documentation/Functional.Sead.html +++ b/Documentation/Functional.Sead.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

-
-
-
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Functional.Shorad.html b/Documentation/Functional.Shorad.html index 4c254658d..30d994ee6 100644 --- a/Documentation/Functional.Shorad.html +++ b/Documentation/Functional.Shorad.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

-
-
-
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Functional.Suppression.html b/Documentation/Functional.Suppression.html index b86e42a92..d2daa678e 100644 --- a/Documentation/Functional.Suppression.html +++ b/Documentation/Functional.Suppression.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

-
-
-
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Functional.Warehouse.html b/Documentation/Functional.Warehouse.html index c01771385..736ce0a76 100644 --- a/Documentation/Functional.Warehouse.html +++ b/Documentation/Functional.Warehouse.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

-
- -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Functional.ZoneCaptureCoalition.html b/Documentation/Functional.ZoneCaptureCoalition.html index 645f48fa1..4c05bedc7 100644 --- a/Documentation/Functional.ZoneCaptureCoalition.html +++ b/Documentation/Functional.ZoneCaptureCoalition.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Functional.ZoneGoal.html b/Documentation/Functional.ZoneGoal.html index 57f78a16a..7c6ff0d6e 100644 --- a/Documentation/Functional.ZoneGoal.html +++ b/Documentation/Functional.ZoneGoal.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Functional.ZoneGoalCargo.html b/Documentation/Functional.ZoneGoalCargo.html index 116697d8c..2baea05fb 100644 --- a/Documentation/Functional.ZoneGoalCargo.html +++ b/Documentation/Functional.ZoneGoalCargo.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Functional.ZoneGoalCoalition.html b/Documentation/Functional.ZoneGoalCoalition.html index a0018a93d..a5d8f5dc2 100644 --- a/Documentation/Functional.ZoneGoalCoalition.html +++ b/Documentation/Functional.ZoneGoalCoalition.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Ops.ATIS.html b/Documentation/Ops.ATIS.html index c2cc08647..d965d600d 100644 --- a/Documentation/Ops.ATIS.html +++ b/Documentation/Ops.ATIS.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index a8e36af2a..202e4eccd 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

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

Radio queue of LSO.

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

Radio queue of marshal.

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

Radio queue of LSO.

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

Radio queue of marshal.

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

Radio queue of LSO.

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

Radio queue of marshal.

- - - -
-
- - -AIRBOSS.RQMid - - -
@@ -41458,6 +41381,9 @@ When moose is loading dynamically (for moose class development), tracing is swit + +

Make player section lead if he was not before.

+ @@ -41671,17 +41597,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

Band modulation.

- - - -
-
- - -AIRBOSS.Radio.voice - - -
diff --git a/Documentation/Ops.CSAR.html b/Documentation/Ops.CSAR.html index 60909a1c1..634cf9773 100644 --- a/Documentation/Ops.CSAR.html +++ b/Documentation/Ops.CSAR.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -4217,7 +4206,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.FreeVHFFrequencies @@ -10441,7 +10430,7 @@ callsigns from playername or group name.

- + #table CSAR.FreeVHFFrequencies @@ -12963,7 +12952,7 @@ callsigns from playername or group name.

- + #table CSAR.FreeVHFFrequencies diff --git a/Documentation/Ops.CTLD.html b/Documentation/Ops.CTLD.html index be82d0f6e..faadcd432 100644 --- a/Documentation/Ops.CTLD.html +++ b/Documentation/Ops.CTLD.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

-
-
-
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

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

Field(s)

-
-
- - #number -CTLD.CargoCounter - - - -
- -
@@ -8203,17 +8181,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Name of the class.

-
- -
-
-
- - #number -CTLD.CrateCounter - - -
@@ -8234,7 +8201,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.CtldUnits @@ -8256,7 +8223,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.DroppedTroops @@ -8281,28 +8248,11 @@ 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

-
@@ -8356,14 +8306,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.FreeVHFFrequencies - -

Beacons

-
@@ -8484,11 +8431,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + CTLD.RadioPath + +

Folderpath.

+
@@ -8550,17 +8500,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #number -CTLD.TroopCounter - - -
@@ -8605,6 +8544,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +CTLD.UserSetGroup + + +
@@ -8741,17 +8691,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

#1570

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

time to repairor build a unit/group

+

noob catch

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

sub categories

- @@ -18978,17 +18914,6 @@ However, if you create a new folder inside the miz file, which contains the soun

Field(s)

-
-
- - #number -CTLD.CargoCounter - - - -
- -
@@ -19055,17 +18980,6 @@ However, if you create a new folder inside the miz file, which contains the soun

Name of the class.

-
- -
-
-
- - #number -CTLD.CrateCounter - - -
@@ -19086,7 +19000,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.CtldUnits @@ -19108,7 +19022,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.DroppedTroops @@ -19133,28 +19047,11 @@ However, if you create a new folder inside the miz file, which contains the soun
- #number -CTLD.Engineers - - - -

use as counter

- -
- -
-
-
- - #table CTLD.EngineersInField - -

holds #CTLD_ENGINEERING objects

-
@@ -19208,14 +19105,11 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.FreeVHFFrequencies - -

Beacons

-
@@ -19336,11 +19230,14 @@ However, if you create a new folder inside the miz file, which contains the soun
- #string + CTLD.RadioPath + +

Folderpath.

+
@@ -19402,17 +19299,6 @@ However, if you create a new folder inside the miz file, which contains the soun -
- -
-
-
- - #number -CTLD.TroopCounter - - -
@@ -19457,6 +19343,17 @@ However, if you create a new folder inside the miz file, which contains the soun +
+ +
+
+
+ + +CTLD.UserSetGroup + + +
@@ -19593,17 +19490,6 @@ However, if you create a new folder inside the miz file, which contains the soun

#1570

- - - -
-
- - #table -CTLD.droppedBeacons - - -
@@ -19874,7 +19760,7 @@ However, if you create a new folder inside the miz file, which contains the soun -

time to repairor build a unit/group

+

noob catch

@@ -20000,9 +19886,6 @@ However, if you create a new folder inside the miz file, which contains the soun - -

sub categories

- @@ -21484,17 +21367,6 @@ However, if you create a new folder inside the miz file, which contains the soun

Field(s)

-
-
- - #number -CTLD.CargoCounter - - - -
- -
@@ -21561,17 +21433,6 @@ However, if you create a new folder inside the miz file, which contains the soun

Name of the class.

-
- -
-
-
- - #number -CTLD.CrateCounter - - -
@@ -21592,7 +21453,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.CtldUnits @@ -21614,7 +21475,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.DroppedTroops @@ -21639,28 +21500,11 @@ However, if you create a new folder inside the miz file, which contains the soun
- #number -CTLD.Engineers - - - -

use as counter

- -
- -
-
-
- - #table CTLD.EngineersInField - -

holds #CTLD_ENGINEERING objects

-
@@ -21714,14 +21558,11 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.FreeVHFFrequencies - -

Beacons

-
@@ -21842,11 +21683,14 @@ However, if you create a new folder inside the miz file, which contains the soun
- #string + CTLD.RadioPath + +

Folderpath.

+
@@ -21908,17 +21752,6 @@ However, if you create a new folder inside the miz file, which contains the soun -
- -
-
-
- - #number -CTLD.TroopCounter - - -
@@ -21963,6 +21796,17 @@ However, if you create a new folder inside the miz file, which contains the soun +
+ +
+
+
+ + +CTLD.UserSetGroup + + +
@@ -22099,17 +21943,6 @@ However, if you create a new folder inside the miz file, which contains the soun

#1570

- - - -
-
- - #table -CTLD.droppedBeacons - - -
@@ -22380,7 +22213,7 @@ However, if you create a new folder inside the miz file, which contains the soun -

time to repairor build a unit/group

+

noob catch

@@ -22506,9 +22339,6 @@ However, if you create a new folder inside the miz file, which contains the soun - -

sub categories

- @@ -37136,17 +36966,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

template for a group of 10 paratroopers

- - - -
-
- - #number -CTLD_HERCULES.j - - -
@@ -38473,17 +38292,6 @@ Use either this method to integrate the Hercules **or** the one from the "normal

template for a group of 10 paratroopers

- - - -
-
- - #number -CTLD_HERCULES.j - - -
diff --git a/Documentation/Ops.RecoveryTanker.html b/Documentation/Ops.RecoveryTanker.html index cb53fb549..f6e80c196 100644 --- a/Documentation/Ops.RecoveryTanker.html +++ b/Documentation/Ops.RecoveryTanker.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Ops.RescueHelo.html b/Documentation/Ops.RescueHelo.html index f5c90af57..6db70dd0a 100644 --- a/Documentation/Ops.RescueHelo.html +++ b/Documentation/Ops.RescueHelo.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Shapes.CUBE.html b/Documentation/Shapes.CUBE.html index 2afdf6355..af20d9d4e 100644 --- a/Documentation/Shapes.CUBE.html +++ b/Documentation/Shapes.CUBE.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Shapes.LINE.html b/Documentation/Shapes.LINE.html index 613fda147..7fa5a0ce1 100644 --- a/Documentation/Shapes.LINE.html +++ b/Documentation/Shapes.LINE.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Shapes.OVAL.html b/Documentation/Shapes.OVAL.html index 5b0adc488..547d920de 100644 --- a/Documentation/Shapes.OVAL.html +++ b/Documentation/Shapes.OVAL.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Shapes.POLYGON.html b/Documentation/Shapes.POLYGON.html index 0e37e3242..39195436c 100644 --- a/Documentation/Shapes.POLYGON.html +++ b/Documentation/Shapes.POLYGON.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Shapes.SHAPE_BASE.html b/Documentation/Shapes.SHAPE_BASE.html index 7f8c17f7c..5e4b883d9 100644 --- a/Documentation/Shapes.SHAPE_BASE.html +++ b/Documentation/Shapes.SHAPE_BASE.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Shapes.TRIANGLE.html b/Documentation/Shapes.TRIANGLE.html index f8ee86598..2f95ad102 100644 --- a/Documentation/Shapes.TRIANGLE.html +++ b/Documentation/Shapes.TRIANGLE.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Sound.Radio.html b/Documentation/Sound.Radio.html index 10182a5b3..7ff227c44 100644 --- a/Documentation/Sound.Radio.html +++ b/Documentation/Sound.Radio.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Sound.RadioQueue.html b/Documentation/Sound.RadioQueue.html index c933a40ed..5ccad52f8 100644 --- a/Documentation/Sound.RadioQueue.html +++ b/Documentation/Sound.RadioQueue.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Sound.RadioSpeech.html b/Documentation/Sound.RadioSpeech.html index 185b98bc0..8ce013b2f 100644 --- a/Documentation/Sound.RadioSpeech.html +++ b/Documentation/Sound.RadioSpeech.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Sound.SRS.html b/Documentation/Sound.SRS.html index 183dd764b..fd6e7758d 100644 --- a/Documentation/Sound.SRS.html +++ b/Documentation/Sound.SRS.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Sound.SoundOutput.html b/Documentation/Sound.SoundOutput.html index 76f57d5a3..50d815644 100644 --- a/Documentation/Sound.SoundOutput.html +++ b/Documentation/Sound.SoundOutput.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Sound.UserSound.html b/Documentation/Sound.UserSound.html index 9a833ef3a..cbdcb769e 100644 --- a/Documentation/Sound.UserSound.html +++ b/Documentation/Sound.UserSound.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Tasking.CommandCenter.html b/Documentation/Tasking.CommandCenter.html index fc6aa4d7f..6f3a1d77b 100644 --- a/Documentation/Tasking.CommandCenter.html +++ b/Documentation/Tasking.CommandCenter.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Tasking.DetectionManager.html b/Documentation/Tasking.DetectionManager.html index d33713040..1ec6c2ff5 100644 --- a/Documentation/Tasking.DetectionManager.html +++ b/Documentation/Tasking.DetectionManager.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Tasking.Mission.html b/Documentation/Tasking.Mission.html index d07c8604d..fa5c179ca 100644 --- a/Documentation/Tasking.Mission.html +++ b/Documentation/Tasking.Mission.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Tasking.Task.html b/Documentation/Tasking.Task.html index dd6d68c3a..6b41fe068 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Tasking.TaskInfo.html b/Documentation/Tasking.TaskInfo.html index 73e7f2df1..5c4364932 100644 --- a/Documentation/Tasking.TaskInfo.html +++ b/Documentation/Tasking.TaskInfo.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Tasking.Task_A2A.html b/Documentation/Tasking.Task_A2A.html index a1b10293d..6f91ae7ee 100644 --- a/Documentation/Tasking.Task_A2A.html +++ b/Documentation/Tasking.Task_A2A.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Tasking.Task_A2A_Dispatcher.html b/Documentation/Tasking.Task_A2A_Dispatcher.html index 9d1d71d75..20b645ec3 100644 --- a/Documentation/Tasking.Task_A2A_Dispatcher.html +++ b/Documentation/Tasking.Task_A2A_Dispatcher.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Tasking.Task_A2G.html b/Documentation/Tasking.Task_A2G.html index be740357a..6f0ce4408 100644 --- a/Documentation/Tasking.Task_A2G.html +++ b/Documentation/Tasking.Task_A2G.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Tasking.Task_A2G_Dispatcher.html b/Documentation/Tasking.Task_A2G_Dispatcher.html index 5a2c4b978..73bfefb18 100644 --- a/Documentation/Tasking.Task_A2G_Dispatcher.html +++ b/Documentation/Tasking.Task_A2G_Dispatcher.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Tasking.Task_CARGO.html b/Documentation/Tasking.Task_CARGO.html index dad052db6..f49c46cfe 100644 --- a/Documentation/Tasking.Task_CARGO.html +++ b/Documentation/Tasking.Task_CARGO.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -3335,22 +3324,11 @@ based on the tasking capabilities defined in
- Cargo.Cargo#CARGO + FSM_PROCESS.Cargo -
- - -
-
- - -FSM_PROCESS.DeployZone - - -
diff --git a/Documentation/Tasking.Task_Capture_Dispatcher.html b/Documentation/Tasking.Task_Capture_Dispatcher.html index f090a4c4a..ed868c08b 100644 --- a/Documentation/Tasking.Task_Capture_Dispatcher.html +++ b/Documentation/Tasking.Task_Capture_Dispatcher.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Tasking.Task_Capture_Zone.html b/Documentation/Tasking.Task_Capture_Zone.html index 5ba809e1e..f1c1169dd 100644 --- a/Documentation/Tasking.Task_Capture_Zone.html +++ b/Documentation/Tasking.Task_Capture_Zone.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Tasking.Task_Cargo_CSAR.html b/Documentation/Tasking.Task_Cargo_CSAR.html index c89541413..c521e7d72 100644 --- a/Documentation/Tasking.Task_Cargo_CSAR.html +++ b/Documentation/Tasking.Task_Cargo_CSAR.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index 6b6c8111a..e027297b2 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -3376,61 +3365,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-TASK_CARGO_DISPATCHER.CSARBriefing - - - -
- - -
-
- - -TASK_CARGO_DISPATCHER.CSARDeployZones - - - -
- -
-
-
- - -TASK_CARGO_DISPATCHER.CSARTaskName - - - -
- -
-
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
-
-
- - #number -TASK_CARGO_DISPATCHER.CountCSAR - - - -
- -
-
-
- - #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4537,61 +4471,6 @@ This method can only be used once!

-TASK_CARGO_DISPATCHER.CSARBriefing - - - -
- -
-
-
- - -TASK_CARGO_DISPATCHER.CSARDeployZones - - - -
- -
-
-
- - -TASK_CARGO_DISPATCHER.CSARTaskName - - - -
- -
-
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
-
-
- - #number -TASK_CARGO_DISPATCHER.CountCSAR - - - -
- -
-
-
- - #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -5450,61 +5329,6 @@ This method can only be used once!

-TASK_CARGO_DISPATCHER.CSARBriefing - - - -
- -
-
-
- - -TASK_CARGO_DISPATCHER.CSARDeployZones - - - -
- -
-
-
- - -TASK_CARGO_DISPATCHER.CSARTaskName - - - -
- -
-
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
-
-
- - #number -TASK_CARGO_DISPATCHER.CountCSAR - - - -
- -
-
-
- - #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -6994,61 +6818,6 @@ This method can only be used once!

-TASK_CARGO_DISPATCHER.CSARBriefing - - - -
- -
-
-
- - -TASK_CARGO_DISPATCHER.CSARDeployZones - - - -
- -
-
-
- - -TASK_CARGO_DISPATCHER.CSARTaskName - - - -
- -
-
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
-
-
- - #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 e40ce14e5..129183a43 100644 --- a/Documentation/Tasking.Task_Cargo_Transport.html +++ b/Documentation/Tasking.Task_Cargo_Transport.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

-
-
-
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Tasking.Task_Manager.html b/Documentation/Tasking.Task_Manager.html index 49f83a1f1..12570fa32 100644 --- a/Documentation/Tasking.Task_Manager.html +++ b/Documentation/Tasking.Task_Manager.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

-
- -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Utilities.Enums.html b/Documentation/Utilities.Enums.html index f86641791..6bf52671e 100644 --- a/Documentation/Utilities.Enums.html +++ b/Documentation/Utilities.Enums.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Utilities.FiFo.html b/Documentation/Utilities.FiFo.html index e486f4914..b63e0b7dc 100644 --- a/Documentation/Utilities.FiFo.html +++ b/Documentation/Utilities.FiFo.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -8118,6 +8107,17 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +
+
+ + #number +LIFO.uniquecounter + + +
@@ -8967,6 +8967,17 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +
+
+ + #number +LIFO.uniquecounter + + +
diff --git a/Documentation/Utilities.Profiler.html b/Documentation/Utilities.Profiler.html index 01fd9144b..3065e0ff7 100644 --- a/Documentation/Utilities.Profiler.html +++ b/Documentation/Utilities.Profiler.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Utilities.STTS.html b/Documentation/Utilities.STTS.html index a2f9df0a6..8aa435e45 100644 --- a/Documentation/Utilities.STTS.html +++ b/Documentation/Utilities.STTS.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Utilities.Socket.html b/Documentation/Utilities.Socket.html index 1e00d6072..98bbcceec 100644 --- a/Documentation/Utilities.Socket.html +++ b/Documentation/Utilities.Socket.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Utilities.Templates.html b/Documentation/Utilities.Templates.html index 67a1606cb..f41d7d7de 100644 --- a/Documentation/Utilities.Templates.html +++ b/Documentation/Utilities.Templates.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Utilities.Utils.html b/Documentation/Utilities.Utils.html index 1ef8991a8..6d8010923 100644 --- a/Documentation/Utilities.Utils.html +++ b/Documentation/Utilities.Utils.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Wrapper.Airbase.html b/Documentation/Wrapper.Airbase.html index 16365f5fb..c2b1ab756 100644 --- a/Documentation/Wrapper.Airbase.html +++ b/Documentation/Wrapper.Airbase.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Wrapper.Client.html b/Documentation/Wrapper.Client.html index 2fffa37a7..ff9b9ff3b 100644 --- a/Documentation/Wrapper.Client.html +++ b/Documentation/Wrapper.Client.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Wrapper.Controllable.html b/Documentation/Wrapper.Controllable.html index 0e260fb14..a65fbc945 100644 --- a/Documentation/Wrapper.Controllable.html +++ b/Documentation/Wrapper.Controllable.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -4563,6 +4552,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +CONTROLLABLE.spot + + +
@@ -17599,6 +17599,17 @@ mygroup:WayPointExecute() + + + +
+
+ + +CONTROLLABLE.spot + + +
@@ -21622,6 +21633,17 @@ Coordinates are dependent on the position of the maps origin.

+ + + +
+
+ + +CONTROLLABLE.spot + + +
@@ -22197,6 +22219,17 @@ If the Identifiable is alive, true is returned.

+ + + +
+
+ + +CONTROLLABLE.spot + + +
@@ -22373,6 +22406,17 @@ If the Identifiable is alive, true is returned.

+ + + +
+
+ + +CONTROLLABLE.spot + + +
diff --git a/Documentation/Wrapper.DynamicCargo.html b/Documentation/Wrapper.DynamicCargo.html index 94bf290f3..ed9bcd86d 100644 --- a/Documentation/Wrapper.DynamicCargo.html +++ b/Documentation/Wrapper.DynamicCargo.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index 2c6e19f3c..6bb8a283c 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Wrapper.Identifiable.html b/Documentation/Wrapper.Identifiable.html index deb9bda49..9ea2909e9 100644 --- a/Documentation/Wrapper.Identifiable.html +++ b/Documentation/Wrapper.Identifiable.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index a91c10881..b06be5755 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -3269,6 +3258,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #boolean +MARKER.tocoalition + + + +
+ +
+
+
+ + #boolean +MARKER.togroup + + +
@@ -5386,6 +5397,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #boolean +MARKER.tocoalition + + + +
+ +
+
+
+ + #boolean +MARKER.togroup + + +
@@ -6974,6 +7007,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #boolean +MARKER.tocoalition + + + +
+ +
+
+
+ + #boolean +MARKER.togroup + + +
diff --git a/Documentation/Wrapper.Net.html b/Documentation/Wrapper.Net.html index 2e191f2e0..01aa7728d 100644 --- a/Documentation/Wrapper.Net.html +++ b/Documentation/Wrapper.Net.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Wrapper.Object.html b/Documentation/Wrapper.Object.html index 6f20c85af..d8d82342a 100644 --- a/Documentation/Wrapper.Object.html +++ b/Documentation/Wrapper.Object.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index 631b17470..5f9d6b211 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Wrapper.Scenery.html b/Documentation/Wrapper.Scenery.html index fcfce2d2b..145c7d936 100644 --- a/Documentation/Wrapper.Scenery.html +++ b/Documentation/Wrapper.Scenery.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Wrapper.Static.html b/Documentation/Wrapper.Static.html index 46baf5489..e0d07c8e1 100644 --- a/Documentation/Wrapper.Static.html +++ b/Documentation/Wrapper.Static.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Wrapper.Storage.html b/Documentation/Wrapper.Storage.html index f2405570b..98326be67 100644 --- a/Documentation/Wrapper.Storage.html +++ b/Documentation/Wrapper.Storage.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Wrapper.Unit.html b/Documentation/Wrapper.Unit.html index 300b2d08b..043df4ab1 100644 --- a/Documentation/Wrapper.Unit.html +++ b/Documentation/Wrapper.Unit.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/Wrapper.Weapon.html b/Documentation/Wrapper.Weapon.html index 884bd91e2..5ffef0bc7 100644 --- a/Documentation/Wrapper.Weapon.html +++ b/Documentation/Wrapper.Weapon.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

diff --git a/Documentation/index.html b/Documentation/index.html index c521fe83c..280dc9f0f 100644 --- a/Documentation/index.html +++ b/Documentation/index.html @@ -689,17 +689,6 @@

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - -
-
-
- Image -

Core.Spawn

-
-

-

Core - Spawn dynamically new groups of units in running missions.

@@ -2423,18 +2412,6 @@

Core.Settings

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.

-

- - - -
-
- Image -
-
-

Core.Spawn

-

-

Core - Spawn dynamically new groups of units in running missions.