diff --git a/Moose Development/Moose/Core/Scheduler.lua b/Moose Development/Moose/Core/Scheduler.lua
index 525124c47..2244d9b1b 100644
--- a/Moose Development/Moose/Core/Scheduler.lua
+++ b/Moose Development/Moose/Core/Scheduler.lua
@@ -1,5 +1,9 @@
---- This module contains the SCHEDULER class.
+--- **Core** - SCHEDULER prepares and handles the **execution of functions over scheduled time (intervals)**.
--
+-- 
+--
+-- ===
+--
-- # 1) @{Scheduler#SCHEDULER} class, extends @{Base#BASE}
--
-- The @{Scheduler#SCHEDULER} class creates schedule.
diff --git a/Moose Development/Moose/Core/Zone.lua b/Moose Development/Moose/Core/Zone.lua
index fe1848037..dedde1fb4 100644
--- a/Moose Development/Moose/Core/Zone.lua
+++ b/Moose Development/Moose/Core/Zone.lua
@@ -1,5 +1,7 @@
--- **Core** - ZONE classes define **zones** within your mission of **various forms**, with **various capabilities**.
--
+-- 
+--
-- ===
--
-- There are essentially two core functions that zones accomodate:
diff --git a/Moose Presentations/SCHEDULER.pptx b/Moose Presentations/SCHEDULER.pptx
new file mode 100644
index 000000000..6dab2d58c
Binary files /dev/null and b/Moose Presentations/SCHEDULER.pptx differ
diff --git a/Moose Presentations/ZONE.pptx b/Moose Presentations/ZONE.pptx
new file mode 100644
index 000000000..7bf099ec4
Binary files /dev/null and b/Moose Presentations/ZONE.pptx differ
diff --git a/docs/Documentation/AI_Balancer.html b/docs/Documentation/AI_Balancer.html
index b5afcb1a4..c5b24c824 100644
--- a/docs/Documentation/AI_Balancer.html
+++ b/docs/Documentation/AI_Balancer.html
@@ -61,8 +61,8 @@
Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone COMMANDCENTER:HasGroup(Wrapper, MissionGroup)
Checks of the COMMANDCENTER has a GROUP.
+
+
+
+ COMMANDCENTER:MessageToAll(Message)
+Send a CC message to the coalition of the CC.
@@ -471,6 +477,27 @@ Group#GROUP
+
+COMMANDCENTER:MessageToAll(Message)
+
+
+
+
+Send a CC message to the coalition of the CC.
+
+ Parameter
+
+
+
+
+
+
COMMANDCENTER:MessageToCoalition(Message)
diff --git a/docs/Documentation/Controllable.html b/docs/Documentation/Controllable.html
index 86b4d42d2..9ae29ec73 100644
--- a/docs/Documentation/Controllable.html
+++ b/docs/Documentation/Controllable.html
@@ -61,8 +61,8 @@
Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone
- CONTROLLABLE:TaskAttackUnit(AttackUnit, GroupAttack, WeaponExpend, AttackQty, Direction, Altitude, Visible, ControllableAttack) CONTROLLABLE:TaskAttackUnit(AttackUnit, GroupAttack, WeaponExpend, AttackQty, Direction, AttackQtyLimit, ControllableAttack, Altitude, Visible)
(AIR) Attack the Unit.
@@ -2110,7 +2110,7 @@ The DCS task structure.
-CONTROLLABLE:TaskAttackUnit(AttackUnit, GroupAttack, WeaponExpend, AttackQty, Direction, Altitude, Visible, ControllableAttack)
+CONTROLLABLE:TaskAttackUnit(AttackUnit, GroupAttack, WeaponExpend, AttackQty, Direction, AttackQtyLimit, ControllableAttack, Altitude, Visible)
@@ -2151,19 +2151,8 @@ The UNIT.
-<<<<<<< HEAD
-Dcs.DCSTypes#Distance Altitude
-
-
-
-
-#boolean Visible
-=======
#boolean AttackQtyLimit
->>>>>>> refs/remotes/origin/master
@@ -2171,6 +2160,16 @@ The UNIT.
#boolean ControllableAttack
+
+
+
+ Altitude
+
+
+
+
+ Visible
+
Return value
diff --git a/docs/Documentation/Database.html b/docs/Documentation/Database.html
index 93a9354c4..4edfad744 100644
--- a/docs/Documentation/Database.html
+++ b/docs/Documentation/Database.html
@@ -61,8 +61,8 @@
Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone DATABASE.CLIENTS
+
+
+
+ DATABASE.COUNTRY_ID
+
+
+
+
+ DATABASE.COUNTRY_NAME
+
@@ -628,6 +640,34 @@ The following iterator methods are currently available within the DATABASE:
+
+
+
+
+
+
+DATABASE.COUNTRY_ID
+
+
+
+
+
+
+
+
+
+
+
+
+DATABASE.COUNTRY_NAME
+
+
+
+
+
+
diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html
index bbf38dbd0..f55f9ae2c 100644
--- a/docs/Documentation/Detection.html
+++ b/docs/Documentation/Detection.html
@@ -61,8 +61,8 @@
Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone
-
# 1) #DETECTION_BASE class, extends Fsm#FSM
The #DETECTION_BASE class defines the core functions to administer detected objects.
@@ -163,7 +162,7 @@
Use the method Detection#DETECTION_BASE.SetDistanceProbability () to set the probability factor upon a 10 km distance.
- ### 1.4.2 ) Height visual detection probability
+ ### 1.4.2 ) Alpha Angle visual detection probability
Upon a visual detection, the higher the unit is during the detecting process, the more likely the detected unit is to be detected properly.
A detection at a 90% alpha angle is the most optimal, a detection at 10% is less and a detection at 0% is less likely to be correct.
@@ -173,7 +172,7 @@
For example, if a alpha angle probability factor of 0.7 is given, the extrapolated probabilities of the different angles would look like:
0°: 70%, 10°: 75,21%, 20°: 80,26%, 30°: 85%, 40°: 89,28%, 50°: 92,98%, 60°: 95,98%, 70°: 98,19%, 80°: 99,54%, 90°: 100%
- Use the method Detection#DETECTION_BASE.SetHeightProbability () to set the probability factor if 0°.
+ Use the method Detection#DETECTION_BASE.SetAlphaAngleProbability () to set the probability factor if 0°.
### 1.4.3 ) Cloudy Zones detection probability
@@ -280,10 +279,17 @@
# 2) Detection#DETECTION_UNITS class, extends Detection#DETECTION_BASE
- The Detection#DETECTION_UNITS class will detect units within the battle zone within a specified range.
+
The Detection#DETECTION_UNITS class will detect units within the battle zone.
It will build a DetectedItems list filled with DetectedItems. Each DetectedItem will contain a field Set, which contains a Set#SET_UNIT containing ONE UNIT object reference.
Beware that when the amount of units detected is large, the DetectedItems list will be large also.
+ # 3) Detection#DETECTION_TYPES class, extends Detection#DETECTION_BASE
+
+ The Detection#DETECTION_TYPES class will detect units within the battle zone.
+ It will build a DetectedItems[] list filled with DetectedItems, grouped by the type of units detected.
+ Each DetectedItem will contain a field Set, which contains a Set#SET_UNIT containing ONE UNIT object reference.
+ Beware that when the amount of different types detected is large, the DetectedItems[] list will be large also.
+
# 4) Detection#DETECTION_AREAS class, extends Detection#DETECTION_BASE
The Detection#DETECTION_AREAS class will detect units within the battle zone for a list of Group s detecting targets following (a) detection method(s),
@@ -306,9 +312,17 @@
Use the methods Detection#DETECTION_AREAS.FlareDetectedUnits () or Detection#DETECTION_AREAS.SmokeDetectedUnits () to flare or smoke the detected units when a new detection has taken place.
- ## 4.5) Flare or Smoke detected zones
+ ## 4.5) Flare or Smoke or Bound detected zones
- Use the methods Detection#DETECTION_AREAS.FlareDetectedZones () or Detection#DETECTION_AREAS.SmokeDetectedZones () to flare or smoke the detected zones when a new detection has taken place.
+ Use the methods:
+
+
+
+ the detected zones when a new detection has taken place.
DETECTION_BASE
+
+
+
+ DETECTION_TYPES
+
@@ -367,9 +387,15 @@
- DETECTION_AREAS.AddDetectedItem(Set, Zone, self) DETECTION_AREAS:AddDetectedItem(Set, Zone)
Add a detected DETECTION_AREAS.DetectedItem .
+
+
+
+ DETECTION_AREAS:BoundDetectedZones()
+Bound the detected zones
@@ -424,12 +450,6 @@
DETECTION_AREAS:GetChangeText(DetectedArea)
Make text documenting the changes of the detected zone.
-
-
-
- DETECTION_AREAS:GetDetectedZone(Index)
-Get the Zone#ZONE_UNIT of a detection area using a given numeric index.
@@ -454,12 +474,6 @@
DETECTION_AREAS:New(DetectionSetGroup, DetectionZoneRange)
DETECTION_AREAS constructor.
-
-
-
- DETECTION_AREAS:RemoveDetectedItem(Index, DetectedItemIndex)
-Remove a detected DETECTION_AREAS.DetectedItem with a given Index.
@@ -478,6 +492,12 @@
DETECTION_AREAS:SmokeDetectedZones()
Smoke the detected zones
+
+
+
+ DETECTION_AREAS._BoundDetectedZones
+
@@ -601,15 +621,27 @@
- DETECTION_BASE:AddDetectedItem() DETECTION_BASE:AddDetectedItem(Set, Zone)
Adds a new DetectedItem to the DetectedItems list.
+
+
+
+ DETECTION_BASE.AlphaAngleProbability
+
DETECTION_BASE.ClassName
+
+
+
+ DETECTION_BASE.CountryID
+
@@ -664,6 +696,12 @@
DETECTION_BASE:Detected()
Synchronous Event Trigger for Event Detected.
+
+
+
+ DETECTION_BASE.DetectedItemCount
+
@@ -688,6 +726,18 @@
DETECTION_BASE.DetectedObjectsIdentified
Map of the DetectedObjects identified.
+
+
+
+ DETECTION_BASE:DetectedReportDetailed()
+Report detailed of a detectedion result.
+
+
+
+ DETECTION_BASE.DetectionCount
+
@@ -757,15 +807,15 @@
- DETECTION_BASE:GetDetectionSetGroup() DETECTION_BASE:GetDetectedZone(Index)
-Get the detection Groups.
+Get the Zone#ZONE_UNIT of a detection area using a given numeric index.
- DETECTION_BASE.HeightProbability DETECTION_BASE:GetDetectionSetGroup()
-
+Get the detection Groups.
@@ -937,15 +987,21 @@
- DETECTION_BASE:SetDistanceProbability(DistanceProbability) DETECTION_BASE:SetAlphaAngleProbability(AlphaAngleProbability)
-Upon a visual detection, the further away a detected object is, the less likely it is to be detected properly.
+Upon a visual detection, the higher the unit is during the detecting process, the more likely the detected unit is to be detected properly.
- DETECTION_BASE:SetHeightProbability(HeightProbability) DETECTION_BASE:SetDetectionInterval(DetectionInterval)
-Upon a visual detection, the higher the unit is during the detecting process, the more likely the detected unit is to be detected properly.
+Set the detection interval time in seconds.
+
+
+
+ DETECTION_BASE:SetDistanceProbability(DistanceProbability)
+Upon a visual detection, the further away a detected object is, the less likely it is to be detected properly.
@@ -955,7 +1011,7 @@
- DETECTION_BASE:SetZoneProbability(CloudyZone, ZoneProbability) DETECTION_BASE:SetZoneProbability(ZoneArray)
Upon a visual detection, the more a detected unit is within a cloudy zone, the less likely the detected unit is to be detected successfully.
@@ -1012,6 +1068,24 @@
DETECTION_BASE:__Stop(Delay)
Asynchronous Event Trigger for Event Stop.
+
+
+
+ DETECTION_BASE:onafterDetect(From, Event, To)
+
+
+
+
+ DETECTION_BASE:onafterDetectionGroup(From, Event, To, DetectionGroup)
+
+
+
+
+ DETECTION_BASE:onafterStart(From, Event, To)
+
@@ -1056,6 +1130,112 @@
DETECTION_BASE.DetectedObject.Visible
+
+
+
+
+
+
@@ -1084,6 +1264,12 @@
DETECTION_UNITS.DetectedItems
+
+
+
+ DETECTION_UNITS:DetectedReportDetailed()
+Report detailed of a detection result.
@@ -1096,6 +1282,12 @@
DETECTION_UNITS:New(DetectionSetGroup)
DETECTION_UNITS constructor.
+
+
+
+ DETECTION_UNITS._BoundDetectedZones
+
@@ -1151,6 +1343,20 @@
+
+
+
+
+
+ #DETECTION_TYPES
+DETECTION_TYPES
+
+
+
+
+
+
@@ -1276,7 +1482,7 @@ self
-DETECTION_AREAS.AddDetectedItem(Set, Zone, self)
+DETECTION_AREAS:AddDetectedItem(Set, Zone)
@@ -1296,11 +1502,6 @@ self
Core.Zone#ZONE_UNIT Zone
-
-
-
- self
-
Return value
@@ -1313,6 +1514,24 @@ DetectedItem
+
+DETECTION_AREAS:BoundDetectedZones()
+
+
+
+
+Bound the detected zones
+
+ Return value
+
+#DETECTION_AREAS :
+
+
+
+
+
+
DETECTION_AREAS:CalculateThreatLevelA2G(DetectedArea)
@@ -1381,7 +1600,7 @@ self
-#number Index
+ Index
@@ -1485,32 +1704,6 @@ The Changes text
-
-DETECTION_AREAS:GetDetectedZone(Index)
-
-
-
-
-Get the Zone#ZONE_UNIT of a detection area using a given numeric index.
-
- Parameter
-
-
-
-#number Index
-
-
-
- Return value
-
-Core.Zone#ZONE_UNIT :
-
-
-
-
-
-
DETECTION_AREAS:GetTreatLevelA2G(DetectedArea)
@@ -1614,39 +1807,7 @@ The range till which targets are grouped upon the first detected target.
Return value
-Functional.Detection#DETECTION_AREAS :
-
-
-
-
-
-
-
-DETECTION_AREAS:RemoveDetectedItem(Index, DetectedItemIndex)
-
-
-
-
-Remove a detected DETECTION_AREAS.DetectedItem with a given Index.
-
- Parameters
-
- Return value
-
-#nil:
+#DETECTION_AREAS :
@@ -1711,6 +1872,20 @@ self
#DETECTION_AREAS :
+
+
+
+
+
+ #boolean
+
+DETECTION_AREAS._BoundDetectedZones
+
+
+
+
+
+
@@ -1986,7 +2161,7 @@ self
-DETECTION_BASE:AddDetectedItem()
+DETECTION_BASE:AddDetectedItem(Set, Zone)
@@ -1996,11 +2171,40 @@ self
The DetectedItem is a table and contains a SET_UNIT in the field Set.
+ Parameters
+
Return value
#DETECTION_BASE.DetectedItem :
+
+
+
+
+
+
+DETECTION_BASE.AlphaAngleProbability
+
+
+
+
+
+
@@ -2015,6 +2219,20 @@ self
+
+
+
+
+
+
+DETECTION_BASE.CountryID
+
+
+
+
+
+
@@ -2146,6 +2364,20 @@ self
Synchronous Event Trigger for Event Detected.
+
+
+
+
+
+ #number
+
+DETECTION_BASE.DetectedItemCount
+
+
+
+
+
+
@@ -2163,7 +2395,7 @@ self
-#number Index
+ Index
@@ -2214,6 +2446,38 @@ self
Map of the DetectedObjects identified.
+
+
+
+
+
+
+DETECTION_BASE:DetectedReportDetailed()
+
+
+
+
+Report detailed of a detectedion result.
+
+ Return value
+
+#string:
+
+
+
+
+
+
+
+ #number
+
+DETECTION_BASE.DetectionCount
+
+
+
+
+
+
@@ -2417,6 +2681,32 @@ DetectedSet
+
+DETECTION_BASE:GetDetectedZone(Index)
+
+
+
+
+Get the Zone#ZONE_UNIT of a detection area using a given numeric index.
+
+ Parameter
+
+
+
+#number Index
+
+
+
+ Return value
+
+Core.Zone#ZONE_UNIT :
+
+
+
+
+
+
DETECTION_BASE:GetDetectionSetGroup()
@@ -2430,20 +2720,6 @@ DetectedSet
Wrapper.Group#GROUP :
-
-
-
-
-
-
-DETECTION_BASE.HeightProbability
-
-
-
-
-
-
@@ -3271,6 +3547,68 @@ self
+
+DETECTION_BASE:SetAlphaAngleProbability(AlphaAngleProbability)
+
+
+
+
+Upon a visual detection, the higher the unit is during the detecting process, the more likely the detected unit is to be detected properly.
+
+
+A detection at a 90% alpha angle is the most optimal, a detection at 10% is less and a detection at 0% is less likely to be correct.
+
+A probability factor between 0 and 1 can be given, that will model a progressive extrapolated probability if the target would be detected at a 0° angle.
+
+For example, if a alpha angle probability factor of 0.7 is given, the extrapolated probabilities of the different angles would look like:
+0°: 70%, 10°: 75,21%, 20°: 80,26%, 30°: 85%, 40°: 89,28%, 50°: 92,98%, 60°: 95,98%, 70°: 98,19%, 80°: 99,54%, 90°: 100%
+
+ Parameter
+
+ Return value
+
+#DETECTION_BASE :
+
+
+
+
+
+
+
+DETECTION_BASE:SetDetectionInterval(DetectionInterval)
+
+
+
+
+Set the detection interval time in seconds.
+
+ Parameter
+
+ Return value
+
+#DETECTION_BASE :
+
+
+
+
+
+
DETECTION_BASE:SetDistanceProbability(DistanceProbability)
@@ -3304,41 +3642,6 @@ self
-
-DETECTION_BASE:SetHeightProbability(HeightProbability)
-
-
-
-
-Upon a visual detection, the higher the unit is during the detecting process, the more likely the detected unit is to be detected properly.
-
-
-A detection at a 90% alpha angle is the most optimal, a detection at 10% is less and a detection at 0% is less likely to be correct.
-
-A probability factor between 0 and 1 can be given, that will model a progressive extrapolated probability if the target would be detected at a 0° angle.
-
-For example, if a alpha angle probability factor of 0.7 is given, the extrapolated probabilities of the different angles would look like:
-0°: 70%, 10°: 75,21%, 20°: 80,26%, 30°: 85%, 40°: 89,28%, 50°: 92,98%, 60°: 95,98%, 70°: 98,19%, 80°: 99,54%, 90°: 100%
-
- Parameter
-
- Return value
-
-#DETECTION_BASE :
-
-
-
-
-
-
DETECTION_BASE:SetRejectZones(RejectZones)
@@ -3367,7 +3670,7 @@ self
-DETECTION_BASE:SetZoneProbability(CloudyZone, ZoneProbability)
+DETECTION_BASE:SetZoneProbability(ZoneArray)
@@ -3378,18 +3681,12 @@ self
The Cloudy Zones work with the ZONE_BASE derived classes. The mission designer can define within the mission
zones that reflect cloudy areas where detected units may not be so easily visually detected.
- Parameters
+ Parameter
- CloudyZone
-
-
-
-
- ZoneProbability
+ ZoneArray
@@ -3561,6 +3858,114 @@ The delay in seconds.
+
+
+
+
+
+DETECTION_BASE:onafterDetect(From, Event, To)
+
+
+
+
+
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+
+
+
+
+
+
+DETECTION_BASE:onafterDetectionGroup(From, Event, To, DetectionGroup)
+
+
+
+
+
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+
+Wrapper.Group#GROUP DetectionGroup
+
+
+
+
+
+
+
+
+
+DETECTION_BASE:onafterStart(From, Event, To)
+
+
+
+
+
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+
@@ -3657,6 +4062,345 @@ The delay in seconds.
+
+
+DETECTION_TYPES class
+
+ Field(s)
+
+
+
+
+DETECTION_TYPES:AddDetectedItem(TypeName)
+
+
+
+
+Adds a new DetectedItem to the DetectedItems list.
+
+
+The DetectedItem is a table and contains a SET_UNIT in the field Set.
+
+ Parameter
+
+
+
+#string TypeName
+
+
+
+ Return value
+
+#DETECTION_TYPES.DetectedItem :
+
+
+
+
+
+
+
+ #string
+
+DETECTION_TYPES.ClassName
+
+
+
+
+
+
+
+
+
+
+
+
+DETECTION_TYPES:CreateDetectionSets()
+
+
+
+
+Create the DetectedItems list from the DetectedObjects table.
+
+
+For each DetectedItem, a one field array is created containing the Unit detected.
+
+ Return value
+
+#DETECTION_TYPES :
+
+
+
+
+
+
+
+DETECTION_TYPES:DetectedItemReportSummary(Index, DetectedTypeName)
+
+
+
+
+Report summary of a DetectedItem using a given numeric index.
+
+ Parameters
+
+
+
+ Index
+
+
+
+
+ DetectedTypeName
+
+
+
+ Return value
+
+#string:
+
+
+
+
+
+
+
+
+DETECTION_TYPES.DetectedItems
+
+
+
+
+
+
+
+
+
+
+
+
+DETECTION_TYPES:DetectedReportDetailed()
+
+
+
+
+Report detailed of a detection result.
+
+ Return value
+
+#string:
+
+
+
+
+
+
+
+
+DETECTION_TYPES.DetectionRange
+
+
+
+
+
+
+
+
+
+
+
+
+DETECTION_TYPES:GetDetectedItem(TypeName)
+
+
+
+
+Get a detected item using a given numeric index.
+
+ Parameter
+
+
+
+#string TypeName
+
+
+
+ Return value
+
+
+DETECTION_TYPES.DetectedItem
+
+
+
+
+
+
+
+DETECTION_TYPES:GetDetectedItemsCount()
+
+
+
+
+Get the amount of SETs with detected objects.
+
+ Return value
+
+#number:
+Count
+
+
+
+
+
+
+
+DETECTION_TYPES:GetDetectedSet(TypeName)
+
+
+
+
+Get the Set#SET_UNIT of a detecttion area using a given numeric index.
+
+ Parameter
+
+
+
+#string TypeName
+
+
+
+ Return value
+
+Core.Set#SET_UNIT :
+
+
+
+
+
+
+
+DETECTION_TYPES:New(DetectionSetGroup)
+
+
+
+
+DETECTION_TYPES constructor.
+
+ Parameter
+
+ Return value
+
+Functional.Detection#DETECTION_TYPES :
+
+
+
+
+
+
+
+DETECTION_TYPES:RemoveDetectedItem(TypeName)
+
+
+
+
+Removes an existing DetectedItem from the DetectedItems list.
+
+
+The DetectedItem is a table and contains a SET_UNIT in the field Set.
+
+ Parameter
+
+
+
+#string TypeName
+
+
+
+
+
+
+
+
+ #boolean
+
+DETECTION_TYPES._BoundDetectedZones
+
+
+
+
+
+
+
+
+
+
+
+ #boolean
+
+DETECTION_TYPES._FlareDetectedUnits
+
+
+
+
+
+
+
+
+
+
+
+ #boolean
+
+DETECTION_TYPES._FlareDetectedZones
+
+
+
+
+
+
+
+
+
+
+
+ #boolean
+
+DETECTION_TYPES._SmokeDetectedUnits
+
+
+
+
+
+
+
+
+
+
+
+ #boolean
+
+DETECTION_TYPES._SmokeDetectedZones
+
+
+
+
+
+
+
+
+
+
+
DETECTION_UNITS class
@@ -3712,7 +4456,7 @@ self
-#number Index
+ Index
@@ -3735,6 +4479,24 @@ self
+
+
+
+
+
+
+DETECTION_UNITS:DetectedReportDetailed()
+
+
+
+
+Report detailed of a detection result.
+
+ Return value
+
+#string:
+
+
@@ -3776,6 +4538,20 @@ The Set of GROUPs in the Forward Air Controller role.
Functional.Detection#DETECTION_UNITS :
+
+
+
+
+
+ #boolean
+
+DETECTION_UNITS._BoundDetectedZones
+
+
+
+
+
+
diff --git a/docs/Documentation/DetectionManager.html b/docs/Documentation/DetectionManager.html
index 4da79c117..4828a274a 100644
--- a/docs/Documentation/DetectionManager.html
+++ b/docs/Documentation/DetectionManager.html
@@ -61,8 +61,8 @@
Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone DetectionManager#DETECTION_REPORTING.New () method creates a new DETECTION_REPORTING instance.
-The #DETECTION_DISPATCHER class implements the dynamic dispatching of tasks upon groups of detected units determined a Set of FAC (groups).
-The FAC will detect units, will group them, and will dispatch Task s to groups. Depending on the type of target detected, different tasks will be dispatched.
-Find a summary below describing for which situation a task type is created:
-
-
- CAS Task : Is created when there are enemy ground units within range of the FAC, while there are friendly units in the FAC perimeter.BAI Task : Is created when there are enemy ground units within range of the FAC, while there are NO other friendly units within the FAC perimeter.SEAD Task : Is created when there are enemy ground units wihtin range of the FAC, with air search radars.
-
-Other task types will follow...
-
-3.1) DETECTION_DISPATCHER constructor:
-The DETECTION_DISPATCHER.New () method creates a new DETECTION_DISPATCHER instance.
Global(s)
-
-
-
@@ -352,20 +259,6 @@ Find a summary below describing for which situation a task type is created:
- #DETECTION_DISPATCHER
-DETECTION_DISPATCHER
-
-
-
-
-
-
-
-
-
-
-
#DETECTION_MANAGER
DETECTION_MANAGER
@@ -393,282 +286,6 @@ Find a summary below describing for which situation a task type is created:
-
-
-DETECTION_DISPATCHER class.
-
- Field(s)
-
-
-
- #string
-
-DETECTION_DISPATCHER.ClassName
-
-
-
-
-
-
-
-
-
-
-
- Wrapper.Group#GROUP
-DETECTION_DISPATCHER.CommandCenter
-
-
-
-
-
-
-
-
-
-
-
- Functional.Detection#DETECTION_BASE
-DETECTION_DISPATCHER.Detection
-
-
-
-
-The DETECTION_BASE object that is used to report the detected objects.
-
-
-
-
-
-
-
-DETECTION_DISPATCHER:EvaluateBAI(DetectedArea, FriendlyCoalition)
-
-
-
-
-Creates a BAI task when there are targets for it.
-
- Parameters
-
- Return value
-
-Tasking.Task#TASK :
-
-
-
-
-
-
-
-
-DETECTION_DISPATCHER:EvaluateCAS(DetectedArea)
-
-
-
-
-Creates a CAS task when there are targets for it.
-
- Parameter
-
- Return value
-
-Tasking.Task#TASK :
-
-
-
-
-
-
-
-
-DETECTION_DISPATCHER:EvaluateRemoveTask(Mission, Task, DetectedArea)
-
-
-
-
-Evaluates the removal of the Task from the Mission.
-
-
-Can only occur when the DetectedArea is Changed AND the state of the Task is "Planned".
-
- Parameters
-
- Return value
-
-Tasking.Task#TASK :
-
-
-
-
-
-
-
-
-DETECTION_DISPATCHER:EvaluateSEAD(DetectedArea)
-
-
-
-
-Creates a SEAD task when there are targets for it.
-
- Parameter
-
- Return values
-
-
-
-Set#SET_UNIT :
-
-
-
-
-#nil:
-If there are no targets to be set.
-
-
-
-
-
-
-
-
- Tasking.Mission#MISSION
-DETECTION_DISPATCHER.Mission
-
-
-
-
-
-
-
-
-
-
-
-
-DETECTION_DISPATCHER:New(SetGroup, Detection, Mission, CommandCenter)
-
-
-
-
-DETECTION_DISPATCHER constructor.
-
- Parameters
-
- Return value
-
-#DETECTION_DISPATCHER :
-
-
-
-
-
-
-
-DETECTION_DISPATCHER:ProcessDetected(Detection)
-
-
-
-
-Assigns tasks in relation to the detected items to the Set#SET_GROUP .
-
- Parameter
-
- Return value
-
-#boolean:
-Return true if you want the task assigning to continue... false will cancel the loop.
-
-
-
-
-
-
- Set#SET_GROUP
-DETECTION_DISPATCHER.SetGroup
-
-
-
-
-The groups to which the FAC will report to.
-
-
-
-
DETECTION_MANAGER class.
diff --git a/docs/Documentation/Escort.html b/docs/Documentation/Escort.html
index f07ad5198..b3a03693c 100644
--- a/docs/Documentation/Escort.html
+++ b/docs/Documentation/Escort.html
@@ -61,8 +61,8 @@
Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone 3) EVENTDATA type
-The EVENTDATA contains all the fields that are populated with event information before
+
The Event#EVENTDATA structure contains all the fields that are populated with event information before
an Event Handler method is being called by the event dispatcher.
The Event Handler received the EVENTDATA object as a parameter, and can be used to investigate further the different events.
There are basically 4 main categories of information stored in the EVENTDATA structure:
- Initiator Unit data: Several fields documenting the initiator unit related to the event.
- Target Unit data: Several fields documenting the target unit related to the event.
- Weapon data: Certain events populate weapon information.
- Place data: Certain events populate place information.
+ Initiator Unit data: Several fields documenting the initiator unit related to the event.
Target Unit data: Several fields documenting the target unit related to the event.
Weapon data: Certain events populate weapon information.
Place data: Certain events populate place information.
+
+ --- This function is an Event Handling function that will be called when Tank1 is Dead.
+ -- EventData is an EVENTDATA structure.
+ -- We use the EventData.IniUnit to smoke the tank Green.
+ -- @param Wrapper.Unit#UNIT self
+ -- @param Core.Event#EVENTDATA EventData
+ function Tank1:OnEventDead( EventData )
+
+ EventData.IniUnit:SmokeGreen()
+ end
+
Find below an overview which events populate which information categories:
@@ -345,33 +356,6 @@ YYYY-MM-DD: CLASS:NewFunction( Params ) added
EVENT:OnEngineShutDownForTemplate(EventTemplate, EventFunction, EventClass)
Create an OnDead event handler for a group
-
-
-
-<<<<<<< HEAD
- EVENT:OnEventForTemplate(EventTemplate, EventFunction, EventClass, OnEventFunction, EventID) EVENT:OnEngineShutDownForUnit(EventDCSUnitName, EventFunction, EventClass)
-Set a new listener for an SEVENT ENGINE_SHUTDOWN event.
-
-
-
- EVENT:OnEngineShutDownRemove(EventClass)
-Stop listening to SEVENT ENGINE_SHUTDOWN event.
-
-
-
- EVENT:OnEngineStartUpForUnit(EventDCSUnitName, EventFunction, EventClass)
-Set a new listener for an SEVENT ENGINE_STARTUP event.
-
-
-
- EVENT:OnEngineStartUpRemove(EventClass)
-Stop listening to SEVENT ENGINE_STARTUP event.
@@ -381,8 +365,7 @@ YYYY-MM-DD: CLASS:NewFunction( Params ) added
- EVENT:OnEventForTemplate(EventTemplate, EventFunction, EventClass, OnEventFunction) EVENT:OnEventForTemplate(EventTemplate, EventFunction, EventClass, OnEventFunction, EventID)
Create an OnDead event handler for a group
@@ -458,55 +441,49 @@ YYYY-MM-DD: CLASS:NewFunction( Params ) added
EVENTDATA.IniCategory
- (UNIT) The category of the initiator.
-(UNIT) The category of the initiator.
EVENTDATA.IniCoalition
- (UNIT) The coalition of the initiator.
-(UNIT) The coalition of the initiator.
EVENTDATA.IniDCSGroup
- (UNIT) The initiating {Dcs.DCSGroup#Group}.
-(UNIT) The initiating {DCSGroup#Group}.
EVENTDATA.IniDCSGroupName
- (UNIT) The initiating Group name.
+(UNIT) The initiating Group name.
EVENTDATA.IniDCSUnit
- (UNIT/STATIC) The initiating <a href="Dcs.DCSUnit.html##(Unit)">Dcs.DCSUnit#Unit</a> or <a href="Dcs.DCSStaticObject.html##(StaticObject)">Dcs.DCSStaticObject#StaticObject</a>.
-(UNIT/STATIC) The initiating DCSUnit#Unit or DCSStaticObject#StaticObject .
EVENTDATA.IniDCSUnitName
- (UNIT/STATIC) The initiating Unit name.
+(UNIT/STATIC) The initiating Unit name.
EVENTDATA.IniGroup
- (UNIT) The initiating MOOSE wrapper <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> of the initiator Group object.
-(UNIT) The initiating MOOSE wrapper Group#GROUP of the initiator Group object.
EVENTDATA.IniGroupName
- (UNIT) The initiating GROUP name (same as IniDCSGroupName).
-UNIT) The initiating GROUP name (same as IniDCSGroupName).
@@ -518,120 +495,105 @@ YYYY-MM-DD: CLASS:NewFunction( Params ) added
EVENTDATA.IniPlayerName
-(UNIT) The name of the initiating player in case the Unit is a client or player slot.
-(UNIT) The name of the initiating player in case the Unit is a client or player slot.
EVENTDATA.IniTypeName
- (UNIT) The type name of the initiator.
-(UNIT) The type name of the initiator.
EVENTDATA.IniUnit
- (UNIT/STATIC) The initiating MOOSE wrapper <a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> of the initiator Unit object.
-(UNIT/STATIC) The initiating MOOSE wrapper Unit#UNIT of the initiator Unit object.
EVENTDATA.IniUnitName
- (UNIT/STATIC) The initiating UNIT name (same as IniDCSUnitName).
-(UNIT/STATIC) The initiating UNIT name (same as IniDCSUnitName).
EVENTDATA.TgtCategory
- (UNIT) The category of the target.
-(UNIT) The category of the target.
EVENTDATA.TgtCoalition
- (UNIT) The coalition of the target.
-(UNIT) The coalition of the target.
EVENTDATA.TgtDCSGroup
- (UNIT) The target {Dcs.DCSGroup#Group}.
-(UNIT) The target {DCSGroup#Group}.
EVENTDATA.TgtDCSGroupName
- (UNIT) The target Group name.
+(UNIT) The target Group name.
EVENTDATA.TgtDCSUnit
- (UNIT/STATIC) The target <a href="Dcs.DCSUnit.html##(Unit)">Dcs.DCSUnit#Unit</a> or <a href="Dcs.DCSStaticObject.html##(StaticObject)">Dcs.DCSStaticObject#StaticObject</a>.
-(UNIT/STATIC) The target DCSUnit#Unit or DCSStaticObject#StaticObject .
EVENTDATA.TgtDCSUnitName
- (UNIT/STATIC) The target Unit name.
+(UNIT/STATIC) The target Unit name.
EVENTDATA.TgtGroup
- (UNIT) The target MOOSE wrapper <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> of the target Group object.
-(UNIT) The target MOOSE wrapper Group#GROUP of the target Group object.
EVENTDATA.TgtGroupName
- (UNIT) The target GROUP name (same as TgtDCSGroupName).
-(UNIT) The target GROUP name (same as TgtDCSGroupName).
EVENTDATA.TgtObjectCategory
- (UNIT/STATIC) The target object category ( Object.Category.UNIT or Object.Category.STATIC ).
-(UNIT/STATIC) The target object category ( Object.Category.UNIT or Object.Category.STATIC ).
EVENTDATA.TgtPlayerName
-(UNIT) The name of the target player in case the Unit is a client or player slot.
-(UNIT) The name of the target player in case the Unit is a client or player slot.
EVENTDATA.TgtTypeName
- (UNIT) The type name of the target.
-(UNIT) The type name of the target.
EVENTDATA.TgtUnit
- (UNIT/STATIC) The target MOOSE wrapper <a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> of the target Unit object.
-(UNIT/STATIC) The target MOOSE wrapper Unit#UNIT of the target Unit object.
EVENTDATA.TgtUnitName
- (UNIT/STATIC) The target UNIT name (same as TgtDCSUnitName).
-(UNIT/STATIC) The target UNIT name (same as TgtDCSUnitName).
@@ -662,15 +624,13 @@ YYYY-MM-DD: CLASS:NewFunction( Params ) added
EVENTDATA.initiator
- (UNIT/STATIC/SCENERY) The initiating <a href="Dcs.DCSUnit.html##(Unit)">Dcs.DCSUnit#Unit</a> or <a href="Dcs.DCSStaticObject.html##(StaticObject)">Dcs.DCSStaticObject#StaticObject</a>.
-(UNIT/STATIC/SCENERY) The initiating Dcs.DCSUnit#Unit or Dcs.DCSStaticObject#StaticObject .
EVENTDATA.target
- (UNIT/STATIC) The target <a href="Dcs.DCSUnit.html##(Unit)">Dcs.DCSUnit#Unit</a> or <a href="Dcs.DCSStaticObject.html##(StaticObject)">Dcs.DCSStaticObject#StaticObject</a>.
-(UNIT/STATIC) The target Dcs.DCSUnit#Unit or DCSStaticObject#StaticObject .
@@ -1167,412 +1127,6 @@ The self instance of the class for which the event is.
#EVENT :
-
-
-
-
-
-
-EVENT:OnEventForTemplate(EventTemplate, EventFunction, EventClass, OnEventFunction, EventID)
-
-
-
-
-Create an OnDead event handler for a group
-
- Parameters
-
-
-
-#table EventTemplate
-
-
-
-
-#function EventFunction
-
-
-
-
- EventClass
-
-
-
-
-#function OnEventFunction
-
-
-
-
- EventID
-
-
-
- Return value
-
-#EVENT :
-
-
-
-
-
-
-
-
-EVENT:OnEventForUnit(EventDCSUnitName, EventFunction, EventClass, EventID)
-
-
-
-
-Set a new listener for an SEVENT X event
-
- Parameters
-
-
-
-#string EventDCSUnitName
-
-
-
-
-#function EventFunction
-
-
-
-
-Core.Base#BASE EventClass
-
-
-
-
- EventID
-
-
-
- Return value
-
-#EVENT :
-
-
-
-
-
-
-
-
-EVENT:OnEventGeneric(EventFunction, EventClass, EventID)
-
-
-
-
-Set a new listener for an SEVENT X event independent from a unit or a weapon.
-
- Parameters
-
-
-
-#function EventFunction
-
-
-
-
-Core.Base#BASE EventClass
-
-
-
-
- EventID
-
-
-
- Return value
-
-#EVENT :
-
-
-
-
-
-
-
-<<<<<<< HEAD
-
-EVENT:OnLandForTemplate(EventTemplate, EventFunction, EventClass)
-=======
-
-EVENT:OnDeadForTemplate(EventGroup, EventFunction, EventClass, EventTemplate)
-
-
-
-
-Create an OnDead event handler for a group
-
- Parameters
-
-
-
-Wrapper.Group#GROUP EventGroup
-
-
-
-
-#function EventFunction
-
-
-
-
- EventClass
-
-
-
-
- EventTemplate
-
-
-
- Return value
-
-#EVENT :
-
-
-
-
-
-
-
-
-EVENT:OnDeadForUnit(EventDCSUnitName, EventFunction, EventClass)
-
-
-
-
-Set a new listener for an SEVENT DEAD event.
-
- Parameters
-
-
-
-#string EventDCSUnitName
-
-
-
-
-#function EventFunction
-
-
-
-
-Base#BASE EventClass
-
-
-
- Return value
-
-#EVENT :
-
-
-
-
-
-
-
-
-EVENT:OnDeadRemove(EventClass)
-
-
-
-
-Stop listening to SEVENT DEAD event.
-
- Parameter
-
- Return value
-
-#EVENT :
-
-
-
-
-
-
-
-
-EVENT:OnEngineShutDownForTemplate(EventTemplate, EventFunction, EventClass)
-
-
-
-
-Create an OnDead event handler for a group
-
- Parameters
-
- Return value
-
-#EVENT :
-
-
-
-
-
-
-
-
-EVENT:OnEngineShutDownForUnit(EventDCSUnitName, EventFunction, EventClass)
-
-
-
-
-Set a new listener for an SEVENT ENGINE_SHUTDOWN event.
-
- Parameters
-
-
-
-#string EventDCSUnitName
-
-
-
-
-#function EventFunction
-
-
-
-
-Base#BASE EventClass
-
-
-
- Return value
-
-#EVENT :
-
-
-
-
-
-
-
-
-EVENT:OnEngineShutDownRemove(EventClass)
-
-
-
-
-Stop listening to SEVENT ENGINE_SHUTDOWN event.
-
- Parameter
-
- Return value
-
-#EVENT :
-
-
-
-
-
-
-
-
-EVENT:OnEngineStartUpForUnit(EventDCSUnitName, EventFunction, EventClass)
-
-
-
-
-Set a new listener for an SEVENT ENGINE_STARTUP event.
-
- Parameters
-
-
-
-#string EventDCSUnitName
-
-
-
-
-#function EventFunction
-
-
-
-
-Base#BASE EventClass
-
-
-
- Return value
-
-#EVENT :
-
-
-
-
-
-
-
-
-EVENT:OnEngineStartUpRemove(EventClass)
-
-
-
-
-Stop listening to SEVENT ENGINE_STARTUP event.
-
- Parameter
-
- Return value
-
-#EVENT :
-
-
@@ -1623,7 +1177,7 @@ The self instance of the class for which the event is.
-EVENT:OnEventForTemplate(EventTemplate, EventFunction, EventClass, OnEventFunction)
+EVENT:OnEventForTemplate(EventTemplate, EventFunction, EventClass, OnEventFunction, EventID)
@@ -1653,6 +1207,11 @@ The instance of the class for which the event is.
#function OnEventFunction
+
+
+
+ EventID
+
Return value
@@ -1742,103 +1301,6 @@ The self instance of the class for which the event is captured. When the event h
#EVENT :
-
-
-
-
-
-
-EVENT:OnHit(EventFunction, EventClass)
-
-
-
-
-Set a new listener for an SEVENT HIT event.
-
- Parameters
-
- Return value
-
-#EVENT :
-
-
-
-
-
-
-
-
-EVENT:OnHitForUnit(EventDCSUnitName, EventFunction, EventClass)
-
-
-
-
-Set a new listener for an SEVENT HIT event.
-
- Parameters
-
-
-
-#string EventDCSUnitName
-
-
-
-
-#function EventFunction
-
-
-
-
-Base#BASE EventClass
-
-
-
- Return value
-
-#EVENT :
-
-
-
-
-
-
-
-
-EVENT:OnHitRemove(EventClass)
-
-
-
-
-Stop listening to SEVENT HIT event.
-
- Parameter
-
- Return value
-
-#EVENT :
-
-
@@ -1852,283 +1314,6 @@ The self instance of the class for which the event is.
- Parameters
-
-
-
- EventTemplate
-
-
-
-
- EventFunction
-
-
-
-
- EventClass
-
-
-
-
-
-
-
-
-
-EVENT:OnLandForUnit(EventDCSUnitName, EventFunction, EventClass)
-
-
-
-
-Set a new listener for an SEVENT LAND event.
-
- Parameters
-
-
-
-#string EventDCSUnitName
-
-
-
-
-#function EventFunction
-
-
-
-
-Base#BASE EventClass
-
-
-
- Return value
-
-#EVENT :
-
-
-
-
-
-
-
-
-EVENT:OnLandRemove(EventClass)
-
-
-
-
-Stop listening to SEVENT LAND event.
-
- Parameter
-
- Return value
-
-#EVENT :
-
-
-
-
-
-
-
-
-EVENT:OnPilotDead(EventFunction, EventClass)
-
-
-
-
-Set a new listener for an SEVENT PILOT_DEAD event.
-
- Parameters
-
- Return value
-
-#EVENT :
-
-
-
-
-
-
-
-
-EVENT:OnPilotDeadForUnit(EventDCSUnitName, EventFunction, EventClass)
-
-
-
-
-Set a new listener for an SEVENT PILOT_DEAD event.
-
- Parameters
-
-
-
-#string EventDCSUnitName
-
-
-
-
-#function EventFunction
-
-
-
-
-Base#BASE EventClass
-
-
-
- Return value
-
-#EVENT :
-
-
-
-
-
-
-
-
-EVENT:OnPilotDeadRemove(EventClass)
-
-
-
-
-Stop listening to SEVENT PILOT_DEAD event.
-
- Parameter
-
- Return value
-
-#EVENT :
-
-
-
-
-
-
-
-
-EVENT:OnPlayerEnterRemove(EventClass)
-
-
-
-
-Stop listening to SEVENT PLAYERENTER UNIT event.
-
- Parameter
-
- Return value
-
-#EVENT :
-
-
-
-
-
-
-
-
-EVENT:OnPlayerEnterUnit(EventFunction, EventClass)
-
-
-
-
-Set a new listener for an SEVENT PLAYERENTER UNIT event.
-
- Parameters
-
- Return value
-
-#EVENT :
-
-
-
-
-
-
-
-
-EVENT:OnPlayerLeaveRemove(EventClass)
-
-
-
-
-Stop listening to SEVENT PLAYERLEAVE UNIT event.
-
- Parameter
-
- Return value
-
-#EVENT :
-
-
-
-
-
-
-
-
-EVENT:OnPlayerLeaveUnit(EventFunction, EventClass)
->>>>>>> refs/remotes/origin/master
-
-
-
-
-
-
Parameters
@@ -2377,8 +1562,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT) The category of the initiator.
-(UNIT) The category of the initiator.
@@ -2392,8 +1576,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT) The coalition of the initiator.
-(UNIT) The coalition of the initiator.
@@ -2407,8 +1590,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT) The initiating {Dcs.DCSGroup#Group}.
-(UNIT) The initiating {DCSGroup#Group}.
@@ -2422,7 +1604,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT) The initiating Group name.
+(UNIT) The initiating Group name.
@@ -2436,8 +1618,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT/STATIC) The initiating <a href="Dcs.DCSUnit.html##(Unit)">Dcs.DCSUnit#Unit</a> or <a href="Dcs.DCSStaticObject.html##(StaticObject)">Dcs.DCSStaticObject#StaticObject</a>.
-(UNIT/STATIC) The initiating DCSUnit#Unit or DCSStaticObject#StaticObject .
@@ -2451,7 +1632,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT/STATIC) The initiating Unit name.
+(UNIT/STATIC) The initiating Unit name.
@@ -2465,8 +1646,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT) The initiating MOOSE wrapper <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> of the initiator Group object.
-(UNIT) The initiating MOOSE wrapper Group#GROUP of the initiator Group object.
@@ -2480,8 +1660,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT) The initiating GROUP name (same as IniDCSGroupName).
-UNIT) The initiating GROUP name (same as IniDCSGroupName).
@@ -2509,8 +1688,7 @@ Note that at the beginning of each field description, there is an indication whi
-(UNIT) The name of the initiating player in case the Unit is a client or player slot.
-(UNIT) The name of the initiating player in case the Unit is a client or player slot.
@@ -2524,8 +1702,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT) The type name of the initiator.
-(UNIT) The type name of the initiator.
@@ -2540,8 +1717,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT/STATIC) The initiating MOOSE wrapper <a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> of the initiator Unit object.
-(UNIT/STATIC) The initiating MOOSE wrapper Unit#UNIT of the initiator Unit object.
@@ -2555,8 +1731,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT/STATIC) The initiating UNIT name (same as IniDCSUnitName).
-(UNIT/STATIC) The initiating UNIT name (same as IniDCSUnitName).
@@ -2570,8 +1745,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT) The category of the target.
-(UNIT) The category of the target.
@@ -2585,8 +1759,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT) The coalition of the target.
-(UNIT) The coalition of the target.
@@ -2600,8 +1773,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT) The target {Dcs.DCSGroup#Group}.
-(UNIT) The target {DCSGroup#Group}.
@@ -2615,7 +1787,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT) The target Group name.
+(UNIT) The target Group name.
@@ -2629,8 +1801,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT/STATIC) The target <a href="Dcs.DCSUnit.html##(Unit)">Dcs.DCSUnit#Unit</a> or <a href="Dcs.DCSStaticObject.html##(StaticObject)">Dcs.DCSStaticObject#StaticObject</a>.
-(UNIT/STATIC) The target DCSUnit#Unit or DCSStaticObject#StaticObject .
@@ -2644,7 +1815,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT/STATIC) The target Unit name.
+(UNIT/STATIC) The target Unit name.
@@ -2658,8 +1829,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT) The target MOOSE wrapper <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> of the target Group object.
-(UNIT) The target MOOSE wrapper Group#GROUP of the target Group object.
@@ -2673,8 +1843,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT) The target GROUP name (same as TgtDCSGroupName).
-(UNIT) The target GROUP name (same as TgtDCSGroupName).
@@ -2688,8 +1857,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT/STATIC) The target object category ( Object.Category.UNIT or Object.Category.STATIC ).
-(UNIT/STATIC) The target object category ( Object.Category.UNIT or Object.Category.STATIC ).
@@ -2703,8 +1871,7 @@ Note that at the beginning of each field description, there is an indication whi
-(UNIT) The name of the target player in case the Unit is a client or player slot.
-(UNIT) The name of the target player in case the Unit is a client or player slot.
@@ -2718,8 +1885,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT) The type name of the target.
-(UNIT) The type name of the target.
@@ -2734,8 +1900,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT/STATIC) The target MOOSE wrapper <a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> of the target Unit object.
-(UNIT/STATIC) The target MOOSE wrapper Unit#UNIT of the target Unit object.
@@ -2749,8 +1914,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT/STATIC) The target UNIT name (same as TgtDCSUnitName).
-(UNIT/STATIC) The target UNIT name (same as TgtDCSUnitName).
@@ -2818,8 +1982,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT/STATIC/SCENERY) The initiating <a href="Dcs.DCSUnit.html##(Unit)">Dcs.DCSUnit#Unit</a> or <a href="Dcs.DCSStaticObject.html##(StaticObject)">Dcs.DCSStaticObject#StaticObject</a>.
-(UNIT/STATIC/SCENERY) The initiating Dcs.DCSUnit#Unit or Dcs.DCSStaticObject#StaticObject .
@@ -2833,8 +1996,7 @@ Note that at the beginning of each field description, there is an indication whi
- (UNIT/STATIC) The target <a href="Dcs.DCSUnit.html##(Unit)">Dcs.DCSUnit#Unit</a> or <a href="Dcs.DCSStaticObject.html##(StaticObject)">Dcs.DCSStaticObject#StaticObject</a>.
-(UNIT/STATIC) The target Dcs.DCSUnit#Unit or DCSStaticObject#StaticObject .
diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html
index 15f5cbb49..769a40841 100644
--- a/docs/Documentation/Fsm.html
+++ b/docs/Documentation/Fsm.html
@@ -61,8 +61,8 @@
Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone NewFunction( Params ) added
FSM_PROCESS.Task
+
+
+
+ FSM_PROCESS:_call_handler(handler, params, EventName)
+
@@ -1542,7 +1548,7 @@ A string defining the start state.
- #string
FSM._StartState
@@ -1841,7 +1847,6 @@ A string defining the start state.
-
FSM.current
@@ -2508,6 +2513,37 @@ self
+
+
+
+
+
+
+FSM_PROCESS:_call_handler(handler, params, EventName)
+
+
+
+
+
+
+ Parameters
+
+
+
+ handler
+
+
+
+
+ params
+
+
+
+
+ EventName
+
+
+
diff --git a/docs/Documentation/Group.html b/docs/Documentation/Group.html
index 9e33d5cc9..afa5c8eac 100644
--- a/docs/Documentation/Group.html
+++ b/docs/Documentation/Group.html
@@ -61,8 +61,8 @@
Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Point#POINT_VEC3.NewFromVec3 (): a 3D point created from a DCSTypes#Vec3 .1.2) Smoke, flare, explode, illuminate
+1.2) Manupulate the X, Y, Z coordinates of the point
+
+A POINT_VEC3 class works in 3D space. It contains internally an X, Y, Z coordinate.
+Methods exist to manupulate these coordinates.
+
+The current X, Y, Z axis can be retrieved with the methods POINT_VEC3.GetX (), POINT_VEC3.GetY (), POINT_VEC3.GetZ () respectively.
+The methods POINT_VEC3.SetX (), POINT_VEC3.SetY (), POINT_VEC3.SetZ () change the respective axis with a new value.
+The current axis values can be changed by using the methods POINT_VEC3.AddX (), POINT_VEC3.AddY (), POINT_VEC3.AddZ ()
+to add or substract a value from the current respective axis value.
+Note that the Set and Add methods return the current POINT_VEC3 object, so these manipulation methods can be chained... For example:
+
+ local Vec3 = PointVec3:AddX( 100 ):AddZ( 150 ):GetVec3()
+1.3) Create waypoints for routes
+
+A POINT_VEC3 can prepare waypoints for Ground, Air and Naval groups to be embedded into a Route.
+
+
+1.5) Smoke, flare, explode, illuminate
At the point a smoke, flare, explosion and illumination bomb can be triggered. Use the following methods:
-1.2.1) Smoke
+1.5.1) Smoke
POINT_VEC3.Smoke (): To smoke the point in a certain color.POINT_VEC3.SmokeGreen (): To smoke the point in green.
-1.2.2) Flare
+1.5.2) Flare
POINT_VEC3.Flare (): To flare the point in a certain color.POINT_VEC3.FlareGreen (): To flare the point in green.
-1.2.3) Explode
+1.5.3) Explode
-1.2.4) Illuminate
+1.5.4) Illuminate
+1.2) Manupulate the X, Altitude, Y coordinates of the 2D point
+
+A POINT_VEC2 class works in 2D space, with an altitude setting. It contains internally an X, Altitude, Y coordinate.
+Methods exist to manupulate these coordinates.
+
+The current X, Altitude, Y axis can be retrieved with the methods POINT_VEC2.GetX (), POINT_VEC2.GetAlt (), POINT_VEC2.GetY () respectively.
+The methods POINT_VEC2.SetX (), POINT_VEC2.SetAlt (), POINT_VEC2.SetY () change the respective axis with a new value.
+The current Lat(itude), Alt(itude), Lon(gitude) values can also be retrieved with the methods POINT_VEC2.GetLat (), POINT_VEC2.GetAlt (), POINT_VEC2.GetLon () respectively.
+The current axis values can be changed by using the methods POINT_VEC2.AddX (), POINT_VEC2.AddAlt (), POINT_VEC2.AddY ()
+to add or substract a value from the current respective axis value.
+Note that the Set and Add methods return the current POINT_VEC2 object, so these manipulation methods can be chained... For example:
+
+ local Vec2 = PointVec2:AddX( 100 ):AddY( 2000 ):GetVec2()
+API CHANGE HISTORY
+ POINT_VEC2:AddAlt(Altitude)
+Add to the current land height an altitude.
+
+
+
+ POINT_VEC2:AddX(x)
+Add to the x coordinate of the POINT_VEC2.
+
+
+
+ POINT_VEC2:AddY(y)
+Add to the y coordinate of the POINT_VEC2.
+
+
+
POINT_VEC2.ClassName
@@ -216,13 +268,25 @@ In order to keep the credibility of the the author, I want to emphasize that the
POINT_VEC2:GetAlt()
-Return the altitude of the land at the POINT_VEC2.
+Return the altitude (height) of the land at the POINT_VEC2.
POINT_VEC2:GetAltitudeText()
Return no text for the altitude of the POINT_VEC2.
+
+
+
+ POINT_VEC2:GetLat()
+Return Return the Lat(itude) coordinate of the POINTVEC2 (ie: (parent)POINT VEC3.x).
+
+
+
+ POINT_VEC2:GetLon()
+Return the Lon(gitude) coordinate of the POINTVEC2 (ie: (parent)POINT VEC3.z).
@@ -256,13 +320,31 @@ In order to keep the credibility of the the author, I want to emphasize that the
- POINT_VEC2.SetX(x, self) POINT_VEC2:SetAlt(Altitude)
+Set the altitude of the POINT_VEC2.
+
+
+
+ POINT_VEC2:SetLat(x)
+Set the Lat(itude) coordinate of the POINTVEC2 (ie: POINT VEC3.x).
+
+
+
+ POINT_VEC2:SetLon(y, z)
+Set the Lon(gitude) coordinate of the POINTVEC2 (ie: POINT VEC3.z).
+
+
+
+ POINT_VEC2:SetX(x)
Set the x coordinate of the POINT_VEC2.
- POINT_VEC2.SetY(y, self) POINT_VEC2:SetY(y)
Set the y coordinate of the POINT_VEC2.
@@ -283,6 +365,12 @@ In order to keep the credibility of the the author, I want to emphasize that the
POINT_VEC2.y
the y coordinate in meters.
+
+
+
+ POINT_VEC2.z
+
@@ -290,6 +378,24 @@ In order to keep the credibility of the the author, I want to emphasize that the
+ POINT_VEC3:AddX(x)
+Add to the x coordinate of the POINT_VEC3.
+
+
+
+ POINT_VEC3:AddY(y)
+Add to the y coordinate of the POINT_VEC3.
+
+
+
+ POINT_VEC3:AddZ(z)
+Add to the z coordinate of the POINT_VEC3.
+
+
+
POINT_VEC3.ClassName
@@ -506,19 +612,19 @@ In order to keep the credibility of the the author, I want to emphasize that the
- POINT_VEC3.SetX(x, self) POINT_VEC3:SetX(x)
Set the x coordinate of the POINT_VEC3.
- POINT_VEC3.SetY(y, self) POINT_VEC3:SetY(y)
Set the y coordinate of the POINT_VEC3.
- POINT_VEC3.SetZ(z, self) POINT_VEC3:SetZ(z)
Set the z coordinate of the POINT_VEC3.
@@ -684,6 +790,87 @@ In order to keep the credibility of the the author, I want to emphasize that the
+
+POINT_VEC2:AddAlt(Altitude)
+
+
+
+
+Add to the current land height an altitude.
+
+ Parameter
+
+ Return value
+
+#POINT_VEC2 :
+
+
+
+
+
+
+
+
+POINT_VEC2:AddX(x)
+
+
+
+
+Add to the x coordinate of the POINT_VEC2.
+
+ Parameter
+
+ Return value
+
+#POINT_VEC2 :
+
+
+
+
+
+
+
+
+POINT_VEC2:AddY(y)
+
+
+
+
+Add to the y coordinate of the POINT_VEC2.
+
+ Parameter
+
+ Return value
+
+#POINT_VEC2 :
+
+
+
+
+
+
+
#string
POINT_VEC2.ClassName
@@ -758,7 +945,7 @@ The distance from the reference DCSTypes#Vec2
-Return the altitude of the land at the POINT_VEC2.
+Return the altitude (height) of the land at the POINT_VEC2.
Return value
@@ -788,6 +975,42 @@ Empty string.
+
+POINT_VEC2:GetLat()
+
+
+
+
+Return Return the Lat(itude) coordinate of the POINTVEC2 (ie: (parent)POINT VEC3.x).
+
+ Return value
+
+#number:
+The x coodinate.
+
+
+
+
+
+
+
+POINT_VEC2:GetLon()
+
+
+
+
+Return the Lon(gitude) coordinate of the POINTVEC2 (ie: (parent)POINT VEC3.z).
+
+ Return value
+
+#number:
+The y coodinate.
+
+
+
+
+
+
POINT_VEC2:GetX()
@@ -922,40 +1145,67 @@ self
-
-POINT_VEC2.SetX(x, self)
+
+POINT_VEC2:SetAlt(Altitude)
-Set the x coordinate of the POINT_VEC2.
+Set the altitude of the POINT_VEC2.
- Parameters
+ Parameter
+
+ Return value
+
+#POINT_VEC2 :
+
+
+
+
+
+
+
+
+POINT_VEC2:SetLat(x)
+
+
+
+
+Set the Lat(itude) coordinate of the POINTVEC2 (ie: POINT VEC3.x).
+
+ Parameter
+ Return value
+
+#POINT_VEC2 :
+
+
-
-POINT_VEC2.SetY(y, self)
+
+POINT_VEC2:SetLon(y, z)
-Set the y coordinate of the POINT_VEC2.
+Set the Lon(gitude) coordinate of the POINTVEC2 (ie: POINT VEC3.z).
Parameters
@@ -967,10 +1217,69 @@ The y coordinate.
- self
+ z
+ Return value
+
+#POINT_VEC2 :
+
+
+
+
+
+
+
+
+POINT_VEC2:SetX(x)
+
+
+
+
+Set the x coordinate of the POINT_VEC2.
+
+ Parameter
+
+ Return value
+
+#POINT_VEC2 :
+
+
+
+
+
+
+
+
+POINT_VEC2:SetY(y)
+
+
+
+
+Set the y coordinate of the POINT_VEC2.
+
+ Parameter
+
+ Return value
+
+#POINT_VEC2 :
+
+
@@ -1034,8 +1343,6 @@ The new calculated POINT_VEC2.
-<<<<<<< HEAD
-=======
@@ -1049,7 +1356,6 @@ The new calculated POINT_VEC2.
->>>>>>> refs/remotes/origin/master
@@ -1059,6 +1365,87 @@ The new calculated POINT_VEC2.
+
+POINT_VEC3:AddX(x)
+
+
+
+
+Add to the x coordinate of the POINT_VEC3.
+
+ Parameter
+
+ Return value
+
+#POINT_VEC3 :
+
+
+
+
+
+
+
+
+POINT_VEC3:AddY(y)
+
+
+
+
+Add to the y coordinate of the POINT_VEC3.
+
+ Parameter
+
+ Return value
+
+#POINT_VEC3 :
+
+
+
+
+
+
+
+
+POINT_VEC3:AddZ(z)
+
+
+
+
+Add to the z coordinate of the POINT_VEC3.
+
+ Parameter
+
+ Return value
+
+#POINT_VEC3 :
+
+
+
+
+
+
+
#string
POINT_VEC3.ClassName
@@ -1919,81 +2306,81 @@ true means metric, false means NM.
-POINT_VEC3.SetX(x, self)
+POINT_VEC3:SetX(x)
Set the x coordinate of the POINT_VEC3.
- Parameters
+ Parameter
+ Return value
+
+#POINT_VEC3 :
+
+
-POINT_VEC3.SetY(y, self)
+POINT_VEC3:SetY(y)
Set the y coordinate of the POINT_VEC3.
- Parameters
+ Parameter
+ Return value
+
+#POINT_VEC3 :
+
+
-POINT_VEC3.SetZ(z, self)
+POINT_VEC3:SetZ(z)
Set the z coordinate of the POINT_VEC3.
- Parameters
+ Parameter
+ Return value
+
+#POINT_VEC3 :
+
+
diff --git a/docs/Documentation/Positionable.html b/docs/Documentation/Positionable.html
index 93943636f..0fbf409de 100644
--- a/docs/Documentation/Positionable.html
+++ b/docs/Documentation/Positionable.html
@@ -61,8 +61,8 @@
Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone ACT_ROUTE
+
+
+
+ ACT_ROUTE_POINT
+
@@ -206,7 +212,7 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil
- ACT_ROUTE.TargetZone ACT_ROUTE.Zone
@@ -227,6 +233,106 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil
ACT_ROUTE:onfuncHasArrived(ProcessUnit)
Check if the controllable has arrived.
+
+
+
+
+
+
@@ -261,6 +367,12 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil
ACT_ROUTE_ZONE.DisplayTime
+
+
+
+ ACT_ROUTE_ZONE:GetZone()
+Get Zone
@@ -270,7 +382,7 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil
- ACT_ROUTE_ZONE:New(TargetZone) ACT_ROUTE_ZONE:New(Zone)
Creates a new routing state machine.
@@ -279,6 +391,12 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil
ACT_ROUTE_ZONE.ProcessUnit
+
+
+
+ ACT_ROUTE_ZONE:SetZone(Zone)
+Set Zone
@@ -288,7 +406,7 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil
- ACT_ROUTE_ZONE.TargetZone ACT_ROUTE_ZONE.Zone
@@ -320,6 +438,20 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil
+
+
+
+
+
+ #ACT_ROUTE_POINT
+ACT_ROUTE_POINT
+
+
+
+
+
+
@@ -424,8 +556,8 @@ self
Core.Zone#ZONE_BASE
-ACT_ROUTE.TargetZone
+
+ACT_ROUTE.Zone
@@ -530,6 +662,330 @@ self
#boolean:
+
+
+
+
+
+ACTROUTE POINT class
+
+ Field(s)
+
+
+
+ #string
+
+ACT_ROUTE_POINT.ClassName
+
+
+
+
+
+
+
+
+
+
+
+ #number
+
+ACT_ROUTE_POINT.DisplayCount
+
+
+
+
+
+
+
+
+
+
+
+ #number
+
+ACT_ROUTE_POINT.DisplayInterval
+
+
+
+
+
+
+
+
+
+
+
+ #boolean
+
+ACT_ROUTE_POINT.DisplayMessage
+
+
+
+
+
+
+
+
+
+
+
+ #number
+
+ACT_ROUTE_POINT.DisplayTime
+
+
+
+
+
+
+
+ 10 seconds is the default
+
+
+
+
+
+
+
+ACT_ROUTE_POINT:GetPointVec2()
+
+
+
+
+Get PointVec2
+
+ Return value
+
+Core.Point#POINT_VEC2 :
+
+
+
+
+
+
+
+ACT_ROUTE_POINT:GetRange()
+
+
+
+
+Get Range around PointVec2
+
+ Return value
+
+#number:
+The Range to consider the arrival. Default is 10000 meters.
+
+
+
+
+
+
+
+ACT_ROUTE_POINT:Init(FsmRoute)
+
+
+
+
+
+
+ Parameter
+
+
+
+
+
+
+
+ACT_ROUTE_POINT:New(The, Range, Zone, PointVec2)
+
+
+
+
+Creates a new routing state machine.
+
+
+The task will route a controllable to a PointVec2 until the controllable is within the Range.
+
+ Parameters
+
+
+
+
+
+
+
+ACT_ROUTE_POINT.PointVec2
+
+
+
+
+
+
+
+
+
+
+
+
+ACT_ROUTE_POINT.Range
+
+
+
+
+
+
+
+
+
+
+
+
+ACT_ROUTE_POINT:SetPointVec2(PointVec2)
+
+
+
+
+Set PointVec2
+
+ Parameter
+
+
+
+
+
+
+
+ACT_ROUTE_POINT:SetRange(Range)
+
+
+
+
+Set Range around PointVec2
+
+ Parameter
+
+
+
+
+
+
+ Tasking.Task#TASK
+ACT_ROUTE_POINT.TASK
+
+
+
+
+
+
+
+
+
+
+
+
+ACT_ROUTE_POINT:onenterReporting(ProcessUnit, Event, From, To)
+
+
+
+
+StateMachine callback function
+
+ Parameters
+
+
+
+
+
+
+
+ACT_ROUTE_POINT:onfuncHasArrived(ProcessUnit)
+
+
+
+
+Method override to check if the controllable has arrived.
+
+ Parameter
+
+ Return value
+
+#boolean:
+
+
@@ -614,6 +1070,24 @@ self
+
+ACT_ROUTE_ZONE:GetZone()
+
+
+
+
+Get Zone
+
+ Return value
+
+Core.Zone#ZONE_BASE :
+
+
+
+
+
+
ACT_ROUTE_ZONE:Init(FsmRoute)
@@ -636,7 +1110,7 @@ self
-ACT_ROUTE_ZONE:New(TargetZone)
+ACT_ROUTE_ZONE:New(Zone)
@@ -650,7 +1124,7 @@ self
@@ -668,6 +1142,28 @@ self
+
+
+
+
+
+
+ACT_ROUTE_ZONE:SetZone(Zone)
+
+
+
+
+Set Zone
+
+ Parameter
+
@@ -688,8 +1184,8 @@ self
Core.Zone#ZONE_BASE
-ACT_ROUTE_ZONE.TargetZone
+
+ACT_ROUTE_ZONE.Zone
diff --git a/docs/Documentation/Scenery.html b/docs/Documentation/Scenery.html
index f7258b5b4..b9e8b4a3d 100644
--- a/docs/Documentation/Scenery.html
+++ b/docs/Documentation/Scenery.html
@@ -39,11 +39,11 @@
Fsm Group Identifiable MOVEMENT Menu Message MissileTrainer Mission Movement Object Point Positionable Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone
Module Scheduler
-
This module contains the SCHEDULER class.
+
Core - SCHEDULER prepares and handles the execution of functions over scheduled time (intervals) .
+
+
+
+
The Scheduler#SCHEDULER class creates schedule.
diff --git a/docs/Documentation/Scoring.html b/docs/Documentation/Scoring.html
index 3d38a7d76..c869150bd 100644
--- a/docs/Documentation/Scoring.html
+++ b/docs/Documentation/Scoring.html
@@ -61,8 +61,8 @@
Static Task Task_A2G
+
Task_A2G_Dispatcher Task_PICKUP
-
Task_SEAD Unit Utils Zone
@@ -493,6 +493,12 @@ Various methods exist to configure:
SCORING:ReportDetailedPlayerDestroys(PlayerName)
Produce detailed report of player destroy scores.
+
+
+
+ SCORING:ReportDetailedPlayerGoals(PlayerName)
+Produce detailed report of player goal scores.
@@ -504,7 +510,7 @@ Various methods exist to configure:
SCORING:ReportDetailedPlayerMissions(PlayerName)
-Produce detailed report of player goal scores.
+Produce detailed report of player penalty scores because of changing the coalition.
@@ -1441,6 +1447,33 @@ The report.
+
+SCORING:ReportDetailedPlayerGoals(PlayerName)
+
+
+
+
+Produce detailed report of player goal scores.
+
+ Parameter
+
+ Return value
+
+#string:
+The report.
+
+
+
+
+
+
SCORING:ReportDetailedPlayerHits(PlayerName)
@@ -1474,7 +1507,7 @@ The report.
-Produce detailed report of player goal scores.
+Produce detailed report of player penalty scores because of changing the coalition.
Parameter
+
+ SET_BASE:GetRandom()
+Gets a random object from the Set#SET_BASE and derived classes.
SET_BASE:GetSet()
Gets the Set.
+
+
+
+ SET_BASE.Index
+
@@ -1892,6 +1904,24 @@ self
Core.Base#BASE :
+
+
+
+
+
+
+SET_BASE:GetRandom()
+
+
+
+
+Gets a random object from the Set#SET_BASE and derived classes.
+
+ Return value
+
+Core.Base#BASE :
+
+
@@ -1910,6 +1940,20 @@ self
#SET_BASE :
+
+
+
+
+
+
+SET_BASE.Index
+
+
+
+
+
+
diff --git a/docs/Documentation/Smoke.html b/docs/Documentation/Smoke.html
index 6702e3e2c..f21743f78 100644
--- a/docs/Documentation/Smoke.html
+++ b/docs/Documentation/Smoke.html
@@ -61,8 +61,8 @@
Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone ACT_ASSIST:onafterStart(ProcessUnit, Event, From, To)
StateMachine callback function
+
+
+
+ ACT_ASSIST:onafterStop(ProcessUnit, Event, From, To)
+StateMachine callback function
@@ -467,6 +473,42 @@ At random intervals, a new target is smoked.
+StateMachine callback function
+
+ Parameters
+
+
+
+
+
+
+
+ACT_ASSIST:onafterStop(ProcessUnit, Event, From, To)
+
+
+
+
StateMachine callback function
Parameters
diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html
index 00b707335..b80258536 100644
--- a/docs/Documentation/Spawn.html
+++ b/docs/Documentation/Spawn.html
@@ -61,8 +61,8 @@
Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)
-
-
-
- SPAWN.uncontrolled
-
@@ -1765,9 +1759,6 @@ The group that was spawned. You can use this group for further actions.
-
- Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.
-
@@ -2562,7 +2553,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
- 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.
@@ -3201,20 +3192,6 @@ True = Continue Scheduler
-
-
-
-
-
-
-SPAWN.uncontrolled
-
-
-
-
-
-
diff --git a/docs/Documentation/Static.html b/docs/Documentation/Static.html
index 60fca2b1e..ebd47c91e 100644
--- a/docs/Documentation/Static.html
+++ b/docs/Documentation/Static.html
@@ -61,8 +61,8 @@
Static
Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Static Task
Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone TASK.AddScore () to add scores whe
TASK:GetScoring()
Gets the Scoring of the task
+
+
+
+ TASK:GetStateMachine(TaskUnit)
+Gets the FiniteStateMachine of Task with key TaskUnit
@@ -264,7 +270,7 @@ Use the method TASK.AddScore () to add scores whe
- TASK:GetUnitProcess() TASK:GetUnitProcess(TaskUnit)
Get the Task FSM Process Template
@@ -354,9 +360,9 @@ Use the method TASK.AddScore () to add scores whe
- TASK.MenuTaskStatus(MenuParam) TASK:MenuTaskStatus(TaskGroup)
-
+Report the task status.
@@ -609,12 +615,18 @@ Use the method TASK.AddScore () to add scores whe
TASK.TimeOut
+
+
+
+ TASK:UnAssignFromGroup(TaskGroup)
+UnAssign the Task from a Group .
TASK:UnAssignFromGroups()
-Assign the Task from the Group s.
+UnAssign the Task from the Group s.
@@ -1072,6 +1084,32 @@ The Task Name
Functional.Scoring#SCORING :
+
+
+
+
+
+
+TASK:GetStateMachine(TaskUnit)
+
+
+
+
+Gets the FiniteStateMachine of Task with key TaskUnit
+
+ Parameter
+
+ Return value
+
+Core.Fsm#FSM_PROCESS :
+
+
@@ -1145,13 +1183,21 @@ TaskType
-TASK:GetUnitProcess()
+TASK:GetUnitProcess(TaskUnit)
Get the Task FSM Process Template
+ Parameter
+
Return value
Core.Fsm#FSM_PROCESS :
@@ -1431,18 +1477,18 @@ true if Unit is part of the Task.
-
+Report the task status.
Parameter
- MenuParam
+ TaskGroup
@@ -2005,7 +2051,7 @@ self
- Fsm
+Core.Fsm#FSM_PROCESS Fsm
@@ -2270,6 +2316,27 @@ Fsm#FSM_PROCESS
+
+
+
+
+
+
+TASK:UnAssignFromGroup(TaskGroup)
+
+
+
+
+UnAssign the Task from a Group .
+
+ Parameter
+
@@ -2281,7 +2348,7 @@ Fsm#FSM_PROCESS
-Assign the Task from the Group s.
+UnAssign the Task from the Group s.
diff --git a/docs/Documentation/Task_A2G.html b/docs/Documentation/Task_A2G.html
index d3718c2c3..8b3b168d3 100644
--- a/docs/Documentation/Task_A2G.html
+++ b/docs/Documentation/Task_A2G.html
@@ -61,8 +61,8 @@
Static Task Task_A2G
+ Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone
Module Task_A2G
-
(AI) (SP) (MP) Tasking for Air to Ground Processes.
+
This module contains the TASK_A2G classes.
-
-
The #TASK_A2G class defines a CAS or BAI task of a Set of Target Units,
-located at a Target Zone, based on the tasking capabilities defined in Task#TASK .
+
+
+
The #TASK_A2G class defines Air To Ground tasks for a Set of Target Units,
+based on the tasking capabilities defined in Task#TASK .
The TASK_A2G is implemented using a Statemachine#FSM_TASK , and has the following statuses:
None : Start of the processPlanned : The SEAD task is planned. Upon Planned, the sub-process ProcessFsm.Assign#ACT ASSIGN_ACCEPT is started to accept the task.Assigned : The SEAD task is assigned to a Group#GROUP . Upon Assigned, the sub-process ProcessFsm.Route#ACT ROUTE is started to route the active Units in the Group to the attack zone.Success : The SEAD task is successfully completed. Upon Success, the sub-process ProcessSEAD#PROCESS SEAD is started to follow-up successful SEADing of the targets assigned in the task.Failed : The SEAD task has failed. This will happen if the player exists the task early, without communicating a possible cancellation to HQ.Planned : The A2G task is planned.Assigned : The A2G task is assigned to a Group#GROUP .Success : The A2G task is successfully completed.Failed : The A2G task has failed. This will happen if the player exists the task early, without communicating a possible cancellation to HQ.
+
+
+
The #TASK_SEAD class defines a SEAD task for a Set of Target Units.
+
-
Authors: FlightControl - Design and Programming
+
API CHANGE HISTORY
+
The underlying change log documents the API changes. Please read this carefully. The following notation is used:
+
+
+ Added parts are expressed in bold type face.Removed parts are expressed in italic type face.
+
+
Hereby the change log:
+
+
2017-03-09: Revised version.
+
+
+
+
AUTHORS and CONTRIBUTIONS
+
+
Contributions:
+
+
+ [WingThor] : Concept, Advice & Testing.
+
+
Authors:
+
+
+ FlightControl : Concept, Design & Programming.
+
Global(s)
@@ -118,9 +168,129 @@ The TASK_A2G is implemented using a
Stat
- TASK_A2G:New(Mission, SetGroup, TaskName, TaskType, UnitSetTargets, TargetZone, TargetSetUnit, FACUnit) TASK_A2G:GetRendezVousPointVec2(TaskUnit)
+
+
+
+
+ TASK_A2G:GetRendezVousZone(TaskUnit)
+
+
+
+
+ TASK_A2G:GetTargetPointVec2(TaskUnit)
+
+
+
+
+ TASK_A2G:GetTargetZone(TaskUnit)
+
+
+
+
+ TASK_A2G:New(Mission, SetGroup, TaskName, UnitSetTargets, TargetDistance, TargetZone, TargetSetUnit, TaskType)
Instantiates a new TASK_A2G.
+
+
+
+ TASK_A2G:SetRendezVousPointVec2(RendezVousPointVec2, RendezVousRange, TaskUnit)
+
+
+
+
+ TASK_A2G:SetRendezVousZone(RendezVousZone, TaskUnit)
+
+
+
+
+ TASK_A2G:SetTargetPointVec2(TargetPointVec2, TaskUnit)
+
+
+
+
+ TASK_A2G:SetTargetZone(TargetZone, TaskUnit)
+
+
+
+
+ TASK_A2G.TargetSetUnit
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -138,10 +308,54 @@ The TASK_A2G is implemented using a Stat
+
+
+
+
+
+ #TASK_BAI
+TASK_BAI
+
+
+
+
+
+
+
+
+
+
+
+ #TASK_CAS
+TASK_CAS
+
+
+
+
+
+
+
+
+
+
+
+ #TASK_SEAD
+TASK_SEAD
+
+
+
+
+
+
+
+
The TASK_A2G class
@@ -172,13 +386,127 @@ The TASK_A2G is implemented using a Stat
+
+
+
+
+
+
+TASK_A2G:GetRendezVousPointVec2(TaskUnit)
+
+
+
+
+
+
+ Parameter
+
+ Return values
+
+
+
+Core.Point#POINT_VEC2 :
+
+
+
+
+#number:
+The RendezVousRange that defines when the player is considered to have arrived at the RendezVous point.
+
+
+
+
+
+
+
+
+
+TASK_A2G:GetRendezVousZone(TaskUnit)
+
+
+
+
+
+
+ Parameter
+
+ Return value
+
+Core.Zone#ZONE_BASE :
+
+
+
+
+
+
+
+TASK_A2G:GetTargetPointVec2(TaskUnit)
+
+
+
+
+
+
+ Parameter
+
+ Return value
+
+Core.Point#POINT_VEC2 :
+
+
+
+
+
+
+
+TASK_A2G:GetTargetZone(TaskUnit)
+
+
+
+
+
+
+ Parameter
+
+ Return value
+
+Core.Zone#ZONE_BASE :
+
-TASK_A2G:New(Mission, SetGroup, TaskName, TaskType, UnitSetTargets, TargetZone, TargetSetUnit, FACUnit)
+TASK_A2G:New(Mission, SetGroup, TaskName, UnitSetTargets, TargetDistance, TargetZone, TargetSetUnit, TaskType)
@@ -206,18 +534,20 @@ The name of the Task.
-#string TaskType
-
-
-
-
Set#SET_UNIT UnitSetTargets
-Core.Zone#ZONE_BASE TargetZone
+#number TargetDistance
+
+
+
+
+Core.Zone#ZONE_BASE TargetZone
@@ -227,7 +557,7 @@ BAI or CAS
- FACUnit
+ TaskType
@@ -236,6 +566,419 @@ BAI or CAS
#TASK_A2G :
+
+
+
+
+
+
+TASK_A2G:SetRendezVousPointVec2(RendezVousPointVec2, RendezVousRange, TaskUnit)
+
+
+
+
+
+
+ Parameters
+
+
+
+Core.Point#POINT_VEC2 RendezVousPointVec2
+
+
+
+
+#number RendezVousRange
+
+
+
+
+Wrapper.Unit#UNIT TaskUnit
+
+
+
+
+
+
+
+
+
+TASK_A2G:SetRendezVousZone(RendezVousZone, TaskUnit)
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
+
+
+TASK_A2G:SetTargetPointVec2(TargetPointVec2, TaskUnit)
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
+
+
+TASK_A2G:SetTargetZone(TargetZone, TaskUnit)
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
+
+ Set#SET_UNIT
+TASK_A2G.TargetSetUnit
+
+
+
+
+
+
+
+
+
+
+
+The TASK_BAI class
+
+ Field(s)
+
+
+
+ #string
+
+TASK_BAI.ClassName
+
+
+
+
+
+
+
+
+
+
+
+
+TASK_BAI:New(Mission, SetGroup, TaskName, UnitSetTargets, TargetDistance, TargetZone, TargetSetUnit)
+
+
+
+
+Instantiates a new TASK_BAI.
+
+ Parameters
+
+
+
+Tasking.Mission#MISSION Mission
+
+
+
+
+Set#SET_GROUP SetGroup
+
+
+
+
+#string TaskName
+
+
+
+
+Set#SET_UNIT UnitSetTargets
+
+
+
+
+#number TargetDistance
+
+
+
+
+Core.Zone#ZONE_BASE TargetZone
+
+
+
+
+ TargetSetUnit
+
+
+
+ Return value
+
+#TASK_BAI :
+
+
+
+
+
+
+ Set#SET_UNIT
+TASK_BAI.TargetSetUnit
+
+
+
+
+
+
+
+
+
+
+
+The TASK_CAS class
+
+ Field(s)
+
+
+
+ #string
+
+TASK_CAS.ClassName
+
+
+
+
+
+
+
+
+
+
+
+
+TASK_CAS:New(Mission, SetGroup, TaskName, UnitSetTargets, TargetDistance, TargetZone, TargetSetUnit)
+
+
+
+
+Instantiates a new TASK_CAS.
+
+ Parameters
+
+
+
+Tasking.Mission#MISSION Mission
+
+
+
+
+Set#SET_GROUP SetGroup
+
+
+
+
+#string TaskName
+
+
+
+
+Set#SET_UNIT UnitSetTargets
+
+
+
+
+#number TargetDistance
+
+
+
+
+Core.Zone#ZONE_BASE TargetZone
+
+
+
+
+ TargetSetUnit
+
+
+
+ Return value
+
+#TASK_CAS :
+
+
+
+
+
+
+ Set#SET_UNIT
+TASK_CAS.TargetSetUnit
+
+
+
+
+
+
+
+
+
+
+
+The TASK_SEAD class
+
+ Field(s)
+
+
+
+ #string
+
+TASK_SEAD.ClassName
+
+
+
+
+
+
+
+
+
+
+
+
+TASK_SEAD:New(Mission, SetGroup, TaskName, UnitSetTargets, TargetDistance, TargetZone, TargetSetUnit)
+
+
+
+
+Instantiates a new TASK_SEAD.
+
+ Parameters
+
+
+
+Tasking.Mission#MISSION Mission
+
+
+
+
+Set#SET_GROUP SetGroup
+
+
+
+
+#string TaskName
+
+
+
+
+Set#SET_UNIT UnitSetTargets
+
+
+
+
+#number TargetDistance
+
+
+
+
+Core.Zone#ZONE_BASE TargetZone
+
+
+
+
+ TargetSetUnit
+
+
+
+ Return value
+
+#TASK_SEAD :
+
+
+
+
+
+
+ Set#SET_UNIT
+TASK_SEAD.TargetSetUnit
+
+
+
+
+
+
diff --git a/docs/Documentation/Task_A2G_Dispatcher.html b/docs/Documentation/Task_A2G_Dispatcher.html
new file mode 100644
index 000000000..a6b227934
--- /dev/null
+++ b/docs/Documentation/Task_A2G_Dispatcher.html
@@ -0,0 +1,502 @@
+
+
+
+
+
+
+
+
+
Module Task_A2G_Dispatcher
+
+
Tasking - The TASKA2G DISPATCHER creates and manages player TASK_A2G tasks based on detected targets.
+
+
+
+
+
+
+
+
The #TASKA2G DISPATCHER class implements the dynamic dispatching of tasks upon groups of detected units determined a Set of FAC (groups).
+The FAC will detect units, will group them, and will dispatch Task s to groups. Depending on the type of target detected, different tasks will be dispatched.
+Find a summary below describing for which situation a task type is created:
+
+
+ CAS Task : Is created when there are enemy ground units within range of the FAC, while there are friendly units in the FAC perimeter.BAI Task : Is created when there are enemy ground units within range of the FAC, while there are NO other friendly units within the FAC perimeter.SEAD Task : Is created when there are enemy ground units wihtin range of the FAC, with air search radars.
+
+
Other task types will follow...
+
+
3.1) TASKA2G DISPATCHER constructor:
+
The TASKA2G DISPATCHER.New () method creates a new TASKA2G DISPATCHER instance.
+
+
+
+
API CHANGE HISTORY
+
+
The underlying change log documents the API changes. Please read this carefully. The following notation is used:
+
+
+ Added parts are expressed in bold type face.Removed parts are expressed in italic type face.
+
+
Hereby the change log:
+
+
2017-03-09: Initial class and API.
+
+
+
+
AUTHORS and CONTRIBUTIONS
+
+
Contributions:
+
+
Authors:
+
+
+ FlightControl : Concept, Design & Programming.
+
+
+
Global(s)
+
+
+
+
+
Global(s)
+
+
+
+ #TASK_A2G_DISPATCHER
+TASK_A2G_DISPATCHER
+
+
+
+
+
+
+
+
+
+
+
+
+
TASKA2G DISPATCHER class.
+
+
Field(s)
+
+
+
+ #string
+
+TASK_A2G_DISPATCHER.ClassName
+
+
+
+
+
+
+
+
+
+
+
+ Wrapper.Group#GROUP
+TASK_A2G_DISPATCHER.CommandCenter
+
+
+
+
+
+
+
+
+
+
+
+ Functional.Detection#DETECTION_BASE
+TASK_A2G_DISPATCHER.Detection
+
+
+
+
+The DETECTION_BASE object that is used to report the detected objects.
+
+
+
+
+
+
+
+TASK_A2G_DISPATCHER:EvaluateBAI(DetectedArea, FriendlyCoalition)
+
+
+
+
+Creates a BAI task when there are targets for it.
+
+ Parameters
+
+ Return value
+
+Tasking.Task#TASK :
+
+
+
+
+
+
+
+
+TASK_A2G_DISPATCHER:EvaluateCAS(DetectedArea)
+
+
+
+
+Creates a CAS task when there are targets for it.
+
+ Parameter
+
+ Return value
+
+Tasking.Task#TASK :
+
+
+
+
+
+
+
+
+TASK_A2G_DISPATCHER:EvaluateRemoveTask(Mission, Task, DetectedItem)
+
+
+
+
+Evaluates the removal of the Task from the Mission.
+
+
+Can only occur when the DetectedArea is Changed AND the state of the Task is "Planned".
+
+ Parameters
+
+ Return value
+
+Tasking.Task#TASK :
+
+
+
+
+
+
+
+
+TASK_A2G_DISPATCHER:EvaluateSEAD(DetectedItem)
+
+
+
+
+Creates a SEAD task when there are targets for it.
+
+ Parameter
+
+ Return values
+
+
+
+Set#SET_UNIT :
+
+
+
+
+#nil:
+If there are no targets to be set.
+
+
+
+
+
+
+
+
+ Tasking.Mission#MISSION
+TASK_A2G_DISPATCHER.Mission
+
+
+
+
+
+
+
+
+
+
+
+
+TASK_A2G_DISPATCHER:New(SetGroup, Detection, Mission, CommandCenter)
+
+
+
+
+TASKA2G DISPATCHER constructor.
+
+ Parameters
+
+ Return value
+
+#TASKA2G DISPATCHER :
+
+
+
+
+
+
+
+TASK_A2G_DISPATCHER:ProcessDetected(Detection)
+
+
+
+
+Assigns tasks in relation to the detected items to the Set#SET_GROUP .
+
+ Parameter
+
+ Return value
+
+#boolean:
+Return true if you want the task assigning to continue... false will cancel the loop.
+
+
+
+
+
+
+ Set#SET_GROUP
+TASK_A2G_DISPATCHER.SetGroup
+
+
+
+
+The groups to which the FAC will report to.
+
+
+
+
+
+
+
+
+
diff --git a/docs/Documentation/Task_PICKUP.html b/docs/Documentation/Task_PICKUP.html
index 16565d8d4..3cd5f394a 100644
--- a/docs/Documentation/Task_PICKUP.html
+++ b/docs/Documentation/Task_PICKUP.html
@@ -61,8 +61,8 @@
Static Task Task_A2G
+
Task_A2G_Dispatcher Task_PICKUP
-
Task_SEAD Unit Utils Zone
diff --git a/docs/Documentation/Unit.html b/docs/Documentation/Unit.html
index 27a770ddb..10e57e762 100644
--- a/docs/Documentation/Unit.html
+++ b/docs/Documentation/Unit.html
@@ -61,8 +61,8 @@
Static Task Task_A2G
+
Task_A2G_Dispatcher Task_PICKUP
-
Task_SEAD Unit
Utils Zone
diff --git a/docs/Documentation/Utils.html b/docs/Documentation/Utils.html
index 86500945d..ca23f3aa4 100644
--- a/docs/Documentation/Utils.html
+++ b/docs/Documentation/Utils.html
@@ -61,8 +61,8 @@
Static Task Task_A2G
+
Task_A2G_Dispatcher Task_PICKUP
-
Task_SEAD Unit Utils
Zone
diff --git a/docs/Documentation/Zone.html b/docs/Documentation/Zone.html
index aa6a657fb..7931424c8 100644
--- a/docs/Documentation/Zone.html
+++ b/docs/Documentation/Zone.html
@@ -50,6 +50,7 @@
Process_JTAC Process_Pickup Route
+
Scenery ScheduleDispatcher Scheduler Scoring
@@ -60,8 +61,8 @@
Static Task Task_A2G
+
Task_A2G_Dispatcher Task_PICKUP
-
Task_SEAD Unit Utils Zone
@@ -71,18 +72,14 @@
Module Zone
-<<<<<<< HEAD
-
This module contains the ZONE classes, inherited from Zone#ZONE_BASE .
-
-
-=======
Core - ZONE classes define zones within your mission of various forms , with various capabilities .
+
+
->>>>>>> refs/remotes/origin/master
There are essentially two core functions that zones accomodate:
@@ -115,22 +112,23 @@
This class is an abstract BASE class for derived classes, and is not meant to be instantiated.
-1.1) Each zone has a name:
+1.1) Each zone has a name:
-1.2) Each zone implements two polymorphic functions defined in Zone#ZONE_BASE :
+1.2) Each zone implements two polymorphic functions defined in Zone#ZONE_BASE :
-1.3) A zone has a probability factor that can be set to randomize a selection between zones:
+1.3) A zone has a probability factor that can be set to randomize a selection between zones:
ZONE_BASE.SetRandomizeProbability (): Set the randomization probability of a zone to be selected, taking a value between 0 and 1 ( 0 = 0%, 1 = 100% )ZONE_BASE.GetZoneMaybe (): Get the zone taking into account the randomization probability. nil is returned if this zone is not a candidate.
-1.4) A zone manages Vectors:
+1.4) A zone manages Vectors:
-1.5) A zone has a bounding square:
+1.5) A zone has a bounding square:
-1.6) A zone can be marked:
+1.6) A zone can be marked:
ZONE_BASE.SmokeZone (): Smokes the zone boundaries in a color.The ZONERADIUS class defined by a zone name, a location and a radius.
This class implements the inherited functions from Core.Zone#ZONE BASE taking into account the own zone format and properties.
-
+
-2.2) Manage the radius of the zone:
+2.2) Manage the radius of the zone
-2.3) Manage the location of the zone:
+2.3) Manage the location of the zone
+
+2.4) Zone point randomization
+
+Various functions exist to find random points within the zone.
+
+
The ZONE class, defined by the zone name as defined within the Mission Editor.
This class implements the inherited functions from {Core.Zone#ZONE_RADIUS} taking into account the own zone format and properties.
The ZONE_UNIT class defined by a zone around a Unit#UNIT with a radius.
This class implements the inherited functions from Zone#ZONE_RADIUS taking into account the own zone format and properties.
The ZONE_GROUP class defines by a zone around a Group#GROUP with a radius. The current leader of the group defines the center of the zone.
This class implements the inherited functions from Zone#ZONE_RADIUS taking into account the own zone format and properties.
The ZONEPOLYGON BASE class defined by a sequence of Group#GROUP waypoints within the Mission Editor, forming a polygon.
This class implements the inherited functions from Zone#ZONE_RADIUS taking into account the own zone format and properties.
This class is an abstract BASE class for derived classes, and is not meant to be instantiated.
+6.1) Zone point randomization
+
+Various functions exist to find random points within the zone.
+
+
+
+
The ZONE_POLYGON class defined by a sequence of Group#GROUP waypoints within the Mission Editor, forming a polygon.
This class implements the inherited functions from Zone#ZONE_RADIUS taking into account the own zone format and properties.
@@ -229,6 +254,21 @@ This class implements the inherited functions from ZONE_BASE:GetPointVec3(Height)
Returns a Point#POINT_VEC3 of the zone.
+
+
+
+ ZONE_BASE:GetRandomPointVec2()
+Define a random Point#POINT_VEC2 within the zone.
+
+
+
+ ZONE_BASE:GetRandomPointVec3()
+Define a random Point#POINT_VEC3 within the zone.
@@ -370,13 +422,13 @@ This class implements the inherited functions from ZONE_BASE:IsPointVec2InZone(Vec2)
+ ZONE_BASE:IsVec2InZone(Vec2)
Returns if a location is within the zone.
- ZONE_BASE:IsPointVec3InZone(Vec3) ZONE_BASE:IsVec3InZone(Vec3)
Returns if a point is within the zone.
@@ -494,7 +546,7 @@ This class implements the inherited functions from Type ZONE_POLYGON_BASE
- ZONE_POLYGON_BASE:BoundZone() ZONE_POLYGON_BASE:BoundZone(UnBound)
Smokes the zone boundaries in a color.
@@ -515,6 +567,18 @@ This class implements the inherited functions from ZONE_POLYGON_BASE:GetBoundingSquare()
Get the bounding square the zone.
+
+
+
+ ZONE_POLYGON_BASE:GetRandomPointVec2()
+Return a Point#POINT_VEC2 object representing a random 2D point at landheight within the zone.
+
+
+
+ ZONE_POLYGON_BASE:GetRandomPointVec3()
+Return a Point#POINT_VEC3 object representing a random 3D point at landheight within the zone.
@@ -524,7 +588,7 @@ This class implements the inherited functions from ZONE_POLYGON_BASE:IsPointVec2InZone(Vec2)
+ ZONE_POLYGON_BASE:IsVec2InZone(Vec2)
Returns if a location is within the zone.
@@ -552,7 +616,7 @@ This class implements the inherited functions from Type ZONE_RADIUS
- ZONE_RADIUS:BoundZone(Points) ZONE_RADIUS:BoundZone(Points, UnBound, CountryID)
Bounds the zone with tires.
@@ -573,12 +637,24 @@ This class implements the inherited functions from ZONE_RADIUS:GetRadius()
Returns the radius of the zone.
+
+
+
+ ZONE_RADIUS:GetRandomPointVec2(inner, outer)
+Returns a Point#POINT_VEC2 object reflecting a random 2D location within the zone.
+
+
+
+ ZONE_RADIUS:GetRandomPointVec3(inner, outer)
+Returns a Point#POINT_VEC3 object reflecting a random 3D location within the zone.
ZONE_RADIUS:GetRandomVec2(inner, outer)
-Returns a random location within the zone.
+Returns a random Vec2 location within the zone.
@@ -594,13 +670,13 @@ This class implements the inherited functions from ZONE_RADIUS:IsPointVec2InZone(Vec2)
+ ZONE_RADIUS:IsVec2InZone(Vec2)
Returns if a location is within the zone.
- ZONE_RADIUS:IsPointVec3InZone(Vec3) ZONE_RADIUS:IsVec3InZone(Vec3)
Returns if a point is within the zone.
@@ -965,6 +1041,42 @@ The PointVec3 of the zone.
+
+ZONE_BASE:GetRandomPointVec2()
+
+
+
+
+Define a random Point#POINT_VEC2 within the zone.
+
+ Return value
+
+Core.Point#POINT_VEC2 :
+
+
+
+
+
+
+
+ZONE_BASE:GetRandomPointVec3()
+
+
+
+
+Define a random Point#POINT_VEC3 within the zone.
+
+ Return value
+
+Core.Point#POINT_VEC3 :
+
+
+
+
+
+
ZONE_BASE:GetRandomVec2()
@@ -1074,8 +1186,8 @@ A value between 0 and 1. 0 = 0% and 1 = 100% probability.
-
-ZONE_BASE:IsPointVec2InZone(Vec2)
+
+ZONE_BASE:IsVec2InZone(Vec2)
@@ -1101,8 +1213,8 @@ true if the location is within the zone.
-
-ZONE_BASE:IsPointVec3InZone(Vec3)
+
+ZONE_BASE:IsVec3InZone(Vec3)
@@ -1461,13 +1573,22 @@ self
-ZONE_POLYGON_BASE:BoundZone()
+ZONE_POLYGON_BASE:BoundZone(UnBound)
Smokes the zone boundaries in a color.
+ Parameter
+
Return value
#ZONEPOLYGON BASE :
+
+ZONE_POLYGON_BASE:GetRandomPointVec2()
+
+
+
+
+Return a Point#POINT_VEC2 object representing a random 2D point at landheight within the zone.
+
+ Return value
+
+
+Point#POINT_VEC2
+
+
+
+
+
+
+
+ZONE_POLYGON_BASE:GetRandomPointVec3()
+
+
+
+
+Return a Point#POINT_VEC3 object representing a random 3D point at landheight within the zone.
+
+ Return value
+
+
+Point#POINT_VEC3
+
+
+
+
+
+
ZONE_POLYGON_BASE:GetRandomVec2()
@@ -1546,8 +1703,8 @@ The Vec2 coordinate.
-
-ZONE_POLYGON_BASE:IsPointVec2InZone(Vec2)
+
+ZONE_POLYGON_BASE:IsVec2InZone(Vec2)
@@ -1667,20 +1824,31 @@ self
-ZONE_RADIUS:BoundZone(Points)
+ZONE_RADIUS:BoundZone(Points, UnBound, CountryID)
Bounds the zone with tires.
- Parameter
+ Parameters
Return value
@@ -1764,26 +1932,92 @@ The radius of the zone.
-
-ZONE_RADIUS:GetRandomVec2(inner, outer)
+
+ZONE_RADIUS:GetRandomPointVec2(inner, outer)
-Returns a random location within the zone.
+Returns a Point#POINT_VEC2 object reflecting a random 2D location within the zone.
Parameters
+ Return value
+
+Core.Point#POINT_VEC2 :Point#POINT_VEC2 object reflecting the random 3D location within the zone.
+
+
+
+
+
+
+
+ZONE_RADIUS:GetRandomPointVec3(inner, outer)
+
+
+
+
+Returns a Point#POINT_VEC3 object reflecting a random 3D location within the zone.
+
+ Parameters
+
+ Return value
+
+Core.Point#POINT_VEC3 :Point#POINT_VEC3 object reflecting the random 3D location within the zone.
+
+
+
+
+
+
+
+ZONE_RADIUS:GetRandomVec2(inner, outer)
+
+
+
+
+Returns a random Vec2 location within the zone.
+
+ Parameters
+
@@ -1842,8 +2076,8 @@ The point of the zone.
-
-ZONE_RADIUS:IsPointVec2InZone(Vec2)
+
+ZONE_RADIUS:IsVec2InZone(Vec2)
@@ -1869,8 +2103,8 @@ true if the location is within the zone.
-
-ZONE_RADIUS:IsPointVec3InZone(Vec3)
+
+ZONE_RADIUS:IsVec3InZone(Vec3)
diff --git a/docs/Documentation/index.html b/docs/Documentation/index.html
index 36f072d2f..2bda7fee8 100644
--- a/docs/Documentation/index.html
+++ b/docs/Documentation/index.html
@@ -61,8 +61,8 @@
Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone Scheduler
-This module contains the SCHEDULER class.
+Core - SCHEDULER prepares and handles the execution of functions over scheduled time (intervals) .
@@ -402,19 +402,19 @@ and creates a CSV file logging the scoring events and results for use at team or
Task_A2G
-(AI) (SP) (MP) Tasking for Air to Ground Processes.
+This module contains the TASK_A2G classes.
+
+
+
+ Task_A2G_Dispatcher
+Tasking - The TASKA2G DISPATCHER creates and manages player TASK_A2G tasks based on detected targets.
Task_PICKUP
This module contains the TASK_PICKUP classes.
-
-
-
- Task_SEAD
-This module contains the TASK_SEAD classes.
diff --git a/docs/Documentation/routines.html b/docs/Documentation/routines.html
index ba89d2875..70d5e3c47 100644
--- a/docs/Documentation/routines.html
+++ b/docs/Documentation/routines.html
@@ -61,8 +61,8 @@
Static Task Task_A2G Task_A2G_Dispatcher Task_PICKUP Task_SEAD Unit Utils Zone
