From be8c95fcfd69fa7239f309ba4a14fcd5d04cbc8a Mon Sep 17 00:00:00 2001 From: Applevangelist Date: Mon, 20 Dec 2021 12:06:00 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2A_Cap.html | 14 +- Documentation/AI.AI_A2A_Dispatcher.html | 14 +- Documentation/AI.AI_A2G_Dispatcher.html | 14 +- Documentation/AI.AI_AIR_Dispatcher.html | 58 +- Documentation/AI.AI_Air.html | 14 +- Documentation/AI.AI_Air_Patrol.html | 14 +- Documentation/AI.AI_Bai.html | 14 +- Documentation/AI.AI_Balancer.html | 14 +- Documentation/AI.AI_Cap.html | 14 +- Documentation/AI.AI_Cargo.html | 14 +- Documentation/AI.AI_Cargo_APC.html | 14 +- Documentation/AI.AI_Cargo_Airplane.html | 82 ++- Documentation/AI.AI_Cargo_Dispatcher.html | 14 +- Documentation/AI.AI_Cargo_Dispatcher_APC.html | 14 +- .../AI.AI_Cargo_Dispatcher_Airplane.html | 14 +- .../AI.AI_Cargo_Dispatcher_Helicopter.html | 14 +- .../AI.AI_Cargo_Dispatcher_Ship.html | 14 +- Documentation/AI.AI_Cargo_Helicopter.html | 14 +- Documentation/AI.AI_Cargo_Ship.html | 14 +- Documentation/AI.AI_Cas.html | 14 +- .../AI.AI_ESCORT_DISPATCHER_REQUEST.html | 14 +- Documentation/AI.AI_Escort_Dispatcher.html | 14 +- Documentation/AI.AI_Formation.html | 14 +- Documentation/AI.AI_Patrol.html | 26 +- Documentation/Actions.Account.html | 14 +- Documentation/Actions.Assign.html | 14 +- Documentation/Actions.Assist.html | 14 +- Documentation/Actions.Route.html | 14 +- Documentation/Cargo.Cargo.html | 14 +- Documentation/Cargo.CargoGroup.html | 28 - Documentation/Cargo.CargoUnit.html | 44 +- Documentation/Core.Fsm.html | 127 ++-- Documentation/Core.Goal.html | 16 +- Documentation/Core.Menu.html | 90 +-- Documentation/Core.Message.html | 140 ++-- Documentation/Core.Point.html | 33 - Documentation/Core.Report.html | 4 +- Documentation/Core.ScheduleDispatcher.html | 24 +- Documentation/Core.Scheduler.html | 38 +- Documentation/Core.Settings.html | 26 +- Documentation/Core.Spawn.html | 689 ++++++++---------- Documentation/Core.SpawnStatic.html | 84 --- Documentation/Core.Spot.html | 146 +++- Documentation/Core.Zone.html | 14 +- Documentation/Functional.Arty.html | 14 +- Documentation/Functional.Designate.html | 69 +- Documentation/Functional.Detection.html | 89 ++- Documentation/Functional.FOX.html | 14 +- Documentation/Functional.Mantis.html | 6 - Documentation/Functional.Range.html | 14 +- Documentation/Functional.Rat.html | 522 +++++++------ Documentation/Functional.Suppression.html | 14 +- Documentation/Functional.Warehouse.html | 14 +- Documentation/Ops.Airboss.html | 33 +- Documentation/Ops.Atis.html | 14 +- Documentation/Ops.CSAR.html | 149 +--- Documentation/Ops.CTLD.html | 238 +++++- Documentation/Ops.RecoveryTanker.html | 14 +- Documentation/Ops.RescueHelo.html | 14 +- Documentation/Tasking.DetectionManager.html | 14 +- Documentation/Tasking.Mission.html | 14 +- .../Tasking.Task_A2A_Dispatcher.html | 14 +- .../Tasking.Task_A2G_Dispatcher.html | 14 +- Documentation/Tasking.Task_Cargo.html | 8 +- .../Tasking.Task_Cargo_Dispatcher.html | 198 ++++- Documentation/Tasking.Task_Manager.html | 14 +- .../Tasking.Task_Zone_Capture_Dispatcher.html | 14 +- Documentation/Wrapper.Group.html | 78 +- Documentation/Wrapper.Marker.html | 80 +- 69 files changed, 2023 insertions(+), 1676 deletions(-) diff --git a/Documentation/AI.AI_A2A_Cap.html b/Documentation/AI.AI_A2A_Cap.html index 2600e7ba7..ec8370a7d 100644 --- a/Documentation/AI.AI_A2A_Cap.html +++ b/Documentation/AI.AI_A2A_Cap.html @@ -8495,7 +8495,7 @@ Once the time is finished, the old AI will return to the base.

-

Current FSM state.

+

Current FSM state.

@@ -8824,7 +8824,7 @@ Once the time is finished, the old AI will return to the base.

-

Table of call backs.

+

Table of call backs.

@@ -9098,7 +9098,7 @@ Once the time is finished, the old AI will return to the base.

-

Event name.

+

Event name.

@@ -9109,7 +9109,7 @@ Once the time is finished, the old AI will return to the base.

-

Function.

+

Function.

@@ -9142,7 +9142,7 @@ Once the time is finished, the old AI will return to the base.

-

Event name.

+

Event name.

@@ -9412,7 +9412,7 @@ Once the time is finished, the old AI will return to the base.

-

Name.

+

Name.

@@ -9554,7 +9554,7 @@ Once the time is finished, the old AI will return to the base.

-

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/AI.AI_A2A_Dispatcher.html b/Documentation/AI.AI_A2A_Dispatcher.html index 339ce97f8..46d125381 100644 --- a/Documentation/AI.AI_A2A_Dispatcher.html +++ b/Documentation/AI.AI_A2A_Dispatcher.html @@ -12863,7 +12863,7 @@ They will lock the parking spot.

-

Current FSM state.

+

Current FSM state.

@@ -13192,7 +13192,7 @@ They will lock the parking spot.

-

Table of call backs.

+

Table of call backs.

@@ -13466,7 +13466,7 @@ They will lock the parking spot.

-

Event name.

+

Event name.

@@ -13477,7 +13477,7 @@ They will lock the parking spot.

-

Function.

+

Function.

@@ -13510,7 +13510,7 @@ They will lock the parking spot.

-

Event name.

+

Event name.

@@ -13780,7 +13780,7 @@ They will lock the parking spot.

-

Name.

+

Name.

@@ -13922,7 +13922,7 @@ They will lock the parking spot.

-

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html index eb19ced3a..7c17dceec 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -14837,7 +14837,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

-

Current FSM state.

+

Current FSM state.

@@ -15166,7 +15166,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

-

Table of call backs.

+

Table of call backs.

@@ -15440,7 +15440,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

-

Event name.

+

Event name.

@@ -15451,7 +15451,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

-

Function.

+

Function.

@@ -15484,7 +15484,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

-

Event name.

+

Event name.

@@ -15754,7 +15754,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

-

Name.

+

Name.

@@ -15896,7 +15896,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

-

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/AI.AI_AIR_Dispatcher.html b/Documentation/AI.AI_AIR_Dispatcher.html index 27694aa04..9ed05de83 100644 --- a/Documentation/AI.AI_AIR_Dispatcher.html +++ b/Documentation/AI.AI_AIR_Dispatcher.html @@ -4440,6 +4440,17 @@ 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 + + +
@@ -9737,6 +9748,17 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_AIR_DISPATCHER.DefenderPatrolIndex + + +
@@ -11585,7 +11618,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

-

Current FSM state.

+

Current FSM state.

@@ -11914,7 +11947,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

-

Table of call backs.

+

Table of call backs.

@@ -12188,7 +12221,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

-

Event name.

+

Event name.

@@ -12199,7 +12232,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

-

Function.

+

Function.

@@ -12232,7 +12265,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

-

Event name.

+

Event name.

@@ -12502,7 +12535,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

-

Name.

+

Name.

@@ -12644,7 +12677,7 @@ multiplied by the Overhead and rounded up to the smallest integer.

-

true, FSM is in this state.

+

true, FSM is in this state.

@@ -12677,6 +12710,17 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_AIR_DISPATCHER.DefenderPatrolIndex + + +
diff --git a/Documentation/AI.AI_Air.html b/Documentation/AI.AI_Air.html index fb06814c7..945b9fb3e 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -6931,7 +6931,7 @@ Once the time is finished, the old AI will return to the base.

-

Current FSM state.

+

Current FSM state.

@@ -7260,7 +7260,7 @@ Once the time is finished, the old AI will return to the base.

-

Table of call backs.

+

Table of call backs.

@@ -7534,7 +7534,7 @@ Once the time is finished, the old AI will return to the base.

-

Event name.

+

Event name.

@@ -7545,7 +7545,7 @@ Once the time is finished, the old AI will return to the base.

-

Function.

+

Function.

@@ -7578,7 +7578,7 @@ Once the time is finished, the old AI will return to the base.

-

Event name.

+

Event name.

@@ -7848,7 +7848,7 @@ Once the time is finished, the old AI will return to the base.

-

Name.

+

Name.

@@ -7990,7 +7990,7 @@ Once the time is finished, the old AI will return to the base.

-

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/AI.AI_Air_Patrol.html b/Documentation/AI.AI_Air_Patrol.html index fd32f851c..9a1aad4b0 100644 --- a/Documentation/AI.AI_Air_Patrol.html +++ b/Documentation/AI.AI_Air_Patrol.html @@ -8025,7 +8025,7 @@ Once the time is finished, the old AI will return to the base.

-

Current FSM state.

+

Current FSM state.

@@ -8354,7 +8354,7 @@ Once the time is finished, the old AI will return to the base.

-

Table of call backs.

+

Table of call backs.

@@ -8628,7 +8628,7 @@ Once the time is finished, the old AI will return to the base.

-

Event name.

+

Event name.

@@ -8639,7 +8639,7 @@ Once the time is finished, the old AI will return to the base.

-

Function.

+

Function.

@@ -8672,7 +8672,7 @@ Once the time is finished, the old AI will return to the base.

-

Event name.

+

Event name.

@@ -8942,7 +8942,7 @@ Once the time is finished, the old AI will return to the base.

-

Name.

+

Name.

@@ -9084,7 +9084,7 @@ Once the time is finished, the old AI will return to the base.

-

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/AI.AI_Bai.html b/Documentation/AI.AI_Bai.html index 1cbbde787..f51746389 100644 --- a/Documentation/AI.AI_Bai.html +++ b/Documentation/AI.AI_Bai.html @@ -9895,7 +9895,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Current FSM state.

+

Current FSM state.

@@ -10224,7 +10224,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Table of call backs.

+

Table of call backs.

@@ -10498,7 +10498,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Event name.

+

Event name.

@@ -10509,7 +10509,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Function.

+

Function.

@@ -10542,7 +10542,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Event name.

+

Event name.

@@ -10812,7 +10812,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Name.

+

Name.

@@ -10954,7 +10954,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/AI.AI_Balancer.html b/Documentation/AI.AI_Balancer.html index b0cbedd3c..7a0c7b3cb 100644 --- a/Documentation/AI.AI_Balancer.html +++ b/Documentation/AI.AI_Balancer.html @@ -3876,7 +3876,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

Current FSM state.

+

Current FSM state.

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

Table of call backs.

+

Table of call backs.

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

Event name.

+

Event name.

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

Function.

+

Function.

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

Event name.

+

Event name.

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

Name.

+

Name.

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

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/AI.AI_Cap.html b/Documentation/AI.AI_Cap.html index 29101304f..f7c73dd04 100644 --- a/Documentation/AI.AI_Cap.html +++ b/Documentation/AI.AI_Cap.html @@ -9506,7 +9506,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Current FSM state.

+

Current FSM state.

@@ -9835,7 +9835,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Table of call backs.

+

Table of call backs.

@@ -10109,7 +10109,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Event name.

+

Event name.

@@ -10120,7 +10120,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Function.

+

Function.

@@ -10153,7 +10153,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Event name.

+

Event name.

@@ -10423,7 +10423,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Name.

+

Name.

@@ -10565,7 +10565,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html index 940904080..8d818d32d 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -5695,7 +5695,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

Current FSM state.

+

Current FSM state.

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

Table of call backs.

+

Table of call backs.

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

Event name.

+

Event name.

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

Function.

+

Function.

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

Event name.

+

Event name.

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

Name.

+

Name.

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

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/AI.AI_Cargo_APC.html b/Documentation/AI.AI_Cargo_APC.html index 2a40855bb..04d883912 100644 --- a/Documentation/AI.AI_Cargo_APC.html +++ b/Documentation/AI.AI_Cargo_APC.html @@ -7562,7 +7562,7 @@ AICargoAPC:SetCombatRadius( false )
-

Current FSM state.

+

Current FSM state.

@@ -7891,7 +7891,7 @@ AICargoAPC:SetCombatRadius( false )
-

Table of call backs.

+

Table of call backs.

@@ -8165,7 +8165,7 @@ AICargoAPC:SetCombatRadius( false )
-

Event name.

+

Event name.

@@ -8176,7 +8176,7 @@ AICargoAPC:SetCombatRadius( false )
-

Function.

+

Function.

@@ -8209,7 +8209,7 @@ AICargoAPC:SetCombatRadius( false )
-

Event name.

+

Event name.

@@ -8479,7 +8479,7 @@ AICargoAPC:SetCombatRadius( false )
-

Name.

+

Name.

@@ -8621,7 +8621,7 @@ AICargoAPC:SetCombatRadius( false )
-

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index de6a5aaa4..c19959a55 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2620,6 +2620,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + + +

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + + +

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + + +

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Current FSM state.

+

Current FSM state.

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

Table of call backs.

+

Table of call backs.

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

Event name.

+

Event name.

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

Function.

+

Function.

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

Event name.

+

Event name.

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

Name.

+

Name.

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

true, FSM is in this state.

+

true, FSM is in this state.

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

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + + +

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

+
diff --git a/Documentation/AI.AI_Cargo_Dispatcher.html b/Documentation/AI.AI_Cargo_Dispatcher.html index 47e2acf28..28b2de6d8 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher.html +++ b/Documentation/AI.AI_Cargo_Dispatcher.html @@ -6230,7 +6230,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Current FSM state.

+

Current FSM state.

@@ -6559,7 +6559,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Table of call backs.

+

Table of call backs.

@@ -6833,7 +6833,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Event name.

+

Event name.

@@ -6844,7 +6844,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Function.

+

Function.

@@ -6877,7 +6877,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Event name.

+

Event name.

@@ -7147,7 +7147,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Name.

+

Name.

@@ -7289,7 +7289,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_APC.html b/Documentation/AI.AI_Cargo_Dispatcher_APC.html index 6797e6e98..7e0c7b752 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_APC.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_APC.html @@ -5830,7 +5830,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Current FSM state.

+

Current FSM state.

@@ -6159,7 +6159,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Table of call backs.

+

Table of call backs.

@@ -6433,7 +6433,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Event name.

+

Event name.

@@ -6444,7 +6444,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Function.

+

Function.

@@ -6477,7 +6477,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Event name.

+

Event name.

@@ -6747,7 +6747,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Name.

+

Name.

@@ -6889,7 +6889,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html b/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html index 3a2c7b88e..5dfcedb92 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html @@ -5424,7 +5424,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Current FSM state.

+

Current FSM state.

@@ -5753,7 +5753,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Table of call backs.

+

Table of call backs.

@@ -6027,7 +6027,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Event name.

+

Event name.

@@ -6038,7 +6038,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Function.

+

Function.

@@ -6071,7 +6071,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Event name.

+

Event name.

@@ -6341,7 +6341,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Name.

+

Name.

@@ -6483,7 +6483,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html b/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html index 94f33d1be..91f262de2 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html @@ -5456,7 +5456,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Current FSM state.

+

Current FSM state.

@@ -5785,7 +5785,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Table of call backs.

+

Table of call backs.

@@ -6059,7 +6059,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Event name.

+

Event name.

@@ -6070,7 +6070,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Function.

+

Function.

@@ -6103,7 +6103,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Event name.

+

Event name.

@@ -6373,7 +6373,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Name.

+

Name.

@@ -6515,7 +6515,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_Ship.html b/Documentation/AI.AI_Cargo_Dispatcher_Ship.html index c76881d9d..3e2375668 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_Ship.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_Ship.html @@ -5499,7 +5499,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Current FSM state.

+

Current FSM state.

@@ -5828,7 +5828,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Table of call backs.

+

Table of call backs.

@@ -6102,7 +6102,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Event name.

+

Event name.

@@ -6113,7 +6113,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Function.

+

Function.

@@ -6146,7 +6146,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Event name.

+

Event name.

@@ -6416,7 +6416,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

Name.

+

Name.

@@ -6558,7 +6558,7 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
-

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/AI.AI_Cargo_Helicopter.html b/Documentation/AI.AI_Cargo_Helicopter.html index b8d9cb183..f5b87d05f 100644 --- a/Documentation/AI.AI_Cargo_Helicopter.html +++ b/Documentation/AI.AI_Cargo_Helicopter.html @@ -5760,7 +5760,7 @@ Adjust if necessary.
-

Current FSM state.

+

Current FSM state.

@@ -6089,7 +6089,7 @@ Adjust if necessary.
-

Table of call backs.

+

Table of call backs.

@@ -6363,7 +6363,7 @@ Adjust if necessary.
-

Event name.

+

Event name.

@@ -6374,7 +6374,7 @@ Adjust if necessary.
-

Function.

