diff --git a/Moose Development/Moose/Core/Base.lua b/Moose Development/Moose/Core/Base.lua
index c36ea3405..d2047524e 100644
--- a/Moose Development/Moose/Core/Base.lua
+++ b/Moose Development/Moose/Core/Base.lua
@@ -269,6 +269,19 @@ function BASE:Inherit( Child, Parent )
return Child
end
+
+local function getParent( Child )
+ local Parent = nil
+
+ if rawget( Child, "__" ) then
+ Parent = getmetatable( Child.__ ).__index
+ else
+ Parent = getmetatable( Child ).__index
+ end
+ return Parent
+end
+
+
--- This is the worker method to retrieve the Parent class.
-- Note that the Parent class must be passed to call the parent class method.
--
@@ -278,17 +291,27 @@ end
-- @param #BASE self
-- @param #BASE Child is the Child class from which the Parent class needs to be retrieved.
-- @return #BASE
-function BASE:GetParent( Child )
+function BASE:GetParent( Child, FromClass )
+
+
local Parent
-- BASE class has no parent
if Child.ClassName == 'BASE' then
Parent = nil
- elseif rawget( Child, "__" ) then
- Parent = getmetatable( Child.__ ).__index
- else
- Parent = getmetatable( Child ).__index
- end
- return Parent
+ else
+
+ self:E({FromClass = FromClass})
+ self:E({Child = Child.ClassName})
+ if FromClass then
+ while( Child.ClassName ~= FromClass.ClassName ) do
+ Child = getParent( Child )
+ self:E({Child.ClassName})
+ end
+ end
+ Parent = getParent( Child )
+ end
+ self:E({Parent.ClassName})
+ return Parent
end
--- This is the worker method to check if an object is an (sub)instance of a class.
@@ -334,7 +357,7 @@ function BASE:IsInstanceOf( ClassName )
return true
end
- local Parent = self:GetParent(self)
+ local Parent = getParent(self)
while Parent do
@@ -342,7 +365,7 @@ function BASE:IsInstanceOf( ClassName )
return true
end
- Parent = Parent:GetParent(Parent)
+ Parent = getParent(Parent)
end
diff --git a/Moose Development/Moose/Core/Goal.lua b/Moose Development/Moose/Core/Goal.lua
index 711609bff..67aa91930 100644
--- a/Moose Development/Moose/Core/Goal.lua
+++ b/Moose Development/Moose/Core/Goal.lua
@@ -77,8 +77,6 @@ do -- Goal
-- @param #string Event
-- @param #string To
- GOAL.States.On = "On"
-
end
do
@@ -101,13 +99,10 @@ do -- Goal
-- @param #string Event
-- @param #string To
- GOAL.States.Off = "Off"
-
end
--- Achieved State for GOAL
-- @field GOAL.Achieved
- GOAL.States.Achieved = "Achieved"
--- Achieved State Handler OnLeave for GOAL
-- @function [parent=#GOAL] OnLeaveAchieved
@@ -125,8 +120,8 @@ do -- Goal
-- @param #string To
- self:SetStartState( GOAL.States.Off )
- self:AddTransition( GOAL.States.Off, "Start", GOAL.States.On )
+ self:SetStartState( "Idle" )
+ self:AddTransition( "Idle", "Start", "On" )
--- Start Handler OnBefore for GOAL
-- @function [parent=#GOAL] OnBeforeStart
@@ -152,7 +147,7 @@ do -- Goal
-- @param #GOAL self
-- @param #number Delay
- self:AddTransition( GOAL.States.On, "Stop", GOAL.States.Off )
+ self:AddTransition( "On", "Stop", "Idle" )
--- Stop Handler OnBefore for GOAL
-- @function [parent=#GOAL] OnBeforeStop
@@ -179,7 +174,7 @@ do -- Goal
-- @param #number Delay
- self:AddTransition( GOAL.States.On, "IsAchieved", GOAL.States.On )
+ self:AddTransition( "On", "IsAchieved", "On" )
--- IsAchieved Handler OnBefore for GOAL
-- @function [parent=#GOAL] OnBeforeIsAchieved
@@ -205,7 +200,7 @@ do -- Goal
-- @param #GOAL self
-- @param #number Delay
- self:AddTransition( GOAL.States.On, "Achieved", GOAL.States.Achieved )
+ self:AddTransition( "On", "Achieved", "Achieved" )
--- Achieved Handler OnBefore for GOAL
-- @function [parent=#GOAL] OnBeforeAchieved
diff --git a/Moose Development/Moose/Core/ZoneGoal.lua b/Moose Development/Moose/Core/ZoneGoal.lua
index 0ad882ab2..59d34ca94 100644
--- a/Moose Development/Moose/Core/ZoneGoal.lua
+++ b/Moose Development/Moose/Core/ZoneGoal.lua
@@ -10,15 +10,15 @@
--
-- ====
--
--- @module Zone
+-- @module ZoneGoal
do -- Zone
--- @type ZONE_GOAL
- -- @extends Core.Goal#GOAL
+ -- @extends Core.Fsm#FSM
- --- # ZONE_GOAL class, extends @{Goal#GOAL}
+ --- # ZONE_GOAL class, extends @{Fsm#FSM}
--
-- ZONE_GOAL models processes that have an objective with a defined achievement involving a Zone. Derived classes implement the ways how the achievements can be realized.
--
@@ -56,7 +56,8 @@ do -- Zone
self:F( { Zone = Zone } )
self.Zone = Zone -- Core.Zone#ZONE_BASE
- self.Goal = GOAL:New():Start()
+ self.Goal = GOAL:New()
+ self.Goal:Start()
do
@@ -75,8 +76,6 @@ do -- Zone
-- @param #string Event
-- @param #string To
- ZONE_GOAL.States.Guarded = "Guarded"
-
end
@@ -97,12 +96,10 @@ do -- Zone
-- @param #string Event
-- @param #string To
- ZONE_GOAL.States.Empty = "Empty"
-
end
- self:AddTransition( "*", "Guard", ZONE_GOAL.States.Guarded )
+ self:AddTransition( "*", "Guard", "Guarded" )
--- Guard Handler OnBefore for ZONE_GOAL
-- @function [parent=#ZONE_GOAL] OnBeforeGuard
@@ -128,7 +125,7 @@ do -- Zone
-- @param #ZONE_GOAL self
-- @param #number Delay
- self:AddTransition( "*", "Empty", ZONE_GOAL.States.Empty )
+ self:AddTransition( "*", "Empty", "Empty" )
--- Empty Handler OnBefore for ZONE_GOAL
-- @function [parent=#ZONE_GOAL] OnBeforeEmpty
@@ -228,15 +225,16 @@ do -- Zone
-- @param #ZONE_GOAL self
function ZONE_GOAL:StatusZone()
+ local State = self:GetState()
self:E( { State = self:GetState() } )
self.Zone:Scan()
- if self:IsGuarded() then
+ if State ~= "Guarded" and self:IsGuarded() then
self:Guard()
end
- if self:IsEmpty() then
+ if State ~= "Empty" and self:IsEmpty() then
self:Empty()
end
diff --git a/Moose Development/Moose/Core/ZoneGoalCoalition.lua b/Moose Development/Moose/Core/ZoneGoalCoalition.lua
index 152b8388d..e0437433b 100644
--- a/Moose Development/Moose/Core/ZoneGoalCoalition.lua
+++ b/Moose Development/Moose/Core/ZoneGoalCoalition.lua
@@ -2,7 +2,8 @@
--
-- ====
--
--- ZONE_GOAL_COALITION models processes that have an objective with a defined achievement involving a Zone. Derived classes implement the ways how the achievements can be realized.
+-- ZONE_GOAL_COALITION models processes that have a Goal with a defined achievement involving a Zone for a Coalition.
+-- Derived classes implement the ways how the achievements can be realized.
--
-- ====
--
@@ -10,17 +11,18 @@
--
-- ====
--
--- @module ZoneGoal
+-- @module ZoneGoalCoalition
do -- ZoneGoal
--- @type ZONE_GOAL_COALITION
- -- @extends Core.Goal#ZONE_GOAL_COALITION
+ -- @extends Core.ZoneGoal#ZONE_GOAL
- --- # ZONE_GOAL_COALITION class, extends @{Goal#GOAL}
+ --- # ZONE_GOAL_COALITION class, extends @{ZoneGoal#ZONE_GOAL}
--
- -- ZONE_GOAL_COALITION models processes that have an objective with a defined achievement involving a Zone. Derived classes implement the ways how the achievements can be realized.
+ -- ZONE_GOAL_COALITION models processes that have a Goal with a defined achievement involving a Zone for a Coalition.
+ -- Derived classes implement the ways how the achievements can be realized.
--
-- ## 1. ZONE_GOAL_COALITION constructor
--
@@ -29,16 +31,26 @@ do -- ZoneGoal
-- ## 2. ZONE_GOAL_COALITION is a finite state machine (FSM).
--
-- ### 2.1 ZONE_GOAL_COALITION States
- --
- -- * **Off**: The goal is not timely measured.
- -- * **On**: The goal is timely being measured.
- -- * **Achieved**: The objective is achieved.
+ --
+ -- * **Captured**: The Zone has been captured by an other coalition.
+ -- * **Attacked**: The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone.
+ -- * **Guarded**: The Zone is guarded by the owning coalition. There is no other unit of an other coalition in the Zone.
+ -- * **Empty**: The Zone is empty. There is not valid unit in the Zone.
--
-- ### 2.2 ZONE_GOAL_COALITION Events
--
- -- * **@{#ZONE_GOAL_COALITION.Start}()**: Start Measuring the Goal.
- -- * **@{#ZONE_GOAL_COALITION.Stop}()**: Stop Measuring the Goal.
- -- * **@{#ZONE_GOAL_COALITION.IsAchieved}()**: Check if the Goal is Achieved.
+ -- * **Capture**: The Zone has been captured by an other coalition.
+ -- * **Attack**: The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone.
+ -- * **Guard**: The Zone is guarded by the owning coalition. There is no other unit of an other coalition in the Zone.
+ -- * **Empty**: The Zone is empty. There is not valid unit in the Zone.
+ --
+ -- ### 2.3 ZONE_GOAL_COALITION State Machine
+ --
+ --
+ --
+ -- Hello | World
+ -- ------|------
+ -- Test|Test2
--
-- @field #ZONE_GOAL_COALITION
ZONE_GOAL_COALITION = {
@@ -77,8 +89,6 @@ do -- ZoneGoal
-- @param #string Event
-- @param #string To
- ZONE_GOAL_COALITION.States.Captured = "Captured"
-
end
@@ -99,13 +109,13 @@ do -- ZoneGoal
-- @param #string Event
-- @param #string To
- ZONE_GOAL_COALITION.States.Attacked = "Attacked"
-
end
+
+ self:E( { Guarded = "Guarded" } )
- self:AddTransition( { ZONE_GOAL_COALITION.States.Guarded, ZONE_GOAL_COALITION.States.Empty }, "Attack", ZONE_GOAL_COALITION.States.Attacked )
+ self:AddTransition( { "Guarded", "Empty" }, "Attack", "Attacked" )
--- Attack Handler OnBefore for ZONE_GOAL_COALITION
-- @function [parent=#ZONE_GOAL_COALITION] OnBeforeAttack
@@ -131,7 +141,7 @@ do -- ZoneGoal
-- @param #ZONE_GOAL_COALITION self
-- @param #number Delay
- self:AddTransition( { ZONE_GOAL_COALITION.States.Guarded, ZONE_GOAL_COALITION.States.Attacked, ZONE_GOAL_COALITION.States.Empty }, "Capture", ZONE_GOAL_COALITION.States.Captured )
+ self:AddTransition( { "Guarded", "Attacked", "Empty" }, "Capture", "Captured" )
--- Capture Handler OnBefore for ZONE_GOAL_COALITION
-- @function [parent=#ZONE_GOAL_COALITION] OnBeforeCapture
@@ -265,7 +275,7 @@ do -- ZoneGoal
--self:GetParent( self ):onenterCaptured()
- local NewCoalition = self.ProtectZone:GetCoalition()
+ local NewCoalition = self.Zone:GetCoalition()
self:E( { NewCoalition = NewCoalition } )
self:SetCoalition( NewCoalition )
@@ -324,15 +334,16 @@ do -- ZoneGoal
-- @param #ZONE_GOAL_COALITION self
function ZONE_GOAL_COALITION:StatusZone()
+ local State = self:GetState()
self:E( { State = self:GetState() } )
- self:GetParent( self ):StatusZone()
+ self:GetParent( self, ZONE_GOAL_COALITION ).StatusZone( self )
- if self:IsAttacked() then
+ if State ~= "Attacked" and self:IsAttacked() then
self:Attack()
end
- if self:IsCaptured() then
+ if State ~= "Captured" and self:IsCaptured() then
self:Capture()
end
diff --git a/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua b/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua
index 27cf8d615..c80b409bc 100644
--- a/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua
+++ b/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua
@@ -18,7 +18,7 @@ do -- ZoneGoal
-- @extends Core.ZoneGoalCoalition#ZONE_GOAL_COALITION
- --- # ZONE_CAPTURE_COALITION class, extends @{Goal#GOAL}
+ --- # ZONE_CAPTURE_COALITION class, extends @{ZoneGoalCoalition#ZONE_GOAL_COALITION}
--
-- ZONE_CAPTURE_COALITION models processes that have an objective with a defined achievement involving a Zone. Derived classes implement the ways how the achievements can be realized.
--
@@ -50,7 +50,7 @@ do -- ZoneGoal
local self = BASE:Inherit( self, ZONE_GOAL_COALITION:New( Zone, Coalition ) ) -- #ZONE_CAPTURE_COALITION
self:F( { Zone = Zone, Coalition = Coalition } )
-
+
return self
end
diff --git a/docs/Documentation/AI_A2A.html b/docs/Documentation/AI_A2A.html
index 80b5691bd..405037841 100644
--- a/docs/Documentation/AI_A2A.html
+++ b/docs/Documentation/AI_A2A.html
@@ -60,6 +60,7 @@
Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines AIPATROL ZONE.M
-
- This table contains the targets detected during patrol.
-
diff --git a/docs/Documentation/Account.html b/docs/Documentation/Account.html
index 67a542954..87a5e5499 100644
--- a/docs/Documentation/Account.html
+++ b/docs/Documentation/Account.html
@@ -60,6 +60,7 @@
Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines BASE:OnEventTakeoff(EventData)
Occurs when an aircraft takes off from an airbase, farp, or ship.
+
+
+
+ BASE:ScheduleOnce(Start, SchedulerFunction, ...)
+Schedule a new time event.
+
+
+
+ BASE:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)
+Schedule a new time event.
+
+
+
+ BASE:ScheduleStop(SchedulerFunction)
+Stops the Schedule.
+
+
+
+ BASE.SchedulerObject
+
@@ -485,6 +515,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
BASE:UnHandleEvent(Event)
UnSubscribe to a DCS event.
+
+
+
+ BASE._
+
@@ -1900,6 +1936,144 @@ The EventData structure.
+
+
+
+
+
+
+BASE:ScheduleOnce(Start, SchedulerFunction, ...)
+
+
+
+
+Schedule a new time event.
+
+
+Note that the schedule will only take place if the scheduler is started . Even for a single schedule event, the scheduler needs to be started also.
+
+ Parameters
+
+
+
+#number Start
+
+
+
+
+#function SchedulerFunction
+
+
+
+
+#table ...
+
+
+
+ Return value
+
+#number:
+The ScheduleID of the planned schedule.
+
+
+
+
+
+
+
+BASE:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)
+
+
+
+
+Schedule a new time event.
+
+
+Note that the schedule will only take place if the scheduler is started . Even for a single schedule event, the scheduler needs to be started also.
+
+ Parameters
+
+
+
+#number Start
+
+
+
+
+#number Repeat
+
+
+
+
+#number RandomizeFactor
+
+
+
+
+#number Stop
+
+
+
+
+#function SchedulerFunction
+
+
+
+
+#table ...
+
+
+
+ Return value
+
+#number:
+The ScheduleID of the planned schedule.
+
+
+
+
+
+
+
+BASE:ScheduleStop(SchedulerFunction)
+
+
+
+
+Stops the Schedule.
+
+ Parameter
+
+
+
+
+
+
+
+BASE.SchedulerObject
+
+
+
+
+
+
@@ -2209,6 +2383,20 @@ BASE:TraceOnOff( false )
#BASE :
+
+
+
+
+
+ #BASE._
+BASE._
+
+
+
+
+
+
@@ -2320,6 +2508,8 @@ A #table or any field.
+
+
diff --git a/docs/Documentation/Cargo.html b/docs/Documentation/Cargo.html
index e1ae98516..d60d35ba4 100644
--- a/docs/Documentation/Cargo.html
+++ b/docs/Documentation/Cargo.html
@@ -60,6 +60,7 @@
Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines
+
CARGO_UNIT.CargoCarrier
@@ -3543,7 +3550,6 @@ The range till cargo will board.
- #number
CARGO_UNIT.RunCount
diff --git a/docs/Documentation/CleanUp.html b/docs/Documentation/CleanUp.html
index 4fd8e2211..ac5588ab4 100644
--- a/docs/Documentation/CleanUp.html
+++ b/docs/Documentation/CleanUp.html
@@ -60,6 +60,7 @@
Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines
+
DESIGNATE.LaserCodes
diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html
index da950516a..10b6e448e 100644
--- a/docs/Documentation/Detection.html
+++ b/docs/Documentation/Detection.html
@@ -60,6 +60,7 @@
Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines
- #number
DETECTION_BASE.RefreshTimeInterval
diff --git a/docs/Documentation/DetectionManager.html b/docs/Documentation/DetectionManager.html
index fada6894a..138fb4a00 100644
--- a/docs/Documentation/DetectionManager.html
+++ b/docs/Documentation/DetectionManager.html
@@ -60,6 +60,7 @@
Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort
Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event
Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm
+ Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines
- #string
FSM._StartState
@@ -1898,7 +1904,6 @@ A string defining the start state.
-
FSM.current
diff --git a/docs/Documentation/Goal.html b/docs/Documentation/Goal.html
new file mode 100644
index 000000000..b4075db2f
--- /dev/null
+++ b/docs/Documentation/Goal.html
@@ -0,0 +1,1190 @@
+
+
+
+
+
+
+
+
+
Module Goal
+
+
Core -- Base class that models processes to achieve goals.
+
+
+
+
+
+
GOAL models processes that have an objective with a defined achievement. Derived classes implement the ways how the achievements can be realized.
+
+
+
+
Author: Sven Van de Velde (FlightControl)
+
+
+
+
+
Global(s)
+
+
+ GOAL
+GOAL class, extends Fsm#FSM
+
+GOAL models processes that have an objective with a defined achievement.
+
+
+
+
+
+
+ GOAL:Achieved()
+Achieved Trigger for GOAL
+
+
+
+ GOAL.AchievedScheduler
+
+
+
+
+ GOAL.ArchievedScheduler
+
+
+
+
+ GOAL:CheckAchieved(From, Event, To)
+
+
+
+
+ GOAL.FsmStateAchieved
+
+
+
+
+ GOAL.FsmStateOff
+
+
+
+
+ GOAL.FsmStateOn
+
+
+
+
+ GOAL:IsAchieved()
+IsAchieved Trigger for GOAL
+
+
+
+ GOAL:New()
+GOAL Constructor.
+
+
+
+ GOAL:OnAfterAchieved(From, Event, To)
+Achieved Handler OnAfter for GOAL
+
+
+
+ GOAL:OnAfterIsAchieved(From, Event, To)
+IsAchieved Handler OnAfter for GOAL
+
+
+
+ GOAL:OnAfterStart(From, Event, To)
+Start Handler OnAfter for GOAL
+
+
+
+ GOAL:OnAfterStop(From, Event, To)
+Stop Handler OnAfter for GOAL
+
+
+
+ GOAL:OnBeforeAchieved(From, Event, To)
+Achieved Handler OnBefore for GOAL
+
+
+
+ GOAL:OnBeforeIsAchieved(From, Event, To)
+IsAchieved Handler OnBefore for GOAL
+
+
+
+ GOAL:OnBeforeStart(From, Event, To)
+Start Handler OnBefore for GOAL
+
+
+
+ GOAL:OnBeforeStop(From, Event, To)
+Stop Handler OnBefore for GOAL
+
+
+
+ GOAL:OnEnterAchieved(From, Event, To)
+Achieved State Handler OnEnter for GOAL
+
+
+
+ GOAL:OnEnterOff(From, Event, To)
+Off State Handler OnEnter for GOAL
+
+
+
+ GOAL:OnEnterOn(From, Event, To)
+On State Handler OnEnter for GOAL
+
+
+
+ GOAL:OnLeaveAchieved(From, Event, To)
+Achieved State Handler OnLeave for GOAL
+
+
+
+ GOAL:OnLeaveOff(From, Event, To)
+Off State Handler OnLeave for GOAL
+
+
+
+ GOAL:OnLeaveOn(From, Event, To)
+On State Handler OnLeave for GOAL
+
+
+
+ GOAL:Start()
+Start Trigger for GOAL
+
+
+
+ GOAL.States
+
+
+
+
+ GOAL:Stop()
+Stop Trigger for GOAL
+
+
+
+ GOAL:__Achieved(Delay)
+Achieved Asynchronous Trigger for GOAL
+
+
+
+ GOAL:__IsAchieved(Delay)
+IsAchieved Asynchronous Trigger for GOAL
+
+
+
+ GOAL:__Start(Delay)
+Start Asynchronous Trigger for GOAL
+
+
+
+ GOAL:__Stop(Delay)
+Stop Asynchronous Trigger for GOAL
+
+
+
+ GOAL:onafterOff(From, Event, To)
+
+
+
+
+ GOAL:onafterOn(From, Event, To)
+
+
+
+
+
+
Global(s)
+
+
+
+ #GOAL
+GOAL
+
+
+
+
+GOAL class, extends Fsm#FSM
+
+GOAL models processes that have an objective with a defined achievement.
+
+
+Derived classes implement the ways how the achievements can be realized.
+
+1. GOAL constructor
+
+
+ GOAL.New (): Creates a new GOAL object.
+
+2. GOAL is a finite state machine (FSM).
+
+2.1 GOAL States
+
+
+ Off : The goal is not timely measured.On : The goal is timely being measured.Achieved : The objective is achieved.
+
+2.2 GOAL Events
+
+
+
+
+
+
+
+
+
+
Field(s)
+
+
+
+
+GOAL:Achieved()
+
+
+
+
+Achieved Trigger for GOAL
+
+
+
+
+
+
+
+GOAL.AchievedScheduler
+
+
+
+
+
+
+
+
+
+
+
+
+GOAL.ArchievedScheduler
+
+
+
+
+
+
+
+
+
+
+
+
+GOAL:CheckAchieved(From, Event, To)
+
+
+
+
+
+
+ Parameters
+
+
+
+ From
+
+
+
+
+ Event
+
+
+
+
+ To
+
+
+
+
+
+
+
+
+ #string
+
+GOAL.FsmStateAchieved
+
+
+
+
+
+
+
+
+
+
+
+ #string
+
+GOAL.FsmStateOff
+
+
+
+
+
+
+
+
+
+
+
+ #string
+
+GOAL.FsmStateOn
+
+
+
+
+
+
+
+
+
+
+
+
+GOAL:IsAchieved()
+
+
+
+
+IsAchieved Trigger for GOAL
+
+
+
+
+
+
+
+GOAL:New()
+
+
+
+
+GOAL Constructor.
+
+ Return value
+
+#GOAL :
+
+
+
+
+
+
+
+
+GOAL:OnAfterAchieved(From, Event, To)
+
+
+
+
+Achieved Handler OnAfter for GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+
+
+
+
+
+
+GOAL:OnAfterIsAchieved(From, Event, To)
+
+
+
+
+IsAchieved Handler OnAfter for GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+
+
+
+
+
+
+GOAL:OnAfterStart(From, Event, To)
+
+
+
+
+Start Handler OnAfter for GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+
+
+
+
+
+
+GOAL:OnAfterStop(From, Event, To)
+
+
+
+
+Stop Handler OnAfter for GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+
+
+
+
+
+
+GOAL:OnBeforeAchieved(From, Event, To)
+
+
+
+
+Achieved Handler OnBefore for GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+GOAL:OnBeforeIsAchieved(From, Event, To)
+
+
+
+
+IsAchieved Handler OnBefore for GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+GOAL:OnBeforeStart(From, Event, To)
+
+
+
+
+Start Handler OnBefore for GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+GOAL:OnBeforeStop(From, Event, To)
+
+
+
+
+Stop Handler OnBefore for GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+GOAL:OnEnterAchieved(From, Event, To)
+
+
+
+
+Achieved State Handler OnEnter for GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+
+
+
+
+
+
+GOAL:OnEnterOff(From, Event, To)
+
+
+
+
+Off State Handler OnEnter for GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+
+
+
+
+
+
+GOAL:OnEnterOn(From, Event, To)
+
+
+
+
+On State Handler OnEnter for GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+
+
+
+
+
+
+GOAL:OnLeaveAchieved(From, Event, To)
+
+
+
+
+Achieved State Handler OnLeave for GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+GOAL:OnLeaveOff(From, Event, To)
+
+
+
+
+Off State Handler OnLeave for GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+GOAL:OnLeaveOn(From, Event, To)
+
+
+
+
+On State Handler OnLeave for GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+GOAL:Start()
+
+
+
+
+Start Trigger for GOAL
+
+
+
+
+
+
+
+GOAL.States
+
+
+
+
+
+
+
+
+
+
+
+
+GOAL:Stop()
+
+
+
+
+Stop Trigger for GOAL
+
+
+
+
+
+
+
+GOAL:__Achieved(Delay)
+
+
+
+
+Achieved Asynchronous Trigger for GOAL
+
+ Parameter
+
+
+
+#number Delay
+
+
+
+
+
+
+
+
+
+GOAL:__IsAchieved(Delay)
+
+
+
+
+IsAchieved Asynchronous Trigger for GOAL
+
+ Parameter
+
+
+
+#number Delay
+
+
+
+
+
+
+
+
+
+GOAL:__Start(Delay)
+
+
+
+
+Start Asynchronous Trigger for GOAL
+
+ Parameter
+
+
+
+#number Delay
+
+
+
+
+
+
+
+
+
+GOAL:__Stop(Delay)
+
+
+
+
+Stop Asynchronous Trigger for GOAL
+
+ Parameter
+
+
+
+#number Delay
+
+
+
+
+
+
+
+
+
+GOAL:onafterOff(From, Event, To)
+
+
+
+
+
+
+ Parameters
+
+
+
+ From
+
+
+
+
+ Event
+
+
+
+
+ To
+
+
+
+
+
+
+
+
+
+GOAL:onafterOn(From, Event, To)
+
+
+
+
+
+
+ Parameters
+
+
+
+ From
+
+
+
+
+ Event
+
+
+
+
+ To
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/Documentation/Group.html b/docs/Documentation/Group.html
index ab3cd39d0..9028b1bc4 100644
--- a/docs/Documentation/Group.html
+++ b/docs/Documentation/Group.html
@@ -60,6 +60,7 @@
Escort Event Fsm
+
Goal Group
Identifiable Menu
@@ -72,6 +73,7 @@
Positionable Process_JTAC Process_Pickup
+
Protect Radio Rat Route
@@ -95,9 +97,13 @@
Task_A2G_Dispatcher Task_Cargo Task_PICKUP
+
Task_Protect Unit Utils Zone
+
ZoneCaptureCoalition
+
ZoneGoal
+
ZoneGoalCoalition env land routines
diff --git a/docs/Documentation/Identifiable.html b/docs/Documentation/Identifiable.html
index 9ff17c120..8db30255f 100644
--- a/docs/Documentation/Identifiable.html
+++ b/docs/Documentation/Identifiable.html
@@ -60,6 +60,7 @@
Escort Event Fsm
+
Goal Group Identifiable
Menu
@@ -72,6 +73,7 @@
Positionable Process_JTAC Process_Pickup
+
Protect Radio Rat Route
@@ -95,9 +97,13 @@
Task_A2G_Dispatcher Task_Cargo Task_PICKUP
+
Task_Protect Unit Utils Zone
+
ZoneCaptureCoalition
+
ZoneGoal
+
ZoneGoalCoalition env land routines
@@ -158,6 +164,12 @@
IDENTIFIABLE:GetCoalition()
Returns coalition of the Identifiable.
+
+
+
+ IDENTIFIABLE:GetCoalitionName()
+Returns the name of the coalition of the Identifiable.
@@ -335,6 +347,34 @@ The DCS Identifiable is not existing or alive.
+
+IDENTIFIABLE:GetCoalitionName()
+
+
+
+
+Returns the name of the coalition of the Identifiable.
+
+ Return values
+
+
+
+#string:
+The name of the coalition.
+
+
+
+
+#nil:
+The DCS Identifiable is not existing or alive.
+
+
+
+
+
+
+
+
IDENTIFIABLE:GetCountry()
diff --git a/docs/Documentation/Menu.html b/docs/Documentation/Menu.html
index be629eda7..beb816a72 100644
--- a/docs/Documentation/Menu.html
+++ b/docs/Documentation/Menu.html
@@ -60,6 +60,7 @@
Escort Event Fsm Goal Group Identifiable Menu
@@ -72,6 +73,7 @@
Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines
+ #string
MESSAGE.MessageCategory
@@ -316,6 +323,9 @@ To send messages, you need to use the To functions.
+
+ self.MessageType .. ": "
+
diff --git a/docs/Documentation/MissileTrainer.html b/docs/Documentation/MissileTrainer.html
index 0b8a44d5b..960aa20f7 100644
--- a/docs/Documentation/MissileTrainer.html
+++ b/docs/Documentation/MissileTrainer.html
@@ -60,6 +60,7 @@
Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines
+
POINT_VEC2.z
diff --git a/docs/Documentation/Positionable.html b/docs/Documentation/Positionable.html
index e531312d4..60389de0c 100644
--- a/docs/Documentation/Positionable.html
+++ b/docs/Documentation/Positionable.html
@@ -60,6 +60,7 @@
Escort Event Fsm Goal Group Identifiable Menu Positionable
Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC
Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup
+ Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines
+
+
+
+
+
Module Protect
+
+
Functional -- The PROTECT class handles the protection of objects, which can be zones, units, scenery.
+
+
+
+
+
+
Author: Sven Van de Velde (FlightControl)
+
Contributions: MillerTime
+
+
+
+
+
Global(s)
+
+
+
+
+
Global(s)
+
+
+
+ #PROTECT
+PROTECT
+
+
+
+
+
+
+
+
+
+
+
+
+
Field(s)
+
+
+
+
+PROTECT:AreProtectStaticsAlive()
+
+
+
+
+Check if the statics are still alive.
+
+
+
+
+
+
+
+PROTECT:AreProtectUnitsAlive()
+
+
+
+
+Check if the units are still alive.
+
+
+
+
+
+
+
+PROTECT.Coalition
+
+
+
+
+
+
+
+
+
+
+
+
+PROTECT:Flare(FlareColor)
+
+
+
+
+Flare.
+
+ Parameter
+
+
+
+
+
+
+
+PROTECT:GetCoalition()
+
+
+
+
+Get the owning coalition of the zone.
+
+ Return value
+
+DCSCoalition.DCSCoalition#coalition :
+
+
+
+
+
+
+
+PROTECT:GetCoalitionName()
+
+
+
+
+Get the owning coalition name of the zone.
+
+ Return value
+
+#string:
+Coalition name.
+
+
+
+
+
+
+
+PROTECT:GetProtectZone()
+
+
+
+
+Get the ProtectZone
+
+ Return value
+
+Core.Zone#ZONE_BASE :
+
+
+
+
+
+
+
+
+PROTECT:GetProtectZoneName()
+
+
+
+
+Get the name of the ProtectZone
+
+ Return value
+
+#string:
+
+
+
+
+
+
+
+
+PROTECT:IsAttacked()
+
+
+
+
+
+
+
+
+
+
+
+
+PROTECT:IsCaptureUnitInZone()
+
+
+
+
+Check if there is a capture unit in the zone.
+
+
+
+
+
+
+
+PROTECT:IsCaptured()
+
+
+
+
+
+
+
+
+
+
+
+
+PROTECT:IsEmpty()
+
+
+
+
+
+
+
+
+
+
+
+
+PROTECT:IsGuarded()
+
+
+
+
+
+
+
+
+
+
+
+
+PROTECT:Mark()
+
+
+
+
+Mark.
+
+
+
+
+
+
+
+PROTECT.MarkBlue
+
+
+
+
+
+
+
+
+
+
+
+
+PROTECT.MarkRed
+
+
+
+
+
+
+
+
+
+
+
+
+PROTECT:SetCoalition(Coalition)
+
+
+
+
+Set the owning coalition of the zone.
+
+ Parameter
+
+
+
+
+
+
+
+PROTECT:Smoke(SmokeColor)
+
+
+
+
+Smoke.
+
+ Parameter
+
+
+
+
+
+
+
+PROTECT.SmokeColor
+
+
+
+
+
+
+
+
+
+
+
+
+PROTECT.SmokeTime
+
+
+
+
+
+
+
+self.SmokeColor = nil
+
+
+
+
+
+
+
+PROTECT:StatusCoalition()
+
+
+
+
+Check status Coalition ownership.
+
+
+
+
+
+
+
+PROTECT:StatusSmoke()
+
+
+
+
+Check status Smoke.
+
+
+
+
+
+
+
+PROTECT:StatusZone()
+
+
+
+
+Check status Zone.
+
+
+
+
+
+
+
+PROTECT:onafterStart()
+
+
+
+
+Bound.
+
+
+
+
+
+
+
+PROTECT:onenterAttacked()
+
+
+
+
+
+
+
+
+
+
+
+
+PROTECT:onenterCaptured()
+
+
+
+
+
+
+
+
+
+
+
+
+PROTECT:onenterEmpty()
+
+
+
+
+
+
+
+
+
+
+
+
+PROTECT:onenterGuarded()
+
+
+
+
+Bound.
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/Documentation/Radio.html b/docs/Documentation/Radio.html
index 5fc5b4646..680ce4efa 100644
--- a/docs/Documentation/Radio.html
+++ b/docs/Documentation/Radio.html
@@ -60,6 +60,7 @@
Escort Event Fsm
+
Goal Group Identifiable Menu
@@ -72,6 +73,7 @@
Positionable Process_JTAC Process_Pickup
+
Protect Radio
Rat Route
@@ -95,9 +97,13 @@
Task_A2G_Dispatcher Task_Cargo Task_PICKUP
+
Task_Protect Unit Utils Zone
+
ZoneCaptureCoalition
+
ZoneGoal
+
ZoneGoalCoalition env land routines
diff --git a/docs/Documentation/Rat.html b/docs/Documentation/Rat.html
index f055b5df2..2b22f2198 100644
--- a/docs/Documentation/Rat.html
+++ b/docs/Documentation/Rat.html
@@ -60,6 +60,7 @@
Escort Event Fsm
+
Goal Group Identifiable Menu
@@ -72,6 +73,7 @@
Positionable Process_JTAC Process_Pickup
+
Protect Radio Rat
Route
@@ -95,9 +97,13 @@
Task_A2G_Dispatcher Task_Cargo Task_PICKUP
+
Task_Protect Unit Utils Zone
+
ZoneCaptureCoalition
+
ZoneGoal
+
ZoneGoalCoalition env land routines
diff --git a/docs/Documentation/Route.html b/docs/Documentation/Route.html
index 2874fa7d7..8497006e2 100644
--- a/docs/Documentation/Route.html
+++ b/docs/Documentation/Route.html
@@ -60,6 +60,7 @@
Escort Event Fsm
+
Goal Group Identifiable Menu
@@ -72,6 +73,7 @@
Positionable Process_JTAC Process_Pickup
+
Protect Radio Rat Route
@@ -95,9 +97,13 @@
Task_A2G_Dispatcher Task_Cargo Task_PICKUP
+
Task_Protect Unit Utils Zone
+
ZoneCaptureCoalition
+
ZoneGoal
+
ZoneGoalCoalition env land routines
diff --git a/docs/Documentation/Scenery.html b/docs/Documentation/Scenery.html
index 4529c2db6..716e91a86 100644
--- a/docs/Documentation/Scenery.html
+++ b/docs/Documentation/Scenery.html
@@ -60,6 +60,7 @@
Escort Event Fsm
+
Goal Group Identifiable Menu
@@ -72,6 +73,7 @@
Positionable Process_JTAC Process_Pickup
+
Protect Radio Rat Route
@@ -95,9 +97,13 @@
Task_A2G_Dispatcher Task_Cargo Task_PICKUP
+
Task_Protect Unit Utils Zone
+
ZoneCaptureCoalition
+
ZoneGoal
+
ZoneGoalCoalition env land routines
diff --git a/docs/Documentation/ScheduleDispatcher.html b/docs/Documentation/ScheduleDispatcher.html
index a9155213d..ca9920a31 100644
--- a/docs/Documentation/ScheduleDispatcher.html
+++ b/docs/Documentation/ScheduleDispatcher.html
@@ -60,6 +60,7 @@
Escort Event Fsm
+
Goal Group Identifiable Menu
@@ -72,6 +73,7 @@
Positionable Process_JTAC Process_Pickup
+
Protect Radio Rat Route
@@ -95,9 +97,13 @@
Task_A2G_Dispatcher Task_Cargo Task_PICKUP
+
Task_Protect Unit Utils Zone
+
ZoneCaptureCoalition
+
ZoneGoal
+
ZoneGoalCoalition env land routines
diff --git a/docs/Documentation/Scheduler.html b/docs/Documentation/Scheduler.html
index ec5dfe8b4..d8c5cf1f6 100644
--- a/docs/Documentation/Scheduler.html
+++ b/docs/Documentation/Scheduler.html
@@ -60,6 +60,7 @@
Escort Event Fsm
+
Goal Group Identifiable Menu
@@ -72,6 +73,7 @@
Positionable Process_JTAC Process_Pickup
+
Protect Radio Rat Route
@@ -95,9 +97,13 @@
Task_A2G_Dispatcher Task_Cargo Task_PICKUP
+
Task_Protect Unit Utils Zone
+
ZoneCaptureCoalition
+
ZoneGoal
+
ZoneGoalCoalition env land routines
diff --git a/docs/Documentation/Scoring.html b/docs/Documentation/Scoring.html
index 91b76b720..f5917caa5 100644
--- a/docs/Documentation/Scoring.html
+++ b/docs/Documentation/Scoring.html
@@ -60,6 +60,7 @@
Escort Event Fsm
+
Goal Group Identifiable Menu
@@ -72,6 +73,7 @@
Positionable Process_JTAC Process_Pickup
+
Protect Radio Rat Route
@@ -95,9 +97,13 @@
Task_A2G_Dispatcher Task_Cargo Task_PICKUP
+
Task_Protect Unit Utils Zone
+
ZoneCaptureCoalition
+
ZoneGoal
+
ZoneGoalCoalition env land routines
diff --git a/docs/Documentation/Sead.html b/docs/Documentation/Sead.html
index 409f76d29..7dc75619b 100644
--- a/docs/Documentation/Sead.html
+++ b/docs/Documentation/Sead.html
@@ -60,6 +60,7 @@
Escort Event Fsm
+
Goal Group Identifiable Menu
@@ -72,6 +73,7 @@
Positionable Process_JTAC Process_Pickup
+
Protect Radio Rat Route
@@ -95,9 +97,13 @@
Task_A2G_Dispatcher Task_Cargo Task_PICKUP
+
Task_Protect Unit Utils Zone
+
ZoneCaptureCoalition
+
ZoneGoal
+
ZoneGoalCoalition env land routines
diff --git a/docs/Documentation/Set.html b/docs/Documentation/Set.html
index 815665856..57a6570b6 100644
--- a/docs/Documentation/Set.html
+++ b/docs/Documentation/Set.html
@@ -60,6 +60,7 @@
Escort Event Fsm
+
Goal Group Identifiable Menu
@@ -72,6 +73,7 @@
Positionable Process_JTAC Process_Pickup
+
Protect Radio Rat Route
@@ -95,9 +97,13 @@
Task_A2G_Dispatcher Task_Cargo Task_PICKUP
+
Task_Protect Unit Utils Zone
+
ZoneCaptureCoalition
+
ZoneGoal
+
ZoneGoalCoalition env land routines
@@ -227,6 +233,22 @@
Countries
Starting with certain prefix strings.
+
+
+
+ SET_STATIC
+3) SET_STATIC class, extends Set#SET_BASE
+
+Mission designers can use the SET_STATIC class to build sets of Statics belonging to certain:
+
+
+ Coalitions
+ Categories
+ Countries
+ Static types
+ Starting with certain prefix strings.
+
@@ -914,6 +936,172 @@ mission designer to add a dedicated method
SET_GROUP:_EventOnDeadOrCrash(Event)
Handles the OnDead or OnCrash event for alive groups set.
+
+
+
+
+
+
+
+ SET_STATIC:AddInDatabase(Event)
+Handles the Database to check on an event (birth) that the Object was added in the Database.
+
+
+
+ SET_STATIC:AddStatic(AddStatic)
+Add STATIC(s) to SET_STATIC.
+
+
+
+ SET_STATIC:AddStaticsByName(AddStaticNames)
+Add STATIC(s) to SET_STATIC.
+
+
+
+ SET_STATIC:FilterCategories(Categories)
+Builds a set of units out of categories.
+
+
+
+ SET_STATIC:FilterCoalitions(Coalitions)
+Builds a set of units of coalitions.
+
+
+
+ SET_STATIC:FilterCountries(Countries)
+Builds a set of units of defined countries.
+
+
+
+ SET_STATIC:FilterPrefixes(Prefixes)
+Builds a set of units of defined unit prefixes.
+
+
+
+ SET_STATIC:FilterStart()
+Starts the filtering.
+
+
+
+ SET_STATIC:FilterTypes(Types)
+Builds a set of units of defined unit types.
+
+
+
+ SET_STATIC:FindInDatabase(Event)
+Handles the Database to check on any event that Object exists in the Database.
+
+
+
+ SET_STATIC:FindStatic(StaticName)
+Finds a Static based on the Static Name.
+
+
+
+ SET_STATIC:ForEachStatic(IteratorFunction, ...)
+Iterate the SET_STATIC and call an interator function for each alive STATIC, providing the STATIC and optional parameters.
+
+
+
+ SET_STATIC:ForEachStaticCompletelyInZone(ZoneObject, IteratorFunction, ...)
+Iterate the SET_STATIC and call an iterator function for each alive STATIC presence completely in a Zone , providing the STATIC and optional parameters to the called function.
+
+
+
+ SET_STATIC:ForEachStaticInZone(IteratorFunction, ...)
+Check if minimal one element of the SET_STATIC is in the Zone.
+
+
+
+ SET_STATIC:ForEachStaticNotInZone(ZoneObject, IteratorFunction, ...)
+Iterate the SET_STATIC and call an iterator function for each alive STATIC presence not in a Zone , providing the STATIC and optional parameters to the called function.
+
+
+
+ SET_STATIC:GetCoordinate()
+Get the center coordinate of the SET_STATIC.
+
+
+
+ SET_STATIC:GetFirst()
+Get the first unit from the set.
+
+
+
+ SET_STATIC:GetHeading()
+Get the average heading of the SET_STATIC.
+
+
+
+ SET_STATIC:GetStaticTypes()
+Returns map of unit types.
+
+
+
+ SET_STATIC:GetStaticTypesText()
+Returns a comma separated string of the unit types with a count in the Set .
+
+
+
+ SET_STATIC:GetTypeNames(Delimiter)
+Retrieve the type names of the Static s in the SET, delimited by an optional delimiter.
+
+
+
+ SET_STATIC:GetVelocity()
+Get the maximum velocity of the SET_STATIC.
+
+
+
+ SET_STATIC:IsIncludeObject(MStatic)
+
+
+
+
+ SET_STATIC:IsNotInZone(ZoneObject, Zone)
+Check if no element of the SET_STATIC is in the Zone.
+
+
+
+ SET_STATIC:IsPatriallyInZone(Zone)
+Check if minimal one element of the SET_STATIC is in the Zone.
+
+
+
+ SET_STATIC:New()
+Creates a new SET_STATIC object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.
+
+
+
+ SET_STATIC:RemoveStaticsByName(RemoveStaticNames)
+Remove STATIC(s) from SET_STATIC.
@@ -1014,6 +1202,12 @@ mission designer to add a dedicated method
SET_UNIT:ForEachUnitCompletelyInZone(ZoneObject, IteratorFunction, ...)
Iterate the SET_UNIT and call an iterator function for each alive UNIT presence completely in a Zone , providing the UNIT and optional parameters to the called function.
+
+
+
+ SET_UNIT:ForEachUnitInZone(IteratorFunction, ...)
+Check if minimal one element of the SET_UNIT is in the Zone.
@@ -1105,6 +1299,18 @@ mission designer to add a dedicated method
SET_UNIT:IsIncludeObject(MUnit)
+
+
+
+ SET_UNIT:IsNotInZone(ZoneObject, Zone)
+Check if no element of the SET_UNIT is in the Zone.
+
+
+
+ SET_UNIT:IsPartiallyInZone(ZoneTest)
+Check if minimal one element of the SET_UNIT is in the Zone.
@@ -1443,6 +1649,100 @@ The following iterator methods are currently available within the SETGROUP:
+
+
+ #SET_STATIC
+SET_STATIC
+
+
+
+
+3) SET_STATIC class, extends Set#SET_BASE
+
+Mission designers can use the SET_STATIC class to build sets of Statics belonging to certain:
+
+
+ Coalitions
+ Categories
+ Countries
+ Static types
+ Starting with certain prefix strings.
+
+
+
+
+3.1) SET_STATIC constructor
+
+Create a new SET_STATIC object with the SET_STATIC.New method:
+
+
+
+3.2) Add or Remove STATIC(s) from SET_STATIC
+
+STATICs can be added and removed using the Set#SET_STATIC.AddStaticsByName and Set#SET_STATIC.RemoveStaticsByName respectively.
+These methods take a single STATIC name or an array of STATIC names to be added or removed from SET_STATIC.
+
+3.3) SET_STATIC filter criteria
+
+You can set filter criteria to define the set of units within the SET_STATIC.
+Filter criteria are defined by:
+
+
+
+Once the filter criteria have been set for the SET_STATIC, you can start filtering using:
+
+
+
+Planned filter criteria within development are (so these are not yet available):
+
+
+
+3.4) SET_STATIC iterators
+
+Once the filters have been defined and the SETSTATIC has been built, you can iterate the SET STATIC with the available iterator methods.
+The iterator methods will walk the SETSTATIC set, and call for each element within the set a function that you provide.
+The following iterator methods are currently available within the SET STATIC:
+
+
+ SET_STATIC.ForEachStatic : Calls a function for each alive unit it finds within the SET_STATIC.SET_GROUP.ForEachGroupCompletelyInZone : Iterate the SET_GROUP and call an iterator function for each alive GROUP presence completely in a Zone , providing the GROUP and optional parameters to the called function.SET_GROUP.ForEachGroupNotInZone : Iterate the SET_GROUP and call an iterator function for each alive GROUP presence not in a Zone , providing the GROUP and optional parameters to the called function.
+
+Planned iterators methods in development are (so these are not yet available):
+
+
+
+3.5 ) SET_STATIC atomic methods
+
+Various methods exist for a SETSTATIC to perform actions or calculations and retrieve results from the SET STATIC:
+
+
+
+
@@ -4477,6 +4777,744 @@ A single name or an array of GROUP names.
+
+
+
+
+ Field(s)
+
+
+
+
+SET_STATIC:AddInDatabase(Event)
+
+
+
+
+Handles the Database to check on an event (birth) that the Object was added in the Database.
+
+
+This is required, because sometimes the DATABASE birth event gets called later than the SET BASE birth event!
+
+ Parameter
+
+ Return values
+
+
+
+#string:
+The name of the STATIC
+
+
+
+
+#table:
+The STATIC
+
+
+
+
+
+
+
+
+
+SET_STATIC:AddStatic(AddStatic)
+
+
+
+
+Add STATIC(s) to SET_STATIC.
+
+ Parameter
+
+ Return value
+
+#SET_STATIC :
+
+
+
+
+
+
+
+SET_STATIC:AddStaticsByName(AddStaticNames)
+
+
+
+
+Add STATIC(s) to SET_STATIC.
+
+ Parameter
+
+ Return value
+
+#SET_STATIC :
+
+
+
+
+
+
+
+SET_STATIC:FilterCategories(Categories)
+
+
+
+
+Builds a set of units out of categories.
+
+
+Possible current categories are plane, helicopter, ground, ship.
+
+ Parameter
+
+ Return value
+
+#SET_STATIC :
+
+
+
+
+
+
+
+SET_STATIC:FilterCoalitions(Coalitions)
+
+
+
+
+Builds a set of units of coalitions.
+
+
+Possible current coalitions are red, blue and neutral.
+
+ Parameter
+
+ Return value
+
+#SET_STATIC :
+
+
+
+
+
+
+
+SET_STATIC:FilterCountries(Countries)
+
+
+
+
+Builds a set of units of defined countries.
+
+
+Possible current countries are those known within DCS world.
+
+ Parameter
+
+ Return value
+
+#SET_STATIC :
+
+
+
+
+
+
+
+SET_STATIC:FilterPrefixes(Prefixes)
+
+
+
+
+Builds a set of units of defined unit prefixes.
+
+
+All the units starting with the given prefixes will be included within the set.
+
+ Parameter
+
+ Return value
+
+#SET_STATIC :
+
+
+
+
+
+
+
+SET_STATIC:FilterStart()
+
+
+
+
+Starts the filtering.
+
+ Return value
+
+#SET_STATIC :
+
+
+
+
+
+
+
+SET_STATIC:FilterTypes(Types)
+
+
+
+
+Builds a set of units of defined unit types.
+
+
+Possible current types are those types known within DCS world.
+
+ Parameter
+
+ Return value
+
+#SET_STATIC :
+
+
+
+
+
+
+
+SET_STATIC:FindInDatabase(Event)
+
+
+
+
+Handles the Database to check on any event that Object exists in the Database.
+
+
+This is required, because sometimes the DATABASE event gets called later than the SET BASE event or vise versa!
+
+ Parameter
+
+ Return values
+
+
+
+#string:
+The name of the STATIC
+
+
+
+
+#table:
+The STATIC
+
+
+
+
+
+
+
+
+
+SET_STATIC:FindStatic(StaticName)
+
+
+
+
+Finds a Static based on the Static Name.
+
+ Parameter
+
+
+
+#string StaticName
+
+
+
+ Return value
+
+Wrapper.Static#STATIC :
+
+
+
+
+
+
+
+SET_STATIC:ForEachStatic(IteratorFunction, ...)
+
+
+
+
+Iterate the SET_STATIC and call an interator function for each alive STATIC, providing the STATIC and optional parameters.
+
+ Parameters
+
+ Return value
+
+#SET_STATIC :
+
+
+
+
+
+
+
+SET_STATIC:ForEachStaticCompletelyInZone(ZoneObject, IteratorFunction, ...)
+
+
+
+
+Iterate the SET_STATIC and call an iterator function for each alive STATIC presence completely in a Zone , providing the STATIC and optional parameters to the called function.
+
+ Parameters
+
+
+
+Core.Zone#ZONE ZoneObject
+
+
+
+
+#function IteratorFunction
+
+
+
+
+ ...
+
+
+
+ Return value
+
+#SET_STATIC :
+
+
+
+
+
+
+
+SET_STATIC:ForEachStaticInZone(IteratorFunction, ...)
+
+
+
+
+Check if minimal one element of the SET_STATIC is in the Zone.
+
+ Parameters
+
+ Return value
+
+#SET_STATIC :
+
+
+
+
+
+
+
+SET_STATIC:ForEachStaticNotInZone(ZoneObject, IteratorFunction, ...)
+
+
+
+
+Iterate the SET_STATIC and call an iterator function for each alive STATIC presence not in a Zone , providing the STATIC and optional parameters to the called function.
+
+ Parameters
+
+
+
+Core.Zone#ZONE ZoneObject
+
+
+
+
+#function IteratorFunction
+
+
+
+
+ ...
+
+
+
+ Return value
+
+#SET_STATIC :
+
+
+
+
+
+
+
+SET_STATIC:GetCoordinate()
+
+
+
+
+Get the center coordinate of the SET_STATIC.
+
+ Return value
+
+Core.Point#COORDINATE :
+
+
+
+
+
+
+
+SET_STATIC:GetFirst()
+
+
+
+
+Get the first unit from the set.
+
+ Return value
+
+Wrapper.Static#STATIC :
+
+
+
+
+
+
+
+SET_STATIC:GetHeading()
+
+
+
+
+Get the average heading of the SET_STATIC.
+
+ Return value
+
+#number:
+Heading Heading in degrees and speed in mps in case of moving units.
+
+
+
+
+
+
+
+SET_STATIC:GetStaticTypes()
+
+
+
+
+Returns map of unit types.
+
+ Return value
+
+#map :
+string,#number> A map of the unit types found. The key is the StaticTypeName and the value is the amount of unit types found.
+
+
+
+
+
+
+
+SET_STATIC:GetStaticTypesText()
+
+
+
+
+Returns a comma separated string of the unit types with a count in the Set .
+
+ Return value
+
+#string:
+The unit types string
+
+
+
+
+
+
+
+SET_STATIC:GetTypeNames(Delimiter)
+
+
+
+
+Retrieve the type names of the Static s in the SET, delimited by an optional delimiter.
+
+ Parameter
+
+ Return value
+
+#string:
+The types of the Static s delimited.
+
+
+
+
+
+
+
+SET_STATIC:GetVelocity()
+
+
+
+
+Get the maximum velocity of the SET_STATIC.
+
+ Return value
+
+#number:
+The speed in mps in case of moving units.
+
+
+
+
+
+
+
+SET_STATIC:IsIncludeObject(MStatic)
+
+
+
+
+
+
+ Parameter
+
+ Return value
+
+#SET_STATIC :
+
+
+
+
+
+
+
+SET_STATIC:IsNotInZone(ZoneObject, Zone)
+
+
+
+
+Check if no element of the SET_STATIC is in the Zone.
+
+ Parameters
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+SET_STATIC:IsPatriallyInZone(Zone)
+
+
+
+
+Check if minimal one element of the SET_STATIC is in the Zone.
+
+ Parameter
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+SET_STATIC:New()
+
+
+
+
+Creates a new SET_STATIC object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.
+
+ Return value
+
+#SET_STATIC :
+
+
+ Usage:
+ -- Define a new SET_STATIC Object. This DBObject will contain a reference to all alive Statics.
+DBObject = SET_STATIC:New()
+
+
+
+
+
+SET_STATIC:RemoveStaticsByName(RemoveStaticNames)
+
+
+
+
+Remove STATIC(s) from SET_STATIC.
+
+ Parameter
+
+ Return value
+
+
+self
+
@@ -4947,6 +5985,38 @@ self
+
+SET_UNIT:ForEachUnitInZone(IteratorFunction, ...)
+
+
+
+
+Check if minimal one element of the SET_UNIT is in the Zone.
+
+ Parameters
+
+ Return value
+
+#SET_UNIT :
+
+
+
+
+
+
SET_UNIT:ForEachUnitNotInZone(ZoneObject, IteratorFunction, ...)
@@ -5302,6 +6372,65 @@ The amount of SEADable units in the Set
#SET_UNIT :
+
+
+
+
+
+
+SET_UNIT:IsNotInZone(ZoneObject, Zone)
+
+
+
+
+Check if no element of the SET_UNIT is in the Zone.
+
+ Parameters
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+SET_UNIT:IsPartiallyInZone(ZoneTest)
+
+
+
+
+Check if minimal one element of the SET_UNIT is in the Zone.
+
+ Parameter
+
+ Return value
+
+#boolean:
+
+
diff --git a/docs/Documentation/Settings.html b/docs/Documentation/Settings.html
index 274a10019..2071bcfc9 100644
--- a/docs/Documentation/Settings.html
+++ b/docs/Documentation/Settings.html
@@ -60,6 +60,7 @@
Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines
- #boolean
+
SETTINGS.Metric
diff --git a/docs/Documentation/Smoke.html b/docs/Documentation/Smoke.html
index 14e4cd382..ef5acc76d 100644
--- a/docs/Documentation/Smoke.html
+++ b/docs/Documentation/Smoke.html
@@ -60,6 +60,7 @@
Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.
-
@@ -2763,9 +2766,6 @@ when nothing was spawned.
-
- Overwrite unit names by default with group name.
-
@@ -2780,9 +2780,6 @@ when nothing was spawned.
-
- By default, no InitLimit
-
@@ -2818,7 +2815,7 @@ when nothing was spawned.
- #number
+
SPAWN.SpawnMaxGroups
@@ -2835,7 +2832,7 @@ when nothing was spawned.
- #number
+
SPAWN.SpawnMaxUnitsAlive
@@ -3187,7 +3184,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.
diff --git a/docs/Documentation/SpawnStatic.html b/docs/Documentation/SpawnStatic.html
index 487563b09..1157ef0c2 100644
--- a/docs/Documentation/SpawnStatic.html
+++ b/docs/Documentation/SpawnStatic.html
@@ -60,6 +60,7 @@
Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines
+ #number
SPAWNSTATIC.SpawnIndex
diff --git a/docs/Documentation/Spot.html b/docs/Documentation/Spot.html
index 47f777855..270504b60 100644
--- a/docs/Documentation/Spot.html
+++ b/docs/Documentation/Spot.html
@@ -60,6 +60,7 @@
Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines
-
SPOT.ScheduleID
@@ -780,7 +785,6 @@ true if it is lasing
-
SPOT.SpotIR
@@ -794,7 +798,6 @@ true if it is lasing
-
SPOT.SpotLaser
@@ -808,7 +811,6 @@ true if it is lasing
-
SPOT.Target
diff --git a/docs/Documentation/Static.html b/docs/Documentation/Static.html
index 04a72d991..2821e72e2 100644
--- a/docs/Documentation/Static.html
+++ b/docs/Documentation/Static.html
@@ -60,6 +60,7 @@
Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines
- TASK:Goal() TASK:Goal(PlayerUnit, PlayerName)
Goal Trigger for TASK
@@ -469,7 +475,7 @@
- TASK:OnAfterGoal(Controllable, From, Event, To) TASK:OnAfterGoal(From, Event, To, PlayerUnit, PlayerName)
Goal Handler OnAfter for TASK
@@ -493,7 +499,7 @@
- TASK:OnBeforeGoal(Controllable, From, Event, To) TASK:OnBeforeGoal(From, Event, To, PlayerUnit, PlayerName)
Goal Handler OnBefore for TASK
@@ -805,7 +811,7 @@
- TASK:__Goal(Delay) TASK:__Goal(Delay, PlayerUnit, PlayerName)
Goal Asynchronous Trigger for TASK
@@ -1648,13 +1654,28 @@ TaskType
-TASK:Goal()
+TASK:Goal(PlayerUnit, PlayerName)
Goal Trigger for TASK
+ Parameters
+
@@ -2097,7 +2118,7 @@ self
-TASK:OnAfterGoal(Controllable, From, Event, To)
+TASK:OnAfterGoal(From, Event, To, PlayerUnit, PlayerName)
@@ -2108,11 +2129,6 @@ self
@@ -2217,7 +2245,7 @@ The name of the Player.
-TASK:OnBeforeGoal(Controllable, From, Event, To)
+TASK:OnBeforeGoal(From, Event, To, PlayerUnit, PlayerName)
@@ -2228,11 +2256,6 @@ The name of the Player.
Return value
@@ -3378,19 +3413,31 @@ self
-TASK:__Goal(Delay)
+TASK:__Goal(Delay, PlayerUnit, PlayerName)
Goal Asynchronous Trigger for TASK
- Parameter
+ Parameters
diff --git a/docs/Documentation/Task_A2A.html b/docs/Documentation/Task_A2A.html
index da59f25d5..d839b111d 100644
--- a/docs/Documentation/Task_A2A.html
+++ b/docs/Documentation/Task_A2A.html
@@ -60,6 +60,7 @@
Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher
Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo
Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines Task#TA
- Core.Cargo#CARGO
FSM_PROCESS.Cargo
@@ -567,6 +573,7 @@ based on the tasking capabilities defined in Task#TA
+
FSM_PROCESS.DeployZone
diff --git a/docs/Documentation/Task_PICKUP.html b/docs/Documentation/Task_PICKUP.html
index 01f437f36..5e3bf6e04 100644
--- a/docs/Documentation/Task_PICKUP.html
+++ b/docs/Documentation/Task_PICKUP.html
@@ -60,6 +60,7 @@
Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP
+ Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines
+
+
+
+
+
Module Task_Protect
+
+
Tasking - The TASK_Protect models tasks for players to protect or capture specific zones.
+
+
+
+
+
+
Author: Sven Van de Velde (FlightControl)
+
+
Contributions: MillerTime
+
+
+
+
+
Global(s)
+
+
+ TASK_CAPTURE_ZONE
+
+
+The TASKCAPTURE ZONE class defines an Suppression or Extermination of Air Defenses task for a human player to be executed.
+
+
+
+ TASK_PROTECT
+TASK_PROTECT class, extends Task#TASK
+
+The TASK_PROTECT class defines the task to protect or capture a protection zone.
+
+
+
+
+
+
+ TASK_CAPTURE_ZONE:New(Mission, SetGroup, TaskName, Protect, TaskBriefing)
+Instantiates a new TASKCAPTURE ZONE.
+
+
+
+ TASK_CAPTURE_ZONE:OnAfterGoal(TaskUnit, From, Event, To, PlayerUnit, PlayerName)
+
+
+
+
+ TASK_CAPTURE_ZONE:ReportOrder(ReportGroup)
+
+
+
+
+ TASK_CAPTURE_ZONE:SetScoreOnFail(PlayerName, Penalty, TaskUnit)
+Set a penalty when the A2G attack has failed.
+
+
+
+ TASK_CAPTURE_ZONE:SetScoreOnProgress(PlayerName, Score, TaskUnit)
+Set a score when a target in scope of the A2G attack, has been destroyed .
+
+
+
+ TASK_CAPTURE_ZONE:SetScoreOnSuccess(PlayerName, Score, TaskUnit)
+Set a score when all the targets in scope of the A2G attack, have been destroyed.
+
+
+
+ TASK_CAPTURE_ZONE.TargetSetUnit
+
+
+
+
+ TASK_CAPTURE_ZONE.TaskCoalition
+
+
+
+
+ TASK_CAPTURE_ZONE.TaskCoalitionName
+
+
+
+
+ TASK_CAPTURE_ZONE.TaskZoneName
+
+
+
+
+ TASK_CAPTURE_ZONE:UpdateTaskInfo()
+Instantiates a new TASKCAPTURE ZONE.
+
+
+
+
+
+
+
+
Global(s)
+
+
+
+ #TASK_CAPTURE_ZONE
+TASK_CAPTURE_ZONE
+
+
+
+
+
+
+The TASKCAPTURE ZONE class defines an Suppression or Extermination of Air Defenses task for a human player to be executed.
+
+
+These tasks are important to be executed as they will help to achieve air superiority at the vicinity.
+
+The TASKCAPTURE ZONE is used by the TaskA2G Dispatcher#TASKA2G DISPATCHER to automatically create SEAD tasks
+based on detected enemy ground targets.
+
+
+
+
+
+
+
+ #TASK_PROTECT
+TASK_PROTECT
+
+
+
+
+TASK_PROTECT class, extends Task#TASK
+
+The TASK_PROTECT class defines the task to protect or capture a protection zone.
+
+
+The TASK_PROTECT is implemented using a Fsm#FSM_TASK , and has the following statuses:
+
+
+ None : Start of the processPlanned : 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.
+
+Set the scoring of achievements in an A2G attack.
+
+Scoring or penalties can be given in the following circumstances:
+
+
+
+
+
+
+
+
+
+
+
+
+
The TASKCAPTURE ZONE class
+
+
Field(s)
+
+
+
+
+TASK_CAPTURE_ZONE:New(Mission, SetGroup, TaskName, Protect, TaskBriefing)
+
+
+
+
+Instantiates a new TASKCAPTURE ZONE.
+
+ Parameters
+
+ Return value
+
+#TASKCAPTURE ZONE :
+
+
+
+
+
+
+
+TASK_CAPTURE_ZONE:OnAfterGoal(TaskUnit, From, Event, To, PlayerUnit, PlayerName)
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
+
+
+TASK_CAPTURE_ZONE:ReportOrder(ReportGroup)
+
+
+
+
+
+
+ Parameter
+
+
+
+ ReportGroup
+
+
+
+
+
+
+
+
+
+TASK_CAPTURE_ZONE:SetScoreOnFail(PlayerName, Penalty, TaskUnit)
+
+
+
+
+Set a penalty when the A2G attack has failed.
+
+ Parameters
+
+
+
+#string PlayerName
+
+
+
+
+#number Penalty
+
+
+
+
+Wrapper.Unit#UNIT TaskUnit
+
+
+
+ Return value
+
+#TASKCAPTURE ZONE :
+
+
+
+
+
+
+
+
+TASK_CAPTURE_ZONE:SetScoreOnProgress(PlayerName, Score, TaskUnit)
+
+
+
+
+Set a score when a target in scope of the A2G attack, has been destroyed .
+
+ Parameters
+
+
+
+#string PlayerName
+
+
+
+
+#number Score
+
+
+
+
+Wrapper.Unit#UNIT TaskUnit
+
+
+
+ Return value
+
+#TASKCAPTURE ZONE :
+
+
+
+
+
+
+
+
+TASK_CAPTURE_ZONE:SetScoreOnSuccess(PlayerName, Score, TaskUnit)
+
+
+
+
+Set a score when all the targets in scope of the A2G attack, have been destroyed.
+
+ Parameters
+
+
+
+#string PlayerName
+
+
+
+
+#number Score
+
+
+
+
+Wrapper.Unit#UNIT TaskUnit
+
+
+
+ Return value
+
+#TASKCAPTURE ZONE :
+
+
+
+
+
+
+
+ Set#SET_UNIT
+TASK_CAPTURE_ZONE.TargetSetUnit
+
+
+
+
+
+
+
+
+
+
+
+
+TASK_CAPTURE_ZONE.TaskCoalition
+
+
+
+
+
+
+
+
+
+
+
+
+TASK_CAPTURE_ZONE.TaskCoalitionName
+
+
+
+
+
+
+
+
+
+
+
+
+TASK_CAPTURE_ZONE.TaskZoneName
+
+
+
+
+
+
+
+
+
+
+
+
+TASK_CAPTURE_ZONE:UpdateTaskInfo()
+
+
+
+
+Instantiates a new TASKCAPTURE ZONE.
+
+
+
+
+
+
+
The TASK_PROTECT class
+
+
Field(s)
+
+
+
+
+TASK_PROTECT:GetGoalTotal()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+TASK_PROTECT:GetTargetZone(TaskUnit)
+
+
+
+
+
+
+ Parameter
+
+ Return value
+
+Core.Zone#ZONE_BASE :
+
+
+
+
+
+
+
+TASK_PROTECT:New(Mission, SetGroup, TaskName, Protect, TaskType, TaskBriefing)
+
+
+
+
+Instantiates a new TASK_PROTECT.
+
+ Parameters
+
+ Return value
+
+#TASK_PROTECT :
+
+
+
+
+
+
+ Functional.Protect#PROTECT
+TASK_PROTECT.Protect
+
+
+
+
+
+
+
+
+
+
+
+
+TASK_PROTECT:SetGoalTotal()
+
+
+
+
+
+
+
+
+
+
+
+
+TASK_PROTECT:SetProtect(Protect)
+
+
+
+
+
+
+ Parameter
+
+
+
+
+
+
+
+TASK_PROTECT:SetTargetZone(TargetZone, TaskUnit)
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
+
+
+TASK_PROTECT.TaskType
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/Documentation/Unit.html b/docs/Documentation/Unit.html
index 4dc9e6940..d855ac208 100644
--- a/docs/Documentation/Unit.html
+++ b/docs/Documentation/Unit.html
@@ -60,6 +60,7 @@
Escort Event Fsm
+
Goal Group Identifiable Menu
@@ -72,6 +73,7 @@
Positionable Process_JTAC Process_Pickup
+
Protect Radio Rat Route
@@ -95,9 +97,13 @@
Task_A2G_Dispatcher Task_Cargo Task_PICKUP
+
Task_Protect Unit
Utils Zone
+
ZoneCaptureCoalition
+
ZoneGoal
+
ZoneGoalCoalition env land routines
diff --git a/docs/Documentation/Utils.html b/docs/Documentation/Utils.html
index 321003dae..e46ba62a2 100644
--- a/docs/Documentation/Utils.html
+++ b/docs/Documentation/Utils.html
@@ -60,6 +60,7 @@
Escort Event Fsm
+
Goal Group Identifiable Menu
@@ -72,6 +73,7 @@
Positionable Process_JTAC Process_Pickup
+
Protect Radio Rat Route
@@ -95,9 +97,13 @@
Task_A2G_Dispatcher Task_Cargo Task_PICKUP
+
Task_Protect Unit Utils
Zone
+
ZoneCaptureCoalition
+
ZoneGoal
+
ZoneGoalCoalition env land routines
diff --git a/docs/Documentation/Zone.html b/docs/Documentation/Zone.html
index 21e03ca21..ee4a11436 100644
--- a/docs/Documentation/Zone.html
+++ b/docs/Documentation/Zone.html
@@ -60,6 +60,7 @@
Escort Event Fsm
+
Goal Group Identifiable Menu
@@ -72,6 +73,7 @@
Positionable Process_JTAC Process_Pickup
+
Protect Radio Rat Route
@@ -95,9 +97,13 @@
Task_A2G_Dispatcher Task_Cargo Task_PICKUP
+
Task_Protect Unit Utils Zone
+
ZoneCaptureCoalition
+
ZoneGoal
+
ZoneGoalCoalition env land routines
@@ -328,6 +334,12 @@
ZONE_BASE:New(ZoneName)
ZONE_BASE constructor
+
+
+
+ ZONE_BASE:SetName(ZoneName)
+Sets the name of the zone.
@@ -498,12 +510,30 @@
ZONE_RADIUS:BoundZone(Points, UnBound, CountryID)
Bounds the zone with tires.
+
+
+
+ ZONE_RADIUS.Coalitions
+
+
+
+
+ ZONE_RADIUS:CountCoalitions()
+
ZONE_RADIUS:FlareZone(FlareColor, Points, Azimuth)
Flares the zone boundaries in a color.
+
+
+
+ ZONE_RADIUS:GetCoalition()
+Get the Zone Coalitions.
@@ -546,6 +576,36 @@
ZONE_RADIUS:GetVec3(Height)
Returns the DCSTypes#Vec3 of the ZONE_RADIUS.
+
+
+
+ ZONE_RADIUS:IsAllInZoneOfCoalition(Coalition)
+Is All in Zone of Coalition?
+
+
+
+ ZONE_RADIUS:IsAllInZoneOfOtherCoalition(Coalition)
+Is All in Zone of Other Coalition?
+
+
+
+ ZONE_RADIUS:IsNoneInZone()
+Is None in Zone?
+
+
+
+ ZONE_RADIUS:IsNoneInZoneOfCoalition(Coalition)
+Is None in Zone of Coalition?
+
+
+
+ ZONE_RADIUS:IsSomeInZoneOfCoalition(Coalition)
+Is Some in Zone of Coalition?
@@ -570,6 +630,18 @@
ZONE_RADIUS.Radius
The radius of the zone.
+
+
+
+ ZONE_RADIUS:Scan(Coalition)
+Scan the zone
+
+
+
+ ZONE_RADIUS:SearchZone(EvaluateFunction)
+Searches the zone
@@ -679,8 +751,10 @@
+
Each zone implements two polymorphic functions defined in Zone#ZONE_BASE :
@@ -1302,6 +1376,33 @@ Name of the zone.
#ZONE_BASE :
+
+
+
+
+
+
+ZONE_BASE:SetName(ZoneName)
+
+
+
+
+Sets the name of the zone.
+
+ Parameter
+
+ Return value
+
+#ZONE_BASE :
+
+
@@ -1886,6 +1987,33 @@ If true the tyres will be destroyed.
#ZONE_RADIUS :
+
+
+
+
+
+
+ZONE_RADIUS.Coalitions
+
+
+
+
+
+
+
+
+
+
+
+
+ZONE_RADIUS:CountCoalitions()
+
+
+
+
+
+
@@ -1930,6 +2058,27 @@ self
+
+ZONE_RADIUS:GetCoalition()
+
+
+
+
+Get the Zone Coalitions.
+
+
+Returns nil if there are none ot two coalitions in the zone!
+
+ Return value
+
+
+Coalitions
+
+
+
+
+
+
ZONE_RADIUS:GetRadius()
@@ -2120,6 +2269,128 @@ The height to add to the land height where the center of the zone is located.Dcs.DCSTypes#Vec3 :
+
+
+
+
+ZONE_RADIUS:IsAllInZoneOfCoalition(Coalition)
+
+
+
+
+Is All in Zone of Coalition?
+
+ Parameter
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+ZONE_RADIUS:IsAllInZoneOfOtherCoalition(Coalition)
+
+
+
+
+Is All in Zone of Other Coalition?
+
+ Parameter
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+ZONE_RADIUS:IsNoneInZone()
+
+
+
+
+Is None in Zone?
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+ZONE_RADIUS:IsNoneInZoneOfCoalition(Coalition)
+
+
+
+
+Is None in Zone of Coalition?
+
+ Parameter
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+ZONE_RADIUS:IsSomeInZoneOfCoalition(Coalition)
+
+
+
+
+Is Some in Zone of Coalition?
+
+ Parameter
+
+ Return value
+
+#boolean:
+
+
@@ -2232,6 +2503,48 @@ self
+
+ZONE_RADIUS:Scan(Coalition)
+
+
+
+
+Scan the zone
+
+ Parameter
+
+
+
+
+
+
+
+ZONE_RADIUS:SearchZone(EvaluateFunction)
+
+
+
+
+Searches the zone
+
+ Parameter
+
+
+
+ EvaluateFunction
+
+
+
+
+
+
+
+
ZONE_RADIUS:SetRadius(Radius)
diff --git a/docs/Documentation/ZoneCaptureCoalition.html b/docs/Documentation/ZoneCaptureCoalition.html
new file mode 100644
index 000000000..1bb9f91b1
--- /dev/null
+++ b/docs/Documentation/ZoneCaptureCoalition.html
@@ -0,0 +1,265 @@
+
+
+
+
+
+
+
+
+
Module ZoneCaptureCoalition
+
+
Core -- Base class that models processes to capture a Zone for a Coalition, guarded by another Coalition.
+
+
+
+
+
+
ZONECAPTURE COALITION models processes that have an objective with a defined achievement involving a Zone. Derived classes implement the ways how the achievements can be realized.
+
+
+
+
Author: Sven Van de Velde (FlightControl)
+
+
+
+
+
Global(s)
+
+
+ ZONE_CAPTURE_COALITION
+ZONECAPTURE COALITION class, extends Goal#GOAL
+
+ZONECAPTURE COALITION models processes that have an objective with a defined achievement involving a Zone.
+
+
+
+
+
+
+
Global(s)
+
+
+
+ #ZONE_CAPTURE_COALITION
+ZONE_CAPTURE_COALITION
+
+
+
+
+ZONECAPTURE COALITION class, extends Goal#GOAL
+
+ZONECAPTURE COALITION models processes that have an objective with a defined achievement involving a Zone.
+
+
+Derived classes implement the ways how the achievements can be realized.
+
+1. ZONECAPTURE COALITION constructor
+
+
+
+2. ZONECAPTURE COALITION is a finite state machine (FSM).
+
+2.1 ZONECAPTURE COALITION States
+
+2.2 ZONECAPTURE COALITION Events
+
+
+
+
+
+
+
+
Field(s)
+
+
+
+
+ZONE_CAPTURE_COALITION:New(Zone, Coalition)
+
+
+
+
+ZONECAPTURE COALITION Constructor.
+
+ Parameters
+
+ Return value
+
+#ZONECAPTURE COALITION :
+
+
+
+
+
+
+
+
+ZONE_CAPTURE_COALITION.States
+
+
+
+
+
+
+
+
+
+
+
+
+ZONE_CAPTURE_COALITION:onenterCaptured()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/Documentation/ZoneGoal.html b/docs/Documentation/ZoneGoal.html
new file mode 100644
index 000000000..b364d5bff
--- /dev/null
+++ b/docs/Documentation/ZoneGoal.html
@@ -0,0 +1,1000 @@
+
+
+
+
+
+
+
+
+
+
+
+
Module ZoneGoal
+
+
Core -- Base class that models processes to achieve goals involving a Zone.
+
+
+
+
+
+
ZONE_GOAL models processes that have an objective with a defined achievement involving a Zone. Derived classes implement the ways how the achievements can be realized.
+
+
+
+
Author: Sven Van de Velde (FlightControl)
+
+
+
+
+
Global(s)
+
+
+ ZONE_GOAL
+ZONE_GOAL class, extends Fsm#FSM
+
+ZONE_GOAL models processes that have an objective with a defined achievement involving a Zone.
+
+
+
+
+
+
+ ZONE_GOAL:Empty()
+Empty Trigger for ZONE_GOAL
+
+
+
+ ZONE_GOAL:Flare(FlareColor)
+Flare the center of the zone.
+
+
+
+ ZONE_GOAL.FsmStateEmpty
+
+
+
+
+ ZONE_GOAL.FsmStateGuarded
+
+
+
+
+ ZONE_GOAL:GetZone()
+Get the Zone
+
+
+
+ ZONE_GOAL:GetZoneName()
+Get the name of the ProtectZone
+
+
+
+ ZONE_GOAL.Goal
+
+
+
+
+ ZONE_GOAL:Guard()
+Guard Trigger for ZONE_GOAL
+
+
+
+ ZONE_GOAL:IsEmpty()
+
+
+
+
+ ZONE_GOAL:IsGuarded()
+
+
+
+
+ ZONE_GOAL:New(Zone)
+ZONE_GOAL Constructor.
+
+
+
+ ZONE_GOAL:OnAfterEmpty(From, Event, To)
+Empty Handler OnAfter for ZONE_GOAL
+
+
+
+ ZONE_GOAL:OnAfterGuard(From, Event, To)
+Guard Handler OnAfter for ZONE_GOAL
+
+
+
+ ZONE_GOAL:OnBeforeEmpty(From, Event, To)
+Empty Handler OnBefore for ZONE_GOAL
+
+
+
+ ZONE_GOAL:OnBeforeGuard(From, Event, To)
+Guard Handler OnBefore for ZONE_GOAL
+
+
+
+ ZONE_GOAL:OnEnterEmpty(From, Event, To)
+Empty State Handler OnEnter for ZONE_GOAL
+
+
+
+ ZONE_GOAL:OnEnterGuarded(From, Event, To)
+Guarded State Handler OnEnter for ZONE_GOAL
+
+
+
+ ZONE_GOAL:OnLeaveEmpty(From, Event, To)
+Empty State Handler OnLeave for ZONE_GOAL
+
+
+
+ ZONE_GOAL:OnLeaveGuarded(From, Event, To)
+Guarded State Handler OnLeave for ZONE_GOAL
+
+
+
+ ZONE_GOAL:Smoke(SmokeColor)
+Smoke the center of theh zone.
+
+
+
+ ZONE_GOAL.SmokeColor
+
+
+
+
+ ZONE_GOAL.SmokeScheduler
+
+
+
+
+ ZONE_GOAL.SmokeTime
+
+
+
+
+ ZONE_GOAL.States
+
+
+
+
+ ZONE_GOAL:StatusSmoke()
+Check status Smoke.
+
+
+
+ ZONE_GOAL:StatusZone()
+Check status Zone.
+
+
+
+ ZONE_GOAL.Zone
+
+
+
+
+ ZONE_GOAL:__Empty(Delay)
+Empty Asynchronous Trigger for ZONE_GOAL
+
+
+
+ ZONE_GOAL:__Guard(Delay)
+Guard Asynchronous Trigger for ZONE_GOAL
+
+
+
+ ZONE_GOAL:onafterGuard()
+When started, check the Smoke and the Zone status.
+
+
+
+
+
Global(s)
+
+
+
+ #ZONE_GOAL
+ZONE_GOAL
+
+
+
+
+ZONE_GOAL class, extends Fsm#FSM
+
+ZONE_GOAL models processes that have an objective with a defined achievement involving a Zone.
+
+
+Derived classes implement the ways how the achievements can be realized.
+
+1. ZONE_GOAL constructor
+
+
+
+2. ZONE_GOAL is a finite state machine (FSM).
+
+2.1 ZONE_GOAL States
+
+
+ Empty : The Zone is Empty.Guarded : The Zone is Guarded.
+
+2.2 ZONE_GOAL Events
+
+
+
+
+
+
+
+
+
+
+
+
Field(s)
+
+
+
+
+ZONE_GOAL:Empty()
+
+
+
+
+Empty Trigger for ZONE_GOAL
+
+
+
+
+
+
+
+ZONE_GOAL:Flare(FlareColor)
+
+
+
+
+Flare the center of the zone.
+
+ Parameter
+
+
+
+
+
+
+ #string
+
+ZONE_GOAL.FsmStateEmpty
+
+
+
+
+
+
+
+
+
+
+
+ #string
+
+ZONE_GOAL.FsmStateGuarded
+
+
+
+
+
+
+
+
+
+
+
+
+ZONE_GOAL:GetZone()
+
+
+
+
+Get the Zone
+
+ Return value
+
+Core.Zone#ZONE_BASE :
+
+
+
+
+
+
+
+
+ZONE_GOAL:GetZoneName()
+
+
+
+
+Get the name of the ProtectZone
+
+ Return value
+
+#string:
+
+
+
+
+
+
+
+
+ZONE_GOAL.Goal
+
+
+
+
+
+
+
+
+
+
+
+
+ZONE_GOAL:Guard()
+
+
+
+
+Guard Trigger for ZONE_GOAL
+
+
+
+
+
+
+
+ZONE_GOAL:IsEmpty()
+
+
+
+
+
+
+
+
+
+
+
+
+ZONE_GOAL:IsGuarded()
+
+
+
+
+
+
+
+
+
+
+
+
+ZONE_GOAL:New(Zone)
+
+
+
+
+ZONE_GOAL Constructor.
+
+ Parameter
+
+ Return value
+
+#ZONE_GOAL :
+
+
+
+
+
+
+
+
+ZONE_GOAL:OnAfterEmpty(From, Event, To)
+
+
+
+
+Empty Handler OnAfter for ZONE_GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+
+
+
+
+
+
+ZONE_GOAL:OnAfterGuard(From, Event, To)
+
+
+
+
+Guard Handler OnAfter for ZONE_GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+
+
+
+
+
+
+ZONE_GOAL:OnBeforeEmpty(From, Event, To)
+
+
+
+
+Empty Handler OnBefore for ZONE_GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+ZONE_GOAL:OnBeforeGuard(From, Event, To)
+
+
+
+
+Guard Handler OnBefore for ZONE_GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+ZONE_GOAL:OnEnterEmpty(From, Event, To)
+
+
+
+
+Empty State Handler OnEnter for ZONE_GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+
+
+
+
+
+
+ZONE_GOAL:OnEnterGuarded(From, Event, To)
+
+
+
+
+Guarded State Handler OnEnter for ZONE_GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+
+
+
+
+
+
+ZONE_GOAL:OnLeaveEmpty(From, Event, To)
+
+
+
+
+Empty State Handler OnLeave for ZONE_GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+ZONE_GOAL:OnLeaveGuarded(From, Event, To)
+
+
+
+
+Guarded State Handler OnLeave for ZONE_GOAL
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+ZONE_GOAL:Smoke(SmokeColor)
+
+
+
+
+Smoke the center of theh zone.
+
+ Parameter
+
+
+
+
+
+
+
+ZONE_GOAL.SmokeColor
+
+
+
+
+
+
+
+
+
+
+
+
+ZONE_GOAL.SmokeScheduler
+
+
+
+
+
+
+
+
+
+
+
+
+ZONE_GOAL.SmokeTime
+
+
+
+
+
+
+
+self.SmokeColor = nil
+
+
+
+
+
+
+
+ZONE_GOAL.States
+
+
+
+
+
+
+
+
+
+
+
+
+ZONE_GOAL:StatusSmoke()
+
+
+
+
+Check status Smoke.
+
+
+
+
+
+
+
+ZONE_GOAL:StatusZone()
+
+
+
+
+Check status Zone.
+
+
+
+
+
+
+ Core.Zone#ZONE_BASE
+ZONE_GOAL.Zone
+
+
+
+
+
+
+
+
+
+
+
+
+ZONE_GOAL:__Empty(Delay)
+
+
+
+
+Empty Asynchronous Trigger for ZONE_GOAL
+
+ Parameter
+
+
+
+#number Delay
+
+
+
+
+
+
+
+
+
+ZONE_GOAL:__Guard(Delay)
+
+
+
+
+Guard Asynchronous Trigger for ZONE_GOAL
+
+ Parameter
+
+
+
+#number Delay
+
+
+
+
+
+
+
+
+
+ZONE_GOAL:onafterGuard()
+
+
+
+
+When started, check the Smoke and the Zone status.
+
+
+
+
+
+
+
+
+
diff --git a/docs/Documentation/ZoneGoalCoalition.html b/docs/Documentation/ZoneGoalCoalition.html
new file mode 100644
index 000000000..b7dfa5f18
--- /dev/null
+++ b/docs/Documentation/ZoneGoalCoalition.html
@@ -0,0 +1,1089 @@
+
+
+
+
+
+
+
+
+
+
+
+
Module ZoneGoalCoalition
+
+
Core -- Base class that models processes to achieve goals involving a Zone for a Coalition.
+
+
+
+
+
+
ZONEGOAL COALITION models processes that have a Goal with a defined achievement involving a Zone for a Coalition.
+
+
+
+
Author: Sven Van de Velde (FlightControl)
+
+
+
+
+
Global(s)
+
+
+ ZONE_GOAL_COALITION
+
+
+ZONEGOAL COALITION models processes that have a Goal with a defined achievement involving a Zone for a Coalition.
+
+
+
+
+
+
+
+
+
+ ZONE_GOAL_COALITION:Attack()
+Attack Trigger for ZONEGOAL COALITION
+
+
+
+ ZONE_GOAL_COALITION:Capture()
+Capture Trigger for ZONEGOAL COALITION
+
+
+
+ ZONE_GOAL_COALITION.Coalition
+
+
+
+
+ ZONE_GOAL_COALITION.FsmStateAttacked
+
+
+
+
+ ZONE_GOAL_COALITION.FsmStateCaptured
+
+
+
+
+ ZONE_GOAL_COALITION:GetCoalition()
+Get the owning coalition of the zone.
+
+
+
+ ZONE_GOAL_COALITION:GetCoalitionName()
+Get the owning coalition name of the zone.
+
+
+
+ ZONE_GOAL_COALITION:IsAttacked()
+
+
+
+
+ ZONE_GOAL_COALITION:IsCaptured()
+
+
+
+
+ ZONE_GOAL_COALITION:IsGuarded()
+
+
+
+
+ ZONE_GOAL_COALITION:Mark()
+Mark.
+
+
+
+ ZONE_GOAL_COALITION.MarkBlue
+
+
+
+
+ ZONE_GOAL_COALITION.MarkRed
+
+
+
+
+ ZONE_GOAL_COALITION:New(Zone, Coalition)
+ZONEGOAL COALITION Constructor.
+
+
+
+ ZONE_GOAL_COALITION:OnAfterAttack(From, Event, To)
+Attack Handler OnAfter for ZONEGOAL COALITION
+
+
+
+ ZONE_GOAL_COALITION:OnAfterCapture(From, Event, To)
+Capture Handler OnAfter for ZONEGOAL COALITION
+
+
+
+ ZONE_GOAL_COALITION:OnBeforeAttack(From, Event, To)
+Attack Handler OnBefore for ZONEGOAL COALITION
+
+
+
+ ZONE_GOAL_COALITION:OnBeforeCapture(From, Event, To)
+Capture Handler OnBefore for ZONEGOAL COALITION
+
+
+
+ ZONE_GOAL_COALITION:OnEnterAttacked(From, Event, To)
+Attacked State Handler OnEnter for ZONEGOAL COALITION
+
+
+
+ ZONE_GOAL_COALITION:OnEnterCaptured(From, Event, To)
+Captured State Handler OnEnter for ZONEGOAL COALITION
+
+
+
+ ZONE_GOAL_COALITION:OnLeaveAttacked(From, Event, To)
+Attacked State Handler OnLeave for ZONEGOAL COALITION
+
+
+
+ ZONE_GOAL_COALITION:OnLeaveCaptured(From, Event, To)
+Captured State Handler OnLeave for ZONEGOAL COALITION
+
+
+
+ ZONE_GOAL_COALITION:SetCoalition(Coalition)
+Set the owning coalition of the zone.
+
+
+
+ ZONE_GOAL_COALITION.States
+
+
+
+
+ ZONE_GOAL_COALITION:StatusZone()
+Check status Coalition ownership.
+
+
+
+ ZONE_GOAL_COALITION:__Attack(Delay)
+Attack Asynchronous Trigger for ZONEGOAL COALITION
+
+
+
+ ZONE_GOAL_COALITION:__Capture(Delay)
+Capture Asynchronous Trigger for ZONEGOAL COALITION
+
+
+
+ ZONE_GOAL_COALITION:onafterGuard()
+When started, check the Coalition status.
+
+
+
+ ZONE_GOAL_COALITION:onenterAttacked()
+
+
+
+
+ ZONE_GOAL_COALITION:onenterCaptured()
+
+
+
+
+ ZONE_GOAL_COALITION:onenterEmpty()
+
+
+
+
+ ZONE_GOAL_COALITION:onenterGuarded()
+Bound.
+
+
+
+
+
Global(s)
+
+
+
+ #ZONE_GOAL_COALITION
+ZONE_GOAL_COALITION
+
+
+
+
+
+
+ZONEGOAL COALITION models processes that have a Goal with a defined achievement involving a Zone for a Coalition.
+
+
+Derived classes implement the ways how the achievements can be realized.
+
+1. ZONEGOAL COALITION constructor
+
+
+
+2. ZONEGOAL COALITION is a finite state machine (FSM).
+
+2.1 ZONEGOAL COALITION States
+
+
+ Captured : The Zone has been captured by an other coalition.Attacked : The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone.Guarded : The Zone is guarded by the owning coalition. There is no other unit of an other coalition in the Zone.Empty : The Zone is empty. There is not valid unit in the Zone.
+
+2.2 ZONEGOAL COALITION Events
+
+
+ Capture : The Zone has been captured by an other coalition.Attack : The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone.Guard : The Zone is guarded by the owning coalition. There is no other unit of an other coalition in the Zone.Empty : The Zone is empty. There is not valid unit in the Zone.
+
+2.3 ZONEGOAL COALITION State Machine
+
+
+
+Hello | World
+------|------
+Test|Test2
+
+
+
+
+
+
+
+
Field(s)
+
+
+
+
+ZONE_GOAL.ScheduleStatusZone
+
+
+
+
+
+
+
+
+
+
+
+
+ZONE_GOAL.SmokeScheduler
+
+
+
+
+
+
+
+
+
+
+
Field(s)
+
+
+
+
+ZONE_GOAL_COALITION:Attack()
+
+
+
+
+Attack Trigger for ZONEGOAL COALITION
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:Capture()
+
+
+
+
+Capture Trigger for ZONEGOAL COALITION
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION.Coalition
+
+
+
+
+
+
+
+
+
+
+
+ #string
+
+ZONE_GOAL_COALITION.FsmStateAttacked
+
+
+
+
+
+
+
+
+
+
+
+ #string
+
+ZONE_GOAL_COALITION.FsmStateCaptured
+
+
+
+
+
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:GetCoalition()
+
+
+
+
+Get the owning coalition of the zone.
+
+ Return value
+
+DCSCoalition.DCSCoalition#coalition :
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:GetCoalitionName()
+
+
+
+
+Get the owning coalition name of the zone.
+
+ Return value
+
+#string:
+Coalition name.
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:IsAttacked()
+
+
+
+
+
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:IsCaptured()
+
+
+
+
+
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:IsGuarded()
+
+
+
+
+
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:Mark()
+
+
+
+
+Mark.
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION.MarkBlue
+
+
+
+
+
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION.MarkRed
+
+
+
+
+
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:New(Zone, Coalition)
+
+
+
+
+ZONEGOAL COALITION Constructor.
+
+ Parameters
+
+ Return value
+
+#ZONEGOAL COALITION :
+
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:OnAfterAttack(From, Event, To)
+
+
+
+
+Attack Handler OnAfter for ZONEGOAL COALITION
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:OnAfterCapture(From, Event, To)
+
+
+
+
+Capture Handler OnAfter for ZONEGOAL COALITION
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:OnBeforeAttack(From, Event, To)
+
+
+
+
+Attack Handler OnBefore for ZONEGOAL COALITION
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:OnBeforeCapture(From, Event, To)
+
+
+
+
+Capture Handler OnBefore for ZONEGOAL COALITION
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:OnEnterAttacked(From, Event, To)
+
+
+
+
+Attacked State Handler OnEnter for ZONEGOAL COALITION
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:OnEnterCaptured(From, Event, To)
+
+
+
+
+Captured State Handler OnEnter for ZONEGOAL COALITION
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:OnLeaveAttacked(From, Event, To)
+
+
+
+
+Attacked State Handler OnLeave for ZONEGOAL COALITION
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:OnLeaveCaptured(From, Event, To)
+
+
+
+
+Captured State Handler OnLeave for ZONEGOAL COALITION
+
+ Parameters
+
+
+
+#string From
+
+
+
+
+#string Event
+
+
+
+
+#string To
+
+
+
+ Return value
+
+#boolean:
+
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:SetCoalition(Coalition)
+
+
+
+
+Set the owning coalition of the zone.
+
+ Parameter
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION.States
+
+
+
+
+
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:StatusZone()
+
+
+
+
+Check status Coalition ownership.
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:__Attack(Delay)
+
+
+
+
+Attack Asynchronous Trigger for ZONEGOAL COALITION
+
+ Parameter
+
+
+
+#number Delay
+
+
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:__Capture(Delay)
+
+
+
+
+Capture Asynchronous Trigger for ZONEGOAL COALITION
+
+ Parameter
+
+
+
+#number Delay
+
+
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:onafterGuard()
+
+
+
+
+When started, check the Coalition status.
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:onenterAttacked()
+
+
+
+
+
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:onenterCaptured()
+
+
+
+
+
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:onenterEmpty()
+
+
+
+
+
+
+
+
+
+
+
+
+ZONE_GOAL_COALITION:onenterGuarded()
+
+
+
+
+Bound.
+
+
+
+
+
+
+
+
+
diff --git a/docs/Documentation/env.html b/docs/Documentation/env.html
index a88348417..c52b02783 100644
--- a/docs/Documentation/env.html
+++ b/docs/Documentation/env.html
@@ -60,6 +60,7 @@
Escort Event Fsm
+
Goal Group Identifiable Menu
@@ -72,6 +73,7 @@
Positionable Process_JTAC Process_Pickup
+
Protect Radio Rat Route
@@ -95,9 +97,13 @@
Task_A2G_Dispatcher Task_Cargo Task_PICKUP
+
Task_Protect Unit Utils Zone
+
ZoneCaptureCoalition
+
ZoneGoal
+
ZoneGoalCoalition env
land routines
diff --git a/docs/Documentation/index.html b/docs/Documentation/index.html
index f84a58bb2..c7000023f 100644
--- a/docs/Documentation/index.html
+++ b/docs/Documentation/index.html
@@ -60,6 +60,7 @@
Escort Event Fsm
+
Goal Group Identifiable Menu
@@ -72,6 +73,7 @@
Positionable Process_JTAC Process_Pickup
+
Protect Radio Rat Route
@@ -95,9 +97,13 @@
Task_A2G_Dispatcher Task_Cargo Task_PICKUP
+
Task_Protect Unit Utils Zone
+
ZoneCaptureCoalition
+
ZoneGoal
+
ZoneGoalCoalition env land routines
@@ -443,6 +449,12 @@ even when there are hardly any players in the mission.
Core -- The FSM (F inite S tate M achine) class and derived FSM_ classes
are design patterns allowing efficient (long-lasting) processes and workflows.
+
+
+
+ Goal
+Core -- Base class that models processes to achieve goals.
@@ -515,6 +527,12 @@ are design patterns allowing efficient (long-lasting) processes and workflows.Process_Pickup
+
+
+
+ Protect
+Functional -- The PROTECT class handles the protection of objects, which can be zones, units, scenery.
@@ -663,6 +681,12 @@ and creates a CSV file logging the scoring events and results for use at team or
Task_PICKUP
This module contains the TASK_PICKUP classes.
+
+
+
+ Task_Protect
+Tasking - The TASK_Protect models tasks for players to protect or capture specific zones.
@@ -682,6 +706,24 @@ which are excellent tools to be reused in an OO environment!.
Zone
Core -- ZONE classes define zones within your mission of various forms , with various capabilities .
+
+
+
+ ZoneCaptureCoalition
+Core -- Base class that models processes to capture a Zone for a Coalition, guarded by another Coalition.
+
+
+
+ ZoneGoal
+Core -- Base class that models processes to achieve goals involving a Zone.
+
+
+
+ ZoneGoalCoalition
+Core -- Base class that models processes to achieve goals involving a Zone for a Coalition.
diff --git a/docs/Documentation/land.html b/docs/Documentation/land.html
index faf8ff947..450568627 100644
--- a/docs/Documentation/land.html
+++ b/docs/Documentation/land.html
@@ -60,6 +60,7 @@
Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land
routines Escort Event Fsm Goal Group Identifiable Menu Positionable Process_JTAC Process_Pickup Protect Radio Rat Route Task_A2G_Dispatcher Task_Cargo Task_PICKUP Task_Protect Unit Utils Zone ZoneCaptureCoalition ZoneGoal ZoneGoalCoalition env land routines