ARTY v1.0.5

ARTY
* Groups can now be transported as cargo via ARTY:NewFromCargoGroup() function.
* If immobile units are defined as cargo, targets out of range are not deleted from the queue.

AI_CARGO_APC
* Adjusted function documentation.

AI_CARGO_DISPATCHER
* Adjusted function documentation.

AI_CARGO_HELICOPTER
* Adjusted function documentation.

CARGOG_ROUP
* Ajusted function documentation.

MESSAGE
* Adjusted function documentation.
* Added missing Settings parameter to some functions.

DCS
* Improved documentation.

MISSION:
* Adusted function documentatoin.

Moose Development/Moose/AI/AI_Cargo_APC.lua

@@ -117,6 +117,7 @@ function AI_CARGO_APC:New( APC, CargoSet, CombatRadius )
   -- @param #string Event
   -- @param #string To
   -- @param Core.Point#COORDINATE Coordinate
+  -- @param #number Speed Speed in km/h. Default is 50% of max possible speed the group can do. 
   -- @return #boolean
   
   --- Pickup Handler OnAfter for AI_CARGO_APC
@@ -126,17 +127,20 @@ function AI_CARGO_APC:New( APC, CargoSet, CombatRadius )
   -- @param #string Event
   -- @param #string To
   -- @param Core.Point#COORDINATE Coordinate