+

Function.

@@ -6407,7 +6407,7 @@ Adjust if necessary.
-

Event name.

+

Event name.

@@ -6677,7 +6677,7 @@ Adjust if necessary.
-

Name.

+

Name.

@@ -6819,7 +6819,7 @@ Adjust if necessary.
-

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/AI.AI_Cargo_Ship.html b/Documentation/AI.AI_Cargo_Ship.html index 4cd8d4721..7adb30769 100644 --- a/Documentation/AI.AI_Cargo_Ship.html +++ b/Documentation/AI.AI_Cargo_Ship.html @@ -6760,7 +6760,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

Current FSM state.

+

Current FSM state.

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

Table of call backs.

+

Table of call backs.

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

Event name.

+

Event name.

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

Function.

+

Function.

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

Event name.

+

Event name.

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

Name.

+

Name.

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

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/AI.AI_Cas.html b/Documentation/AI.AI_Cas.html index c1d254b96..1c2807d39 100644 --- a/Documentation/AI.AI_Cas.html +++ b/Documentation/AI.AI_Cas.html @@ -9731,7 +9731,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Current FSM state.

+

Current FSM state.

@@ -10060,7 +10060,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Table of call backs.

+

Table of call backs.

@@ -10334,7 +10334,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Event name.

+

Event name.

@@ -10345,7 +10345,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Function.

+

Function.

@@ -10378,7 +10378,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Event name.

+

Event name.

@@ -10648,7 +10648,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Name.

+

Name.

@@ -10790,7 +10790,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/AI.AI_ESCORT_DISPATCHER_REQUEST.html b/Documentation/AI.AI_ESCORT_DISPATCHER_REQUEST.html index 3ff716650..4778b4fd9 100644 --- a/Documentation/AI.AI_ESCORT_DISPATCHER_REQUEST.html +++ b/Documentation/AI.AI_ESCORT_DISPATCHER_REQUEST.html @@ -3269,7 +3269,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

Current FSM state.

+

Current FSM state.

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

Table of call backs.

+

Table of call backs.

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

Event name.

+

Event name.

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

Function.

+

Function.

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

Event name.

+

Event name.

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

Name.

+

Name.

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

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/AI.AI_Escort_Dispatcher.html b/Documentation/AI.AI_Escort_Dispatcher.html index 13fb3573c..3025fa1fa 100644 --- a/Documentation/AI.AI_Escort_Dispatcher.html +++ b/Documentation/AI.AI_Escort_Dispatcher.html @@ -3290,7 +3290,7 @@ Red_SU25T_EscortDispatcher:Start()
-

Current FSM state.

+

Current FSM state.

@@ -3619,7 +3619,7 @@ Red_SU25T_EscortDispatcher:Start()
-

Table of call backs.

+

Table of call backs.

@@ -3893,7 +3893,7 @@ Red_SU25T_EscortDispatcher:Start()
-

Event name.

+

Event name.

@@ -3904,7 +3904,7 @@ Red_SU25T_EscortDispatcher:Start()
-

Function.

+

Function.

@@ -3937,7 +3937,7 @@ Red_SU25T_EscortDispatcher:Start()
-

Event name.

+

Event name.

@@ -4207,7 +4207,7 @@ Red_SU25T_EscortDispatcher:Start()
-

Name.

+

Name.

@@ -4349,7 +4349,7 @@ Red_SU25T_EscortDispatcher:Start()
-

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/AI.AI_Formation.html b/Documentation/AI.AI_Formation.html index 57e89efaf..d255c143c 100644 --- a/Documentation/AI.AI_Formation.html +++ b/Documentation/AI.AI_Formation.html @@ -10531,7 +10531,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

Current FSM state.

+

Current FSM state.

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

Table of call backs.

+

Table of call backs.

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

Event name.

+

Event name.

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

Function.

+

Function.

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

Event name.

+

Event name.

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

Name.

+

Name.

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

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/AI.AI_Patrol.html b/Documentation/AI.AI_Patrol.html index 29941877b..6b2552022 100644 --- a/Documentation/AI.AI_Patrol.html +++ b/Documentation/AI.AI_Patrol.html @@ -3136,9 +3136,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

This table contains the targets detected during patrol.

- @@ -6386,9 +6383,6 @@ Note that this method is required, as triggers the next route when patrolling fo - -

This table contains the targets detected during patrol.

- @@ -7133,9 +7127,6 @@ Note that this method is required, as triggers the next route when patrolling fo - -

This table contains the targets detected during patrol.

- @@ -7606,7 +7597,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Current FSM state.

+

Current FSM state.

@@ -7935,7 +7926,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Table of call backs.

+

Table of call backs.

@@ -8209,7 +8200,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Event name.

+

Event name.

@@ -8220,7 +8211,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Function.

+

Function.

@@ -8253,7 +8244,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Event name.

+

Event name.

@@ -8523,7 +8514,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

Name.

+

Name.

@@ -8665,7 +8656,7 @@ Note that this method is required, as triggers the next route when patrolling fo
-

true, FSM is in this state.

+

true, FSM is in this state.

@@ -8772,9 +8763,6 @@ Note that this method is required, as triggers the next route when patrolling fo - -

This table contains the targets detected during patrol.

- diff --git a/Documentation/Actions.Account.html b/Documentation/Actions.Account.html index e89b46277..04580cb7b 100644 --- a/Documentation/Actions.Account.html +++ b/Documentation/Actions.Account.html @@ -4630,7 +4630,7 @@ There are 2 moments when state transition methods will be called by the state ma
-

Current FSM state.

+

Current FSM state.

@@ -4959,7 +4959,7 @@ There are 2 moments when state transition methods will be called by the state ma
-

Table of call backs.

+

Table of call backs.

@@ -5233,7 +5233,7 @@ There are 2 moments when state transition methods will be called by the state ma
-

Event name.

+

Event name.

@@ -5244,7 +5244,7 @@ There are 2 moments when state transition methods will be called by the state ma
-

Function.

+

Function.

@@ -5277,7 +5277,7 @@ There are 2 moments when state transition methods will be called by the state ma
-

Event name.

+

Event name.

@@ -5547,7 +5547,7 @@ There are 2 moments when state transition methods will be called by the state ma
-

Name.

+

Name.

@@ -5689,7 +5689,7 @@ There are 2 moments when state transition methods will be called by the state ma
-

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/Actions.Assign.html b/Documentation/Actions.Assign.html index 3128dd4b2..5dfe3a2de 100644 --- a/Documentation/Actions.Assign.html +++ b/Documentation/Actions.Assign.html @@ -4589,7 +4589,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

Current FSM state.

+

Current FSM state.

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

Table of call backs.

+

Table of call backs.

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

Event name.

+

Event name.

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

Function.

+

Function.

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

Event name.

+

Event name.

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

Name.

+

Name.

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

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/Actions.Assist.html b/Documentation/Actions.Assist.html index 6b7b5dbf2..05e56accb 100644 --- a/Documentation/Actions.Assist.html +++ b/Documentation/Actions.Assist.html @@ -4811,7 +4811,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

Current FSM state.

+

Current FSM state.

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

Table of call backs.

+

Table of call backs.

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

Event name.

+

Event name.

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

Function.

+

Function.

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

Event name.

+

Event name.

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

Name.

+

Name.

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

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/Actions.Route.html b/Documentation/Actions.Route.html index cb9189ab1..d2e0e3eb1 100644 --- a/Documentation/Actions.Route.html +++ b/Documentation/Actions.Route.html @@ -5231,7 +5231,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

Current FSM state.

+

Current FSM state.

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

Table of call backs.

+

Table of call backs.

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

Event name.

+

Event name.

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

Function.

+

Function.

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

Event name.

+

Event name.

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

Name.

+

Name.

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

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/Cargo.Cargo.html b/Documentation/Cargo.Cargo.html index 01b0ff41d..ea6f8534d 100644 --- a/Documentation/Cargo.Cargo.html +++ b/Documentation/Cargo.Cargo.html @@ -8472,7 +8472,7 @@ The cargo must be in the Loaded state.

-

Current FSM state.

+

Current FSM state.

@@ -8801,7 +8801,7 @@ The cargo must be in the Loaded state.

-

Table of call backs.

+

Table of call backs.

@@ -9075,7 +9075,7 @@ The cargo must be in the Loaded state.

-

Event name.

+

Event name.

@@ -9086,7 +9086,7 @@ The cargo must be in the Loaded state.

-

Function.

+

Function.

@@ -9119,7 +9119,7 @@ The cargo must be in the Loaded state.

-

Event name.

+

Event name.

@@ -9389,7 +9389,7 @@ The cargo must be in the Loaded state.

-

Name.

+

Name.

@@ -9531,7 +9531,7 @@ The cargo must be in the Loaded state.

-

true, FSM is in this state.

+

true, FSM is in this state.

diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index ed75b0774..0aebdaa8f 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1820,20 +1820,6 @@ Controls a network of short range air/missile defense groups.

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- - -
-
- - CARGO_GROUP.CargoGroup @@ -3155,20 +3141,6 @@ This works for ground only groups.

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- -
-
-
- - CARGO_GROUP.CargoGroup diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index 92565b046..945e48c7b 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1698,17 +1698,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-CARGO_UNIT.CargoCarrier - - - -
- -
-
-
- - CARGO_UNIT.CargoInAir @@ -1727,6 +1716,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles

Set cargo object.

+
+ +
+
+
+ + #number +CARGO_UNIT.RunCount + + +
@@ -2413,17 +2413,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-CARGO_UNIT.CargoCarrier - - - -
- -
-
-
- - CARGO_UNIT.CargoInAir @@ -2442,6 +2431,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles

Set cargo object.

+
+ +
+
+
+ + #number +CARGO_UNIT.RunCount + + +
diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html index 13d61ff9e..07974b0ba 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -1518,12 +1518,12 @@ Controls a network of short range air/missile defense groups.

A Finite State Machine (FSM) models a process flow that transitions between various States through triggered Events.

A FSM can only be in one of a finite number of states. -The machine is in only one state at a time; the state it is in at any given time is called the current state. -It can change from one state to another when initiated by an internal or external triggering event, which is called a transition. +The machine is in only one state at a time; the state it is in at any given time is called the current state. +It can change from one state to another when initiated by an internal or external triggering event, which is called a transition. An FSM implementation is defined by a list of its states, its initial state, and the triggering events for each possible transition. An FSM implementation is composed out of two parts, a set of state transition rules, and an implementation set of state transition handlers, implementing those transitions.

-

The FSM class supports a hierarchical implementation of a Finite State Machine, +

The FSM class supports a hierarchical implementation of a Finite State Machine, that is, it allows to embed existing FSM implementations in a master FSM. FSM hierarchies allow for efficient FSM re-use, not having to re-invent the wheel every time again when designing complex processes.

@@ -1531,7 +1531,7 @@ FSM hierarchies allow for efficient FSM re-use, not having to re-invent

The above diagram shows a graphical representation of a FSM implementation for a Task, which guides a Human towards a Zone, orders him to destroy x targets and account the results. -Other examples of ready made FSM could be:

+Other examples of ready made FSM could be:

  • route a plane to a zone flown by a human
    • @@ -1541,10 +1541,10 @@ Other examples of ready made FSM could be:

  • let an AI patrol a zone
-

The MOOSE framework uses extensively the FSM class and derived FSM_ classes, +

The MOOSE framework uses extensively the FSM class and derived FSM_ classes, because the goal of MOOSE is to simplify mission design complexity for mission building. By efficiently utilizing the FSM class and derived classes, MOOSE allows mission designers to quickly build processes. -Ready made FSM-based implementations classes exist within the MOOSE framework that can easily be re-used, +Ready made FSM-based implementations classes exist within the MOOSE framework that can easily be re-used, and tailored by mission designers through the implementation of Transition Handlers. Each of these FSM implementation classes start either with:

@@ -1556,7 +1556,7 @@ Each of these FSM implementation classes start either with:

Detailed explanations and API specifics are further below clarified and FSM derived class specifics are described in those class documentation sections.

-

Dislaimer:

+

Disclaimer:

The FSM class development is based on a finite state machine implementation made by Conroy Kyle. The state machine can be found on github I've reworked this development (taken the concept), and created a hierarchical state machine out of it, embedded within the DCS simulator. @@ -1574,7 +1574,6 @@ Additionally, I've added extendability and created an API that allows seamless F

-

Author: FlightControl

Contributions: funkyfranky

@@ -1604,12 +1603,12 @@ Additionally, I've added extendability and created an API that allows seamless F

A FSM can only be in one of a finite number of states. -The machine is in only one state at a time; the state it is in at any given time is called the current state. -It can change from one state to another when initiated by an internal or external triggering event, which is called a transition. +The machine is in only one state at a time; the state it is in at any given time is called the current state. +It can change from one state to another when initiated by an internal or external triggering event, which is called a transition. An FSM implementation is defined by a list of its states, its initial state, and the triggering events for each possible transition. An FSM implementation is composed out of two parts, a set of state transition rules, and an implementation set of state transition handlers, implementing those transitions.

-

The FSM class supports a hierarchical implementation of a Finite State Machine, +

The FSM class supports a hierarchical implementation of a Finite State Machine, that is, it allows to embed existing FSM implementations in a master FSM. FSM hierarchies allow for efficient FSM re-use, not having to re-invent the wheel every time again when designing complex processes.

@@ -1617,20 +1616,20 @@ FSM hierarchies allow for efficient FSM re-use, not having to re-invent

The above diagram shows a graphical representation of a FSM implementation for a Task, which guides a Human towards a Zone, orders him to destroy x targets and account the results. -Other examples of ready made FSM could be:

+Other examples of ready made FSM could be:

  • route a plane to a zone flown by a human
  • detect targets by an AI and report to humans
  • account for destroyed targets by human players
    • -
  • handle AI infantry to deploy from or embark to a helicopter or airplane or vehicle
    • +
  • handle AI infantry to deploy from or embark to a helicopter or airplane or vehicle
  • let an AI patrol a zone
-

The MOOSE framework uses extensively the FSM class and derived FSM_ classes, +

The MOOSE framework uses extensively the FSM class and derived FSM_ classes, because the goal of MOOSE is to simplify mission design complexity for mission building. By efficiently utilizing the FSM class and derived classes, MOOSE allows mission designers to quickly build processes. -Ready made FSM-based implementations classes exist within the MOOSE framework that can easily be re-used, +Ready made FSM-based implementations classes exist within the MOOSE framework that can easily be re-used, and tailored by mission designers through the implementation of Transition Handlers. Each of these FSM implementation classes start either with:

@@ -1647,9 +1646,9 @@ The derived FSM_ classes extend the Finite State Machine functionality to run a

Finite State Machines have Transition Rules, Transition Handlers and Event Triggers.

-

The Transition Rules define the "Process Flow Boundaries", that is, +

The Transition Rules define the "Process Flow Boundaries", that is, the path that can be followed hopping from state to state upon triggered events. -If an event is triggered, and there is no valid path found for that event, +If an event is triggered, and there is no valid path found for that event, an error will be raised and the FSM will stop functioning.

The Transition Handlers are special methods that can be defined by the mission designer, following a defined syntax. @@ -1660,20 +1659,20 @@ The method can then define its own custom logic to implement the FSM workflow, a Most of the time, these Event Triggers are used within the Transition Handler methods, so that a workflow is created running through the state machine.

As explained above, a FSM supports Linear State Transitions and Hierarchical State Transitions, and both can be mixed to make a comprehensive FSM implementation. -The below documentation has a seperate chapter explaining both transition modes, taking into account the Transition Rules, Transition Handlers and Event Triggers.

+The below documentation has a separate chapter explaining both transition modes, taking into account the Transition Rules, Transition Handlers and Event Triggers.

FSM Linear Transitions

Linear Transitions are Transition Rules allowing an FSM to transition from one or multiple possible From state(s) towards a To state upon a Triggered Event. -The Lineair transition rule evaluation will always be done from the current state of the FSM. +The Linear transition rule evaluation will always be done from the current state of the FSM. If no valid Transition Rule can be found in the FSM, the FSM will log an error and stop.

FSM Transition Rules

-

The FSM has transition rules that it follows and validates, as it walks the process. +

The FSM has transition rules that it follows and validates, as it walks the process. These rules define when an FSM can transition from a specific state towards an other specific state upon a triggered event.

-

The method FSM.AddTransition() specifies a new possible Transition Rule for the FSM.

+

The method FSM.AddTransition() specifies a new possible Transition Rule for the FSM.

The initial state can be defined using the method FSM.SetStartState(). The default start state of an FSM is "None".

