New File Structure Updates

Moose Development/Moose/Functional/AIBalancer.lua

@@ -2,15 +2,15 @@
 -- 
 -- ===
 -- 
--- 1) @{AIBalancer#AIBALANCER} class, extends @{StateMachine#STATEMACHINE_SET}
+-- 1) @{Functional.AIBalancer#AIBALANCER} class, extends @{Fsm.Fsm#FSM_SET}
 -- ===================================================================================
--- The @{AIBalancer#AIBALANCER} class monitors and manages as many AI GROUPS as there are
+-- The @{Functional.AIBalancer#AIBALANCER} class monitors and manages as many AI GROUPS as there are
 -- CLIENTS in a SET_CLIENT collection not occupied by players.
 -- The AIBALANCER class manages internally a collection of AI management objects, which govern the behaviour 
 -- of the underlying AI GROUPS.
 -- 
--- The parent class @{StateMachine#STATEMACHINE_SET} manages the functionality to control the Finite State Machine (FSM) 
--- and calls for each event the state transition methods providing the internal @{StateMachine#STATEMACHINE_SET.Set} object containing the
+-- The parent class @{Fsm.Fsm#FSM_SET} manages the functionality to control the Finite State Machine (FSM) 
+-- and calls for each event the state transition methods providing the internal @{Fsm.Fsm#FSM_SET.Set} object containing the
 -- SET_GROUP and additional event parameters provided during the event.
 -- 
 -- 1.1) AIBALANCER construction method
@@ -28,8 +28,8 @@
 -- ------------------------------------------
 -- You can configure to have the AI to return to:
 -- 
---    * @{#AIBALANCER.ReturnToHomeAirbase}: Returns the AI to the home @{Airbase#AIRBASE}.
---    * @{#AIBALANCER.ReturnToNearestAirbases}: Returns the AI to the nearest friendly @{Airbase#AIRBASE}.
+--    * @{#AIBALANCER.ReturnToHomeAirbase}: Returns the AI to the home @{Wrapper.Airbase#AIRBASE}.
+--    * @{#AIBALANCER.ReturnToNearestAirbases}: Returns the AI to the nearest friendly @{Wrapper.Airbase#AIRBASE}.
 -- --
 -- ===
 -- 
@@ -73,8 +73,8 @@
 
 --- AIBALANCER class
 -- @type AIBALANCER
--- @field Set#SET_CLIENT SetClient
--- @extends StateMachine#STATEMACHINE_SET
+-- @field Core.Set#SET_CLIENT SetClient
+-- @extends Fsm.Fsm#FSM_SET
 AIBALANCER = {
   ClassName = "AIBALANCER",
   PatrolZones = {},
@@ -83,8 +83,8 @@ AIBALANCER = {
 
 --- Creates a new AIBALANCER object
 -- @param #AIBALANCER self
--- @param Set#SET_CLIENT SetClient A SET\_CLIENT object that will contain the CLIENT objects to be monitored if they are alive or not (joined by a player).
--- @param Spawn#SPAWN SpawnAI The default Spawn object to spawn new AI Groups when needed.
+-- @param Core.Set#SET_CLIENT SetClient A SET\_CLIENT object that will contain the CLIENT objects to be monitored if they are alive or not (joined by a player).
+-- @param Functional.Spawn#SPAWN SpawnAI The default Spawn object to spawn new AI Groups when needed.
 -- @return #AIBALANCER
 -- @usage
 -- -- Define a new AIBALANCER Object.
@@ -104,7 +104,7 @@ function AIBALANCER:New( SetClient, SpawnAI )
   }
   
   -- Inherits from BASE
-  local self = BASE:Inherit( self, STATEMACHINE_SET:New( FSMT, SET_GROUP:New() ) )
+  local self = BASE:Inherit( self, FSM_SET:New( FSMT, SET_GROUP:New() ) )
   
   self.SetClient = SetClient
   self.SpawnAI = SpawnAI
@@ -116,10 +116,10 @@ function AIBALANCER:New( SetClient, SpawnAI )
   return self
 end
 
---- Returns the AI to the nearest friendly @{Airbase#AIRBASE}.
+--- Returns the AI to the nearest friendly @{Wrapper.Airbase#AIRBASE}.
 -- @param #AIBALANCER self
--- @param DCSTypes#Distance ReturnTresholdRange If there is an enemy @{Client#CLIENT} within the ReturnTresholdRange given in meters, the AI will not return to the nearest @{Airbase#AIRBASE}.
--- @param Set#SET_AIRBASE ReturnAirbaseSet The SET of @{Set#SET_AIRBASE}s to evaluate where to return to.
+-- @param Dcs.DCSTypes#Distance ReturnTresholdRange If there is an enemy @{Wrapper.Client#CLIENT} within the ReturnTresholdRange given in meters, the AI will not return to the nearest @{Wrapper.Airbase#AIRBASE}.
+-- @param Core.Set#SET_AIRBASE ReturnAirbaseSet The SET of @{Core.Set#SET_AIRBASE}s to evaluate where to return to.
 function AIBALANCER:ReturnToNearestAirbases( ReturnTresholdRange, ReturnAirbaseSet )
 
   self.ToNearestAirbase = true
@@ -127,9 +127,9 @@ function AIBALANCER:ReturnToNearestAirbases( ReturnTresholdRange, ReturnAirbaseS
   self.ReturnAirbaseSet = ReturnAirbaseSet
 end
 
---- Returns the AI to the home @{Airbase#AIRBASE}.
+--- Returns the AI to the home @{Wrapper.Airbase#AIRBASE}.
 -- @param #AIBALANCER self
--- @param DCSTypes#Distance ReturnTresholdRange If there is an enemy @{Client#CLIENT} within the ReturnTresholdRange given in meters, the AI will not return to the nearest @{Airbase#AIRBASE}.
+-- @param Dcs.DCSTypes#Distance ReturnTresholdRange If there is an enemy @{Wrapper.Client#CLIENT} within the ReturnTresholdRange given in meters, the AI will not return to the nearest @{Wrapper.Airbase#AIRBASE}.
 function AIBALANCER:ReturnToHomeAirbase( ReturnTresholdRange )
 
   self.ToHomeAirbase = true
@@ -137,9 +137,9 @@ function AIBALANCER:ReturnToHomeAirbase( ReturnTresholdRange )
 end
 
 --- @param #AIBALANCER self
--- @param Set#SET_GROUP SetGroup
+-- @param Core.Set#SET_GROUP SetGroup
 -- @param #string ClientName
--- @param Group#GROUP AIGroup
+-- @param Wrapper.Group#GROUP AIGroup
 function AIBALANCER:onenterSpawning( SetGroup, ClientName )
 
   -- OK, Spawn a new group from the default SpawnAI object provided.
@@ -151,16 +151,16 @@ function AIBALANCER:onenterSpawning( SetGroup, ClientName )
 end
 
 --- @param #AIBALANCER self
--- @param Set#SET_GROUP SetGroup
--- @param Group#GROUP AIGroup
+-- @param Core.Set#SET_GROUP SetGroup
+-- @param Wrapper.Group#GROUP AIGroup
 function AIBALANCER:onenterDestroying( SetGroup, AIGroup )
 
   AIGroup:Destroy()
 end
 
 --- @param #AIBALANCER self
--- @param Set#SET_GROUP SetGroup
--- @param Group#GROUP AIGroup
+-- @param Core.Set#SET_GROUP SetGroup
+-- @param Wrapper.Group#GROUP AIGroup
 function AIBALANCER:onenterReturning( SetGroup, AIGroup )
 
     local AIGroupTemplate = AIGroup:GetTemplate()
@@ -188,11 +188,11 @@ end
 function AIBALANCER:onenterMonitoring( SetGroup )
 
   self.SetClient:ForEachClient(
-    --- @param Client#CLIENT Client
+    --- @param Wrapper.Client#CLIENT Client
     function( Client )
       self:E(Client.ClientName)
 
-      local AIGroup = self.Set:Get( Client.UnitName ) -- Group#GROUP
+      local AIGroup = self.Set:Get( Client.UnitName ) -- Wrapper.Group#GROUP
       if Client:IsAlive() then
 
         if AIGroup and AIGroup:IsAlive() == true then
@@ -210,7 +210,7 @@ function AIBALANCER:onenterMonitoring( SetGroup )
             self:E( RangeZone )
             
             _DATABASE:ForEachPlayer(
-              --- @param Unit#UNIT RangeTestUnit
+              --- @param Wrapper.Unit#UNIT RangeTestUnit
               function( RangeTestUnit, RangeZone, AIGroup, PlayerInRange )
                 self:E( { PlayerInRange, RangeTestUnit.UnitName, RangeZone.ZoneName } )
                 if RangeTestUnit:IsInZone( RangeZone ) == true then
@@ -223,7 +223,7 @@ function AIBALANCER:onenterMonitoring( SetGroup )
               end,
               
               --- @param Zone#ZONE_RADIUS RangeZone
-              -- @param Group#GROUP AIGroup
+              -- @param Wrapper.Group#GROUP AIGroup
               function( RangeZone, AIGroup, PlayerInRange )
                 if PlayerInRange.Value == false then
                   self:Return( AIGroup )

Moose Development/Moose/Functional/AirbasePolice.lua

@@ -2,9 +2,9 @@
 --
 -- ===
 --
--- 1) @{AirbasePolice#AIRBASEPOLICE_BASE} class, extends @{Base#BASE}
+-- 1) @{Functional.AirbasePolice#AIRBASEPOLICE_BASE} class, extends @{Core.Base#BASE}
 -- ==================================================================
--- The @{AirbasePolice#AIRBASEPOLICE_BASE} class provides the main methods to monitor CLIENT behaviour at airbases.
+-- The @{Functional.AirbasePolice#AIRBASEPOLICE_BASE} class provides the main methods to monitor CLIENT behaviour at airbases.
 -- CLIENTS should not be allowed to:
 --
 --   * Don't taxi faster than 40 km/h.
@@ -12,7 +12,7 @@
 --   * Avoid to hit other planes on the airbase.
 --   * Obey ground control orders.
 --
--- 2) @{AirbasePolice#AIRBASEPOLICE_CAUCASUS} class, extends @{AirbasePolice#AIRBASEPOLICE_BASE}
+-- 2) @{Functional.AirbasePolice#AIRBASEPOLICE_CAUCASUS} class, extends @{Functional.AirbasePolice#AIRBASEPOLICE_BASE}
 -- =============================================================================================
 -- All the airbases on the caucasus map can be monitored using this class.
 -- If you want to monitor specific airbases, you need to use the @{#AIRBASEPOLICE_BASE.Monitor}() method, which takes a table or airbase names.
@@ -39,7 +39,7 @@
 --   * TbilisiLochini
 --   * Vaziani
 --
--- 3) @{AirbasePolice#AIRBASEPOLICE_NEVADA} class, extends @{AirbasePolice#AIRBASEPOLICE_BASE}
+-- 3) @{Functional.AirbasePolice#AIRBASEPOLICE_NEVADA} class, extends @{Functional.AirbasePolice#AIRBASEPOLICE_BASE}
 -- =============================================================================================
 -- All the airbases on the NEVADA map can be monitored using this class.
 -- If you want to monitor specific airbases, you need to use the @{#AIRBASEPOLICE_BASE.Monitor}() method, which takes a table or airbase names.
@@ -59,8 +59,8 @@
 
 
 --- @type AIRBASEPOLICE_BASE
--- @field Set#SET_CLIENT SetClient
--- @extends Base#BASE
+-- @field Core.Set#SET_CLIENT SetClient
+-- @extends Core.Base#BASE
 
 AIRBASEPOLICE_BASE = {
   ClassName = "AIRBASEPOLICE_BASE",
@@ -99,7 +99,7 @@ function AIRBASEPOLICE_BASE:New( SetClient, Airbases )
 --    self.Airbases.Template.ZoneRunways[1] = ZONE_POLYGON:New( "Template Runway 1", TemplateRunway1 ):SmokeZone(POINT_VEC3.SmokeColor.Red):Flush()
 
   self.SetClient:ForEachClient(
-    --- @param Client#CLIENT Client
+    --- @param Wrapper.Client#CLIENT Client
     function( Client )
       Client:SetState( self, "Speeding", false )
       Client:SetState( self, "Warnings", 0)
@@ -141,7 +141,7 @@ function AIRBASEPOLICE_BASE:_AirbaseMonitor()
 
       self.SetClient:ForEachClientInZone( Airbase.ZoneBoundary,
 
-        --- @param Client#CLIENT Client
+        --- @param Wrapper.Client#CLIENT Client
         function( Client )
 
           self:E( Client.UnitName )
@@ -219,7 +219,7 @@ end
 
 
 --- @type AIRBASEPOLICE_CAUCASUS
--- @field Set#SET_CLIENT SetClient
+-- @field Core.Set#SET_CLIENT SetClient
 -- @extends #AIRBASEPOLICE_BASE
 
 AIRBASEPOLICE_CAUCASUS = {
@@ -960,7 +960,7 @@ end
 
 
 --- @type AIRBASEPOLICE_NEVADA
--- @extends AirbasePolice#AIRBASEPOLICE_BASE
+-- @extends Functional.AirbasePolice#AIRBASEPOLICE_BASE
 AIRBASEPOLICE_NEVADA = {
   ClassName = "AIRBASEPOLICE_NEVADA",
   Airbases = {

Moose Development/Moose/Functional/CleanUp.lua

@@ -10,7 +10,7 @@
 
 --- The CLEANUP class.
 -- @type CLEANUP
--- @extends Base#BASE
+-- @extends Core.Base#BASE
 CLEANUP = {
 	ClassName = "CLEANUP",
 	ZoneNames = {},
@@ -51,7 +51,7 @@ end
 
 --- Destroys a group from the simulator, but checks first if it is still existing!
 -- @param #CLEANUP self
--- @param DCSGroup#Group GroupObject The object to be destroyed.
+-- @param Dcs.DCSWrapper.Group#Group GroupObject The object to be destroyed.
 -- @param #string CleanUpGroupName The groupname...
 function CLEANUP:_DestroyGroup( GroupObject, CleanUpGroupName )
 	self:F( { GroupObject, CleanUpGroupName } )
@@ -62,9 +62,9 @@ function CLEANUP:_DestroyGroup( GroupObject, CleanUpGroupName )
 	end
 end
 
---- Destroys a @{DCSUnit#Unit} from the simulator, but checks first if it is still existing!
+--- Destroys a @{Dcs.DCSWrapper.Unit#Unit} from the simulator, but checks first if it is still existing!
 -- @param #CLEANUP self
--- @param DCSUnit#Unit CleanUpUnit The object to be destroyed.
+-- @param Dcs.DCSWrapper.Unit#Unit CleanUpUnit The object to be destroyed.
 -- @param #string CleanUpUnitName The Unit name ...
 function CLEANUP:_DestroyUnit( CleanUpUnit, CleanUpUnitName )
 	self:F( { CleanUpUnit, CleanUpUnitName } )
@@ -89,10 +89,10 @@ function CLEANUP:_DestroyUnit( CleanUpUnit, CleanUpUnitName )
 	end
 end
 
--- TODO check DCSTypes#Weapon
+-- TODO check Dcs.DCSTypes#Weapon
 --- Destroys a missile from the simulator, but checks first if it is still existing!
 -- @param #CLEANUP self
--- @param DCSTypes#Weapon MissileObject
+-- @param Dcs.DCSTypes#Weapon MissileObject
 function CLEANUP:_DestroyMissile( MissileObject )
 	self:F( { MissileObject } )
 
@@ -134,7 +134,7 @@ end
 --- Detects if a crash event occurs.
 -- Crashed units go into a CleanUpList for removal.
 -- @param #CLEANUP self
--- @param DCSTypes#Event event
+-- @param Dcs.DCSTypes#Event event
 function CLEANUP:_EventCrash( Event )
 	self:F( { Event } )
 
@@ -157,7 +157,7 @@ end
 --- Detects if a unit shoots a missile.
 -- If this occurs within one of the zones, then the weapon used must be destroyed.
 -- @param #CLEANUP self
--- @param DCSTypes#Event event
+-- @param Dcs.DCSTypes#Event event
 function CLEANUP:_EventShot( Event )
 	self:F( { Event } )
 
@@ -174,7 +174,7 @@ end
 
 --- Detects if the Unit has an S_EVENT_HIT within the given ZoneNames. If this is the case, destroy the unit.
 -- @param #CLEANUP self
--- @param DCSTypes#Event event
+-- @param Dcs.DCSTypes#Event event
 function CLEANUP:_EventHitCleanUp( Event )
 	self:F( { Event } )
 
@@ -199,7 +199,7 @@ function CLEANUP:_EventHitCleanUp( Event )
 	end
 end
 
---- Add the @{DCSUnit#Unit} to the CleanUpList for CleanUp.
+--- Add the @{Dcs.DCSWrapper.Unit#Unit} to the CleanUpList for CleanUp.
 function CLEANUP:_AddForCleanUp( CleanUpUnit, CleanUpUnitName )
 	self:F( { CleanUpUnit, CleanUpUnitName } )
 
@@ -217,7 +217,7 @@ end
 
 --- Detects if the Unit has an S_EVENT_ENGINE_SHUTDOWN or an S_EVENT_HIT within the given ZoneNames. If this is the case, add the Group to the CLEANUP List.
 -- @param #CLEANUP self
--- @param DCSTypes#Event event
+-- @param Dcs.DCSTypes#Event event
 function CLEANUP:_EventAddForCleanUp( Event )
 
 	if Event.IniDCSUnit then

Moose Development/Moose/Functional/Detection.lua

@@ -2,14 +2,14 @@
 -- 
 -- ===
 -- 
--- 1) @{Detection#DETECTION_BASE} class, extends @{Base#BASE}
+-- 1) @{Functional.Detection#DETECTION_BASE} class, extends @{Core.Base#BASE}
 -- ==========================================================
--- The @{Detection#DETECTION_BASE} class defines the core functions to administer detected objects.
--- The @{Detection#DETECTION_BASE} class will detect objects within the battle zone for a list of @{Group}s detecting targets following (a) detection method(s).
+-- The @{Functional.Detection#DETECTION_BASE} class defines the core functions to administer detected objects.
+-- The @{Functional.Detection#DETECTION_BASE} class will detect objects within the battle zone for a list of @{Group}s detecting targets following (a) detection method(s).
 -- 
 -- 1.1) DETECTION_BASE constructor
 -- -------------------------------
--- Construct a new DETECTION_BASE instance using the @{Detection#DETECTION_BASE.New}() method.
+-- Construct a new DETECTION_BASE instance using the @{Functional.Detection#DETECTION_BASE.New}() method.
 -- 
 -- 1.2) DETECTION_BASE initialization
 -- ----------------------------------
@@ -20,46 +20,46 @@
 -- 
 -- Use the following functions to report the objects it detected using the methods Visual, Optical, Radar, IRST, RWR, DLINK:
 -- 
---   * @{Detection#DETECTION_BASE.InitDetectVisual}(): Detected using Visual.
---   * @{Detection#DETECTION_BASE.InitDetectOptical}(): Detected using Optical.
---   * @{Detection#DETECTION_BASE.InitDetectRadar}(): Detected using Radar.
---   * @{Detection#DETECTION_BASE.InitDetectIRST}(): Detected using IRST.
---   * @{Detection#DETECTION_BASE.InitDetectRWR}(): Detected using RWR.
---   * @{Detection#DETECTION_BASE.InitDetectDLINK}(): Detected using DLINK.
+--   * @{Functional.Detection#DETECTION_BASE.InitDetectVisual}(): Detected using Visual.
+--   * @{Functional.Detection#DETECTION_BASE.InitDetectOptical}(): Detected using Optical.
+--   * @{Functional.Detection#DETECTION_BASE.InitDetectRadar}(): Detected using Radar.
+--   * @{Functional.Detection#DETECTION_BASE.InitDetectIRST}(): Detected using IRST.
+--   * @{Functional.Detection#DETECTION_BASE.InitDetectRWR}(): Detected using RWR.
+--   * @{Functional.Detection#DETECTION_BASE.InitDetectDLINK}(): Detected using DLINK.
 -- 
 -- 1.3) Obtain objects detected by DETECTION_BASE
 -- ----------------------------------------------
--- DETECTION_BASE builds @{Set}s of objects detected. These @{Set#SET_BASE}s can be retrieved using the method @{Detection#DETECTION_BASE.GetDetectedSets}().
--- The method will return a list (table) of @{Set#SET_BASE} objects.
+-- DETECTION_BASE builds @{Set}s of objects detected. These @{Core.Set#SET_BASE}s can be retrieved using the method @{Functional.Detection#DETECTION_BASE.GetDetectedSets}().
+-- The method will return a list (table) of @{Core.Set#SET_BASE} objects.
 -- 
 -- ===
 -- 
--- 2) @{Detection#DETECTION_AREAS} class, extends @{Detection#DETECTION_BASE}
+-- 2) @{Functional.Detection#DETECTION_AREAS} class, extends @{Functional.Detection#DETECTION_BASE}
 -- ===============================================================================
--- The @{Detection#DETECTION_AREAS} class will detect units within the battle zone for a list of @{Group}s detecting targets following (a) detection method(s), 
--- and will build a list (table) of @{Set#SET_UNIT}s containing the @{Unit#UNIT}s detected.
+-- The @{Functional.Detection#DETECTION_AREAS} class will detect units within the battle zone for a list of @{Group}s detecting targets following (a) detection method(s), 
+-- and will build a list (table) of @{Core.Set#SET_UNIT}s containing the @{Wrapper.Unit#UNIT}s detected.
 -- The class is group the detected units within zones given a DetectedZoneRange parameter.
 -- A set with multiple detected zones will be created as there are groups of units detected.
 -- 
 -- 2.1) Retrieve the Detected Unit sets and Detected Zones
 -- -------------------------------------------------------
--- The DetectedUnitSets methods are implemented in @{Detection#DECTECTION_BASE} and the DetectedZones methods is implemented in @{Detection#DETECTION_AREAS}.
+-- The DetectedUnitSets methods are implemented in @{Functional.Detection#DECTECTION_BASE} and the DetectedZones methods is implemented in @{Functional.Detection#DETECTION_AREAS}.
 -- 
--- Retrieve the DetectedUnitSets with the method @{Detection#DETECTION_BASE.GetDetectedSets}(). A table will be return of @{Set#SET_UNIT}s.
--- To understand the amount of sets created, use the method @{Detection#DETECTION_BASE.GetDetectedSetCount}(). 
--- If you want to obtain a specific set from the DetectedSets, use the method @{Detection#DETECTION_BASE.GetDetectedSet}() with a given index.
+-- Retrieve the DetectedUnitSets with the method @{Functional.Detection#DETECTION_BASE.GetDetectedSets}(). A table will be return of @{Core.Set#SET_UNIT}s.
+-- To understand the amount of sets created, use the method @{Functional.Detection#DETECTION_BASE.GetDetectedSetCount}(). 
+-- If you want to obtain a specific set from the DetectedSets, use the method @{Functional.Detection#DETECTION_BASE.GetDetectedSet}() with a given index.
 -- 
--- Retrieve the formed @{Zone@ZONE_UNIT}s as a result of the grouping the detected units within the DetectionZoneRange, use the method @{Detection#DETECTION_BASE.GetDetectionZones}().
--- To understand the amount of zones created, use the method @{Detection#DETECTION_BASE.GetDetectionZoneCount}(). 
--- If you want to obtain a specific zone from the DetectedZones, use the method @{Detection#DETECTION_BASE.GetDetectionZone}() with a given index.
+-- Retrieve the formed @{Zone@ZONE_UNIT}s as a result of the grouping the detected units within the DetectionZoneRange, use the method @{Functional.Detection#DETECTION_BASE.GetDetectionZones}().
+-- To understand the amount of zones created, use the method @{Functional.Detection#DETECTION_BASE.GetDetectionZoneCount}(). 
+-- If you want to obtain a specific zone from the DetectedZones, use the method @{Functional.Detection#DETECTION_BASE.GetDetectionZone}() with a given index.
 -- 
 -- 1.4) Flare or Smoke detected units
 -- ----------------------------------
--- Use the methods @{Detection#DETECTION_AREAS.FlareDetectedUnits}() or @{Detection#DETECTION_AREAS.SmokeDetectedUnits}() to flare or smoke the detected units when a new detection has taken place.
+-- Use the methods @{Functional.Detection#DETECTION_AREAS.FlareDetectedUnits}() or @{Functional.Detection#DETECTION_AREAS.SmokeDetectedUnits}() to flare or smoke the detected units when a new detection has taken place.
 -- 
 -- 1.5) Flare or Smoke detected zones
 -- ----------------------------------
--- Use the methods @{Detection#DETECTION_AREAS.FlareDetectedZones}() or @{Detection#DETECTION_AREAS.SmokeDetectedZones}() to flare or smoke the detected zones when a new detection has taken place.
+-- Use the methods @{Functional.Detection#DETECTION_AREAS.FlareDetectedZones}() or @{Functional.Detection#DETECTION_AREAS.SmokeDetectedZones}() to flare or smoke the detected zones when a new detection has taken place.
 -- 
 -- ===
 -- 
@@ -77,12 +77,12 @@
 
 --- DETECTION_BASE class
 -- @type DETECTION_BASE
--- @field Set#SET_GROUP DetectionSetGroup The @{Set} of GROUPs in the Forward Air Controller role.
--- @field DCSTypes#Distance DetectionRange The range till which targets are accepted to be detected.
+-- @field Core.Set#SET_GROUP DetectionSetGroup The @{Set} of GROUPs in the Forward Air Controller role.
+-- @field Dcs.DCSTypes#Distance DetectionRange The range till which targets are accepted to be detected.
 -- @field #DETECTION_BASE.DetectedObjects DetectedObjects The list of detected objects.
 -- @field #table DetectedObjectsIdentified Map of the DetectedObjects identified.
 -- @field #number DetectionRun
--- @extends Base#BASE
+-- @extends Core.Base#BASE
 DETECTION_BASE = {
   ClassName = "DETECTION_BASE",
   DetectionSetGroup = nil,
@@ -104,8 +104,8 @@ DETECTION_BASE = {
 
 --- DETECTION constructor.
 -- @param #DETECTION_BASE self
--- @param Set#SET_GROUP DetectionSetGroup The @{Set} of GROUPs in the Forward Air Controller role.
--- @param DCSTypes#Distance DetectionRange The range till which targets are accepted to be detected.
+-- @param Core.Set#SET_GROUP DetectionSetGroup The @{Set} of GROUPs in the Forward Air Controller role.
+-- @param Dcs.DCSTypes#Distance DetectionRange The range till which targets are accepted to be detected.
 -- @return #DETECTION_BASE self
 function DETECTION_BASE:New( DetectionSetGroup, DetectionRange )
 
@@ -245,7 +245,7 @@ function DETECTION_BASE:GetDetectedObject( ObjectName )
   return nil
 end
 
---- Get the detected @{Set#SET_BASE}s.
+--- Get the detected @{Core.Set#SET_BASE}s.
 -- @param #DETECTION_BASE self
 -- @return #DETECTION_BASE.DetectedSets DetectedSets
 function DETECTION_BASE:GetDetectedSets()
@@ -266,7 +266,7 @@ end
 --- Get a SET of detected objects using a given numeric index.
 -- @param #DETECTION_BASE self
 -- @param #number Index
--- @return Set#SET_BASE
+-- @return Core.Set#SET_BASE
 function DETECTION_BASE:GetDetectedSet( Index )
 
   local DetectionSet = self.DetectedSets[Index]
@@ -279,7 +279,7 @@ end
 
 --- Get the detection Groups.
 -- @param #DETECTION_BASE self
--- @return Group#GROUP
+-- @return Wrapper.Group#GROUP
 function DETECTION_BASE:GetDetectionSetGroup()
 
   local DetectionSetGroup = self.DetectionSetGroup
@@ -313,7 +313,7 @@ function DETECTION_BASE:Schedule( DelayTime, RepeatInterval )
 end
 
 
---- Form @{Set}s of detected @{Unit#UNIT}s in an array of @{Set#SET_BASE}s.
+--- Form @{Set}s of detected @{Wrapper.Unit#UNIT}s in an array of @{Core.Set#SET_BASE}s.
 -- @param #DETECTION_BASE self
 function DETECTION_BASE:_DetectionScheduler( SchedulerName )
   self:F2( { SchedulerName } )
@@ -323,7 +323,7 @@ function DETECTION_BASE:_DetectionScheduler( SchedulerName )
   self:UnIdentifyAllDetectedObjects() -- Resets the DetectedObjectsIdentified table
   
   for DetectionGroupID, DetectionGroupData in pairs( self.DetectionSetGroup:GetSet() ) do
-    local DetectionGroup = DetectionGroupData -- Group#GROUP
+    local DetectionGroup = DetectionGroupData -- Wrapper.Group#GROUP
 
     if DetectionGroup:IsAlive() then
 
@@ -339,7 +339,7 @@ function DETECTION_BASE:_DetectionScheduler( SchedulerName )
       )
       
       for DetectionDetectedTargetID, DetectionDetectedTarget in pairs( DetectionDetectedTargets ) do
-        local DetectionObject = DetectionDetectedTarget.object -- DCSObject#Object
+        local DetectionObject = DetectionDetectedTarget.object -- Dcs.DCSWrapper.Object#Object
         self:T2( DetectionObject )
         
         if DetectionObject and DetectionObject:isExist() and DetectionObject.id_ < 50000000 then
@@ -393,9 +393,9 @@ end
 
 --- DETECTION_AREAS class
 -- @type DETECTION_AREAS
--- @field DCSTypes#Distance DetectionZoneRange The range till which targets are grouped upon the first detected target.
+-- @field Dcs.DCSTypes#Distance DetectionZoneRange The range till which targets are grouped upon the first detected target.
 -- @field #DETECTION_AREAS.DetectedAreas DetectedAreas A list of areas containing the set of @{Unit}s, @{Zone}s, the center @{Unit} within the zone, and ID of each area that was detected within a DetectionZoneRange.
--- @extends Detection#DETECTION_BASE
+-- @extends Functional.Detection#DETECTION_BASE
 DETECTION_AREAS = {
   ClassName = "DETECTION_AREAS",
   DetectedAreas = { n = 0 },
@@ -406,21 +406,21 @@ DETECTION_AREAS = {
 -- @list <#DETECTION_AREAS.DetectedArea>
 
 --- @type DETECTION_AREAS.DetectedArea
--- @field Set#SET_UNIT Set -- The Set of Units in the detected area.
--- @field Zone#ZONE_UNIT Zone -- The Zone of the detected area.
+-- @field Core.Set#SET_UNIT Set -- The Set of Units in the detected area.
+-- @field Core.Zone#ZONE_UNIT Zone -- The Zone of the detected area.
 -- @field #boolean Changed Documents if the detected area has changes.
 -- @field #table Changes A list of the changes reported on the detected area. (It is up to the user of the detected area to consume those changes).
 -- @field #number AreaID -- The identifier of the detected area.
 -- @field #boolean FriendliesNearBy Indicates if there are friendlies within the detected area.
--- @field Unit#UNIT NearestFAC The nearest FAC near the Area.
+-- @field Wrapper.Unit#UNIT NearestFAC The nearest FAC near the Area.
 
 
 --- DETECTION_AREAS constructor.
--- @param Detection#DETECTION_AREAS self
--- @param Set#SET_GROUP DetectionSetGroup The @{Set} of GROUPs in the Forward Air Controller role.
--- @param DCSTypes#Distance DetectionRange The range till which targets are accepted to be detected.
--- @param DCSTypes#Distance DetectionZoneRange The range till which targets are grouped upon the first detected target.
--- @return Detection#DETECTION_AREAS self
+-- @param Functional.Detection#DETECTION_AREAS self
+-- @param Core.Set#SET_GROUP DetectionSetGroup The @{Set} of GROUPs in the Forward Air Controller role.
+-- @param Dcs.DCSTypes#Distance DetectionRange The range till which targets are accepted to be detected.
+-- @param Dcs.DCSTypes#Distance DetectionZoneRange The range till which targets are grouped upon the first detected target.
+-- @return Functional.Detection#DETECTION_AREAS self
 function DETECTION_AREAS:New( DetectionSetGroup, DetectionRange, DetectionZoneRange )
 
   -- Inherits from DETECTION_BASE
@@ -439,8 +439,8 @@ function DETECTION_AREAS:New( DetectionSetGroup, DetectionRange, DetectionZoneRa
 end
 
 --- Add a detected @{#DETECTION_AREAS.DetectedArea}.
--- @param Set#SET_UNIT Set -- The Set of Units in the detected area.
--- @param Zone#ZONE_UNIT Zone -- The Zone of the detected area.
+-- @param Core.Set#SET_UNIT Set -- The Set of Units in the detected area.
+-- @param Core.Zone#ZONE_UNIT Zone -- The Zone of the detected area.
 -- @return #DETECTION_AREAS.DetectedArea DetectedArea
 function DETECTION_AREAS:AddDetectedArea( Set, Zone )
   local DetectedAreas = self:GetDetectedAreas()
@@ -487,10 +487,10 @@ function DETECTION_AREAS:GetDetectedAreaCount()
   return DetectedAreaCount
 end
 
---- Get the @{Set#SET_UNIT} of a detecttion area using a given numeric index.
+--- Get the @{Core.Set#SET_UNIT} of a detecttion area using a given numeric index.
 -- @param #DETECTION_AREAS self
 -- @param #number Index
--- @return Set#SET_UNIT DetectedSet
+-- @return Core.Set#SET_UNIT DetectedSet
 function DETECTION_AREAS:GetDetectedSet( Index )
 
   local DetectedSetUnit = self.DetectedAreas[Index].Set
@@ -501,10 +501,10 @@ function DETECTION_AREAS:GetDetectedSet( Index )
   return nil
 end
 
---- Get the @{Zone#ZONE_UNIT} of a detection area using a given numeric index.
+--- Get the @{Core.Zone#ZONE_UNIT} of a detection area using a given numeric index.
 -- @param #DETECTION_AREAS self
 -- @param #number Index
--- @return Zone#ZONE_UNIT DetectedZone
+-- @return Core.Zone#ZONE_UNIT DetectedZone
 function DETECTION_AREAS:GetDetectedZone( Index )
 
   local DetectedZone = self.DetectedAreas[Index].Zone
@@ -517,11 +517,11 @@ end
 
 --- Background worker function to determine if there are friendlies nearby ...
 -- @param #DETECTION_AREAS self
--- @param Unit#UNIT ReportUnit
+-- @param Wrapper.Unit#UNIT ReportUnit
 function DETECTION_AREAS:ReportFriendliesNearBy( ReportGroupData )
   self:F2()
   
-  local DetectedArea = ReportGroupData.DetectedArea  -- Detection#DETECTION_AREAS.DetectedArea    
+  local DetectedArea = ReportGroupData.DetectedArea  -- Functional.Detection#DETECTION_AREAS.DetectedArea    
   local DetectedSet = ReportGroupData.DetectedArea.Set
   local DetectedZone = ReportGroupData.DetectedArea.Zone
   local DetectedZoneUnit = DetectedZone.ZoneUNIT
@@ -537,15 +537,15 @@ function DETECTION_AREAS:ReportFriendliesNearBy( ReportGroupData )
     
    }
    
-   --- @param DCSUnit#Unit FoundDCSUnit
-   -- @param Group#GROUP ReportGroup
+   --- @param Dcs.DCSWrapper.Unit#Unit FoundDCSUnit
+   -- @param Wrapper.Group#GROUP ReportGroup
    -- @param Set#SET_GROUP ReportSetGroup
    local FindNearByFriendlies = function( FoundDCSUnit, ReportGroupData )
       
-      local DetectedArea = ReportGroupData.DetectedArea  -- Detection#DETECTION_AREAS.DetectedArea    
+      local DetectedArea = ReportGroupData.DetectedArea  -- Functional.Detection#DETECTION_AREAS.DetectedArea    
       local DetectedSet = ReportGroupData.DetectedArea.Set
       local DetectedZone = ReportGroupData.DetectedArea.Zone
-      local DetectedZoneUnit = DetectedZone.ZoneUNIT -- Unit#UNIT
+      local DetectedZoneUnit = DetectedZone.ZoneUNIT -- Wrapper.Unit#UNIT
       local ReportSetGroup = ReportGroupData.ReportSetGroup
 
       local EnemyCoalition = DetectedZoneUnit:GetCoalition()
@@ -588,7 +588,7 @@ function DETECTION_AREAS:CalculateThreatLevelA2G( DetectedArea )
   
   local MaxThreatLevelA2G = 0
   for UnitName, UnitData in pairs( DetectedArea.Set:GetSet() ) do
-    local ThreatUnit = UnitData -- Unit#UNIT
+    local ThreatUnit = UnitData -- Wrapper.Unit#UNIT
     local ThreatLevelA2G = ThreatUnit:GetThreatLevel()
     if ThreatLevelA2G > MaxThreatLevelA2G then
       MaxThreatLevelA2G = ThreatLevelA2G
@@ -603,7 +603,7 @@ end
 --- Find the nearest FAC of the DetectedArea.
 -- @param #DETECTION_AREAS self
 -- @param #DETECTION_AREAS.DetectedArea DetectedArea
--- @return Unit#UNIT The nearest FAC unit
+-- @return Wrapper.Unit#UNIT The nearest FAC unit
 function DETECTION_AREAS:NearestFAC( DetectedArea )
   
   local NearestFAC = nil
@@ -611,7 +611,7 @@ function DETECTION_AREAS:NearestFAC( DetectedArea )
   
   for FACGroupName, FACGroupData in pairs( self.DetectionSetGroup:GetSet() ) do
     for FACUnit, FACUnitData in pairs( FACGroupData:GetUnits() ) do
-      local FACUnit = FACUnitData -- Unit#UNIT
+      local FACUnit = FACUnitData -- Wrapper.Unit#UNIT
       if FACUnit:IsActive() then
         local Vec3 = FACUnit:GetVec3()
         local PointVec3 = POINT_VEC3:NewFromVec3( Vec3 )
@@ -829,7 +829,7 @@ function DETECTION_AREAS:CreateDetectionSets()
         -- Then search for a new center area unit within the set. Note that the new area unit candidate must be within the area range.
         for DetectedUnitName, DetectedUnitData in pairs( DetectedSet:GetSet() ) do
  
-          local DetectedUnit = DetectedUnitData -- Unit#UNIT
+          local DetectedUnit = DetectedUnitData -- Wrapper.Unit#UNIT
           local DetectedObject = self:GetDetectedObject( DetectedUnit.UnitName ) 
 
           -- The DetectedObject can be nil when the DetectedUnit is not alive anymore or it is not in the DetectedObjects map.
@@ -859,7 +859,7 @@ function DETECTION_AREAS:CreateDetectionSets()
         -- If a unit was not found in the set, remove it from the set. This may be added later to other existing or new sets.
         for DetectedUnitName, DetectedUnitData in pairs( DetectedSet:GetSet() ) do
 
-          local DetectedUnit = DetectedUnitData -- Unit#UNIT
+          local DetectedUnit = DetectedUnitData -- Wrapper.Unit#UNIT
           local DetectedObject = nil
           if DetectedUnit:IsAlive() then
           --self:E(DetectedUnit:GetName())
@@ -909,7 +909,7 @@ function DETECTION_AREAS:CreateDetectionSets()
     if DetectedObject then
 
       -- We found an unidentified unit outside of any existing detection area.
-      local DetectedUnit = UNIT:FindByName( DetectedUnitName ) -- Unit#UNIT
+      local DetectedUnit = UNIT:FindByName( DetectedUnitName ) -- Wrapper.Unit#UNIT
       
       local AddedToDetectionArea = false
     
@@ -959,7 +959,7 @@ function DETECTION_AREAS:CreateDetectionSets()
       DetectedZone.ZoneUNIT:SmokeRed()
     end
     DetectedSet:ForEachUnit(
-      --- @param Unit#UNIT DetectedUnit
+      --- @param Wrapper.Unit#UNIT DetectedUnit
       function( DetectedUnit )
         if DetectedUnit:IsAlive() then
           self:T( "Detected Set #" .. DetectedArea.AreaID .. ":" .. DetectedUnit:GetName() )

Moose Development/Moose/Functional/Escort.lua

@@ -80,7 +80,7 @@
 -- ============================
 -- Create a new SPAWN object with the @{#ESCORT.New} method:
 --
---  * @{#ESCORT.New}: Creates a new ESCORT object from a @{Group#GROUP} for a @{Client#CLIENT}, with an optional briefing text.
+--  * @{#ESCORT.New}: Creates a new ESCORT object from a @{Wrapper.Group#GROUP} for a @{Wrapper.Client#CLIENT}, with an optional briefing text.
 --
 -- ESCORT initialization methods.
 -- ==============================
@@ -117,17 +117,17 @@
 
 --- ESCORT class
 -- @type ESCORT
--- @extends Base#BASE
--- @field Client#CLIENT EscortClient
--- @field Group#GROUP EscortGroup
+-- @extends Core.Base#BASE
+-- @field Wrapper.Client#CLIENT EscortClient
+-- @field Wrapper.Group#GROUP EscortGroup
 -- @field #string EscortName
 -- @field #ESCORT.MODE EscortMode The mode the escort is in.
--- @field Scheduler#SCHEDULER FollowScheduler The instance of the SCHEDULER class.
+-- @field Core.Scheduler#SCHEDULER FollowScheduler The instance of the SCHEDULER class.
 -- @field #number FollowDistance The current follow distance.
 -- @field #boolean ReportTargets If true, nearby targets are reported.
--- @Field DCSTypes#AI.Option.Air.val.ROE OptionROE Which ROE is set to the EscortGroup.
--- @field DCSTypes#AI.Option.Air.val.REACTION_ON_THREAT OptionReactionOnThreat Which REACTION_ON_THREAT is set to the EscortGroup.
--- @field Menu#MENU_CLIENT EscortMenuResumeMission
+-- @Field Dcs.DCSTypes#AI.Option.Air.val.ROE OptionROE Which ROE is set to the EscortGroup.
+-- @field Dcs.DCSTypes#AI.Option.Air.val.REACTION_ON_THREAT OptionReactionOnThreat Which REACTION_ON_THREAT is set to the EscortGroup.
+-- @field Core.Menu#MENU_CLIENT EscortMenuResumeMission
 ESCORT = {
   ClassName = "ESCORT",
   EscortName = nil, -- The Escort Name
@@ -161,8 +161,8 @@ ESCORT = {
 
 --- ESCORT class constructor for an AI group
 -- @param #ESCORT self
--- @param Client#CLIENT EscortClient The client escorted by the EscortGroup.
--- @param Group#GROUP EscortGroup The group AI escorting the EscortClient.
+-- @param Wrapper.Client#CLIENT EscortClient The client escorted by the EscortGroup.
+-- @param Wrapper.Group#GROUP EscortGroup The group AI escorting the EscortClient.
 -- @param #string EscortName Name of the escort.
 -- @param #string EscortBriefing A text showing the ESCORT briefing to the player. Note that if no EscortBriefing is provided, the default briefing will be shown.
 -- @return #ESCORT self
@@ -179,8 +179,8 @@ function ESCORT:New( EscortClient, EscortGroup, EscortName, EscortBriefing )
   local self = BASE:Inherit( self, BASE:New() )
   self:F( { EscortClient, EscortGroup, EscortName } )
 
-  self.EscortClient = EscortClient -- Client#CLIENT
-  self.EscortGroup = EscortGroup -- Group#GROUP
+  self.EscortClient = EscortClient -- Wrapper.Client#CLIENT
+  self.EscortGroup = EscortGroup -- Wrapper.Group#GROUP
   self.EscortName = EscortName
   self.EscortBriefing = EscortBriefing
 
@@ -268,7 +268,7 @@ end
 --- Defines a menu slot to let the escort Join and Follow you at a certain distance.
 -- This menu will appear under **Navigation**.
 -- @param #ESCORT self
--- @param DCSTypes#Distance Distance The distance in meters that the escort needs to follow the client.
+-- @param Dcs.DCSTypes#Distance Distance The distance in meters that the escort needs to follow the client.
 -- @return #ESCORT
 function ESCORT:MenuFollowAt( Distance )
   self:F(Distance)
@@ -293,8 +293,8 @@ end
 --- Defines a menu slot to let the escort hold at their current position and stay low with a specified height during a specified time in seconds.
 -- This menu will appear under **Hold position**.
 -- @param #ESCORT self
--- @param DCSTypes#Distance Height Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.
--- @param DCSTypes#Time Seconds Optional parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given.
+-- @param Dcs.DCSTypes#Distance Height Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.
+-- @param Dcs.DCSTypes#Time Seconds Optional parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given.
 -- @param #string MenuTextFormat Optional parameter that shows the menu option text. The text string is formatted, and should contain two %d tokens in the string. The first for the Height, the second for the Time (if given). If no text is given, the default text will be displayed.
 -- @return #ESCORT
 -- TODO: Implement Seconds parameter. Challenge is to first develop the "continue from last activity" function.
@@ -355,8 +355,8 @@ end
 --- Defines a menu slot to let the escort hold at the client position and stay low with a specified height during a specified time in seconds.
 -- This menu will appear under **Navigation**.
 -- @param #ESCORT self
--- @param DCSTypes#Distance Height Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.
--- @param DCSTypes#Time Seconds Optional parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given.
+-- @param Dcs.DCSTypes#Distance Height Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.
+-- @param Dcs.DCSTypes#Time Seconds Optional parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given.
 -- @param #string MenuTextFormat Optional parameter that shows the menu option text. The text string is formatted, and should contain one or two %d tokens in the string. The first for the Height, the second for the Time (if given). If no text is given, the default text will be displayed.
 -- @return #ESCORT
 -- TODO: Implement Seconds parameter. Challenge is to first develop the "continue from last activity" function.
@@ -416,8 +416,8 @@ end
 --- Defines a menu slot to let the escort scan for targets at a certain height for a certain time in seconds.
 -- This menu will appear under **Scan targets**.
 -- @param #ESCORT self
--- @param DCSTypes#Distance Height Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.
--- @param DCSTypes#Time Seconds Optional parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given.
+-- @param Dcs.DCSTypes#Distance Height Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.
+-- @param Dcs.DCSTypes#Time Seconds Optional parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given.
 -- @param #string MenuTextFormat Optional parameter that shows the menu option text. The text string is formatted, and should contain one or two %d tokens in the string. The first for the Height, the second for the Time (if given). If no text is given, the default text will be displayed.
 -- @return #ESCORT
 function ESCORT:MenuScanForTargets( Height, Seconds, MenuTextFormat )
@@ -542,7 +542,7 @@ end
 -- This menu will appear under **Report targets**.
 -- Note that if a report targets menu is not specified, no targets will be detected by the escort, and the attack and assisted attack menus will not be displayed.
 -- @param #ESCORT self
--- @param DCSTypes#Time Seconds Optional parameter that lets the escort report their current detected targets after specified time interval in seconds. The default time is 30 seconds.
+-- @param Dcs.DCSTypes#Time Seconds Optional parameter that lets the escort report their current detected targets after specified time interval in seconds. The default time is 30 seconds.
 -- @return #ESCORT
 function ESCORT:MenuReportTargets( Seconds )
   self:F( { Seconds } )
@@ -664,8 +664,8 @@ function ESCORT._HoldPosition( MenuParam )
   local EscortGroup = self.EscortGroup
   local EscortClient = self.EscortClient
 
-  local OrbitGroup = MenuParam.ParamOrbitGroup -- Group#GROUP
-  local OrbitUnit = OrbitGroup:GetUnit(1) -- Unit#UNIT
+  local OrbitGroup = MenuParam.ParamOrbitGroup -- Wrapper.Group#GROUP
+  local OrbitUnit = OrbitGroup:GetUnit(1) -- Wrapper.Unit#UNIT
   local OrbitHeight = MenuParam.ParamHeight
   local OrbitSeconds = MenuParam.ParamSeconds -- Not implemented yet
 
@@ -714,10 +714,10 @@ function ESCORT._JoinUpAndFollow( MenuParam )
 end
 
 --- JoinsUp and Follows a CLIENT.
--- @param Escort#ESCORT self
--- @param Group#GROUP EscortGroup
--- @param Client#CLIENT EscortClient
--- @param DCSTypes#Distance Distance
+-- @param Functional.Escort#ESCORT self
+-- @param Wrapper.Group#GROUP EscortGroup
+-- @param Wrapper.Client#CLIENT EscortClient
+-- @param Dcs.DCSTypes#Distance Distance
 function ESCORT:JoinUpAndFollow( EscortGroup, EscortClient, Distance )
   self:F( { EscortGroup, EscortClient, Distance } )
 
@@ -832,7 +832,7 @@ function ESCORT._ScanTargets( MenuParam )
 
 end
 
---- @param Group#GROUP EscortGroup
+--- @param Wrapper.Group#GROUP EscortGroup
 function _Resume( EscortGroup )
   env.info( '_Resume' )
 
@@ -851,7 +851,7 @@ function ESCORT._AttackTarget( MenuParam )
   local EscortGroup = self.EscortGroup
   
   local EscortClient = self.EscortClient
-  local AttackUnit = MenuParam.ParamUnit -- Unit#UNIT
+  local AttackUnit = MenuParam.ParamUnit -- Wrapper.Unit#UNIT
 
   self.FollowScheduler:Stop()
 
@@ -892,7 +892,7 @@ function ESCORT._AssistTarget( MenuParam )
   local EscortGroup = self.EscortGroup
   local EscortClient = self.EscortClient
   local EscortGroupAttack = MenuParam.ParamEscortGroup
-  local AttackUnit = MenuParam.ParamUnit -- Unit#UNIT
+  local AttackUnit = MenuParam.ParamUnit -- Wrapper.Unit#UNIT
 
   self.FollowScheduler:Stop()
 
@@ -981,7 +981,7 @@ end
 function ESCORT:RegisterRoute()
   self:F()
 
-  local EscortGroup = self.EscortGroup -- Group#GROUP
+  local EscortGroup = self.EscortGroup -- Wrapper.Group#GROUP
 
   local TaskPoints = EscortGroup:GetTaskRoute()
 
@@ -990,7 +990,7 @@ function ESCORT:RegisterRoute()
   return TaskPoints
 end
 
---- @param Escort#ESCORT self
+--- @param Functional.Escort#ESCORT self
 function ESCORT:_FollowScheduler()
   self:F( { self.FollowDistance } )
 

Moose Development/Moose/Functional/MissileTrainer.lua

@@ -2,7 +2,7 @@
 -- 
 -- ===
 --
--- 1) @{MissileTrainer#MISSILETRAINER} class, extends @{Base#BASE}
+-- 1) @{Functional.MissileTrainer#MISSILETRAINER} class, extends @{Core.Base#BASE}
 -- ===============================================================
 -- The @{#MISSILETRAINER} class uses the DCS world messaging system to be alerted of any missiles fired, and when a missile would hit your aircraft,
 -- the class will destroy the missile within a certain range, to avoid damage to your aircraft.
@@ -83,8 +83,8 @@
 
 --- The MISSILETRAINER class
 -- @type MISSILETRAINER
--- @field Set#SET_CLIENT DBClients
--- @extends Base#BASE
+-- @field Core.Set#SET_CLIENT DBClients
+-- @extends Core.Base#BASE
 MISSILETRAINER = {
   ClassName = "MISSILETRAINER",
   TrackingMissiles = {},
@@ -191,7 +191,7 @@ function MISSILETRAINER:New( Distance, Briefing )
 
 
 --  	self.DB:ForEachClient(
---  	 --- @param Client#CLIENT Client
+--  	 --- @param Wrapper.Client#CLIENT Client
 --  	 function( Client )
 --  
 --        ... actions ...
@@ -449,7 +449,7 @@ end
 
 --- Detects if an SA site was shot with an anti radiation missile. In this case, take evasive actions based on the skill level set within the ME.
 -- @param #MISSILETRAINER self
--- @param Event#EVENTDATA Event
+-- @param Core.Event#EVENTDATA Event
 function MISSILETRAINER:_EventShot( Event )
   self:F( { Event } )
 

Moose Development/Moose/Functional/Scoring.lua

@@ -10,7 +10,7 @@
 --- The Scoring class
 -- @type SCORING
 -- @field Players A collection of the current players that have joined the game.
--- @extends Base#BASE
+-- @extends Core.Base#BASE
 SCORING = {
   ClassName = "SCORING",
   ClassID = 0,
@@ -100,7 +100,7 @@ end
 
 --- Track  DEAD or CRASH events for the scoring.
 -- @param #SCORING self
--- @param Event#EVENTDATA Event
+-- @param Core.Event#EVENTDATA Event
 function SCORING:_EventOnDeadOrCrash( Event )
   self:F( { Event } )
 
@@ -265,8 +265,8 @@ end
 
 --- Registers Scores the players completing a Mission Task.
 -- @param #SCORING self
--- @param Mission#MISSION Mission
--- @param Unit#UNIT PlayerUnit
+-- @param Tasking.Mission#MISSION Mission
+-- @param Wrapper.Unit#UNIT PlayerUnit
 -- @param #string Text
 -- @param #number Score
 function SCORING:_AddMissionTaskScore( Mission, PlayerUnit, Text, Score )
@@ -300,8 +300,8 @@ end
 
 --- Registers Mission Scores for possible multiple players that contributed in the Mission.
 -- @param #SCORING self
--- @param Mission#MISSION Mission
--- @param Unit#UNIT PlayerUnit
+-- @param Tasking.Mission#MISSION Mission
+-- @param Wrapper.Unit#UNIT PlayerUnit
 -- @param #string Text
 -- @param #number Score
 function SCORING:_AddMissionScore( Mission, Text, Score )
@@ -330,7 +330,7 @@ end
 
 --- Handles the OnHit event for the scoring.
 -- @param #SCORING self
--- @param Event#EVENTDATA Event
+-- @param Core.Event#EVENTDATA Event
 function SCORING:_EventOnHit( Event )
   self:F( { Event } )
 

Moose Development/Moose/Functional/Sead.lua

@@ -5,7 +5,7 @@
 
 --- The SEAD class
 -- @type SEAD
--- @extends Base#BASE
+-- @extends Core.Base#BASE
 SEAD = {
 	ClassName = "SEAD", 
 	TargetSkill = {

Moose Development/Moose/Functional/Spawn.lua

@@ -1,6 +1,6 @@
 --- This module contains the SPAWN class.
 -- 
--- 1) @{Spawn#SPAWN} class, extends @{Base#BASE}
+-- 1) @{Functional.Spawn#SPAWN} class, extends @{Core.Base#BASE}
 -- =============================================
 -- The @{#SPAWN} class allows to spawn dynamically new groups, based on pre-defined initialization settings, modifying the behaviour when groups are spawned.
 -- For each group to be spawned, within the mission editor, a group has to be created with the "late activation flag" set. We call this group the *"Spawn Template"* of the SPAWN object.
@@ -195,7 +195,7 @@
 
 --- SPAWN Class
 -- @type SPAWN
--- @extends Base#BASE
+-- @extends Core.Base#BASE
 -- @field ClassName
 -- @field #string SpawnTemplatePrefix
 -- @field #string SpawnAliasPrefix
@@ -211,7 +211,7 @@ SPAWN = {
 }
 
 --- @type SPAWN.SpawnZoneTable
--- @list <Zone#ZONE_BASE> SpawnZone
+-- @list <Core.Zone#ZONE_BASE> SpawnZone
 
 
 --- Creates the main object to spawn a @{Group} defined in the DCS ME.
@@ -350,8 +350,8 @@ end
 --- Randomizes the UNITs that are spawned within a radius band given an Outer and Inner radius.
 -- @param #SPAWN self
 -- @param #boolean RandomizeUnits If true, SPAWN will perform the randomization of the @{UNIT}s position within the group between a given outer and inner radius. 
--- @param DCSTypes#Distance OuterRadius (optional) The outer radius in meters where the new group will be spawned.
--- @param DCSTypes#Distance InnerRadius (optional) The inner radius in meters where the new group will NOT be spawned.
+-- @param Dcs.DCSTypes#Distance OuterRadius (optional) The outer radius in meters where the new group will be spawned.
+-- @param Dcs.DCSTypes#Distance InnerRadius (optional) The inner radius in meters where the new group will NOT be spawned.
 -- @return #SPAWN
 -- @usage
 -- -- NATO helicopters engaging in the battle field. 
@@ -572,7 +572,7 @@ end
 --- Will spawn a group based on the internal index.
 -- Note: Uses @{DATABASE} module defined in MOOSE.
 -- @param #SPAWN self
--- @return Group#GROUP The group that was spawned. You can use this group for further actions.
+-- @return Wrapper.Group#GROUP The group that was spawned. You can use this group for further actions.
 function SPAWN:Spawn()
 	self:F( { self.SpawnTemplatePrefix, self.SpawnIndex, self.AliveUnits } )
 
@@ -583,7 +583,7 @@ end
 -- Note: Uses @{DATABASE} module defined in MOOSE.
 -- @param #SPAWN self
 -- @param #string SpawnIndex The index of the group to be spawned.
--- @return Group#GROUP The group that was spawned. You can use this group for further actions.
+-- @return Wrapper.Group#GROUP The group that was spawned. You can use this group for further actions.
 function SPAWN:ReSpawn( SpawnIndex )
 	self:F( { self.SpawnTemplatePrefix, SpawnIndex } )
 	
@@ -607,7 +607,7 @@ end
 -- Uses @{DATABASE} global object defined in MOOSE.
 -- @param #SPAWN self
 -- @param #string SpawnIndex The index of the group to be spawned.
--- @return Group#GROUP The group that was spawned. You can use this group for further actions.
+-- @return Wrapper.Group#GROUP The group that was spawned. You can use this group for further actions.
 function SPAWN:SpawnWithIndex( SpawnIndex )
 	self:F2( { SpawnTemplatePrefix = self.SpawnTemplatePrefix, SpawnIndex = SpawnIndex, AliveUnits = self.AliveUnits, SpawnMaxGroups = self.SpawnMaxGroups } )
 	
@@ -714,7 +714,7 @@ end
 
 --- Allows to place a CallFunction hook when a new group spawns.
 -- The provided method will be called when a new group is spawned, including its given parameters.
--- The first parameter of the SpawnFunction is the @{Group#GROUP} that was spawned.
+-- The first parameter of the SpawnFunction is the @{Wrapper.Group#GROUP} that was spawned.
 -- @param #SPAWN self
 -- @param #function SpawnCallBackFunction The function to be called when a group spawns.
 -- @param SpawnFunctionArguments A random amount of arguments to be provided to the function when the group spawns.
@@ -748,9 +748,9 @@ end
 -- Note that each point in the route assigned to the spawning group is reset to the point of the spawn.
 -- You can use the returned group to further define the route to be followed.
 -- @param #SPAWN self
--- @param DCSTypes#Vec3 Vec3 The Vec3 coordinates where to spawn the group.
+-- @param Dcs.DCSTypes#Vec3 Vec3 The Vec3 coordinates where to spawn the group.
 -- @param #number SpawnIndex (optional) The index which group to spawn within the given zone.
--- @return Group#GROUP that was spawned.
+-- @return Wrapper.Group#GROUP that was spawned.
 -- @return #nil Nothing was spawned.
 function SPAWN:SpawnFromVec3( Vec3, SpawnIndex )
   self:F( { self.SpawnTemplatePrefix, Vec3, SpawnIndex } )
@@ -806,9 +806,9 @@ end
 -- Note that each point in the route assigned to the spawning group is reset to the point of the spawn.
 -- You can use the returned group to further define the route to be followed.
 -- @param #SPAWN self
--- @param DCSTypes#Vec2 Vec2 The Vec2 coordinates where to spawn the group.
+-- @param Dcs.DCSTypes#Vec2 Vec2 The Vec2 coordinates where to spawn the group.
 -- @param #number SpawnIndex (optional) The index which group to spawn within the given zone.
--- @return Group#GROUP that was spawned.
+-- @return Wrapper.Group#GROUP that was spawned.
 -- @return #nil Nothing was spawned.
 function SPAWN:SpawnFromVec2( Vec2, SpawnIndex )
   self:F( { self.SpawnTemplatePrefix, Vec2, SpawnIndex } )
@@ -822,9 +822,9 @@ end
 -- Note that each point in the route assigned to the spawning group is reset to the point of the spawn.
 -- You can use the returned group to further define the route to be followed.
 -- @param #SPAWN self
--- @param Unit#UNIT HostUnit The air or ground unit dropping or unloading the group.
+-- @param Wrapper.Unit#UNIT HostUnit The air or ground unit dropping or unloading the group.
 -- @param #number SpawnIndex (optional) The index which group to spawn within the given zone.
--- @return Group#GROUP that was spawned.
+-- @return Wrapper.Group#GROUP that was spawned.
 -- @return #nil Nothing was spawned.
 function SPAWN:SpawnFromUnit( HostUnit, SpawnIndex )
 	self:F( { self.SpawnTemplatePrefix, HostUnit, SpawnIndex } )
@@ -839,9 +839,9 @@ end
 --- Will spawn a group from a hosting static. This method is mostly advisable to be used if you want to simulate spawning from buldings and structures (static buildings).
 -- You can use the returned group to further define the route to be followed.
 -- @param #SPAWN self
--- @param Static#STATIC HostStatic The static dropping or unloading the group.
+-- @param Wrapper.Static#STATIC HostStatic The static dropping or unloading the group.
 -- @param #number SpawnIndex (optional) The index which group to spawn within the given zone.
--- @return Group#GROUP that was spawned.
+-- @return Wrapper.Group#GROUP that was spawned.
 -- @return #nil Nothing was spawned.
 function SPAWN:SpawnFromStatic( HostStatic, SpawnIndex )
   self:F( { self.SpawnTemplatePrefix, HostStatic, SpawnIndex } )
@@ -854,14 +854,14 @@ function SPAWN:SpawnFromStatic( HostStatic, SpawnIndex )
 end
 
 --- Will spawn a Group within a given @{Zone}.
--- The @{Zone} can be of any type derived from @{Zone#ZONE_BASE}.
+-- The @{Zone} can be of any type derived from @{Core.Zone#ZONE_BASE}.
 -- Once the @{Group} is spawned within the zone, the @{Group} will continue on its route.
 -- The **first waypoint** (where the group is spawned) is replaced with the zone location coordinates.
 -- @param #SPAWN self
--- @param Zone#ZONE Zone The zone where the group is to be spawned.
+-- @param Core.Zone#ZONE Zone The zone where the group is to be spawned.
 -- @param #boolean RandomizeGroup (optional) Randomization of the @{Group} position in the zone.
 -- @param #number SpawnIndex (optional) The index which group to spawn within the given zone.
--- @return Group#GROUP that was spawned.
+-- @return Wrapper.Group#GROUP that was spawned.
 -- @return #nil when nothing was spawned.
 function SPAWN:SpawnInZone( Zone, RandomizeGroup, SpawnIndex )
 	self:F( { self.SpawnTemplatePrefix, Zone, RandomizeGroup, SpawnIndex } )
@@ -920,7 +920,7 @@ end
 
 --- Will find the first alive @{Group} it has spawned, and return the alive @{Group} object and the first Index where the first alive @{Group} object has been found.
 -- @param #SPAWN self
--- @return Group#GROUP, #number The @{Group} object found, the new Index where the group was found.
+-- @return Wrapper.Group#GROUP, #number The @{Group} object found, the new Index where the group was found.
 -- @return #nil, #nil When no group is found, #nil is returned.
 -- @usage
 -- -- Find the first alive @{Group} object of the SpawnPlanes SPAWN object @{Group} collection that it has spawned during the mission.
@@ -946,7 +946,7 @@ end
 --- Will find the next alive @{Group} object from a given Index, and return a reference to the alive @{Group} object and the next Index where the alive @{Group} has been found.
 -- @param #SPAWN self
 -- @param #number SpawnIndexStart A Index holding the start position to search from. This method can also be used to find the first alive @{Group} object from the given Index.
--- @return Group#GROUP, #number The next alive @{Group} object found, the next Index where the next alive @{Group} object was found.
+-- @return Wrapper.Group#GROUP, #number The next alive @{Group} object found, the next Index where the next alive @{Group} object was found.
 -- @return #nil, #nil When no alive @{Group} object is found from the start Index position, #nil is returned.
 -- @usage
 -- -- Find the first alive @{Group} object of the SpawnPlanes SPAWN object @{Group} collection that it has spawned during the mission.
@@ -971,7 +971,7 @@ end
 
 --- Will find the last alive @{Group} object, and will return a reference to the last live @{Group} object and the last Index where the last alive @{Group} object has been found.
 -- @param #SPAWN self
--- @return Group#GROUP, #number The last alive @{Group} object found, the last Index where the last alive @{Group} object was found.
+-- @return Wrapper.Group#GROUP, #number The last alive @{Group} object found, the last Index where the last alive @{Group} object was found.
 -- @return #nil, #nil When no alive @{Group} object is found, #nil is returned.
 -- @usage
 -- -- Find the last alive @{Group} object of the SpawnPlanes SPAWN object @{Group} collection that it has spawned during the mission.
@@ -1002,7 +1002,7 @@ end
 -- If no index is given, it will return the first group in the list.
 -- @param #SPAWN self
 -- @param #number SpawnIndex The index of the group to return.
--- @return Group#GROUP self
+-- @return Wrapper.Group#GROUP self
 function SPAWN:GetGroupFromIndex( SpawnIndex )
 	self:F( { self.SpawnTemplatePrefix, self.SpawnAliasPrefix, SpawnIndex } )
 	
@@ -1022,7 +1022,7 @@ end
 -- The method will search for a #-mark, and will return the index behind the #-mark of the DCSUnit.
 -- It will return nil of no prefix was found.
 -- @param #SPAWN self
--- @param DCSUnit#Unit DCSUnit The @{DCSUnit} to be searched.
+-- @param Dcs.DCSWrapper.Unit#Unit DCSUnit The @{DCSUnit} to be searched.
 -- @return #string The prefix
 -- @return #nil Nothing found
 function SPAWN:_GetGroupIndexFromDCSUnit( DCSUnit )
@@ -1044,7 +1044,7 @@ end
 -- The method will search for a #-mark, and will return the text before the #-mark.
 -- It will return nil of no prefix was found.
 -- @param #SPAWN self
--- @param DCSUnit#UNIT DCSUnit The @{DCSUnit} to be searched.
+-- @param Dcs.DCSWrapper.Unit#UNIT DCSUnit The @{DCSUnit} to be searched.
 -- @return #string The prefix
 -- @return #nil Nothing found
 function SPAWN:_GetPrefixFromDCSUnit( DCSUnit )
@@ -1064,8 +1064,8 @@ end
 
 --- Return the group within the SpawnGroups collection with input a DCSUnit.
 -- @param #SPAWN self
--- @param DCSUnit#Unit DCSUnit The @{DCSUnit} to be searched.
--- @return Group#GROUP The Group
+-- @param Dcs.DCSWrapper.Unit#Unit DCSUnit The @{DCSUnit} to be searched.
+-- @return Wrapper.Group#GROUP The Group
 -- @return #nil Nothing found
 function SPAWN:_GetGroupFromDCSUnit( DCSUnit )
 	self:F3( { self.SpawnTemplatePrefix, self.SpawnAliasPrefix, DCSUnit } )
@@ -1404,7 +1404,7 @@ end
 -- TODO Need to delete this... _DATABASE does this now ...
 
 --- @param #SPAWN self 
--- @param Event#EVENTDATA Event
+-- @param Core.Event#EVENTDATA Event
 function SPAWN:_OnBirth( Event )
 
 	if timer.getTime0() < timer.getAbsTime() then
@@ -1424,7 +1424,7 @@ end
 -- @todo Need to delete this... _DATABASE does this now ...
 
 --- @param #SPAWN self 
--- @param Event#EVENTDATA Event
+-- @param Core.Event#EVENTDATA Event
 function SPAWN:_OnDeadOrCrash( Event )
   self:F( self.SpawnTemplatePrefix,  Event )
 
@@ -1526,7 +1526,7 @@ function SPAWN:_SpawnCleanUpScheduler()
 	  
 	  for UnitID, UnitData in pairs( SpawnUnits ) do
 	    
-	    local SpawnUnit = UnitData -- Unit#UNIT
+	    local SpawnUnit = UnitData -- Wrapper.Unit#UNIT
 	    local SpawnUnitName = SpawnUnit:GetName()