+  -- @param #number Speed Speed in km/h. Default is 50% of max possible speed the group can do.
   
   --- Pickup Trigger for AI_CARGO_APC
   -- @function [parent=#AI_CARGO_APC] Pickup
   -- @param #AI_CARGO_APC self
   -- @param Core.Point#COORDINATE Coordinate
+  -- @param #number Speed Speed in km/h. Default is 50% of max possible speed the group can do.
   
   --- Pickup Asynchronous Trigger for AI_CARGO_APC
   -- @function [parent=#AI_CARGO_APC] __Pickup
   -- @param #AI_CARGO_APC self
   -- @param #number Delay
   -- @param Core.Point#COORDINATE Coordinate
+  -- @param #number Speed Speed in km/h. Default is 50% of max possible speed the group can do.
   
   --- Deploy Handler OnBefore for AI_CARGO_APC
   -- @function [parent=#AI_CARGO_APC] OnBeforeDeploy
@@ -145,6 +149,7 @@ function AI_CARGO_APC:New( APC, CargoSet, CombatRadius )
   -- @param #string Event
   -- @param #string To
   -- @param Core.Point#COORDINATE Coordinate
+  -- @param #number Speed Speed in km/h. Default is 50% of max possible speed the group can do.
   -- @return #boolean
   
   --- Deploy Handler OnAfter for AI_CARGO_APC
@@ -154,17 +159,20 @@ function AI_CARGO_APC:New( APC, CargoSet, CombatRadius )
   -- @param #string Event
   -- @param #string To
   -- @param Core.Point#COORDINATE Coordinate
+  -- @param #number Speed Speed in km/h. Default is 50% of max possible speed the group can do.
   
   --- Deploy Trigger for AI_CARGO_APC
   -- @function [parent=#AI_CARGO_APC] Deploy
   -- @param #AI_CARGO_APC self
   -- @param Core.Point#COORDINATE Coordinate
+  -- @param #number Speed Speed in km/h. Default is 50% of max possible speed the group can do.
   
   --- Deploy Asynchronous Trigger for AI_CARGO_APC
   -- @function [parent=#AI_CARGO_APC] __Deploy
   -- @param #AI_CARGO_APC self
   -- @param Core.Point#COORDINATE Coordinate
   -- @param #number Delay
+  -- @param #number Speed Speed in km/h. Default is 50% of max possible speed the group can do.
 
   
   --- Loaded Handler OnAfter for AI_CARGO_APC
@@ -335,8 +343,12 @@ function AI_CARGO_APC:FollowToCarrier( Me, APCUnit, CargoGroup )
 end
 
 
---- @param #AI_CARGO_APC self
+--- On after Monitor event.
+-- @param #AI_CARGO_APC self
 -- @param Wrapper.Group#GROUP APC
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
 function AI_CARGO_APC:onafterMonitor( APC, From, Event, To )
   self:F( { APC, From, Event, To } )
 
@@ -389,8 +401,12 @@ function AI_CARGO_APC:onafterMonitor( APC, From, Event, To )
 end
 
 
---- @param #AI_CARGO_APC self
+--- On before Load event.
+-- @param #AI_CARGO_APC self
 -- @param Wrapper.Group#GROUP APC
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
 function AI_CARGO_APC:onbeforeLoad( APC, From, Event, To )
   self:F( { APC, From, Event, To } )
 
@@ -427,8 +443,13 @@ function AI_CARGO_APC:onbeforeLoad( APC, From, Event, To )
   
 end
 
---- @param #AI_CARGO_APC self
+--- On after Board event.
+-- @param #AI_CARGO_APC self
 -- @param Wrapper.Group#GROUP APC
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param #string Cargo.Cargo#CARGO Cargo Cargo object.
 function AI_CARGO_APC:onafterBoard( APC, From, Event, To, Cargo )
   self:F( { APC, From, Event, To, Cargo } )
 
@@ -443,8 +464,13 @@ function AI_CARGO_APC:onafterBoard( APC, From, Event, To, Cargo )
   
 end
 
---- @param #AI_CARGO_APC self
+--- On before Loaded event.
+-- @param #AI_CARGO_APC self
 -- @param Wrapper.Group#GROUP APC
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @return #boolean Cargo loaded.
 function AI_CARGO_APC:onbeforeLoaded( APC, From, Event, To )
   self:F( { APC, From, Event, To } )
 
@@ -470,8 +496,13 @@ function AI_CARGO_APC:onbeforeLoaded( APC, From, Event, To )
 end
 
 
---- @param #AI_CARGO_APC self
+--- On after Unload event.
+-- @param #AI_CARGO_APC self
 -- @param Wrapper.Group#GROUP APC
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param #boolean Deployed Cargo is deployed.
 function AI_CARGO_APC:onafterUnload( APC, From, Event, To, Deployed )
   self:F( { APC, From, Event, To, Deployed } )
 
@@ -488,8 +519,14 @@ function AI_CARGO_APC:onafterUnload( APC, From, Event, To, Deployed )
   
 end
 
---- @param #AI_CARGO_APC self
+--- On after Unboard event.
+-- @param #AI_CARGO_APC self
 -- @param Wrapper.Group#GROUP APC
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param #string Cargo.Cargo#CARGO Cargo Cargo object.
+-- @param #boolean Deployed Cargo is deployed.
 function AI_CARGO_APC:onafterUnboard( APC, From, Event, To, Cargo, Deployed )
   self:F( { APC, From, Event, To, Cargo:GetName() } )
 
@@ -503,8 +540,15 @@ function AI_CARGO_APC:onafterUnboard( APC, From, Event, To, Cargo, Deployed )
   
 end
 
---- @param #AI_CARGO_APC self
+--- On before Unloaded event.
+-- @param #AI_CARGO_APC self
 -- @param Wrapper.Group#GROUP APC
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param #string Cargo.Cargo#CARGO Cargo Cargo object.
+-- @param #boolean Deployed Cargo is deployed.
+-- @return #boolean All cargo unloaded.
 function AI_CARGO_APC:onbeforeUnloaded( APC, From, Event, To, Cargo, Deployed )
   self:F( { APC, From, Event, To, Cargo:GetName(), Deployed = Deployed } )
 
@@ -544,8 +588,12 @@ function AI_CARGO_APC:onbeforeUnloaded( APC, From, Event, To, Cargo, Deployed )
 end
 
 
---- @param #AI_CARGO_APC self
+--- On after Follow event.
+-- @param #AI_CARGO_APC self
 -- @param Wrapper.Group#GROUP APC
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
 function AI_CARGO_APC:onafterFollow( APC, From, Event, To )
   self:F( { APC, From, Event, To } )
 
@@ -591,7 +639,8 @@ end
 
 
 
---- @param #AI_CARGO_APC self
+--- On after Pickup event.
+-- @param #AI_CARGO_APC self
 -- @param Wrapper.Group#GROUP APC
 -- @param From
 -- @param Event
@@ -626,13 +675,14 @@ function AI_CARGO_APC:onafterPickup( APC, From, Event, To, Coordinate, Speed )
 end
 
 
---- @param #AI_CARGO_APC self
+--- On after Deploy event.
+-- @param #AI_CARGO_APC self
 -- @param Wrapper.Group#GROUP APC
 -- @param From
 -- @param Event
 -- @param To
--- @param Core.Point#COORDINATE Coordinate
--- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
+-- @param Core.Point#COORDINATE Coordinate Deploy place.
+-- @param #number Speed Speed in km/h to drive to the depoly coordinate. Default is 50% of max possible speed the unit can go.
 function AI_CARGO_APC:onafterDeploy( APC, From, Event, To, Coordinate, Speed )
 
   if APC and APC:IsAlive() then
@@ -655,12 +705,13 @@ function AI_CARGO_APC:onafterDeploy( APC, From, Event, To, Coordinate, Speed )
 end
 
 
---- @param #AI_CARGO_APC self
+--- On after Home event.
+-- @param #AI_CARGO_APC self
 -- @param Wrapper.Group#GROUP APC
 -- @param From
 -- @param Event
 -- @param To
--- @param Core.Point#COORDINATE Coordinate
+-- @param Core.Point#COORDINATE Coordinate Home place.
 -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
 function AI_CARGO_APC:onafterHome( APC, From, Event, To, Coordinate, Speed )
 

Moose Development/Moose/AI/AI_Cargo_Dispatcher.lua

@@ -90,7 +90,7 @@ AI_CARGO_DISPATCHER.PickupCargo = {}
 -- @param #AI_CARGO_DISPATCHER self
 -- @param Core.Set#SET_GROUP SetCarrier
 -- @param Core.Set#SET_CARGO SetCargo
--- @param Core.Set#SET_ZONE SetDeployZone
+-- @param Core.Set#SET_ZONE SetDeployZones
 -- @return #AI_CARGO_DISPATCHER
 -- @usage
 -- 
@@ -434,11 +434,11 @@ end
 --- Loaded Handler OnAfter for AI_CARGO_DISPATCHER
 -- @function [parent=#AI_CARGO_DISPATCHER] OnAfterLoaded
 -- @param #AI_CARGO_DISPATCHER self
--- @param #string From
--- @param #string Event
--- @param #string To
--- @param Wrapper.Group#GROUP Carrier
--- @param Cargo.Cargo#CARGO Cargo
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param Wrapper.Group#GROUP Carrier Carrier object.
+-- @param Cargo.Cargo#CARGO Cargo Cargo object.
 
 --- Unloaded Handler OnAfter for AI_CARGO_DISPATCHER
 -- @function [parent=#AI_CARGO_DISPATCHER] OnAfterUnloaded

Moose Development/Moose/AI/AI_Cargo_Helicopter.lua

@@ -200,8 +200,6 @@ end
 -- @param From
 -- @param Event
 -- @param To
--- @param Core.Point#COORDINATE Coordinate
--- @param #number Speed
 function AI_CARGO_HELICOPTER:onafterLanded( Helicopter, From, Event, To )
 
   Helicopter:F( { Name = Helicopter:GetName() } )
@@ -245,7 +243,7 @@ end
 -- @param To
 -- @param Core.Point#COORDINATE Coordinate
 -- @param #number Speed
-function AI_CARGO_HELICOPTER:onafterQueue( Helicopter, From, Event, To, Coordinate )
+function AI_CARGO_HELICOPTER:onafterQueue( Helicopter, From, Event, To, Coordinate, Speed )
 
   local HelicopterInZone = false
 
@@ -359,10 +357,13 @@ function AI_CARGO_HELICOPTER:onafterOrbit( Helicopter, From, Event, To, Coordina
 end
 
 
-
---- @param #AI_CARGO_HELICOPTER self
+--- On Before event Load.
+-- @param #AI_CARGO_HELICOPTER self
 -- @param Wrapper.Group#GROUP Helicopter
-function AI_CARGO_HELICOPTER:onbeforeLoad( Helicopter, From, Event, To, Coordinate )
+-- @param #string From From state.
+-- @param #string Event Event
+-- @param #string To To state.
+function AI_CARGO_HELICOPTER:onbeforeLoad( Helicopter, From, Event, To)
 
   local Boarding = false
 
@@ -400,10 +401,15 @@ function AI_CARGO_HELICOPTER:onbeforeLoad( Helicopter, From, Event, To, Coordina
   
 end
 
---- @param #AI_CARGO_HELICOPTER self
+--- On after Board event.
+-- @param #AI_CARGO_HELICOPTER self
 -- @param Wrapper.Group#GROUP Helicopter
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param Cargo.Cargo#CARGO Cargo Cargo object.
 function AI_CARGO_HELICOPTER:onafterBoard( Helicopter, From, Event, To, Cargo )
-  self:F( { APC, From, Event, To, Cargo } )
+  self:F( { Helicopter, From, Event, To, Cargo } )
 
   if Helicopter and Helicopter:IsAlive() then
     self:F({ IsLoaded = Cargo:IsLoaded() } )
@@ -416,10 +422,16 @@ function AI_CARGO_HELICOPTER:onafterBoard( Helicopter, From, Event, To, Cargo )
   
 end
 
---- @param #AI_CARGO_HELICOPTER self
+--- On before Land event.
+-- @param #AI_CARGO_HELICOPTER self
 -- @param Wrapper.Group#GROUP Helicopter
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param Cargo.Cargo#CARGO Cargo Cargo object.
+-- @return #boolean Cargo is loaded.
 function AI_CARGO_HELICOPTER:onbeforeLoaded( Helicopter, From, Event, To, Cargo )
-  self:F( { APC, From, Event, To } )
+  self:F( { Helicopter, From, Event, To, Cargo } )
   
   local Loaded = true
 
@@ -439,8 +451,12 @@ function AI_CARGO_HELICOPTER:onbeforeLoaded( Helicopter, From, Event, To, Cargo
 end
 
 
---- @param #AI_CARGO_HELICOPTER self
+--- On after Unload event.
+-- @param #AI_CARGO_HELICOPTER self
 -- @param Wrapper.Group#GROUP Helicopter
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #boolean Deployed Cargo is deployed.
 function AI_CARGO_HELICOPTER:onafterUnload( Helicopter, From, Event, To, Deployed )
 
   if Helicopter and Helicopter:IsAlive() then
@@ -457,8 +473,14 @@ function AI_CARGO_HELICOPTER:onafterUnload( Helicopter, From, Event, To, Deploye
   
 end
 
---- @param #AI_CARGO_HELICOPTER self
+--- On after Unboard event.
+-- @param #AI_CARGO_HELICOPTER self
 -- @param Wrapper.Group#GROUP Helicopter
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param Cargo.Cargo#CARGO Cargo Cargo object.
+-- @param #boolean Deployed Cargo is deployed.
 function AI_CARGO_HELICOPTER:onafterUnboard( Helicopter, From, Event, To, Cargo, Deployed )
 
   if Helicopter and Helicopter:IsAlive() then
@@ -471,8 +493,15 @@ function AI_CARGO_HELICOPTER:onafterUnboard( Helicopter, From, Event, To, Cargo,
   
 end
 
---- @param #AI_CARGO_HELICOPTER self
+--- On before Unloaded event.
+-- @param #AI_CARGO_HELICOPTER self
 -- @param Wrapper.Group#GROUP Helicopter
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param Cargo.Cargo#CARGO Cargo Cargo object.
+-- @param #boolean Deployed Cargo is deployed.
+-- @return #boolean True if all cargo has been unloaded.
 function AI_CARGO_HELICOPTER:onbeforeUnloaded( Helicopter, From, Event, To, Cargo, Deployed )
   self:F( { APC, From, Event, To, Cargo:GetName(), Deployed = Deployed } )
 
@@ -508,8 +537,14 @@ function AI_CARGO_HELICOPTER:onbeforeUnloaded( Helicopter, From, Event, To, Carg
   
 end
 
---- @param #AI_CARGO_HELICOPTER self
+--- On after Unloaded event.
+-- @param #AI_CARGO_HELICOPTER self
 -- @param Wrapper.Group#GROUP Helicopter
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param Cargo.Cargo#CARGO Cargo Cargo object.
+-- @param #boolean Deployed Cargo is deployed.
 function AI_CARGO_HELICOPTER:onafterUnloaded( Helicopter, From, Event, To, Cargo, Deployed )
 
   self:Orbit( Helicopter:GetCoordinate(), 50 )
@@ -523,12 +558,13 @@ function AI_CARGO_HELICOPTER:onafterUnloaded( Helicopter, From, Event, To, Cargo
 
 end
 
---- @param #AI_CARGO_HELICOPTER self
+--- On after Pickup event.
+-- @param #AI_CARGO_HELICOPTER self
 -- @param Wrapper.Group#GROUP Helicopter
 -- @param From
 -- @param Event
 -- @param To
--- @param Core.Point#COORDINATE Coordinate
+-- @param Core.Point#COORDINATE Coordinate Pickup place.
 -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
 function AI_CARGO_HELICOPTER:onafterPickup( Helicopter, From, Event, To, Coordinate, Speed )
 
@@ -537,7 +573,7 @@ function AI_CARGO_HELICOPTER:onafterPickup( Helicopter, From, Event, To, Coordin
     Helicopter:Activate()
 
     self.RoutePickup = true
-    Coordinate.y = math.random( 50, 200 )
+    Coordinate.y = math.random( 50, 500 )
     
     local _speed=Speed or Helicopter:GetSpeedMax()*0.5        
      
@@ -586,12 +622,16 @@ function AI_CARGO_HELICOPTER:onafterPickup( Helicopter, From, Event, To, Coordin
   
 end
 
-
+--- Depoloy function and queue.
+-- @param #AI_CARGO_HELICOPTER self
+-- @param Wrapper.Group#GROUP AICargoHelicopter
+-- @param Core.Point#COORDINATE Coordinate Coordinate
 function AI_CARGO_HELICOPTER:_Deploy( AICargoHelicopter, Coordinate )
   AICargoHelicopter:__Queue( -10, Coordinate, 100 )
 end
 
---- @param #AI_CARGO_HELICOPTER self
+--- On after Deploy event.
+-- @param #AI_CARGO_HELICOPTER self
 -- @param Wrapper.Group#GROUP Helicopter
 -- @param From
 -- @param Event
@@ -609,7 +649,7 @@ function AI_CARGO_HELICOPTER:onafterDeploy( Helicopter, From, Event, To, Coordin
     
     --- Calculate the target route point.
 
-    Coordinate.y = math.random( 50, 200 )  
+    Coordinate.y = math.random( 50, 500 )
     
     local _speed=Speed or Helicopter:GetSpeedMax()*0.5      
 
@@ -659,12 +699,13 @@ function AI_CARGO_HELICOPTER:onafterDeploy( Helicopter, From, Event, To, Coordin
 end
 
 
---- @param #AI_CARGO_HELICOPTER self
+--- On after Home event.
+-- @param #AI_CARGO_HELICOPTER self
 -- @param Wrapper.Group#GROUP Helicopter
 -- @param From
 -- @param Event
 -- @param To
--- @param Core.Point#COORDINATE Coordinate
+-- @param Core.Point#COORDINATE Coordinate Home place.
 -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
 function AI_CARGO_HELICOPTER:onafterHome( Helicopter, From, Event, To, Coordinate, Speed )