@@ -1705,7 +1704,7 @@ These rules define when an FSM can transition from a specific state towards an o
  • The From state can be a "*", indicating that the transition rule will always be valid, regardless of the current state of the FSM.
    • -

    The below code snippet shows how the two last lines can be rewritten and consensed.

    +

    The below code snippet shows how the two last lines can be rewritten and condensed.

     FsmSwitch:AddTransition( { "On",  "Middle" }, "SwitchOff", "Off" )
    @@ -1714,8 +1713,8 @@ These rules define when an FSM can transition from a specific state towards an o

    Transition Handlers

    -

    An FSM transitions in 4 moments when an Event is being triggered and processed.
    -The mission designer can define for each moment specific logic within methods implementations following a defined API syntax.
    +

    An FSM transitions in 4 moments when an Event is being triggered and processed. +The mission designer can define for each moment specific logic within methods implementations following a defined API syntax. These methods define the flow of the FSM process; because in those methods the FSM Internal Events will be triggered.

      @@ -1740,7 +1739,7 @@ These parameters are on the correct order: From, Event, To:

      Event Triggers

      -

      The FSM creates for each Event two Event Trigger methods.
      +

      The FSM creates for each Event two Event Trigger methods. There are two modes how Events can be triggered, which is synchronous and asynchronous:

        @@ -1748,26 +1747,26 @@ There are two modes how Events can be triggered, which is synchronousThe method FSM:Event( __seconds ) triggers an Event that will be processed asynchronously over time, waiting x seconds.
      -

      The destinction between these 2 Event Trigger methods are important to understand. An asynchronous call will "log" the Event Trigger to be executed at a later time. +

      The distinction between these 2 Event Trigger methods are important to understand. An asynchronous call will "log" the Event Trigger to be executed at a later time. Processing will just continue. Synchronous Event Trigger methods are useful to change states of the FSM immediately, but may have a larger processing impact.

      The following example provides a little demonstration on the difference between synchronous and asynchronous Event Triggering.

        function FSM:OnAfterEvent( From, Event, To, Amount )
-    self:T( { Amount = Amount } ) 
+    self:T( { Amount = Amount } )
   end
 
   local Amount = 1
-  FSM:__Event( 5, Amount ) 
+  FSM:__Event( 5, Amount )
 
   Amount = Amount + 1
   FSM:Event( Text, Amount )

      In this example, the :OnAfterEvent() Transition Handler implementation will get called when Event is being triggered. -Before we go into more detail, let's look at the last 4 lines of the example. +Before we go into more detail, let's look at the last 4 lines of the example. The last line triggers synchronously the Event, and passes Amount as a parameter. -The 3rd last line of the example triggers asynchronously Event. +The 3rd last line of the example triggers asynchronously Event. Event will be processed after 5 seconds, and Amount is given as a parameter.

      The output of this little code fragment will be:

      @@ -1823,7 +1822,7 @@ The next code implements this through the event handling method OnAfterS

      The OnAfterSwitch implements a loop. The last line of the code fragment triggers the Switch Event within 5 seconds. Upon the event execution (after 5 seconds), the OnAfterSwitch method is called of FsmDemo (cfr. the double point notation!!! ":"). -The OnAfterSwitch method receives from the FSM the 3 transition parameter details ( From, Event, To ), +The OnAfterSwitch method receives from the FSM the 3 transition parameter details ( From, Event, To ), and one additional parameter that was given when the event was triggered, which is in this case the Unit that is used within OnSwitchAfter.

       function FsmDemo:OnAfterSwitch( From, Event, To, FsmUnit )
@@ -1872,13 +1871,13 @@ And there is no transition handling method defined for that transition, thus, no
 
      FSM Hierarchical Transitions
      
 
 
      Hierarchical Transitions allow to re-use readily available and implemented FSMs.
-This becomes in very useful for mission building, where mission designers build complex processes and workflows, 
+This becomes in very useful for mission building, where mission designers build complex processes and workflows,
 combining smaller FSMs to one single FSM.
      
 
-
      The FSM can embed Sub-FSMs that will execute and return multiple possible Return (End) States. 
      
+
      The FSM can embed Sub-FSMs that will execute and return multiple possible Return (End) States.
 Depending upon which state is returned, the main FSM can continue the flow triggering specific events.
      
 
-
      The method FSM.AddProcess() adds a new Sub-FSM to the FSM.  
      
+
      The method FSM.AddProcess() adds a new Sub-FSM to the FSM.
      
 
 
      
 
@@ -5652,7 +5651,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
 
         
         
      
 
-    
+    #string
 FSM._StartState
     
 
@@ -6083,7 +6082,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
       
      
       
      
         
-
      Current FSM state.  
      
+
      Current FSM state.
      
 
       
      
     
      
@@ -6412,7 +6411,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    -

    Table of call backs.

    +

    Table of call backs.

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

    Event name.

    +

    Event name.

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

    Function.

    +

    Function.

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

    Event name.

    +

    Event name.

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

    Name.

    +

    Name.

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

    true, FSM is in this state.

    +

    true, FSM is in this state.

    @@ -7255,7 +7254,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #string FSM._StartState @@ -11508,7 +11507,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
    -

    Current FSM state.

    +

    Current FSM state.

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

    Table of call backs.

    +

    Table of call backs.

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

    Event name.

    +

    Event name.

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

    Function.

    +

    Function.

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

    Event name.

    +

    Event name.

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

    Name.

    +

    Name.

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

    true, FSM is in this state.

    +

    true, FSM is in this state.

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

    Current FSM state.

    +

    Current FSM state.

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

    Table of call backs.

    +

    Table of call backs.

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

    Event name.

    +

    Event name.

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

    Function.

    +

    Function.

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

    Event name.

    +

    Event name.

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

    Name.

    +

    Name.

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

    true, FSM is in this state.

    +

    true, FSM is in this state.

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

    Current FSM state.

    +

    Current FSM state.

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

    Table of call backs.

    +

    Table of call backs.

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

    Event name.

    +

    Event name.

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

    Function.

    +

    Function.

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

    Event name.

    +

    Event name.

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

    Name.

    +

    Name.

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

    true, FSM is in this state.

    +

    true, FSM is in this state.

    diff --git a/Documentation/Core.Goal.html b/Documentation/Core.Goal.html index 45d838e6a..06d74c7c5 100644 --- a/Documentation/Core.Goal.html +++ b/Documentation/Core.Goal.html @@ -1566,7 +1566,7 @@ Controls a network of short range air/missile defense groups.

    Goals are most of the time achieved by players. These player achievements can be registered as part of the goal achievement. Use GOAL.AddPlayerContribution() to add a player contribution to the goal. The player contributions are based on a points system, an internal counter per player. -So once the goal has been achieved, the player contributions can be queried using GOAL.GetPlayerContributions(), +So once the goal has been achieved, the player contributions can be queried using GOAL.GetPlayerContributions(), that retrieves all contributions done by the players. For one player, the contribution can be queried using GOAL.GetPlayerContribution(). The total amount of player contributions can be queried using GOAL.GetTotalContributions().

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

    Current FSM state.

    +

    Current FSM state.

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

    Table of call backs.

    +

    Table of call backs.

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

    Event name.

    +

    Event name.

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

    Function.

    +

    Function.

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

    Event name.

    +

    Event name.

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

    Name.

    +

    Name.

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

    true, FSM is in this state.

    +

    true, FSM is in this state.

    diff --git a/Documentation/Core.Menu.html b/Documentation/Core.Menu.html index f75ac6679..0c2775531 100644 --- a/Documentation/Core.Menu.html +++ b/Documentation/Core.Menu.html @@ -1511,7 +1511,7 @@ Controls a network of short range air/missile defense groups.

  • Update menu structures.
  • Refresh menu structures intelligently, based on a time stamp of updates.
      -
    • Delete obscolete menus.
      • +
    • Delete obsolete menus.
    • Create new one where required.
    • Don't touch the existing ones.
    • @@ -1521,12 +1521,12 @@ Controls a network of short range air/missile defense groups.

  • Provide a great tool to manage menus in your code.
    • -

    DCS Menus can be managed using the MENU classes. -The advantage of using MENU classes is that it hides the complexity of dealing with menu management in more advanced scanerios where you need to +

    DCS Menus can be managed using the MENU classes. +The advantage of using MENU classes is that it hides the complexity of dealing with menu management in more advanced scenarios where you need to set menus and later remove them, and later set them again. You'll find while using use normal DCS scripting functions, that setting and removing -menus is not a easy feat if you have complex menu hierarchies defined. +menus is not a easy feat if you have complex menu hierarchies defined. Using the MOOSE menu classes, the removal and refreshing of menus are nicely being handled within these classes, and becomes much more easy. -On top, MOOSE implements variable parameter passing for command menus.

    +On top, MOOSE implements variable parameter passing for command menus.

    There are basically two different MENU class types that you need to use:

    @@ -1547,12 +1547,12 @@ On top, MOOSE implements variable parameter passing for command
    -

    -

    +

    -

    Author: FlightControl

    Contributions:

    -

    +

    Global(s)

    @@ -1633,7 +1633,7 @@ Using this object reference, you can then remove ALL the menus and submenus unde end local function AddStatusMenu() - + -- This would create a menu for the red coalition under the MenuCoalitionRed menu object. MenuStatus = MENU_COALITION:New( coalition.side.RED, "Status for Planes" ) MenuStatusShow = MENU_COALITION_COMMAND:New( coalition.side.RED, "Show Status", MenuStatus, ShowStatus, "Status of planes is ok!", "Message to Red Coalition" ) @@ -1678,7 +1678,7 @@ Using this object reference, you can then remove ALL the menus and submenus unde

    Global MENU_COMMAND_BASE

    -

    Defines the main MENU class where other MENU COMMAND_ +

    Defines the main MENU class where other MENU COMMAND_ classes are derived from, in order to set commands.

    @@ -1691,7 +1691,7 @@ classes are derived from, in order to set commands.

    #MENU_COMMAND_BASE MENU_COMMAND_BASE -

    Defines the main MENU class where other MENU COMMAND_ +

    Defines the main MENU class where other MENU COMMAND_ classes are derived from, in order to set commands.

    @@ -1728,7 +1728,7 @@ Using this object reference, you can then remove ALL the menus and submenus unde -- To test, join the planes, then look at the other radio menus (Option F10). -- Then switch planes and check if the menu is still there. -- And play with the Add and Remove menu options. - + -- Note that in multi player, this will only work after the DCS groups bug is solved. local function ShowStatus( PlaneGroup, StatusText, Coalition ) @@ -1983,7 +1983,7 @@ Using this object reference, you can then remove ALL the menus and submenus unde

    MENU_BASE:New(MenuText, ParentMenu)

    -

    Consructor

    +

    Constructor

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

    MENU_COALITION:New(MenuText, ParentMenu)

    -

    Consructor

    +

    Constructor

    @@ -3263,7 +3263,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t

    MENU_COALITION_COMMAND:SetCommandMenuFunction(CommandMenuFunction)

    -

    This sets the new command function of a menu, +

    This sets the new command function of a menu, so that if a menu is regenerated, or if command function changes, that the function set for the menu is loosely coupled with the menu itself!!! If the function changes, no new menu needs to be generated if the menu text is the same!!!

    @@ -3316,7 +3316,7 @@ If the function changes, no new menu needs to be generated if the menu text is t

    MENU_COALITION_COMMAND:New(MenuText, ParentMenu)

    -

    Consructor

    +

    Constructor

    @@ -3916,7 +3916,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t

    MENU_COMMAND_BASE:SetCommandMenuFunction(CommandMenuFunction)

    -

    This sets the new command function of a menu, +

    This sets the new command function of a menu, so that if a menu is regenerated, or if command function changes, that the function set for the menu is loosely coupled with the menu itself!!! If the function changes, no new menu needs to be generated if the menu text is the same!!!

    @@ -3969,7 +3969,7 @@ If the function changes, no new menu needs to be generated if the menu text is t

    MENU_COMMAND_BASE:New(MenuText, ParentMenu)

    -

    Consructor

    +

    Constructor

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

    MENU_GROUP:New(MenuText, ParentMenu)

    -

    Consructor

    +

    Constructor

    @@ -5285,7 +5285,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t

    MENU_GROUP_COMMAND:SetCommandMenuFunction(CommandMenuFunction)

    -

    This sets the new command function of a menu, +

    This sets the new command function of a menu, so that if a menu is regenerated, or if command function changes, that the function set for the menu is loosely coupled with the menu itself!!! If the function changes, no new menu needs to be generated if the menu text is the same!!!

    @@ -5338,7 +5338,7 @@ If the function changes, no new menu needs to be generated if the menu text is t

    MENU_GROUP_COMMAND:New(MenuText, ParentMenu)

    -

    Consructor

    +

    Constructor

    @@ -5995,7 +5995,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t

    MENU_GROUP_COMMAND_DELAYED:SetCommandMenuFunction(CommandMenuFunction)

    -

    This sets the new command function of a menu, +

    This sets the new command function of a menu, so that if a menu is regenerated, or if command function changes, that the function set for the menu is loosely coupled with the menu itself!!! If the function changes, no new menu needs to be generated if the menu text is the same!!!

    @@ -6048,7 +6048,7 @@ If the function changes, no new menu needs to be generated if the menu text is t

    MENU_GROUP_COMMAND_DELAYED:New(MenuText, ParentMenu)

    -

    Consructor

    +

    Constructor

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

    MENU_GROUP_DELAYED:New(MenuText, ParentMenu)

    -

    Consructor

    +

    Constructor

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

    MENU_MISSION:New(MenuText, ParentMenu)

    -

    Consructor

    +

    Constructor

    @@ -8017,7 +8017,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t

    MENU_MISSION_COMMAND:SetCommandMenuFunction(CommandMenuFunction)

    -

    This sets the new command function of a menu, +

    This sets the new command function of a menu, so that if a menu is regenerated, or if command function changes, that the function set for the menu is loosely coupled with the menu itself!!! If the function changes, no new menu needs to be generated if the menu text is the same!!!

    @@ -8070,7 +8070,7 @@ If the function changes, no new menu needs to be generated if the menu text is t

    MENU_MISSION_COMMAND:New(MenuText, ParentMenu)

    -

    Consructor

    +

    Constructor

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

    self:F( { RemoveParent } )

    +

    self:F( { RemoveParent } )

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

    MENU_BASE:New(MenuText, ParentMenu)

    -

    Consructor

    +

    Constructor

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

    self:F( { RemoveParent } )

    +

    self:F( { RemoveParent } )

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

    The parent menu. This parameter can be ignored if you want the menu to be located at the perent menu of DCS world (under F10 other).

    +

    The parent menu. This parameter can be ignored if you want the menu to be located at the parent menu of DCS world (under F10 other).

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

    MENU_COALITION:New(MenuText, ParentMenu)

    -

    Consructor

    +

    Constructor

    @@ -16455,7 +16455,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t

    MENU_COALITION_COMMAND:SetCommandMenuFunction(CommandMenuFunction)

    -

    This sets the new command function of a menu, +

    This sets the new command function of a menu, so that if a menu is regenerated, or if command function changes, that the function set for the menu is loosely coupled with the menu itself!!! If the function changes, no new menu needs to be generated if the menu text is the same!!!

    @@ -16608,7 +16608,7 @@ If the function changes, no new menu needs to be generated if the menu text is t

    MENU_COALITION_COMMAND:New(MenuText, ParentMenu)

    -

    Consructor

    +

    Constructor

    @@ -20244,7 +20244,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t

    MENU_COMMAND_BASE:SetCommandMenuFunction(CommandMenuFunction)

    -

    This sets the new command function of a menu, +

    This sets the new command function of a menu, so that if a menu is regenerated, or if command function changes, that the function set for the menu is loosely coupled with the menu itself!!! If the function changes, no new menu needs to be generated if the menu text is the same!!!

    @@ -20408,7 +20408,7 @@ If the function changes, no new menu needs to be generated if the menu text is t

    MENU_COMMAND_BASE:New(MenuText, ParentMenu)

    -

    Consructor

    +

    Constructor

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

    MENU_GROUP:New(MenuText, ParentMenu)

    -

    Consructor

    +

    Constructor

    @@ -28228,7 +28228,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t

    MENU_GROUP_COMMAND:SetCommandMenuFunction(CommandMenuFunction)

    -

    This sets the new command function of a menu, +

    This sets the new command function of a menu, so that if a menu is regenerated, or if command function changes, that the function set for the menu is loosely coupled with the menu itself!!! If the function changes, no new menu needs to be generated if the menu text is the same!!!

    @@ -28414,7 +28414,7 @@ If the function changes, no new menu needs to be generated if the menu text is t

    MENU_GROUP_COMMAND:New(MenuText, ParentMenu)

    -

    Consructor

    +

    Constructor

    @@ -32381,7 +32381,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t

    MENU_GROUP_COMMAND_DELAYED:SetCommandMenuFunction(CommandMenuFunction)

    -

    This sets the new command function of a menu, +

    This sets the new command function of a menu, so that if a menu is regenerated, or if command function changes, that the function set for the menu is loosely coupled with the menu itself!!! If the function changes, no new menu needs to be generated if the menu text is the same!!!

    @@ -32578,7 +32578,7 @@ If the function changes, no new menu needs to be generated if the menu text is t

    MENU_GROUP_COMMAND_DELAYED:New(MenuText, ParentMenu)

    -

    Consructor

    +

    Constructor

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

    MENU_GROUP_DELAYED:New(MenuText, ParentMenu)

    -

    Consructor

    +

    Constructor

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

    The parent menu. This parameter can be ignored if you want the menu to be located at the perent menu of DCS world (under F10 other).

    +

    The parent menu. This parameter can be ignored if you want the menu to be located at the parent menu of DCS world (under F10 other).

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

    MENU_MISSION:New(MenuText, ParentMenu)

    -

    Consructor

    +

    Constructor

    @@ -44223,7 +44223,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t

    MENU_MISSION_COMMAND:SetCommandMenuFunction(CommandMenuFunction)

    -

    This sets the new command function of a menu, +

    This sets the new command function of a menu, so that if a menu is regenerated, or if command function changes, that the function set for the menu is loosely coupled with the menu itself!!! If the function changes, no new menu needs to be generated if the menu text is the same!!!

    @@ -44376,7 +44376,7 @@ If the function changes, no new menu needs to be generated if the menu text is t

    MENU_MISSION_COMMAND:New(MenuText, ParentMenu)

    -

    Consructor

    +

    Constructor

    diff --git a/Documentation/Core.Message.html b/Documentation/Core.Message.html index 75316b8ef..7f803c2e8 100644 --- a/Documentation/Core.Message.html +++ b/Documentation/Core.Message.html @@ -1648,25 +1648,25 @@ To send messages, you need to use the To functions.

    MESSAGE:ToCoalition(CoalitionSide, Settings)

    -

    Sends a MESSAGE to a Coalition.

    +

    Sends a MESSAGE to a Coalition.

    MESSAGE:ToCoalitionIf(CoalitionSide, Condition)

    -

    Sends a MESSAGE to a Coalition if the given Condition is true.

    +

    Sends a MESSAGE to a Coalition if the given Condition is true.

    MESSAGE:ToGroup(Group, Settings)

    -

    Sends a MESSAGE to a Group.

    +

    Sends a MESSAGE to a Group.

    MESSAGE:ToRed()

    -

    Sends a MESSAGE to the Red Coalition.

    +

    Sends a MESSAGE to the Red Coalition.

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

    Clears all previous messages from the screen before the new message is displayed.

    -

    Not that this must come before all functions starting with ToX(), e.g. ToAll(), ToGroup() etc.

    +

    Not that this must come before all functions starting with ToX(), e.g. ToAll(), ToGroup() etc.

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

    Usage:

    - 
    -- Create a series of new Messages.
