From 4bd6b8333742a76617caa41c36f323b539bd02b0 Mon Sep 17 00:00:00 2001
From: FlightControl-User
Date: Tue, 6 Nov 2018 19:20:44 +0000
Subject: [PATCH] MOOSE generated documentation [skip ci]
---
Documentation/AI.AI_A2A_Dispatcher.html | 324 +++++++++++++++++-
Documentation/AI.AI_Cargo.html | 8 +-
Documentation/AI.AI_Cargo_Airplane.html | 24 +-
Documentation/AI.AI_Patrol.html | 12 -
Documentation/Cargo.CargoCrate.html | 22 ++
Documentation/Cargo.CargoGroup.html | 56 ---
Documentation/Core.Point.html | 6 +
Documentation/Core.Settings.html | 26 +-
Documentation/Core.Spawn.html | 124 +++----
Documentation/Functional.Designate.html | 65 +---
Documentation/Functional.Detection.html | 33 ++
Documentation/Functional.Movement.html | 28 --
Documentation/Functional.Rat.html | 6 +
Documentation/Functional.ZoneGoal.html | 42 +++
Documentation/Tasking.Task_Cargo.html | 17 +-
.../Tasking.Task_Cargo_Dispatcher.html | 228 +-----------
Documentation/Wrapper.Group.html | 78 ++++-
Documentation/Wrapper.Positionable.html | 44 +++
18 files changed, 631 insertions(+), 512 deletions(-)
diff --git a/Documentation/AI.AI_A2A_Dispatcher.html b/Documentation/AI.AI_A2A_Dispatcher.html
index 84372af6a..76760752f 100644
--- a/Documentation/AI.AI_A2A_Dispatcher.html
+++ b/Documentation/AI.AI_A2A_Dispatcher.html
@@ -2351,6 +2351,12 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea
AI_A2A_DISPATCHER:CountDefendersToBeEngaged(AttackerDetection, DefenderCount) |
+ |
+
+
+ AI_A2A_DISPATCHER.DefenderCAPIndex |
+
+
|
@@ -2519,6 +2525,12 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea
AI_A2A_DISPATCHER:GetSquadronTakeoff(SquadronName) |
Gets the method at which new flights will spawn and take-off as part of the defense system.
+ |
+
+
+ AI_A2A_DISPATCHER:IsSquadronVisible(SquadronName) |
+
+ Check if the Squadron is visible before startup of the dispatcher.
|
@@ -2597,6 +2609,12 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea
AI_A2A_DISPATCHER:OnEventLand(EventData) |
+ |
+
+
+ AI_A2A_DISPATCHER:ParkDefender(DefenderSquadron) |
+
+
|
@@ -2609,6 +2627,12 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea
AI_A2A_DISPATCHER:RemoveDefenderFromSquadron(Squadron, Defender) |
+ |
+
+
+ AI_A2A_DISPATCHER:ResourceActivate(DefenderSquadron, DefendersNeeded) |
+
+
|
@@ -2762,7 +2786,7 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea
- AI_A2A_DISPATCHER:SetSquadron(SquadronName, AirbaseName, TemplatePrefixes, Resources) |
+ AI_A2A_DISPATCHER:SetSquadron(SquadronName, AirbaseName, TemplatePrefixes, ResourceCount) |
This is the main method to define Squadrons programmatically.
|
@@ -2867,6 +2891,12 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea
AI_A2A_DISPATCHER:SetSquadronTanker(SquadronName, TankerName) |
Set the squadron tanker where defenders will Refuel in the air.
+ |
+
+
+ AI_A2A_DISPATCHER:SetSquadronVisible(SquadronName) |
+
+ Set the Squadron visible before startup of the dispatcher.
|
@@ -2927,6 +2957,12 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea
AI_A2A_DISPATCHER:onafterGCI(From, Event, To, AttackerDetection, DefendersMissing, DefenderFriendlies) |
+ |
+
+
+ AI_A2A_DISPATCHER:onafterStart(From, Event, To) |
+
+
|
@@ -3795,13 +3831,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- AI_A2A_GCICAP:New(EWRPrefixes, TemplatePrefixes, CapPrefixes, CapLimit, GroupingRadius, EngageRadius, GciRadius, Resources) |
+ AI_A2A_GCICAP:New(EWRPrefixes, TemplatePrefixes, CapPrefixes, CapLimit, GroupingRadius, EngageRadius, GciRadius, ResourceCount) |
AI_A2A_GCICAP constructor.
|
- AI_A2A_GCICAP:NewWithBorder(EWRPrefixes, TemplatePrefixes, BorderPrefix, CapPrefixes, CapLimit, GroupingRadius, EngageRadius, GciRadius, Resources) |
+ AI_A2A_GCICAP:NewWithBorder(EWRPrefixes, TemplatePrefixes, BorderPrefix, CapPrefixes, CapLimit, GroupingRadius, EngageRadius, GciRadius, ResourceCount) |
AI_A2A_GCICAP constructor with border.
|
@@ -3830,6 +3866,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
+
@@ -5013,6 +5060,56 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
+
+
+
+
Check if the Squadron is visible before startup of the dispatcher.
+
+
+
+
Defined in:
+
+
Parameter:
+
+
+
+ #string
+ SquadronName
+
+
+
+
+
The squadron name.
+
+
+
+
Return value:
+
+
Usage:
+
+ -- Set the Squadron visible before startup of dispatcher.
+ local IsVisible = A2ADispatcher:IsSquadronVisible( "Mineralnye" )
+
+
+
+
@@ -5645,6 +5742,36 @@ The Detection object is polymorphic, depending on the type of detection object c
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
Parameter:
+
+
+
@@ -5729,6 +5856,46 @@ The Detection object is polymorphic, depending on the type of detection object c
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
Parameters:
+
+
+
+
@@ -7053,7 +7220,7 @@ when you don't want to let the AI_A2A_DISPATCHER react immediately when a certai
This is the main method to define Squadrons programmatically.
@@ -7151,7 +7318,7 @@ If you have only one prefix name for a squadron, you don't need to use the
#number
- Resources
+ ResourceCount
@@ -7190,7 +7357,7 @@ If you have only one prefix name for a squadron, you don't need to use the
-- This is an example like the previous, but now with infinite resources.
- -- The Resources parameter is not given in the SetSquadron method.
+ -- The ResourceCount parameter is not given in the SetSquadron method.
A2ADispatcher:SetSquadron( "104th", "Batumi", "Mig-29" )
A2ADispatcher:SetSquadron( "23th", "Batumi", "Su-27" )
@@ -8449,6 +8616,60 @@ multiplied by the Overhead and rounded up to the smallest integer.
+
+
+
+
+
+
+
+
Set the Squadron visible before startup of the dispatcher.
+
+
+
All planes will be spawned as uncontrolled on the parking spot.
+They will lock the parking spot.
+
+
+
+
Defined in:
+
+
Parameter:
+
+
+
+ #string
+ SquadronName
+
+
+
+
+
The squadron name.
+
+
+
+
Return value:
+
+
Usage:
+
+ -- Set the Squadron visible before startup of dispatcher.
+ A2ADispatcher:SetSquadronVisible( "Mineralnye" )
+
+
+
+
@@ -8811,12 +9032,73 @@ multiplied by the Overhead and rounded up to the smallest integer.
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
Parameters:
+
+
+
+
+
Field(s)
+
@@ -9823,6 +10105,17 @@ multiplied by the Overhead and rounded up to the smallest integer.
Field(s)
+
@@ -11115,6 +11408,17 @@ multiplied by the Overhead and rounded up to the smallest integer.
Field(s)
+
@@ -13879,7 +14183,7 @@ BASE:TraceOnOff( false )
AI_A2A_GCICAP constructor.
@@ -13987,7 +14291,7 @@ For airplanes, 6000 (6km) is recommended, and is also the default value of this
#number
- Resources
+ ResourceCount
@@ -14086,7 +14390,7 @@ For airplanes, 6000 (6km) is recommended, and is also the default value of this
AI_A2A_GCICAP constructor with border.
@@ -14207,7 +14511,7 @@ For airplanes, 6000 (6km) is recommended, and is also the default value of this
#number
- Resources
+ ResourceCount
diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html
index 483bca1a5..1e105b17a 100644
--- a/Documentation/AI.AI_Cargo.html
+++ b/Documentation/AI.AI_Cargo.html
@@ -2127,7 +2127,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
Wrapper.Group#GROUP
+
AI_CARGO.CargoCarrier
@@ -4065,7 +4065,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
Wrapper.Group#GROUP
+
AI_CARGO.CargoCarrier
@@ -4677,7 +4677,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
Wrapper.Group#GROUP
+
AI_CARGO.CargoCarrier
@@ -5927,7 +5927,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
Wrapper.Group#GROUP
+
AI_CARGO.CargoCarrier
diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html
index abec83831..06ee0479d 100644
--- a/Documentation/AI.AI_Cargo_Airplane.html
+++ b/Documentation/AI.AI_Cargo_Airplane.html
@@ -2169,6 +2169,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
Aircraft is on a depoly mission.
+
@@ -2194,9 +2197,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
Aircraft is on a pickup mission.
-
@@ -3720,6 +3720,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
Aircraft is on a depoly mission.
+
@@ -3745,9 +3748,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
Aircraft is on a pickup mission.
-
@@ -4363,6 +4363,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
Aircraft is on a depoly mission.
+
@@ -4388,9 +4391,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
Aircraft is on a pickup mission.
-
@@ -5644,6 +5644,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
Aircraft is on a depoly mission.
+
@@ -5669,9 +5672,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
Aircraft is on a pickup mission.
-
diff --git a/Documentation/AI.AI_Patrol.html b/Documentation/AI.AI_Patrol.html
index c476f71b6..ad6e190c2 100644
--- a/Documentation/AI.AI_Patrol.html
+++ b/Documentation/AI.AI_Patrol.html
@@ -2636,9 +2636,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
This table contains the targets detected during patrol.
-
@@ -5886,9 +5883,6 @@ Note that this method is required, as triggers the next route when patrolling fo
-
- This table contains the targets detected during patrol.
-
@@ -6633,9 +6627,6 @@ Note that this method is required, as triggers the next route when patrolling fo
-
- This table contains the targets detected during patrol.
-
@@ -8018,9 +8009,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/Cargo.CargoCrate.html b/Documentation/Cargo.CargoCrate.html
index 516c24590..a28641796 100644
--- a/Documentation/Cargo.CargoCrate.html
+++ b/Documentation/Cargo.CargoCrate.html
@@ -1356,6 +1356,17 @@ which are excellent tools to be reused in an OO environment!.
Field(s)
+
@@ -2024,6 +2035,17 @@ which are excellent tools to be reused in an OO environment!.
Field(s)
+
diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html
index d3ca4eade..a01bfefb8 100644
--- a/Documentation/Cargo.CargoGroup.html
+++ b/Documentation/Cargo.CargoGroup.html
@@ -1427,20 +1427,6 @@ which are excellent tools to be reused in an OO environment!.
-
-
-
-
-
-
CARGO_GROUP.CargoGroup
@@ -1459,20 +1445,6 @@ which are excellent tools to be reused in an OO environment!.
-
-
-
-
@@ -2773,20 +2745,6 @@ This works for ground only groups.
-
-
-
-
diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html
index 51b4db22e..15b9dce66 100644
--- a/Documentation/Core.Point.html
+++ b/Documentation/Core.Point.html
@@ -4154,6 +4154,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
Coordinates.
+
@@ -9592,6 +9595,9 @@ By default, the last point is the closest point on road of the ToCoord. Hence, t
+
+ Coordinates.
+
diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html
index 3a7a11128..684bd7d9f 100644
--- a/Documentation/Core.Settings.html
+++ b/Documentation/Core.Settings.html
@@ -2131,7 +2131,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #string
SETTINGS.A2GSystem
@@ -2169,17 +2169,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -4016,7 +4005,7 @@ It is advised to use this method at the start of the mission.
-
+ #string
SETTINGS.A2GSystem
@@ -4054,17 +4043,6 @@ It is advised to use this method at the start of the mission.
-
-
-
-
diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html
index cb6640e69..2c9da8967 100644
--- a/Documentation/Core.Spawn.html
+++ b/Documentation/Core.Spawn.html
@@ -2214,6 +2214,12 @@ and any spaces before and after the resulting name are removed.
SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle) |
+ |
+
+
+ SPAWN.uncontrolled |
+
+
|
@@ -2744,6 +2750,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+ Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.
+
@@ -2937,20 +2946,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -2962,9 +2957,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
- By default, no InitLimit
-
@@ -2976,6 +2968,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -2996,7 +2999,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number
+
SPAWN.SpawnMaxGroups
@@ -3010,7 +3013,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number
+
SPAWN.SpawnMaxUnitsAlive
@@ -3156,17 +3159,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -3179,7 +3171,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.
+
When the first Spawn executes, all the Groups need to be made visible before start.
@@ -3217,6 +3209,17 @@ 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.
+
+
+
+
@@ -7348,6 +7351,9 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.
+
@@ -7541,20 +7547,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
-
-
-
@@ -7566,9 +7558,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups. By default, no InitLimit
-
@@ -7580,6 +7569,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
+
+
+
@@ -7600,7 +7600,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
- #number
+
SPAWN.SpawnMaxGroups
@@ -7614,7 +7614,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
- #number
+
SPAWN.SpawnMaxUnitsAlive
@@ -7760,17 +7760,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.
-
-
-
@@ -7783,7 +7772,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups. Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.
+
When the first Spawn executes, all the Groups need to be made visible before start.
@@ -7821,6 +7810,17 @@ 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.
+
+
+
+
diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html
index 15a7ced40..9f0efeb8f 100644
--- a/Documentation/Functional.Designate.html
+++ b/Documentation/Functional.Designate.html
@@ -2922,7 +2922,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
+ #number
DESIGNATE.LaseDuration
@@ -2938,17 +2938,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
-
@@ -6057,7 +6046,7 @@ Designate:SetFlashStatusMenu( false )
-
@@ -6878,7 +6856,7 @@ Designate:SetFlashStatusMenu( false )
-
@@ -7669,7 +7636,7 @@ Designate:SetFlashStatusMenu( false )
-
@@ -9098,7 +9054,7 @@ Designate:SetFlashStatusMenu( false )
-
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html
index 786ace3e0..667211c28 100644
--- a/Documentation/Functional.Detection.html
+++ b/Documentation/Functional.Detection.html
@@ -16311,6 +16311,17 @@ BASE:TraceOnOff( false )
+
+
+
+
@@ -20632,6 +20643,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual
+
+
+
+
@@ -22124,6 +22146,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual
+
+
+
+
diff --git a/Documentation/Functional.Movement.html b/Documentation/Functional.Movement.html
index 7aef91696..98ff88773 100644
--- a/Documentation/Functional.Movement.html
+++ b/Documentation/Functional.Movement.html
@@ -1653,20 +1653,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
-
-
-
- #number
-
MOVEMENT.AliveUnits
-
-
-
-
-
Contains the counter how many units are currently alive
-
-
-
-
@@ -1897,20 +1883,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
Field(s)
-
-
-
- #number
-
MOVEMENT.AliveUnits
-
-
-
-
-
Contains the counter how many units are currently alive
-
-
-
-
diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html
index df099abd9..8daef817c 100644
--- a/Documentation/Functional.Rat.html
+++ b/Documentation/Functional.Rat.html
@@ -3777,6 +3777,12 @@ and any spaces before and after the resulting name are removed.
RAT:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle) |
+ |
+
+
+ RAT.uncontrolled |
+
+
|
diff --git a/Documentation/Functional.ZoneGoal.html b/Documentation/Functional.ZoneGoal.html
index 5d593eaa5..725deec17 100644
--- a/Documentation/Functional.ZoneGoal.html
+++ b/Documentation/Functional.ZoneGoal.html
@@ -1956,6 +1956,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -2085,6 +2099,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
@@ -3324,6 +3352,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+
diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html
index 14c06cd7c..54a43fd80 100644
--- a/Documentation/Tasking.Task_Cargo.html
+++ b/Documentation/Tasking.Task_Cargo.html
@@ -2683,17 +2683,6 @@ based on the tasking capabilities defined in
-
-
-
@@ -2726,7 +2715,7 @@ based on the tasking capabilities defined in