--- MessageAll is meant to be sent to all players, for 25 seconds, and is classified as "Score".
--- MessageRED is meant to be sent to the RED players only, for 10 seconds, and is classified as "End of Mission", with ID "Win".
--- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
--- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
-MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!",  25, "End of Mission" )
-MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", 25, "Penalty" )
-MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target",  25, "Score" )
-MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", 25, "Score")
    + 
    
+   -- Create a series of new Messages.
+   -- MessageAll is meant to be sent to all players, for 25 seconds, and is classified as "Score".
+   -- MessageRED is meant to be sent to the RED players only, for 10 seconds, and is classified as "End of Mission", with ID "Win".
+   -- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
+   -- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
+  MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!",  25, "End of Mission" )
+  MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", 25, "Penalty" )
+  MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target",  25, "Score" )
+  MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", 25, "Score")
+
    @@ -2453,7 +2455,7 @@ MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", 25

    Creates a new MESSAGE object of a certain type.

    -

    Note that these MESSAGE objects are not yet displayed on the display panel. +

    Note that these MESSAGE objects are not yet displayed on the display panel. You must use the functions ToClient or ToCoalition or ToAll to send these Messages to the respective recipients. The message display times are automatically defined based on the timing settings in the Settings menu.

    @@ -2515,10 +2517,12 @@ The message display times are automatically defined based on the timing settings

    Usage:

    - 
      MessageAll = MESSAGE:NewType( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", MESSAGE.Type.Information )
+    
    
+  MessageAll = MESSAGE:NewType( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", MESSAGE.Type.Information )
   MessageRED = MESSAGE:NewType( "To the RED Players: You receive a penalty because you've killed one of your own units", MESSAGE.Type.Information )
   MessageClient1 = MESSAGE:NewType( "Congratulations, you've just hit a target", MESSAGE.Type.Update )
-  MessageClient2 = MESSAGE:NewType( "Congratulations, you've just killed a target", MESSAGE.Type.Update )
    
+  MessageClient2 = MESSAGE:NewType( "Congratulations, you've just killed a target", MESSAGE.Type.Update )
+
    @@ -2565,13 +2569,15 @@ The message display times are automatically defined based on the timing settings

    Usage:

    - 
    -- Send a message created to all players.
-MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" ):ToAll()
-or
-MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" ):ToAll()
-or
-MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" )
-MessageAll:ToAll()
    + 
    
+  -- Send a message created to all players.
+  MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" ):ToAll()
+  or
+  MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" ):ToAll()
+  or
+  MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" )
+  MessageAll:ToAll()
+
    @@ -2645,13 +2651,15 @@ MessageAll:ToAll()

    Usage:

    - 
    -- Send a message created with the @{New} method to the BLUE coalition.
-MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
-or
-MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
-or
-MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
-MessageBLUE:ToBlue()
    + 
    
+  -- Send a message created with the @{New} method to the BLUE coalition.
+  MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
+  or
+  MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
+  or
+  MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
+  MessageBLUE:ToBlue()
+
    @@ -2714,20 +2722,22 @@ MessageBLUE:ToBlue()

    Usage:

    - 
    -- Send the 2 messages created with the @{New} method to the Client Group.
--- Note that the Message of MessageClient2 is overwriting the Message of MessageClient1.
-ClientGroup = Group.getByName( "ClientGroup" )
+    
    
+  -- Send the 2 messages created with the @{New} method to the Client Group.
+  -- Note that the Message of MessageClient2 is overwriting the Message of MessageClient1.
+  ClientGroup = Group.getByName( "ClientGroup" )
 
-MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" ):ToClient( ClientGroup )
-MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" ):ToClient( ClientGroup )
-or
-MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" ):ToClient( ClientGroup )
-MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" ):ToClient( ClientGroup )
-or
-MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" )
-MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" )
-MessageClient1:ToClient( ClientGroup )
-MessageClient2:ToClient( ClientGroup )
    
+  MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" ):ToClient( ClientGroup )
+  MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" ):ToClient( ClientGroup )
+  or
+  MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" ):ToClient( ClientGroup )
+  MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" ):ToClient( ClientGroup )
+  or
+  MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" )
+  MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" )
+  MessageClient1:ToClient( ClientGroup )
+  MessageClient2:ToClient( ClientGroup )
+
    @@ -2740,7 +2750,7 @@ MessageClient2:ToClient( ClientGroup )

    MESSAGE:ToCoalition(CoalitionSide, Settings)

    -

    Sends a MESSAGE to a Coalition.

    +

    Sends a MESSAGE to a Coalition.

    @@ -2787,13 +2797,15 @@ MessageClient2:ToClient( ClientGroup )

    Usage:

    - 
    -- Send a message created with the @{New} method to the RED coalition.
-MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToCoalition( coalition.side.RED )
-or
-MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToCoalition( coalition.side.RED )
-or
-MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
-MessageRED:ToCoalition( coalition.side.RED )
    + 
    
+  -- Send a message created with the @{New} method to the RED coalition.
+  MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToCoalition( coalition.side.RED )
+  or
+  MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToCoalition( coalition.side.RED )
+  or
+  MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
+  MessageRED:ToCoalition( coalition.side.RED )
+
    @@ -2806,7 +2818,7 @@ MessageRED:ToCoalition( coalition.side.RED )

    MESSAGE:ToCoalitionIf(CoalitionSide, Condition)

    -

    Sends a MESSAGE to a Coalition if the given Condition is true.

    +

    Sends a MESSAGE to a Coalition if the given Condition is true.

    @@ -2836,7 +2848,7 @@ MessageRED:ToCoalition( coalition.side.RED )
    -

    Sends the message only if the condition is true.

    +

    Sends the message only if the condition is true.

    @@ -2862,7 +2874,7 @@ MessageRED:ToCoalition( coalition.side.RED )

    MESSAGE:ToGroup(Group, Settings)

    -

    Sends a MESSAGE to a Group.

    +

    Sends a MESSAGE to a Group.

    @@ -2916,7 +2928,7 @@ MessageRED:ToCoalition( coalition.side.RED )

    MESSAGE:ToRed()

    -

    Sends a MESSAGE to the Red Coalition.

    +

    Sends a MESSAGE to the Red Coalition.

    @@ -2936,13 +2948,15 @@ MessageRED:ToCoalition( coalition.side.RED )

    Usage:

    - 
    -- Send a message created with the @{New} method to the RED coalition.
-MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToRed()
-or
-MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToRed()
-or
-MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
-MessageRED:ToRed()
    + 
    
+  -- Send a message created with the @{New} method to the RED coalition.
+  MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToRed()
+  or
+  MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToRed()
+  or
+  MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
+  MessageRED:ToRed()
+
    diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html index 10ebaf829..5b865c218 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -16164,17 +16164,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

    the y coordinate in meters.

    - - - -
    -
    - - -POINT_VEC2.z - - -
    @@ -16973,17 +16962,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

    the y coordinate in meters.

    - - - -
    -
    - - -POINT_VEC2.z - - -
    @@ -24717,17 +24695,6 @@ Creates a line on the F10 map from one point to another.

    the y coordinate in meters.

    - - - -
    -
    - - -POINT_VEC2.z - - -
    diff --git a/Documentation/Core.Report.html b/Documentation/Core.Report.html index a2383f16c..b1fed3b0c 100644 --- a/Documentation/Core.Report.html +++ b/Documentation/Core.Report.html @@ -1602,7 +1602,7 @@ Controls a network of short range air/missile defense groups.

    REPORT:Text(Delimiter)

    -

    Produces the text of the report, taking into account an optional delimeter, which is \n by default.

    +

    Produces the text of the report, taking into account an optional delimiter, which is \n by default.

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

    REPORT:Text(Delimiter)

    -

    Produces the text of the report, taking into account an optional delimeter, which is \n by default.

    +

    Produces the text of the report, taking into account an optional delimiter, which is \n by default.

    diff --git a/Documentation/Core.ScheduleDispatcher.html b/Documentation/Core.ScheduleDispatcher.html index ce075d3b9..14dc250a4 100644 --- a/Documentation/Core.ScheduleDispatcher.html +++ b/Documentation/Core.ScheduleDispatcher.html @@ -1516,13 +1516,13 @@ The SCHEDULEDISPATCHER class ensures that:

  • When a SCHEDULER object is attached to another object, then the SCHEDULER object is not persistent within memory after a garbage collection!
    • -

    The none persistency of SCHEDULERS attached to objects is required to allow SCHEDULER objects to be garbage collectged, when the parent object is also desroyed or nillified and garbage collected. -Even when there are pending timer scheduled functions to be executed for the SCHEDULER object,
    +

    The non-persistency of SCHEDULERS attached to objects is required to allow SCHEDULER objects to be garbage collected when the parent object is destroyed, or set to nil and garbage collected. +Even when there are pending timer scheduled functions to be executed for the SCHEDULER object, these will not be executed anymore when the SCHEDULER object has been destroyed.

    The SCHEDULEDISPATCHER allows multiple scheduled functions to be planned and executed for one SCHEDULER object. The SCHEDULER object therefore keeps a table of "CallID's", which are returned after each planning of a new scheduled function by the SCHEDULEDISPATCHER. -The SCHEDULER object plans new scheduled functions through the Core.Scheduler#SCHEDULER.Schedule() method. +The SCHEDULER object plans new scheduled functions through the Core.Scheduler#SCHEDULER.Schedule() method. The Schedule() method returns the CallID that is the reference ID for each planned schedule.

    @@ -1611,7 +1611,7 @@ The Schedule() method returns the CallID that is the reference ID for each plann

    SCHEDULEDISPATCHER.PersistentSchedulers

    -

    Persistant schedulers.

    +

    Persistent schedulers.

    @@ -1629,7 +1629,7 @@ The Schedule() method returns the CallID that is the reference ID for each plann

    SCHEDULEDISPATCHER:ShowTrace(Scheduler)

    -

    Shopw tracing info.

    +

    Show tracing info.

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

    SCHEDULEDISPATCHER.ScheduleData.Repeat

    -

    Repeat time intervall in seconds.

    +

    Repeat time interval in seconds.

    @@ -2302,7 +2302,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #table SCHEDULEDISPATCHER.PersistentSchedulers -

    Persistant schedulers.

    +

    Persistent schedulers.

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

    The development of this method was really tidy. -It is constructed as such that a garbage collection is executed on the weak tables, when the Scheduler is nillified. +It is constructed as such that a garbage collection is executed on the weak tables, when the Scheduler is set to nil. Nothing of this code should be modified without testing it thoroughly.

    @@ -2415,7 +2415,7 @@ Nothing of this code should be modified without testing it thoroughly.

    -

    Radomization factor [0,1].

    +

    Randomization factor [0,1].

    @@ -2622,7 +2622,7 @@ Nothing of this code should be modified without testing it thoroughly.

    SCHEDULEDISPATCHER:ShowTrace(Scheduler)

    -

    Shopw tracing info.

    +

    Show tracing info.

    @@ -2796,7 +2796,7 @@ Nothing of this code should be modified without testing it thoroughly.

    #table SCHEDULEDISPATCHER.PersistentSchedulers -

    Persistant schedulers.

    +

    Persistent schedulers.

    @@ -6108,7 +6108,7 @@ When moose is loading dynamically (for moose class development), tracing is swit #number SCHEDULEDISPATCHER.ScheduleData.Repeat -

    Repeat time intervall in seconds.

    +

    Repeat time interval in seconds.

    diff --git a/Documentation/Core.Scheduler.html b/Documentation/Core.Scheduler.html index 9933f4d37..a160a0ab2 100644 --- a/Documentation/Core.Scheduler.html +++ b/Documentation/Core.Scheduler.html @@ -1501,10 +1501,10 @@ Controls a network of short range air/missile defense groups.

    • Schedule functions over time,
      • -
    • optionally in an optional specified time interval,
      • -
    • optionally repeating with a specified time repeat interval,
      • -
    • optionally randomizing with a specified time interval randomization factor,
      • -
    • optionally stop the repeating after a specified time interval.
      • +
    • optionally in an optional specified time interval,
      • +
    • optionally repeating with a specified time repeat interval,
      • +
    • optionally randomizing with a specified time interval randomization factor,
      • +
    • optionally stop the repeating after a specified time interval.
    @@ -1595,7 +1595,7 @@ A separate schedule is created by using the MasterObject using the method :Sched

    Construct a SCHEDULER object without a volatile schedule, but volatile to the Object existence...

      -

    • SCHEDULER.New( Object ): Setup a new SCHEDULER object, which is linked to the Object. When the Object is nillified or destroyed, the SCHEDULER object will also be destroyed and stopped after garbage collection.

      +

    • SCHEDULER.New( Object ): Setup a new SCHEDULER object, which is linked to the Object. When the Object is set to nil or destroyed, the SCHEDULER object will also be destroyed and stopped after garbage collection.

      ZoneObject = ZONE:New( "ZoneName" ) MasterObject = SCHEDULER:New( ZoneObject ) @@ -1658,13 +1658,13 @@ As a result, the MasterObject will cancel the planned schedule.

    The above example creates a new MasterObject, and does schedule the first schedule as part of the call. -Note that 2 variables are returned here: MasterObject, ScheduleID...
    -Later in the logic, the repeating schedule with SchedulerID is stopped.
    -A bit later, the repeating schedule with SchedulerId is (re)-started.

    +Note that 2 variables are returned here: MasterObject, ScheduleID... +Later in the logic, the repeating schedule with SchedulerID is stopped. +A bit later, the repeating schedule with SchedulerId is (re)-started.

    Create a new schedule

    -

    With the method SCHEDULER.Schedule() a new time event can be scheduled. +

    With the method SCHEDULER.Schedule() a new time event can be scheduled. This method is used by the :New() constructor when a new schedule is planned.

    Consider the following code fragment of the SCHEDULER object creation.

    @@ -1673,14 +1673,14 @@ This method is used by the :New() constructor when a new schedule is planned.

    -

    Several parameters can be specified that influence the behaviour of a Schedule.

    +

    Several parameters can be specified that influence the behavior of a Schedule.

    A single schedule, immediately executed

    SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {} )
    -

    The above example schedules a new ScheduleFunction call to be executed asynchronously, within milleseconds ...

    +

    The above example schedules a new ScheduleFunction call to be executed asynchronously, within milliseconds ...

    A single schedule, planned over time

    @@ -1694,7 +1694,7 @@ MasterObject = SCHEDULER:New( ZoneObject ) 
    SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {}, 10, 60 )
    -

    The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds, +

    The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds, and repeating 60 every seconds ...

    A schedule with a repeating time interval, planned over time, with time interval randomization

    @@ -1702,10 +1702,10 @@ and repeating 60 every seconds ...

    SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {}, 10, 60, 0.5 )
    -

    The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds, +

    The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds, and repeating 60 seconds, with a 50% time interval randomization ... -So the repeating time interval will be randomized using the 0.5,
    -and will calculate between 60 - ( 60 * 0.5 ) and 60 + ( 60 * 0.5 ) for each repeat, +So the repeating time interval will be randomized using the 0.5, +and will calculate between 60 - ( 60 * 0.5 ) and 60 + ( 60 * 0.5 ) for each repeat, which is in this example between 30 and 90 seconds.

    A schedule with a repeating time interval, planned over time, with time interval randomization, and stop after a time interval

    @@ -1713,10 +1713,10 @@ which is in this example between 30 and 90 sec 
    SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {}, 10, 60, 0.5, 300 )
    -

    The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds, +

    The above example schedules a new ScheduleFunction call to be executed asynchronously, within 10 seconds, The schedule will repeat every 60 seconds. -So the repeating time interval will be randomized using the 0.5,
    -and will calculate between 60 - ( 60 * 0.5 ) and 60 + ( 60 * 0.5 ) for each repeat, +So the repeating time interval will be randomized using the 0.5, +and will calculate between 60 - ( 60 * 0.5 ) and 60 + ( 60 * 0.5 ) for each repeat, which is in this example between 30 and 90 seconds. The schedule will stop after 300 seconds.

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

    Time interval in seconds after which the scheduler will be stoppe.

    +

    Time interval in seconds after which the scheduler will be stopped.

    diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index ce280b04f..0458af13c 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -1533,7 +1533,7 @@ Controls a network of short range air/missile defense groups.

    Global SETTINGS

    -

    Takes care of various settings that influence the behaviour of certain functionalities and classes within the MOOSE framework.

    +

    Takes care of various settings that influence the behavior of certain functionalities and classes within the MOOSE framework.

    @@ -1544,13 +1544,13 @@ Controls a network of short range air/missile defense groups.

    #SETTINGS SETTINGS -

    Takes care of various settings that influence the behaviour of certain functionalities and classes within the MOOSE framework.

    +

    Takes care of various settings that influence the behavior of certain functionalities and classes within the MOOSE framework.

    -

    The SETTINGS class takes care of various settings that influence the behaviour of certain functionalities and classes within the MOOSE framework. +

    The SETTINGS class takes care of various settings that influence the behavior of certain functionalities and classes within the MOOSE framework. SETTINGS can work on 2 levels:

      @@ -1574,7 +1574,7 @@ These menus can be found on level F10 under "Settings". There a

      A menu is created automatically per Command Center that allows to modify the Default settings. So, when joining a CC unit, a menu will be available that allows to change the settings parameters FOR ALL THE PLAYERS! -Note that the Default settings will only be used when a player has not choosen its own settings.

      +Note that the Default settings will only be used when a player has not chosen its own settings.

      2.2) Player settings menu

      @@ -1584,7 +1584,7 @@ Note that when a player has not chosen a specific setting, the Default s

      2.3) Show or Hide the Player Setting menus

      -

      Of course, it may be requried not to show any setting menus. In this case, a method is available on the _SETTINGS object. +

      Of course, it may be required not to show any setting menus. In this case, a method is available on the _SETTINGS object. Use SETTINGS.SetPlayerMenuOff() to hide the player menus, and use SETTINGS.SetPlayerMenuOn() show the player menus. Note that when this method is used, any player already in a slot will not have its menus visibility changed. The option will only have effect when a player enters a new slot or changes a slot.

      @@ -1611,8 +1611,8 @@ See below a comprehensive description of each.

      3.1.2) A2G coordinates setting menu

      @@ -1713,7 +1713,7 @@ but there isn't any player context (no player unit to reference from), the MGRS

      The settings can be changed by using the Default settings menu on the Command Center or the Player settings menu on the Player Slot.

      Each Message Type has specific timings that will be applied when the message is displayed. -The Settings Menu will provide for each Message Type a selection of proposed durations from which can be choosen. +The Settings Menu will provide for each Message Type a selection of proposed durations from which can be chosen. So the player can choose its own amount of seconds how long a message should be displayed of a certain type. Note that Update messages can be chosen not to be displayed at all!

      @@ -1728,7 +1728,7 @@ Note that Update messages can be chosen not to be displayed at

      3.5) Era of the battle

      -

      The threat level metric is scaled according the era of the battle. A target that is AAA, will pose a much greather threat in WWII than on modern warfare. +

      The threat level metric is scaled according the era of the battle. A target that is AAA, will pose a much greater threat in WWII than on modern warfare. Therefore, there are 4 era that are defined within the settings:

        @@ -2714,7 +2714,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
        - #string + SETTINGS.A2ASystem @@ -2769,7 +2769,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
        - #boolean + SETTINGS.Metric @@ -4808,7 +4808,7 @@ It is advised to use this method at the start of the mission.

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

        - #boolean + SETTINGS.Metric diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index 1e437cb2b..4345c3a2a 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -1494,7 +1494,8 @@ Controls a network of short range air/missile defense groups.

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

        -

        + +

        Features:

        @@ -1505,7 +1506,7 @@ Controls a network of short range air/missile defense groups.

      • Randomize the spawning location between different zones.
      • Randomize the initial positions within the zones.
      • Spawn in array formation.
        • -
      • Spawn uncontrolled (for planes or helos only).
        • +
      • 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.
        • @@ -1563,40 +1564,40 @@ Controls a network of short range air/missile defense 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.

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

        +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 behaviour or the way groups are spawned. +

        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.

        +

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

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

        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.

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

        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, @@ -1604,37 +1605,37 @@ 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, +

        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, +
        2. 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.
          3. -
        3. Spawned units will have the name GroupName#nnn-uu, +
        4. 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.
        -

        That being said, there is a way to keep the same unit names!
        +

        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*, +
        2. 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.

        Some additional notes that need to be considered!!:

          -
        • templates are actually groups defined within the mission editor, with the flag "Late Activation" set. +
        • 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), +
        • 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.
        @@ -1653,7 +1654,7 @@ So in principle, the group list will contain all parameters and configurations a

        SPAWN Initialization methods

        -

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

        +

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

        Unit Names

        @@ -1682,7 +1683,7 @@ So in principle, the group list will contain all parameters and configurations a

        Array formation

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

        Position randomization

        @@ -1710,9 +1711,9 @@ So in principle, the group list will contain all parameters and configurations a

        Delay initial scheduled spawn

        Repeat spawned Wrapper.Groups upon landing

        @@ -1722,7 +1723,6 @@ So in principle, the group list will contain all parameters and configurations a
      • SPAWN.InitRepeatOnEngineShutDown(): This method is used to re-spawn automatically the same group after it has landed and it shuts down the engines at the ramp.
      -

      SPAWN Spawn methods

      Groups can be spawned at different times and methods:

      @@ -1740,20 +1740,19 @@ So in principle, the group list will contain all parameters and configurations a
    • SPAWN.SpawnAtAirbase(): Spawn a new group at an Wrapper.Airbase, which can be an airdrome, ship or helipad.
    -

    Note that SPAWN.Spawn and SPAWN.ReSpawn return a Wrapper.Group#GROUP.New object, that contains a reference to the DCSGroup object. +

    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 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. @@ -1771,24 +1770,24 @@ The method SPAWN.GetGroupFromIndex() w

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

    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 succesfully returned to their airbase, to restart their combat activities. +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. +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. +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

    @@ -1796,11 +1795,10 @@ A coding example is provided at the description of 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 +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.

    - @@ -1897,11 +1895,11 @@ can be used to switch off the initial delay. Because there is no delay by defaul

    SPAWN:InitAIOnOff(AIOnOff)

    - +

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

    -

    SPAWN:InitAirbase(AirbaseName, Takeoff, TerminalTyple, TerminalType)

    +

    SPAWN:InitAirbase(AirbaseName, Takeoff, TerminalType)

    Set spawns to happen at a particular airbase.

    @@ -1909,7 +1907,7 @@ can be used to switch off the initial delay. Because there is no delay by defaul

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

    -

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

    +

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

    @@ -2009,7 +2007,7 @@ and any spaces before and after the resulting name are removed.

    SPAWN:InitRadioCommsOnOff(switch)

    -

    Sets the radio comms on or off.

    +

    Sets the radio communication on or off.

    @@ -2069,7 +2067,7 @@ and any spaces before and after the resulting name are removed.

    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.

    +

    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.

    @@ -2142,6 +2140,7 @@ and any spaces before and after the resulting name are removed.

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

    Will park a group at an Wrapper.Airbase.

    + @@ -2201,7 +2200,7 @@ and any spaces before and after the resulting name are removed.

    SPAWN:SpawnAtParkingSpot(Airbase, Spots, Takeoff)

    -

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

    +

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

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

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

    - - - -

    SPAWN.communication

    - - - - - -

    SPAWN.livery_id

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

    The AI is on by default when spawning a group.

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

    self.CleanUpFunction = routines.scheduleFunction( self._SpawnCleanUpScheduler, { self }, timer.getTime() + 1, SpawnCleanUpInterval )

    +

    self.CleanUpFunction = routines.scheduleFunction( self._SpawnCleanUpScheduler, { self }, timer.getTime() + 1, SpawnCleanUpInterval )

    @@ -3658,28 +3642,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
    -
    - - -SPAWN.SpawnInitModex - - - -
    - -
    -
    -
    - - -SPAWN.SpawnInitModu - - -
    @@ -3905,7 +3867,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

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

    +

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

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

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

    - - - -
    -
    - - -SPAWN.communication - - - -
    - -
    -
    -
    - - -SPAWN.livery_id - - -
    @@ -4060,12 +4000,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    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
    + 
    
+  -- 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
+
    @@ -4154,11 +4096,13 @@ If no index is given, it will return the first group in the list.

    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
    + 
    
+  -- 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
+
    @@ -4213,12 +4157,14 @@ end

    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
    + 
    
+  -- 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
+
    @@ -4324,7 +4270,7 @@ end

    SPAWN:InitAIOnOff(AIOnOff)

    - +

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

    @@ -4336,13 +4282,27 @@ end

    + #boolean AIOnOff

    -

    + +

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

    +
    +

    Return value:

    +
    +
    +

    #SPAWN:

    +
    +
    + +

    The SPAWN object

    + +
    +
    @@ -4351,7 +4311,7 @@ end
    -

    SPAWN:InitAirbase(AirbaseName, Takeoff, TerminalTyple, TerminalType)

    +

    SPAWN:InitAirbase(AirbaseName, Takeoff, TerminalType)

    Set spawns to happen at a particular airbase.

    @@ -4396,7 +4356,7 @@ end

    #number - TerminalTyple + TerminalType

    @@ -4405,16 +4365,6 @@ end
    -
    -
    -

    - TerminalType -

    -
    -
    -

    -
    -

    Return value:

    @@ -4437,7 +4387,7 @@ end

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

    -

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

    +

    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. @@ -4514,12 +4464,12 @@ CAUTION: this directive will NOT work with OnSpawnGroup function.

    Usage:

    - 
    -- Define an array of Groups.
-Spawn_BE_Ground = SPAWN
-  :New( 'BE Ground' )
-  :InitLimit( 2, 24 )
-  :InitArray( 90, 10, 100, 50 )
-
    + 
    
+  -- Define an array of Groups.
+  Spawn_BE_Ground = SPAWN:New( 'BE Ground' )
+                         :InitLimit( 2, 24 )
+                         :InitArray( 90, 10, 100, 50 )
+
    @@ -4613,7 +4563,8 @@ When groups are still alive and have become inactive due to damage and are unabl

    Usage:

    
-Spawn_Helicopter:InitCleanUp( 20 )  -- CleanUp the spawning of the helicopters every 20 seconds when they become inactive.
    + Spawn_Helicopter:InitCleanUp( 20 ) -- CleanUp the spawning of the helicopters every 20 seconds when they become inactive. + @@ -4650,8 +4601,8 @@ Spawn_Helicopter:InitCleanUp( 20 ) -- CleanUp the spawning of the helicopters e

    Coalition of the group as number of enumerator:

    @@ -4683,7 +4634,7 @@ Spawn_Helicopter:InitCleanUp( 20 ) -- CleanUp the spawning of the helicopters e

    Sets the country of the spawn group.

    -

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

    +

    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!

    @@ -4705,10 +4656,10 @@ Spawn_Helicopter:InitCleanUp( 20 ) -- CleanUp the spawning of the helicopters e +

    Return value:

    @@ -4892,16 +4843,16 @@ Note that InitGroupHeading does not rotate the groups route; only its i 
    
 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 +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 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 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)
    @@ -4933,7 +4884,7 @@ mySpawner:InitHeading(0):InitGroupHeading(-60)
    -

    Indicates the maximum amount of units in the group.

    +

    Indicates the maximum amount of units in the group.

    @@ -5010,13 +4961,13 @@ mySpawner:InitHeading(0):InitGroupHeading(-60)

    Usage:

    
-Spawn = SPAWN:New( ... )
+  Spawn = SPAWN:New( ... )
 
--- Spawn the units pointing to 100 degrees.
-Spawn:InitHeading( 100 )
+  -- Spawn the units pointing to 100 degrees.
+  Spawn:InitHeading( 100 )
 
--- Spawn the units pointing between 100 and 150 degrees.
-Spawn:InitHeading( 100, 150 )
+  -- Spawn the units pointing between 100 and 150 degrees.
+  Spawn:InitHeading( 100, 150 )
    @@ -5148,7 +5099,7 @@ When a SPAWN.New is executed and the limit of the am
    -

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

    +

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

    @@ -5161,8 +5112,8 @@ When a SPAWN.New is executed and the limit of the am
    -

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

    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.

    @@ -5179,10 +5130,12 @@ This parameter accepts the value 0, which defines that there are no maximum grou

    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 )
    + 
    
+  -- 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 )
+
    @@ -5213,7 +5166,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitLimit( 2, 24 )
    -

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

    +

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

    @@ -5286,7 +5239,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitLimit( 2, 24 )SPAWN:InitRadioCommsOnOff(switch) -

    Sets the radio comms on or off.

    +

    Sets the radio communication on or off.

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

    @@ -5307,7 +5260,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitLimit( 2, 24 )
    -

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

    +

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

    @@ -5442,7 +5395,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitLimit( 2, 24 )
    -

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

    +

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

    @@ -5497,7 +5450,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitLimit( 2, 24 )Randomizes the defined route of the SpawnTemplatePrefix group in the ME.

    -

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

    +

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

    @@ -5515,7 +5468,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitLimit( 2, 24 )
    -

    is the waypoint where the randomization begins. +

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

    @@ -5529,7 +5482,7 @@ Note that the StartPoint = 0 equaling the point where the group is spawned.

    -

    is the waypoint where the randomization ends counting backwards. +

    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.

    @@ -5572,11 +5525,13 @@ This parameter is useful to avoid randomization to end at a waypoint earlier tha

    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 )
    + 
    
+  -- 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 )
+
    @@ -5593,7 +5548,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitRandomizeRoute(

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

    @@ -5613,7 +5568,7 @@ In other words, this method randomizes between a defined set of groups the templ
    -

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

    +

    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.

    @@ -5629,17 +5584,18 @@ In other words, this method randomizes between a defined set of groups the templ

    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 simulteneously  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 )
    + 
    
+  -- 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 )
    @@ -5655,7 +5611,7 @@ Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150

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

    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.

    @@ -5691,17 +5647,19 @@ In other words, this method randomizes between a defined set of groups the templ

    Usage:

    - 
    -- NATO Tank Platoons invading Gori.
+    
    
+ -- 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.
+  -- 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 simulteneously  and 150 Groups to be spawned during the whole mission.
+  -- 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_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 )
+
    @@ -5717,7 +5675,7 @@ Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150

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

    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.

    @@ -5737,7 +5695,7 @@ In other words, this method randomizes between a defined set of groups the templ
    -

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

    +

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

    @@ -5753,20 +5711,22 @@ In other words, this method randomizes between a defined set of groups the templ

    Usage:

    - 
    -- NATO Tank Platoons invading Gori.
+    
    
+  -- 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.
+  -- 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 simulteneously  and 150 Groups to be spawned during the whole mission.
+  -- 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()
+  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 )
    
+  -- 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 )
+
    @@ -5797,7 +5757,7 @@ Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150
    -

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

    +

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

    @@ -5839,11 +5799,13 @@ Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150

    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 )
    + 
    
+  -- 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 )
+
    @@ -5874,7 +5836,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitRandomizeRoute(
    -

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

    +

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

    @@ -5890,15 +5852,16 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitRandomizeRoute(

    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 )
-
    + 
    
+   -- 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 )
+
    @@ -5911,12 +5874,12 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitRandomizeRoute(

    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.

    +

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

    @@ -5937,15 +5900,15 @@ So ensure that the routes for groups that respawn, always return to the original

    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()
-
    + 
    
+  -- 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()
+
    @@ -5978,14 +5941,14 @@ SpawnRU_SU34 = SPAWN

    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()
    + 
    
+  -- 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()
    @@ -6018,13 +5981,14 @@ SpawnRU_SU34 = SPAWN

    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()
    + 
    
+  -- 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()
+
    @@ -6245,8 +6209,9 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ) 
  • -- Create a new SPAWN object based on a Group Template defined from scratch.
 Spawn_BE_KA50 = SPAWN:NewWithAlias( 'BE KA-50@RAMP-Ground Defense', 'Helicopter Attacking a City' )
  • 
--- Create a new CSAR_Spawn object based on a normal Group Template to spawn a soldier.
-local CSAR_Spawn = SPAWN:NewWithFromTemplate( Template, "CSAR", "Pilot" )
    • + -- Create a new CSAR_Spawn object based on a normal Group Template to spawn a soldier. + local CSAR_Spawn = SPAWN:NewWithFromTemplate( Template, "CSAR", "Pilot" ) + @@ -6384,17 +6349,16 @@ The first parameter of the SpawnFunction is the -- 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 ) - + 
    
+   -- 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 )
+
    @@ -6409,6 +6373,7 @@ The first parameter of the SpawnFunction is the     Wrapper.Airbase.

    +

    Defined in:

    @@ -6499,12 +6464,12 @@ Note that each point in the route assigned to the spawning group is reset to the 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. +

    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.

    @@ -6573,13 +6538,13 @@ You need to provide the exact name of the airbase as the parame

    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 )
    @@ -6733,16 +6698,16 @@ You can use the returned group to further define the route to be followed.

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

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

    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!

    @@ -6828,7 +6793,7 @@ You need to provide the exact name of the airbase as the parame
    -

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

    +

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

    @@ -6844,22 +6809,23 @@ You need to provide the exact name of the airbase as the parame

    Usage:

    - 
      Spawn_Plane = SPAWN:New( "Plane" )
+    
    
+  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 )
 
    
 
@@ -6874,7 +6840,7 @@ You need to provide the exact name of the airbase as the parame
 
    SPAWN:SpawnAtParkingSpot(Airbase, Spots, Takeoff)
    
 
     
-
    Spawn a group on an Wrapper.Airbase at a specific parking spot. 
    
+
    Spawn a group on an Wrapper.Airbase at a specific parking spot.
    
 
 
    
   
    
@@ -7104,10 +7070,10 @@ You can use the returned group to further define the route to be followed.
    
   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 )  
-  
+  SpawnAirplanes:SpawnFromPointVec2( SpawnPointVec2 )
+
   -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
-  SpawnAirplanes:SpawnFromPointVec2( SpawnPointVec2, 2000, 4000 )  
+  SpawnAirplanes:SpawnFromPointVec2( SpawnPointVec2, 2000, 4000 )
    @@ -7185,8 +7151,8 @@ You can use the returned group to further define the route to be followed.

    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 ) - + SpawnAirplanes:SpawnFromPointVec3( SpawnPointVec3 ) + @@ -7288,10 +7254,10 @@ You can use the returned group to further define the route to be followed.

    local SpawnStatic = STATIC:FindByName( StaticName ) -- Spawn from the static position at the height specified in the ME of the group template! - SpawnAirplanes:SpawnFromStatic( SpawnStatic ) - + SpawnAirplanes:SpawnFromStatic( SpawnStatic ) + -- Spawn from the static position at the height randomized between 2000 and 4000 meters. - SpawnAirplanes:SpawnFromStatic( SpawnStatic, 2000, 4000 ) + SpawnAirplanes:SpawnFromStatic( SpawnStatic, 2000, 4000 ) @@ -7395,10 +7361,10 @@ You can use the returned group to further define the route to be followed.

    local SpawnStatic = STATIC:FindByName( StaticName ) -- Spawn from the static position at the height specified in the ME of the group template! - SpawnAirplanes:SpawnFromUnit( SpawnStatic ) - + SpawnAirplanes:SpawnFromUnit( SpawnStatic ) + -- Spawn from the static position at the height randomized between 2000 and 4000 meters. - SpawnAirplanes:SpawnFromUnit( SpawnStatic, 2000, 4000 ) + SpawnAirplanes:SpawnFromUnit( SpawnStatic, 2000, 4000 ) @@ -7502,10 +7468,10 @@ You can use the returned group to further define the route to be followed.

    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 ) - + SpawnAirplanes:SpawnFromVec2( SpawnVec2 ) + -- Spawn from the static position at the height randomized between 2000 and 4000 meters. - SpawnAirplanes:SpawnFromVec2( SpawnVec2, 2000, 4000 ) + SpawnAirplanes:SpawnFromVec2( SpawnVec2, 2000, 4000 ) @@ -7736,20 +7702,20 @@ The first waypoint (where the group is spawned) is replaced wit 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 ) - + 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 ) - + 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 ) + 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 ) - + 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 ) - + SpawnAirplanes:SpawnInZone( SpawnZone, nil, 2000, 4000 ) + @@ -7860,7 +7826,7 @@ The first waypoint (where the group is spawned) is replaced wit

    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 %-tage of variation to be applied on the time interval.

    +The variation is a number between 0 and 1, representing the % of variation to be applied on the time interval.

    @@ -7878,11 +7844,11 @@ The variation is a number between 0 and 1, representing the %-tage of variation

    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 
+-- 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 choosen for each new spawn of the helicopters.
+-- 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 )
    @@ -8729,14 +8695,11 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

    - #boolean + SPAWN.AIOnOff - -

    The AI is on by default when spawning a group.

    -
    @@ -8760,7 +8723,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

    self.CleanUpFunction = routines.scheduleFunction( self._SpawnCleanUpScheduler, { self }, timer.getTime() + 1, SpawnCleanUpInterval )

    +

    self.CleanUpFunction = routines.scheduleFunction( self._SpawnCleanUpScheduler, { self }, timer.getTime() + 1, SpawnCleanUpInterval )

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

    - - -
    -
    - - -SPAWN.SpawnInitModex - - - -
    - -
    -
    -
    - - -SPAWN.SpawnInitModu - - -
    @@ -9335,7 +9276,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

    +

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

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

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

    - - - -
    -
    - - -SPAWN.communication - - - -
    - -
    -
    -
    - - -SPAWN.livery_id - - -
    diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index 72df0a835..8a531f016 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1865,24 +1865,6 @@ 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

    - - @@ -2789,39 +2771,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - - -
    -
    - - -SPAWNSTATIC.heliport_frequency - - - -
    - -
    - @@ -4043,39 +3992,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - - -
    -
    - - -SPAWNSTATIC.heliport_frequency - - - -
    - -
    - diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index 5cbdcac90..eb923e6f9 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -2669,6 +2669,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
    +
    + + +SPOT.ScheduleID + + + +
    + +
    +
    +
    + + +SPOT.SpotIR + + + +
    + +
    +
    +
    + + +SPOT.SpotLaser + + + +
    + +
    +
    +
    + + +SPOT.Target + + +
    @@ -3882,6 +3926,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
    +
    + + +SPOT.ScheduleID + + + +
    + +
    +
    +
    + + +SPOT.SpotIR + + + +
    + +
    +
    +
    + + +SPOT.SpotLaser + + + +
    + +
    +
    +
    + + +SPOT.Target + + +
    @@ -4264,7 +4352,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    -

    Current FSM state.

    +

    Current FSM state.

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

    Table of call backs.

    +

    Table of call backs.

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

    Event name.

    +

    Event name.

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

    Function.

    +

    Function.

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

    Event name.

    +

    Event name.

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

    Name.

    +

    Name.

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

    true, FSM is in this state.

    +

    true, FSM is in this state.

    @@ -5386,6 +5474,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
    +
    + + +SPOT.ScheduleID + + + +
    + +
    +
    +
    + + +SPOT.SpotIR + + + +
    + +
    +
    +
    + + +SPOT.SpotLaser + + + +
    + +
    +
    +
    + + +SPOT.Target + + +
    diff --git a/Documentation/Core.Zone.html b/Documentation/Core.Zone.html index be410fed0..2179ee089 100644 --- a/Documentation/Core.Zone.html +++ b/Documentation/Core.Zone.html @@ -5769,7 +5769,7 @@ end
    -

    Current FSM state.

    +

    Current FSM state.

    @@ -6098,7 +6098,7 @@ end
    -

    Table of call backs.

    +

    Table of call backs.

    @@ -6372,7 +6372,7 @@ end
    -

    Event name.

    +

    Event name.

    @@ -6383,7 +6383,7 @@ end
    -

    Function.

    +

    Function.

    @@ -6416,7 +6416,7 @@ end
    -

    Event name.

    +

    Event name.

    @@ -6686,7 +6686,7 @@ end
    -

    Name.

    +

    Name.

    @@ -6828,7 +6828,7 @@ end
    -

    true, FSM is in this state.

    +

    true, FSM is in this state.

    diff --git a/Documentation/Functional.Arty.html b/Documentation/Functional.Arty.html index 410bf1a06..e7374aca4 100644 --- a/Documentation/Functional.Arty.html +++ b/Documentation/Functional.Arty.html @@ -15925,7 +15925,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent
    -

    Current FSM state.

    +

    Current FSM state.

    @@ -16254,7 +16254,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent
    -

    Table of call backs.

    +

    Table of call backs.

    @@ -16528,7 +16528,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent
    -

    Event name.

    +

    Event name.

    @@ -16539,7 +16539,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent
    -

    Function.

    +

    Function.

    @@ -16572,7 +16572,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent
    -

    Event name.

    +

    Event name.

    @@ -16842,7 +16842,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent
    -

    Name.

    +

    Name.

    @@ -16984,7 +16984,7 @@ The illumination bomb will burn for 300 seconds (5 minutes). Assuming a descent
    -

    true, FSM is in this state.

    +

    true, FSM is in this state.

    diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index a1c1db83b..05b8af552 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -3422,17 +3422,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
    -
    - - -DESIGNATE.LaseDuration - - -
    @@ -6590,17 +6579,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
    -
    - - -DESIGNATE.LaseDuration - - -
    @@ -7400,17 +7378,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
    -
    - - -DESIGNATE.LaseDuration - - -
    @@ -8180,17 +8147,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
    -
    - - -DESIGNATE.LaseDuration - - -
    @@ -8708,7 +8664,7 @@ Designate:SetFlashStatusMenu( false )
    -

    Current FSM state.

    +

    Current FSM state.

    @@ -9037,7 +8993,7 @@ Designate:SetFlashStatusMenu( false )
    -

    Table of call backs.

    +

    Table of call backs.

    @@ -9311,7 +9267,7 @@ Designate:SetFlashStatusMenu( false )
    -

    Event name.

    +

    Event name.

    @@ -9322,7 +9278,7 @@ Designate:SetFlashStatusMenu( false )
    -

    Function.

    +

    Function.

    @@ -9355,7 +9311,7 @@ Designate:SetFlashStatusMenu( false )
    -

    Event name.

    +

    Event name.

    @@ -9625,7 +9581,7 @@ Designate:SetFlashStatusMenu( false )
    -

    Name.

    +

    Name.

    @@ -9767,7 +9723,7 @@ Designate:SetFlashStatusMenu( false )
    -

    true, FSM is in this state.

    +

    true, FSM is in this state.

    @@ -9852,17 +9808,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
    -
    - - -DESIGNATE.LaseDuration - - -
    diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index 2bf4faa51..679749f39 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -14264,7 +14264,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Current FSM state.

    +

    Current FSM state.

    @@ -14593,7 +14593,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Table of call backs.

    +

    Table of call backs.

    @@ -14867,7 +14867,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Event name.

    +

    Event name.

    @@ -14878,7 +14878,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Function.

    +

    Function.

    @@ -14911,7 +14911,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Event name.

    +

    Event name.

    @@ -15181,7 +15181,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Name.

    +

    Name.

    @@ -15323,7 +15323,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    true, FSM is in this state.

    +

    true, FSM is in this state.

    @@ -18915,6 +18915,17 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +
    +
    + + #boolean +DETECTION_BASE.Locking + + +
    @@ -23606,6 +23617,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
    +
    + + #boolean +DETECTION_BASE.Locking + + +
    @@ -24032,7 +24054,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Current FSM state.

    +

    Current FSM state.

    @@ -24361,7 +24383,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Table of call backs.

    +

    Table of call backs.

    @@ -24635,7 +24657,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Event name.

    +

    Event name.

    @@ -24646,7 +24668,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Function.

    +

    Function.

    @@ -24679,7 +24701,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Event name.

    +

    Event name.

    @@ -24949,7 +24971,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Name.

    +

    Name.

    @@ -25091,7 +25113,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    true, FSM is in this state.

    +

    true, FSM is in this state.

    @@ -25352,6 +25374,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
    +
    + + #boolean +DETECTION_BASE.Locking + + +
    @@ -34253,7 +34286,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Current FSM state.

    +

    Current FSM state.

    @@ -34582,7 +34615,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Table of call backs.

    +

    Table of call backs.

    @@ -34856,7 +34889,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Event name.

    +

    Event name.

    @@ -34867,7 +34900,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Function.

    +

    Function.

    @@ -34900,7 +34933,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Event name.

    +

    Event name.

    @@ -35170,7 +35203,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Name.

    +

    Name.

    @@ -35312,7 +35345,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    true, FSM is in this state.

    +

    true, FSM is in this state.

    @@ -43831,7 +43864,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Current FSM state.

    +

    Current FSM state.

    @@ -44160,7 +44193,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Table of call backs.

    +

    Table of call backs.

    @@ -44434,7 +44467,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Event name.

    +

    Event name.

    @@ -44445,7 +44478,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Function.

    +

    Function.

    @@ -44478,7 +44511,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Event name.

    +

    Event name.

    @@ -44748,7 +44781,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    Name.

    +

    Name.

    @@ -44890,7 +44923,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    -

    true, FSM is in this state.

    +

    true, FSM is in this state.

    diff --git a/Documentation/Functional.FOX.html b/Documentation/Functional.FOX.html index 952bd27e1..cdf42fa2b 100644 --- a/Documentation/Functional.FOX.html +++ b/Documentation/Functional.FOX.html @@ -6627,7 +6627,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini
    -

    Current FSM state.

    +

    Current FSM state.

    @@ -6956,7 +6956,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini
    -

    Table of call backs.

    +

    Table of call backs.

    @@ -7230,7 +7230,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini
    -

    Event name.

    +

    Event name.

    @@ -7241,7 +7241,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini
    -

    Function.

    +

    Function.

    @@ -7274,7 +7274,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini
    -

    Event name.

    +

    Event name.

    @@ -7544,7 +7544,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini
    -

    Name.

    +

    Name.

    @@ -7686,7 +7686,7 @@ Don't set the explosion power too big or it will harm the aircraft in the vicini
    -

    true, FSM is in this state.

    +

    true, FSM is in this state.

    diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index be2e8ff72..10a6a2c15 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -3345,9 +3345,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

    switch alarm state RED

    - @@ -7010,9 +7007,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)` - -

    switch alarm state RED

    - diff --git a/Documentation/Functional.Range.html b/Documentation/Functional.Range.html index 6a1a223cc..7b0ee9554 100644 --- a/Documentation/Functional.Range.html +++ b/Documentation/Functional.Range.html @@ -10223,7 +10223,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
    -

    Current FSM state.

    +

    Current FSM state.

    @@ -10552,7 +10552,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
    -

    Table of call backs.

    +

    Table of call backs.

    @@ -10826,7 +10826,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
    -

    Event name.

    +

    Event name.

    @@ -10837,7 +10837,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
    -

    Function.

    +

    Function.

    @@ -10870,7 +10870,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
    -

    Event name.

    +

    Event name.

    @@ -11140,7 +11140,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
    -

    Name.

    +

    Name.

    @@ -11282,7 +11282,7 @@ If a zone is not explicitly specified, the range zone is determined by its locat
    -

    true, FSM is in this state.

    +

    true, FSM is in this state.

    diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html index 9f6fa837f..76d447990 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -3358,12 +3358,6 @@ manager:Stop(7200)

    RAT.termtype

    Type of terminal to be used when spawning at an airbase.

    - - - -

    RAT.type

    - - @@ -3491,11 +3485,11 @@ manager:Stop(7200)

    RAT:InitAIOnOff(AIOnOff)

    - +

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

    -

    RAT:InitAirbase(AirbaseName, Takeoff, TerminalTyple, TerminalType)

    +

    RAT:InitAirbase(AirbaseName, Takeoff, TerminalType)

    Set spawns to happen at a particular airbase.

    @@ -3503,7 +3497,7 @@ manager:Stop(7200)

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

    -

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

    +

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

    @@ -3603,7 +3597,7 @@ and any spaces before and after the resulting name are removed.

    RAT:InitRadioCommsOnOff(switch)

    -

    Sets the radio comms on or off.

    +

    Sets the radio communication on or off.

    @@ -3663,7 +3657,7 @@ and any spaces before and after the resulting name are removed.

    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.

    +

    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.

    @@ -3736,6 +3730,7 @@ and any spaces before and after the resulting name are removed.

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

    Will park a group at an Wrapper.Airbase.

    + @@ -3795,7 +3790,7 @@ and any spaces before and after the resulting name are removed.

    RAT:SpawnAtParkingSpot(Airbase, Spots, Takeoff)

    -

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

    +

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

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

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

    - - - -

    RAT.communication

    - - - - - -

    RAT.livery_id

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

    Type of terminal to be used when spawning at an airbase.

    - - - -
    -
    - - -RAT.type - - -
    @@ -14602,17 +14574,6 @@ Initializes the ratcraft array and group menu.

    Type of terminal to be used when spawning at an airbase.

    - - - -
    -
    - - -RAT.type - - -
    @@ -14749,12 +14710,14 @@ Initializes the ratcraft array and group menu.

    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
    + 
    
+  -- 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
+
    @@ -14843,11 +14806,13 @@ If no index is given, it will return the first group in the list.

    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
    + 
    
+  -- 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
+
    @@ -14902,12 +14867,14 @@ end

    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
    + 
    
+  -- 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
+
    @@ -15013,7 +14980,7 @@ end

    RAT:InitAIOnOff(AIOnOff)

    - +

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

    @@ -15025,13 +14992,27 @@ end

    + #boolean AIOnOff

    -

    + +

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

    +
    +

    Return value:

    +
    +
    +

    #SPAWN:

    +
    +
    + +

    The SPAWN object

    + +
    +
    @@ -15040,7 +15021,7 @@ end
    -

    RAT:InitAirbase(AirbaseName, Takeoff, TerminalTyple, TerminalType)

    +

    RAT:InitAirbase(AirbaseName, Takeoff, TerminalType)

    Set spawns to happen at a particular airbase.

    @@ -15085,7 +15066,7 @@ end

    #number - TerminalTyple + TerminalType

    @@ -15094,16 +15075,6 @@ end
    -
    -
    -

    - TerminalType -

    -
    -
    -

    -
    -

    Return value:

    @@ -15126,7 +15097,7 @@ end

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

    -

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

    +

    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. @@ -15203,12 +15174,12 @@ CAUTION: this directive will NOT work with OnSpawnGroup function.

    Usage:

    - 
    -- Define an array of Groups.
-Spawn_BE_Ground = SPAWN
-  :New( 'BE Ground' )
-  :InitLimit( 2, 24 )
-  :InitArray( 90, 10, 100, 50 )
-
    + 
    
+  -- Define an array of Groups.
+  Spawn_BE_Ground = SPAWN:New( 'BE Ground' )
+                         :InitLimit( 2, 24 )
+                         :InitArray( 90, 10, 100, 50 )
+
    @@ -15302,7 +15273,8 @@ When groups are still alive and have become inactive due to damage and are unabl

    Usage:

    
-Spawn_Helicopter:InitCleanUp( 20 )  -- CleanUp the spawning of the helicopters every 20 seconds when they become inactive.
    + Spawn_Helicopter:InitCleanUp( 20 ) -- CleanUp the spawning of the helicopters every 20 seconds when they become inactive. + @@ -15339,8 +15311,8 @@ Spawn_Helicopter:InitCleanUp( 20 ) -- CleanUp the spawning of the helicopters e

    Coalition of the group as number of enumerator:

    @@ -15372,7 +15344,7 @@ Spawn_Helicopter:InitCleanUp( 20 ) -- CleanUp the spawning of the helicopters e

    Sets the country of the spawn group.

    -

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

    +

    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!

    @@ -15394,10 +15366,10 @@ Spawn_Helicopter:InitCleanUp( 20 ) -- CleanUp the spawning of the helicopters e +

    Return value:

    @@ -15581,16 +15553,16 @@ Note that InitGroupHeading does not rotate the groups route; only its i 
    
 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 +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 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 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)
    @@ -15622,7 +15594,7 @@ mySpawner:InitHeading(0):InitGroupHeading(-60)
    -

    Indicates the maximum amount of units in the group.

    +

    Indicates the maximum amount of units in the group.

    @@ -15699,13 +15671,13 @@ mySpawner:InitHeading(0):InitGroupHeading(-60)

    Usage:

    
-Spawn = SPAWN:New( ... )
+  Spawn = SPAWN:New( ... )
 
--- Spawn the units pointing to 100 degrees.
-Spawn:InitHeading( 100 )
+  -- Spawn the units pointing to 100 degrees.
+  Spawn:InitHeading( 100 )
 
--- Spawn the units pointing between 100 and 150 degrees.
-Spawn:InitHeading( 100, 150 )
+  -- Spawn the units pointing between 100 and 150 degrees.
+  Spawn:InitHeading( 100, 150 )
    @@ -15837,7 +15809,7 @@ When a SPAWN.New is executed and the limit of the am
    -

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

    +

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

    @@ -15850,8 +15822,8 @@ When a SPAWN.New is executed and the limit of the am
    -

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

    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.

    @@ -15868,10 +15840,12 @@ This parameter accepts the value 0, which defines that there are no maximum grou

    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 )
    + 
    
+  -- 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 )
+
    @@ -15902,7 +15876,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitLimit( 2, 24 )
    -

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

    +

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

    @@ -15975,7 +15949,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitLimit( 2, 24 )RAT:InitRadioCommsOnOff(switch) -

    Sets the radio comms on or off.

    +

    Sets the radio communication on or off.

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

    @@ -15996,7 +15970,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitLimit( 2, 24 )
    -

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

    +

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

    @@ -16131,7 +16105,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitLimit( 2, 24 )
    -

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

    +

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

    @@ -16186,7 +16160,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitLimit( 2, 24 )Randomizes the defined route of the SpawnTemplatePrefix group in the ME.

    -

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

    +

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

    @@ -16204,7 +16178,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitLimit( 2, 24 )
    -

    is the waypoint where the randomization begins. +

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

    @@ -16218,7 +16192,7 @@ Note that the StartPoint = 0 equaling the point where the group is spawned.

    -

    is the waypoint where the randomization ends counting backwards. +

    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.

    @@ -16261,11 +16235,13 @@ This parameter is useful to avoid randomization to end at a waypoint earlier tha

    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 )
    + 
    
+  -- 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 )
+
    @@ -16282,7 +16258,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitRandomizeRoute(

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

    @@ -16302,7 +16278,7 @@ In other words, this method randomizes between a defined set of groups the templ
    -

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

    +

    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.

    @@ -16318,17 +16294,18 @@ In other words, this method randomizes between a defined set of groups the templ

    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 simulteneously  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 )
    + 
    
+  -- 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 )
    @@ -16344,7 +16321,7 @@ Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150

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

    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.

    @@ -16380,17 +16357,19 @@ In other words, this method randomizes between a defined set of groups the templ

    Usage:

    - 
    -- NATO Tank Platoons invading Gori.
+    
    
+ -- 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.
+  -- 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 simulteneously  and 150 Groups to be spawned during the whole mission.
+  -- 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_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 )
+
    @@ -16406,7 +16385,7 @@ Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150

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

    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.

    @@ -16426,7 +16405,7 @@ In other words, this method randomizes between a defined set of groups the templ
    -

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

    +

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

    @@ -16442,20 +16421,22 @@ In other words, this method randomizes between a defined set of groups the templ

    Usage:

    - 
    -- NATO Tank Platoons invading Gori.
+    
    
+  -- 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.
+  -- 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 simulteneously  and 150 Groups to be spawned during the whole mission.
+  -- 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()
+  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 )
    
+  -- 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 )
+
    @@ -16486,7 +16467,7 @@ Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150
    -

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

    +

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

    @@ -16528,11 +16509,13 @@ Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150

    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 )
    + 
    
+  -- 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 )
+
    @@ -16563,7 +16546,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitRandomizeRoute(
    -

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

    +

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

    @@ -16579,15 +16562,16 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitRandomizeRoute(

    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 )
-
    + 
    
+   -- 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 )
+
    @@ -16600,12 +16584,12 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitRandomizeRoute(

    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.

    +

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

    @@ -16626,15 +16610,15 @@ So ensure that the routes for groups that respawn, always return to the original

    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()
-
    + 
    
+  -- 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()
+
    @@ -16667,14 +16651,14 @@ SpawnRU_SU34 = SPAWN

    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()
    + 
    
+  -- 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()
    @@ -16707,13 +16691,14 @@ SpawnRU_SU34 = SPAWN

    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()
    + 
    
+  -- 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()
+
    @@ -16934,8 +16919,9 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ) 
  • -- Create a new SPAWN object based on a Group Template defined from scratch.
 Spawn_BE_KA50 = SPAWN:NewWithAlias( 'BE KA-50@RAMP-Ground Defense', 'Helicopter Attacking a City' )
  • 
--- Create a new CSAR_Spawn object based on a normal Group Template to spawn a soldier.
-local CSAR_Spawn = SPAWN:NewWithFromTemplate( Template, "CSAR", "Pilot" )
    • + -- Create a new CSAR_Spawn object based on a normal Group Template to spawn a soldier. + local CSAR_Spawn = SPAWN:NewWithFromTemplate( Template, "CSAR", "Pilot" ) + @@ -17073,17 +17059,16 @@ The first parameter of the SpawnFunction is the -- 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 ) - + 
    
+   -- 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 )
+
    @@ -17098,6 +17083,7 @@ The first parameter of the SpawnFunction is the     Wrapper.Airbase.

    +

    Defined in:

    @@ -17188,12 +17174,12 @@ Note that each point in the route assigned to the spawning group is reset to the 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. +

    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.

    @@ -17262,13 +17248,13 @@ You need to provide the exact name of the airbase as the parame

    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 )
    @@ -17422,16 +17408,16 @@ You can use the returned group to further define the route to be followed.

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

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

    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!

    @@ -17517,7 +17503,7 @@ You need to provide the exact name of the airbase as the parame
    -

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

    +

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

    @@ -17533,22 +17519,23 @@ You need to provide the exact name of the airbase as the parame

    Usage:

    - 
      Spawn_Plane = SPAWN:New( "Plane" )
+    
    
+  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 )
 
    
 
@@ -17563,7 +17550,7 @@ You need to provide the exact name of the airbase as the parame
 
    RAT:SpawnAtParkingSpot(Airbase, Spots, Takeoff)
    
 
     
-
    Spawn a group on an Wrapper.Airbase at a specific parking spot. 
    
+
    Spawn a group on an Wrapper.Airbase at a specific parking spot.
    
 
 
    
   
    
@@ -17793,10 +17780,10 @@ You can use the returned group to further define the route to be followed.
    
   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 )  
-  
+  SpawnAirplanes:SpawnFromPointVec2( SpawnPointVec2 )
+
   -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
-  SpawnAirplanes:SpawnFromPointVec2( SpawnPointVec2, 2000, 4000 )  
+  SpawnAirplanes:SpawnFromPointVec2( SpawnPointVec2, 2000, 4000 )
    @@ -17874,8 +17861,8 @@ You can use the returned group to further define the route to be followed.

    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 ) - + SpawnAirplanes:SpawnFromPointVec3( SpawnPointVec3 ) + @@ -17977,10 +17964,10 @@ You can use the returned group to further define the route to be followed.

    local SpawnStatic = STATIC:FindByName( StaticName ) -- Spawn from the static position at the height specified in the ME of the group template! - SpawnAirplanes:SpawnFromStatic( SpawnStatic ) - + SpawnAirplanes:SpawnFromStatic( SpawnStatic ) + -- Spawn from the static position at the height randomized between 2000 and 4000 meters. - SpawnAirplanes:SpawnFromStatic( SpawnStatic, 2000, 4000 ) + SpawnAirplanes:SpawnFromStatic( SpawnStatic, 2000, 4000 ) @@ -18084,10 +18071,10 @@ You can use the returned group to further define the route to be followed.

    local SpawnStatic = STATIC:FindByName( StaticName ) -- Spawn from the static position at the height specified in the ME of the group template! - SpawnAirplanes:SpawnFromUnit( SpawnStatic ) - + SpawnAirplanes:SpawnFromUnit( SpawnStatic ) + -- Spawn from the static position at the height randomized between 2000 and 4000 meters. - SpawnAirplanes:SpawnFromUnit( SpawnStatic, 2000, 4000 ) + SpawnAirplanes:SpawnFromUnit( SpawnStatic, 2000, 4000 ) @@ -18191,10 +18178,10 @@ You can use the returned group to further define the route to be followed.

    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 ) - + SpawnAirplanes:SpawnFromVec2( SpawnVec2 ) + -- Spawn from the static position at the height randomized between 2000 and 4000 meters. - SpawnAirplanes:SpawnFromVec2( SpawnVec2, 2000, 4000 ) + SpawnAirplanes:SpawnFromVec2( SpawnVec2, 2000, 4000 ) @@ -18425,20 +18412,20 @@ The first waypoint (where the group is spawned) is replaced wit 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 ) - + 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 ) - + 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 ) + 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 ) - + 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 ) - + SpawnAirplanes:SpawnInZone( SpawnZone, nil, 2000, 4000 ) + @@ -18549,7 +18536,7 @@ The first waypoint (where the group is spawned) is replaced wit

    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 %-tage of variation to be applied on the time interval.

    +The variation is a number between 0 and 1, representing the % of variation to be applied on the time interval.

    @@ -18567,11 +18554,11 @@ The variation is a number between 0 and 1, representing the %-tage of variation

    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 
+-- 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 choosen for each new spawn of the helicopters.
+-- 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 )
    @@ -20548,17 +20535,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

    Type of terminal to be used when spawning at an airbase.

    - - - -
    -
    - - -RAT.type - - -
    diff --git a/Documentation/Functional.Suppression.html b/Documentation/Functional.Suppression.html index e7d5be35f..8107b0a35 100644 --- a/Documentation/Functional.Suppression.html +++ b/Documentation/Functional.Suppression.html @@ -10775,7 +10775,7 @@ If the group consists of more than one unit, this referrs to the group strength
    -

    Current FSM state.

    +

    Current FSM state.

    @@ -11104,7 +11104,7 @@ If the group consists of more than one unit, this referrs to the group strength
    -

    Table of call backs.

    +

    Table of call backs.

    @@ -11378,7 +11378,7 @@ If the group consists of more than one unit, this referrs to the group strength
    -

    Event name.

    +

    Event name.

    @@ -11389,7 +11389,7 @@ If the group consists of more than one unit, this referrs to the group strength
    -

    Function.

    +

    Function.

    @@ -11422,7 +11422,7 @@ If the group consists of more than one unit, this referrs to the group strength
    -

    Event name.

    +

    Event name.

    @@ -11692,7 +11692,7 @@ If the group consists of more than one unit, this referrs to the group strength
    -

    Name.

    +

    Name.

    @@ -11834,7 +11834,7 @@ If the group consists of more than one unit, this referrs to the group strength
    -

    true, FSM is in this state.

    +

    true, FSM is in this state.

    diff --git a/Documentation/Functional.Warehouse.html b/Documentation/Functional.Warehouse.html index 71a12cea9..4a8b30172 100644 --- a/Documentation/Functional.Warehouse.html +++ b/Documentation/Functional.Warehouse.html @@ -20357,7 +20357,7 @@ this request is used to put the groups back into the warehouse stock.

    -

    Current FSM state.

    +

    Current FSM state.

    @@ -20686,7 +20686,7 @@ this request is used to put the groups back into the warehouse stock.

    -

    Table of call backs.

    +

    Table of call backs.

    @@ -20960,7 +20960,7 @@ this request is used to put the groups back into the warehouse stock.

    -

    Event name.

    +

    Event name.

    @@ -20971,7 +20971,7 @@ this request is used to put the groups back into the warehouse stock.

    -

    Function.

    +

    Function.

    @@ -21004,7 +21004,7 @@ this request is used to put the groups back into the warehouse stock.

    -

    Event name.

    +

    Event name.

    @@ -21274,7 +21274,7 @@ this request is used to put the groups back into the warehouse stock.

    -

    Name.

    +

    Name.

    @@ -21416,7 +21416,7 @@ this request is used to put the groups back into the warehouse stock.

    -

    true, FSM is in this state.

    +

    true, FSM is in this state.

    diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index d4922608d..1c3fa8f98 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -29823,7 +29823,7 @@ If removed flight is the section lead, we try to find a new leader.

    -

    Current FSM state.

    +

    Current FSM state.

    @@ -30152,7 +30152,7 @@ If removed flight is the section lead, we try to find a new leader.

    -

    Table of call backs.

    +

    Table of call backs.

    @@ -30426,7 +30426,7 @@ If removed flight is the section lead, we try to find a new leader.

    -

    Event name.

    +

    Event name.

    @@ -30437,7 +30437,7 @@ If removed flight is the section lead, we try to find a new leader.

    -

    Function.

    +

    Function.

    @@ -30470,7 +30470,7 @@ If removed flight is the section lead, we try to find a new leader.

    -

    Event name.

    +

    Event name.

    @@ -30740,7 +30740,7 @@ If removed flight is the section lead, we try to find a new leader.

    -

    Name.

    +

    Name.

    @@ -30882,7 +30882,7 @@ If removed flight is the section lead, we try to find a new leader.

    -

    true, FSM is in this state.

    +

    true, FSM is in this state.

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

    Set case of f

    +

    Set case to that of lead.

    @@ -38809,6 +38809,20 @@ When moose is loading dynamically (for moose class development), tracing is swit + +
    +
    + + +AIRBOSS.PlayerData.flag + + + + +

    Decrease stack/flag. Human player needs to take care himself.

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

    Set time stamp.

    +
    diff --git a/Documentation/Ops.Atis.html b/Documentation/Ops.Atis.html index 6d4fa6689..41eac6f23 100644 --- a/Documentation/Ops.Atis.html +++ b/Documentation/Ops.Atis.html @@ -8198,7 +8198,7 @@ Note that the dew point is only an artificial information as DCS does not have a
    -

    Current FSM state.

    +

    Current FSM state.

    @@ -8527,7 +8527,7 @@ Note that the dew point is only an artificial information as DCS does not have a
    -

    Table of call backs.

    +

    Table of call backs.

    @@ -8801,7 +8801,7 @@ Note that the dew point is only an artificial information as DCS does not have a
    -

    Event name.

    +

    Event name.

    @@ -8812,7 +8812,7 @@ Note that the dew point is only an artificial information as DCS does not have a
    -

    Function.

    +

    Function.

    @@ -8845,7 +8845,7 @@ Note that the dew point is only an artificial information as DCS does not have a
    -

    Event name.

    +

    Event name.

    @@ -9115,7 +9115,7 @@ Note that the dew point is only an artificial information as DCS does not have a
    -

    Name.

    +

    Name.

    @@ -9257,7 +9257,7 @@ Note that the dew point is only an artificial information as DCS does not have a
    -

    true, FSM is in this state.

    +

    true, FSM is in this state.

    diff --git a/Documentation/Ops.CSAR.html b/Documentation/Ops.CSAR.html index d125e370e..b535e5c73 100644 --- a/Documentation/Ops.CSAR.html +++ b/Documentation/Ops.CSAR.html @@ -3540,7 +3540,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CSAR.FreeVHFFrequencies @@ -3629,14 +3629,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CSAR.allheligroupset - -

    GROUP_SET of all helis

    -
    @@ -3842,14 +3839,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CSAR.csarUnits - -

    table of CSAR unit names

    -
    @@ -3870,14 +3864,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CSAR.downedPilots - -

    Replacement woundedGroups

    -
    @@ -4184,20 +4175,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    -
    -
    -
    - - #number -CSAR.rescuedpilots - - - - -

    counter for saved pilots

    - -
    -
    @@ -4223,20 +4200,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    -
    -
    -
    - - #number -CSAR.rescues - - - - -

    counter for successful rescue landings at FARP/AFB/MASH

    - -
    -
    @@ -8332,7 +8295,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CSAR.FreeVHFFrequencies @@ -8421,14 +8384,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CSAR.allheligroupset - -

    GROUP_SET of all helis

    -
    @@ -8634,14 +8594,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CSAR.csarUnits - -

    table of CSAR unit names

    -
    @@ -8662,14 +8619,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CSAR.downedPilots - -

    Replacement woundedGroups

    -
    @@ -8976,20 +8930,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    -
    -
    -
    - - #number -CSAR.rescuedpilots - - - - -

    counter for saved pilots

    - -
    -
    @@ -9015,20 +8955,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    -
    -
    -
    - - #number -CSAR.rescues - - - - -

    counter for successful rescue landings at FARP/AFB/MASH

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

    Current FSM state.

    +

    Current FSM state.

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

    Table of call backs.

    +

    Table of call backs.

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

    Event name.

    +

    Event name.

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

    Function.

    +

    Function.

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

    Event name.

    +

    Event name.

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

    Name.

    +

    Name.

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

    true, FSM is in this state.

    +

    true, FSM is in this state.

    @@ -10643,7 +10569,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CSAR.FreeVHFFrequencies @@ -10732,14 +10658,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CSAR.allheligroupset - -

    GROUP_SET of all helis

    -
    @@ -10945,14 +10868,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CSAR.csarUnits - -

    table of CSAR unit names

    -
    @@ -10973,14 +10893,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CSAR.downedPilots - -

    Replacement woundedGroups

    -
    @@ -11287,20 +11204,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    -
    -
    -
    - - #number -CSAR.rescuedpilots - - - - -

    counter for saved pilots

    - -
    -
    @@ -11326,20 +11229,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    -
    -
    -
    - - #number -CSAR.rescues - - - - -

    counter for successful rescue landings at FARP/AFB/MASH

    - -
    -
    diff --git a/Documentation/Ops.CTLD.html b/Documentation/Ops.CTLD.html index a4627c71e..b380f7cda 100644 --- a/Documentation/Ops.CTLD.html +++ b/Documentation/Ops.CTLD.html @@ -5531,6 +5531,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Field(s)

    +
    +
    + + #number +CTLD.CargoCounter + + + +
    + +
    @@ -5597,6 +5608,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Name of the class.

    +
    + +
    +
    +
    + + #number +CTLD.CrateCounter + + +
    @@ -5628,7 +5650,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CTLD.CtldUnits @@ -5650,7 +5672,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CTLD.DroppedTroops @@ -5675,11 +5697,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    + #number +CTLD.Engineers + + + +

    use as counter

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

    holds #CTLD_ENGINEERING objects

    +
    @@ -5711,7 +5750,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CTLD.FreeFMFrequencies @@ -5722,7 +5761,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CTLD.FreeUHFFrequencies @@ -5733,11 +5772,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CTLD.FreeVHFFrequencies + +

    Beacons

    +
    @@ -5863,11 +5905,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CTLD.PilotGroups + +

    tables

    +
    @@ -5951,6 +5996,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
    + +
    +
    +
    + + #number +CTLD.TroopCounter + + +
    @@ -6275,6 +6331,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

    time to repair a unit/group

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

    Field(s)

    +
    +
    + + #number +CTLD.CargoCounter + + + +
    + +
    @@ -12715,6 +12785,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Name of the class.

    +
    + +
    +
    +
    + + #number +CTLD.CrateCounter + + +
    @@ -12746,7 +12827,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CTLD.CtldUnits @@ -12768,7 +12849,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CTLD.DroppedTroops @@ -12793,11 +12874,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    + #number +CTLD.Engineers + + + +

    use as counter

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

    holds #CTLD_ENGINEERING objects

    +
    @@ -12829,7 +12927,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CTLD.FreeFMFrequencies @@ -12840,7 +12938,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CTLD.FreeUHFFrequencies @@ -12851,11 +12949,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CTLD.FreeVHFFrequencies + +

    Beacons

    +
    @@ -12981,11 +13082,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CTLD.PilotGroups + +

    tables

    +
    @@ -13069,6 +13173,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
    + +
    +
    +
    + + #number +CTLD.TroopCounter + + +
    @@ -13393,6 +13508,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

    time to repair a unit/group

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

    Current FSM state.

    +

    Current FSM state.

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

    Table of call backs.

    +

    Table of call backs.

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

    Event name.

    +

    Event name.

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

    Function.

    +

    Function.

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

    Event name.

    +

    Event name.

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

    Name.

    +

    Name.

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

    true, FSM is in this state.

    +

    true, FSM is in this state.

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

    Field(s)

    +
    +
    + + #number +CTLD.CargoCounter + + + +
    + +
    @@ -15005,6 +15134,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Name of the class.

    +
    + +
    +
    +
    + + #number +CTLD.CrateCounter + + +
    @@ -15036,7 +15176,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CTLD.CtldUnits @@ -15058,7 +15198,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CTLD.DroppedTroops @@ -15083,11 +15223,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    + #number +CTLD.Engineers + + + +

    use as counter

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

    holds #CTLD_ENGINEERING objects

    +
    @@ -15119,7 +15276,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CTLD.FreeFMFrequencies @@ -15130,7 +15287,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CTLD.FreeUHFFrequencies @@ -15141,11 +15298,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CTLD.FreeVHFFrequencies + +

    Beacons

    +
    @@ -15271,11 +15431,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CTLD.PilotGroups + +

    tables

    +
    @@ -15359,6 +15522,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
    + +
    +
    +
    + + #number +CTLD.TroopCounter + + +
    @@ -15683,6 +15857,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

    time to repair a unit/group

    +
    @@ -19476,17 +19653,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

    Can transport crate.

    -
    - -
    -
    -
    - - #number -CTLD.UnitCapabilities.length - - -
    diff --git a/Documentation/Ops.RecoveryTanker.html b/Documentation/Ops.RecoveryTanker.html index 46bdf29ef..c05f7353a 100644 --- a/Documentation/Ops.RecoveryTanker.html +++ b/Documentation/Ops.RecoveryTanker.html @@ -7618,7 +7618,7 @@ The group name is the one specified in the RECO
    -

    Current FSM state.

    +

    Current FSM state.

    @@ -7947,7 +7947,7 @@ The group name is the one specified in the RECO
    -

    Table of call backs.

    +

    Table of call backs.

    @@ -8221,7 +8221,7 @@ The group name is the one specified in the     RECO
    -

    Event name.

    +

    Event name.

    @@ -8232,7 +8232,7 @@ The group name is the one specified in the     RECO
    -

    Function.

    +

    Function.

    @@ -8265,7 +8265,7 @@ The group name is the one specified in the     RECO
    -

    Event name.

    +

    Event name.

    @@ -8535,7 +8535,7 @@ The group name is the one specified in the     RECO
    -

    Name.

    +

    Name.

    @@ -8677,7 +8677,7 @@ The group name is the one specified in the     RECO
    -

    true, FSM is in this state.

    +

    true, FSM is in this state.

    diff --git a/Documentation/Ops.RescueHelo.html b/Documentation/Ops.RescueHelo.html index 2b3c87ffc..6397d19dc 100644 --- a/Documentation/Ops.RescueHelo.html +++ b/Documentation/Ops.RescueHelo.html @@ -6746,7 +6746,7 @@ The group name is the one specified in the     RESCUEHE
    -

    Current FSM state.

    +

    Current FSM state.

    @@ -7075,7 +7075,7 @@ The group name is the one specified in the     RESCUEHE
    -

    Table of call backs.

    +

    Table of call backs.

    @@ -7349,7 +7349,7 @@ The group name is the one specified in the     RESCUEHE
    -

    Event name.

    +

    Event name.

    @@ -7360,7 +7360,7 @@ The group name is the one specified in the     RESCUEHE
    -

    Function.

    +

    Function.

    @@ -7393,7 +7393,7 @@ The group name is the one specified in the     RESCUEHE
    -

    Event name.

    +

    Event name.

    @@ -7663,7 +7663,7 @@ The group name is the one specified in the     RESCUEHE
    -

    Name.

    +

    Name.

    @@ -7805,7 +7805,7 @@ The group name is the one specified in the     RESCUEHE
    -

    true, FSM is in this state.

    +

    true, FSM is in this state.

    diff --git a/Documentation/Tasking.DetectionManager.html b/Documentation/Tasking.DetectionManager.html index 80497a96e..86a9c8dc4 100644 --- a/Documentation/Tasking.DetectionManager.html +++ b/Documentation/Tasking.DetectionManager.html @@ -4247,7 +4247,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    -

    Current FSM state.

    +

    Current FSM state.

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

    Table of call backs.

    +

    Table of call backs.

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

    Event name.

    +

    Event name.

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

    Function.

    +

    Function.

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

    Event name.

    +

    Event name.

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

    Name.

    +

    Name.

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

    true, FSM is in this state.

    +

    true, FSM is in this state.

    diff --git a/Documentation/Tasking.Mission.html b/Documentation/Tasking.Mission.html index 464a187f6..411cb35b6 100644 --- a/Documentation/Tasking.Mission.html +++ b/Documentation/Tasking.Mission.html @@ -6869,7 +6869,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al
    -

    Current FSM state.

    +

    Current FSM state.

    @@ -7198,7 +7198,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al
    -

    Table of call backs.

    +

    Table of call backs.

    @@ -7472,7 +7472,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al
    -

    Event name.

    +

    Event name.

    @@ -7483,7 +7483,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al
    -

    Function.

    +

    Function.

    @@ -7516,7 +7516,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al
    -

    Event name.

    +

    Event name.

    @@ -7786,7 +7786,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al
    -

    Name.

    +

    Name.

    @@ -7928,7 +7928,7 @@ Each Task can be set a certain Goals. The Mission will not be completed until al
    -

    true, FSM is in this state.

    +

    true, FSM is in this state.

    diff --git a/Documentation/Tasking.Task_A2A_Dispatcher.html b/Documentation/Tasking.Task_A2A_Dispatcher.html index 91b3c2ae5..84a98db12 100644 --- a/Documentation/Tasking.Task_A2A_Dispatcher.html +++ b/Documentation/Tasking.Task_A2A_Dispatcher.html @@ -5101,7 +5101,7 @@ If too large, any airborne cap may not be able to reach the detected target area
    -

    Current FSM state.

    +

    Current FSM state.

    @@ -5430,7 +5430,7 @@ If too large, any airborne cap may not be able to reach the detected target area
    -

    Table of call backs.

    +

    Table of call backs.

    @@ -5704,7 +5704,7 @@ If too large, any airborne cap may not be able to reach the detected target area
    -

    Event name.

    +

    Event name.

    @@ -5715,7 +5715,7 @@ If too large, any airborne cap may not be able to reach the detected target area
    -

    Function.

    +

    Function.

    @@ -5748,7 +5748,7 @@ If too large, any airborne cap may not be able to reach the detected target area
    -

    Event name.

    +

    Event name.

    @@ -6018,7 +6018,7 @@ If too large, any airborne cap may not be able to reach the detected target area
    -

    Name.

    +

    Name.

    @@ -6160,7 +6160,7 @@ If too large, any airborne cap may not be able to reach the detected target area
    -

    true, FSM is in this state.

    +

    true, FSM is in this state.

    diff --git a/Documentation/Tasking.Task_A2G_Dispatcher.html b/Documentation/Tasking.Task_A2G_Dispatcher.html index 4c79d10d3..8015f4072 100644 --- a/Documentation/Tasking.Task_A2G_Dispatcher.html +++ b/Documentation/Tasking.Task_A2G_Dispatcher.html @@ -5245,7 +5245,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    -

    Current FSM state.

    +

    Current FSM state.

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

    Table of call backs.

    +

    Table of call backs.

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

    Event name.

    +

    Event name.

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

    Function.

    +

    Function.

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

    Event name.

    +

    Event name.

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

    Name.

    +

    Name.

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

    true, FSM is in this state.

    +

    true, FSM is in this state.

    diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html index eb5225e67..e97a2ecce 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -3113,7 +3113,7 @@ based on the tasking capabilities defined in
    - Cargo.Cargo#CARGO + FSM_PROCESS.Cargo @@ -3150,7 +3150,7 @@ based on the tasking capabilities defined in
    - #number + TASK_CARGO.CargoLimit @@ -4572,7 +4572,7 @@ based on the tasking capabilities defined in
    - #number + TASK_CARGO.CargoLimit @@ -9104,7 +9104,7 @@ If the Unit is part of the Task, true is returned.

    - #number + TASK_CARGO.CargoLimit diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index a2f75f225..e98de1f1e 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -3087,6 +3087,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Field(s)

    + + + +
    +
    + + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
    + +
    @@ -3101,7 +3145,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4166,6 +4210,50 @@ This method can only be used once!

    Field(s)

    + + + +
    +
    + + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
    + +
    @@ -4180,7 +4268,7 @@ This method can only be used once!

    - + #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -5024,6 +5112,50 @@ This method can only be used once!

    Field(s)

    + + + +
    +
    + + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
    + +
    @@ -5038,7 +5170,7 @@ This method can only be used once!

    - + #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -5436,7 +5568,7 @@ This method can only be used once!

    -

    Current FSM state.

    +

    Current FSM state.

    @@ -5765,7 +5897,7 @@ This method can only be used once!

    -

    Table of call backs.

    +

    Table of call backs.

    @@ -6039,7 +6171,7 @@ This method can only be used once!

    -

    Event name.

    +

    Event name.

    @@ -6050,7 +6182,7 @@ This method can only be used once!

    -

    Function.

    +

    Function.

    @@ -6083,7 +6215,7 @@ This method can only be used once!

    -

    Event name.

    +

    Event name.

    @@ -6353,7 +6485,7 @@ This method can only be used once!

    -

    Name.

    +

    Name.

    @@ -6495,7 +6627,7 @@ This method can only be used once!

    -

    true, FSM is in this state.

    +

    true, FSM is in this state.

    @@ -6517,6 +6649,50 @@ This method can only be used once!

    Field(s)

    + + + +
    +
    + + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
    + +
    @@ -6531,7 +6707,7 @@ This method can only be used once!

    - + #table TASK_CARGO_DISPATCHER.DefaultDeployZones diff --git a/Documentation/Tasking.Task_Manager.html b/Documentation/Tasking.Task_Manager.html index e63f734fe..09863e79b 100644 --- a/Documentation/Tasking.Task_Manager.html +++ b/Documentation/Tasking.Task_Manager.html @@ -3750,7 +3750,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    -

    Current FSM state.

    +

    Current FSM state.

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

    Table of call backs.

    +

    Table of call backs.

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

    Event name.

    +

    Event name.

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

    Function.

    +

    Function.

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

    Event name.

    +

    Event name.

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

    Name.

    +

    Name.

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

    true, FSM is in this state.

    +

    true, FSM is in this state.

    diff --git a/Documentation/Tasking.Task_Zone_Capture_Dispatcher.html b/Documentation/Tasking.Task_Zone_Capture_Dispatcher.html index 269a353d0..fa346dd8d 100644 --- a/Documentation/Tasking.Task_Zone_Capture_Dispatcher.html +++ b/Documentation/Tasking.Task_Zone_Capture_Dispatcher.html @@ -4458,7 +4458,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
    -

    Current FSM state.

    +

    Current FSM state.

    @@ -4787,7 +4787,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
    -

    Table of call backs.

    +

    Table of call backs.

    @@ -5061,7 +5061,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
    -

    Event name.

    +

    Event name.

    @@ -5072,7 +5072,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
    -

    Function.

    +

    Function.

    @@ -5105,7 +5105,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
    -

    Event name.

    +

    Event name.

    @@ -5375,7 +5375,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
    -

    Name.

    +

    Name.

    @@ -5517,7 +5517,7 @@ The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPref
    -

    true, FSM is in this state.

    +

    true, FSM is in this state.

    diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index 116171993..ae8eddaa5 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -4751,7 +4751,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    -GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
    + + +
    +
    + + +GROUP.InitRespawnRandomizePositionOuter @@ -8858,7 +8869,18 @@ So each unit of the group is respawned at exactly the same parking spot as it cu
    -GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
    + +
    +
    +
    + + +GROUP.InitRespawnRandomizePositionOuter @@ -17399,7 +17421,18 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of
    -GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
    + +
    +
    +
    + + +GROUP.InitRespawnRandomizePositionOuter @@ -21038,7 +21071,18 @@ Coordinates are dependent on the position of the maps origin.

    -GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
    + +
    +
    +
    + + +GROUP.InitRespawnRandomizePositionOuter @@ -21692,7 +21736,18 @@ If the Identifiable is alive, true is returned.

    -GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
    + +
    +
    +
    + + +GROUP.InitRespawnRandomizePositionOuter @@ -21952,7 +22007,18 @@ If the Identifiable is alive, true is returned.

    -GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
    + +
    +
    +
    + + +GROUP.InitRespawnRandomizePositionOuter diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index 305c589a9..7b59c4c2f 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -2986,6 +2986,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
    + +
    +
    +
    + + #boolean +MARKER.tocoaliton + + + +
    + +
    +
    +
    + + #boolean +MARKER.togroup + + +
    @@ -5070,6 +5092,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
    + +
    +
    +
    + + #boolean +MARKER.tocoaliton + + + +
    + +
    +
    +
    + + #boolean +MARKER.togroup + + +
    @@ -5452,7 +5496,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    -

    Current FSM state.

    +

    Current FSM state.

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

    Table of call backs.

    +

    Table of call backs.

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

    Event name.

    +

    Event name.

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

    Function.

    +

    Function.

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

    Event name.

    +

    Event name.

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

    Name.

    +

    Name.

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

    true, FSM is in this state.

    +

    true, FSM is in this state.

    @@ -6662,6 +6706,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
    +
    + + #boolean +MARKER.tocoaliton + + + +
    + +
    +
    +
    + + #boolean +MARKER.togroup + + +