Merge branch 'master' into FF/MasterDevel

Moose Development/Moose/Core/Database.lua

@@ -327,21 +327,18 @@ do -- Zones
               
         Zone=ZONE_POLYGON_BASE:New(ZoneName, ZoneData.verticies)
         
-        for i,vec2 in pairs(ZoneData.verticies) do
+        --for i,vec2 in pairs(ZoneData.verticies) do
-          local coord=COORDINATE:NewFromVec2(vec2)
+        --  local coord=COORDINATE:NewFromVec2(vec2)
-          coord:MarkToAll(string.format("%s Point %d", ZoneName, i))
+        --  coord:MarkToAll(string.format("%s Point %d", ZoneName, i))
-        end
+        --end
       
       end
       
       if Zone then
 
-        -- Debug output.
+        -- Store color of zone.        
-        --self:I({"Register ZONE: %s (", Name = ZoneName})
-        
         Zone.Color=color
       
-      
         -- Store in DB.
         self.ZONENAMES[ZoneName] = ZoneName
         

Moose Development/Moose/Core/Point.lua

@@ -2121,21 +2121,26 @@ do -- COORDINATE
     -- @param #string Text (Optional) Text displayed when mark is added. Default none.
     -- @return #number The resulting Mark ID, which is a number. Can be used to remove the object again. 
     function COORDINATE:MarkupToAllFreeForm(Coordinates, Coalition, Color, Alpha, FillColor, FillAlpha, LineType, ReadOnly, Text)
+    
       local MarkID = UTILS.GetMarkID()
       if ReadOnly==nil then
         ReadOnly=false
       end
+      
       Coalition=Coalition or -1
+      
       Color=Color or {1,0,0}
       Color[4]=Alpha or 1.0
+      
       LineType=LineType or 1
-      FillColor=FillColor or Color
+      
+      FillColor=FillColor or UTILS.DeepCopy(Color)      
       FillColor[4]=FillAlpha or 0.15
       
       local vecs={}
-      table.insert(vecs, self:GetVec3())
+      vecs[1]=self:GetVec3()
-      for _,coord in ipairs(Coordinates) do
+      for i,coord in ipairs(Coordinates) do
-        table.insert(vecs, coord:GetVec3())
+        vecs[i+1]=coord:GetVec3()
       end
 
       if #vecs<3 then
@@ -2147,7 +2152,7 @@ do -- COORDINATE
       elseif #vecs==5 then
         trigger.action.markupToAll(7, Coalition, MarkID, vecs[1], vecs[2], vecs[3], vecs[4], vecs[5], Color, FillColor, LineType, ReadOnly, Text or "")
       elseif #vecs==6 then
-        trigger.action.markupToAll(7, Coalition, MarkID, vecs[1], vecs[2], vecs[3], vecs[4], vecs[5], vecs[6], Color, FillColor, LineType, ReadOnly, Text or "")        
+        trigger.action.markupToAll(7, Coalition, MarkID, vecs[1], vecs[2], vecs[3], vecs[4], vecs[5], vecs[6], Color, FillColor, LineType, Text or "")
       elseif #vecs==7 then
         trigger.action.markupToAll(7, Coalition, MarkID, vecs[1], vecs[2], vecs[3], vecs[4], vecs[5], vecs[6], vecs[7], Color, FillColor, LineType, ReadOnly, Text or "")
       elseif #vecs==8 then

Moose Development/Moose/Core/Zone.lua

@@ -226,22 +226,6 @@ function ZONE_BASE:GetPointVec2()
 end
 
 
---- Returns a @{Core.Point#COORDINATE} of the zone.
--- @param #ZONE_BASE self
--- @return Core.Point#COORDINATE The Coordinate of the zone.
-function ZONE_BASE:GetCoordinate()
-  self:F2( self.ZoneName )
-  
-  local Vec2 = self:GetVec2()
-
-  local Coordinate = COORDINATE:NewFromVec2( Vec2 )
-
-  self:T2( { Coordinate } )
-  
-  return Coordinate  
-end
-
-
 --- Returns the @{DCS#Vec3} of the zone.
 -- @param #ZONE_BASE self
 -- @param DCS#Distance Height The height to add to the land height where the center of the zone is located.
@@ -285,11 +269,23 @@ function ZONE_BASE:GetCoordinate( Height ) --R2.1
 
   local Vec3 = self:GetVec3( Height )
 
-  local PointVec3 = COORDINATE:NewFromVec3( Vec3 )
+  if self.Coordinate then
 
-  self:T2( { PointVec3 } )
+    -- Update coordinates.
+    self.Coordinate.x=Vec3.x
+    self.Coordinate.y=Vec3.y
+    self.Coordinate.z=Vec3.z
 
-  return PointVec3  
+    --env.info("FF GetCoordinate NEW for ZONE_BASE "..tostring(self.ZoneName))
+  else
+
+    -- Create a new coordinate object.
+    self.Coordinate=COORDINATE:NewFromVec3(Vec3)
+
+    --env.info("FF GetCoordinate NEW for ZONE_BASE "..tostring(self.ZoneName))
+  end
+
+  return self.Coordinate
 end
 
 
@@ -512,12 +508,51 @@ ZONE_RADIUS = {
 -- @param DCS#Distance Radius The radius of the zone.
 -- @return #ZONE_RADIUS self
 function ZONE_RADIUS:New( ZoneName, Vec2, Radius )
+
+  -- Inherit ZONE_BASE.
 	local self = BASE:Inherit( self, ZONE_BASE:New( ZoneName ) ) -- #ZONE_RADIUS
 	self:F( { ZoneName, Vec2, Radius } )
 
 	self.Radius = Radius
 	self.Vec2 = Vec2
 
+	--self.Coordinate=COORDINATE:NewFromVec2(Vec2)
+
+	return self
+end
+
+--- Update zone from a 2D vector.
+-- @param #ZONE_RADIUS self
+-- @param DCS#Vec2 Vec2 The location of the zone.
+-- @param DCS#Distance Radius The radius of the zone.
+-- @return #ZONE_RADIUS self
+function ZONE_RADIUS:UpdateFromVec2(Vec2, Radius)
+
+  -- New center of the zone.
+  self.Vec2=Vec2
+
+  if Radius then
+    self.Radius=Radius
+  end
+
+  return self
+end
+
+--- Update zone from a 2D vector.
+-- @param #ZONE_RADIUS self
+-- @param DCS#Vec3 Vec3 The location of the zone.
+-- @param DCS#Distance Radius The radius of the zone.
+-- @return #ZONE_RADIUS self
+function ZONE_RADIUS:UpdateFromVec3(Vec3, Radius)
+
+  -- New center of the zone.
+  self.Vec2.x=Vec3.x
+  self.Vec2.y=Vec3.z
+
+  if Radius then
+    self.Radius=Radius
+  end
+
   return self
 end
 
@@ -886,6 +921,32 @@ function ZONE_RADIUS:GetScannedSetUnit()
   return SetUnit
 end
 
+--- Get a set of scanned units.
+-- @param #ZONE_RADIUS self
+-- @return Core.Set#SET_GROUP Set of groups.
+function ZONE_RADIUS:GetScannedSetGroup()
+
+  self.ScanSetGroup=self.ScanSetGroup or SET_GROUP:New() --Core.Set#SET_GROUP
+
+  self.ScanSetGroup.Set={}
+
+  if self.ScanData then
+    for ObjectID, UnitObject in pairs( self.ScanData.Units ) do
+      local UnitObject = UnitObject -- DCS#Unit
+      if UnitObject:isExist() then
+
+        local FoundUnit=UNIT:FindByName(UnitObject:getName())
+        if FoundUnit then
+          local group=FoundUnit:GetGroup()
+          self.ScanSetGroup:AddGroup(group)
+        end
+      end
+    end
+  end
+
+  return self.ScanSetGroup
+end
+
 
 --- Count the number of different coalitions inside the zone.
 -- @param #ZONE_RADIUS self
@@ -1515,6 +1576,7 @@ end
 -- ## Draw zone
 --
 --   * @{#ZONE_POLYGON_BASE.DrawZone}(): Draws the zone on the F10 map.
+--   * @{#ZONE_POLYGON_BASE.Boundary}(): Draw a frontier on the F10 map with small filled circles.
 --
 --
 -- @field #ZONE_POLYGON_BASE
@@ -1522,21 +1584,27 @@ ZONE_POLYGON_BASE = {
   ClassName="ZONE_POLYGON_BASE",
   }
 
---- A points array.
+--- A 2D points array.
 -- @type ZONE_POLYGON_BASE.ListVec2
--- @list <DCS#Vec2>
+-- @list <DCS#Vec2> Table of 2D vectors.
+
+--- A 3D points array.
+-- @type ZONE_POLYGON_BASE.ListVec3
+-- @list <DCS#Vec3> Table of 3D vectors.
 
 --- Constructor to create a ZONE_POLYGON_BASE instance, taking the zone name and an array of @{DCS#Vec2}, forming a polygon.
 -- The @{Wrapper.Group#GROUP} waypoints define the polygon corners. The first and the last point are automatically connected.
 -- @param #ZONE_POLYGON_BASE self
 -- @param #string ZoneName Name of the zone.
--- @param #ZONE_POLYGON_BASE.ListVec2 PointsArray An array of @{DCS#Vec2}, forming a polygon..
+-- @param #ZONE_POLYGON_BASE.ListVec2 PointsArray An array of @{DCS#Vec2}, forming a polygon.
 -- @return #ZONE_POLYGON_BASE self
 function ZONE_POLYGON_BASE:New( ZoneName, PointsArray )
+
+  -- Inherit ZONE_BASE.
   local self = BASE:Inherit( self, ZONE_BASE:New( ZoneName ) )
   self:F( { ZoneName, PointsArray } )
 
-  local i = 0
+  if PointsArray then
 
     self._.Polygon = {}
 
@@ -1546,6 +1614,42 @@ function ZONE_POLYGON_BASE:New( ZoneName, PointsArray )
       self._.Polygon[i].y = PointsArray[i].y
     end
 
+  end
+
+  return self
+end
+
+--- Update polygon points with an array of @{DCS#Vec2}.
+-- @param #ZONE_POLYGON_BASE self
+-- @param #ZONE_POLYGON_BASE.ListVec2 Vec2Array An array of @{DCS#Vec2}, forming a polygon.
+-- @return #ZONE_POLYGON_BASE self
+function ZONE_POLYGON_BASE:UpdateFromVec2(Vec2Array)
+
+  self._.Polygon = {}
+
+  for i=1,#Vec2Array do
+    self._.Polygon[i] = {}
+    self._.Polygon[i].x=Vec2Array[i].x
+    self._.Polygon[i].y=Vec2Array[i].y
+  end
+
+  return self
+end
+
+--- Update polygon points with an array of @{DCS#Vec3}.
+-- @param #ZONE_POLYGON_BASE self
+-- @param #ZONE_POLYGON_BASE.ListVec3 Vec2Array An array of @{DCS#Vec3}, forming a polygon.
+-- @return #ZONE_POLYGON_BASE self
+function ZONE_POLYGON_BASE:UpdateFromVec3(Vec3Array)
+
+  self._.Polygon = {}
+
+  for i=1,#Vec3Array do
+    self._.Polygon[i] = {}
+    self._.Polygon[i].x=Vec3Array[i].x
+    self._.Polygon[i].y=Vec3Array[i].z
+  end
+
   return self
 end
 
@@ -1922,6 +2026,45 @@ function ZONE_POLYGON_BASE:GetBoundingSquare()
   return { x1 = x1, y1 = y1, x2 = x2, y2 = y2 }
 end
 
+--- Draw a frontier on the F10 map with small filled circles.
+-- @param #ZONE_POLYGON_BASE self
+-- @param #number Coalition (Optional) Coalition: All=-1, Neutral=0, Red=1, Blue=2. Default -1= All.
+-- @param #table Color (Optional) RGB color table {r, g, b}, e.g. {1, 0, 0} for red. Default {1, 1, 1}= White.
+-- @param #number Radius (Optional) Radius of the circles in meters. Default 1000.
+-- @param #number Alpha (Optional) Alpha transparency [0,1]. Default 1.
+-- @param #number Segments (Optional) Number of segments within boundary line. Default 10.
+-- @param #boolean Closed (Optional) Link the last point with the first one to obtain a closed boundary. Default false
+-- @return #ZONE_POLYGON_BASE self
+function ZONE_POLYGON_BASE:Boundary(Coalition, Color, Radius, Alpha, Segments, Closed)
+    Coalition = Coalition or -1
+    Color = Color or {1, 1, 1}
+    Radius = Radius or 1000
+    Alpha = Alpha or 1
+    Segments = Segments or 10
+    Closed = Closed or false
+    local i = 1
+    local j = #self._.Polygon
+    if (Closed) then
+        Limit = #self._.Polygon + 1
+    else
+        Limit = #self._.Polygon
+    end
+    while i <= #self._.Polygon do
+        self:T( { i, j, self._.Polygon[i], self._.Polygon[j] } )
+        if j ~= Limit then
+            local DeltaX = self._.Polygon[j].x - self._.Polygon[i].x
+            local DeltaY = self._.Polygon[j].y - self._.Polygon[i].y
+            for Segment = 0, Segments do
+                local PointX = self._.Polygon[i].x + ( Segment * DeltaX / Segments )
+                local PointY = self._.Polygon[i].y + ( Segment * DeltaY / Segments )
+                ZONE_RADIUS:New( "Zone", {x = PointX, y = PointY}, Radius ):DrawZone(Coalition, Color, 1, Color, Alpha, nil, true)
+            end
+        end
+        j = i
+        i = i + 1
+    end
+    return self
+end
 
 --- @type ZONE_POLYGON
 -- @extends #ZONE_POLYGON_BASE

Moose Development/Moose/Wrapper/Controllable.lua

@@ -177,9 +177,6 @@
 -- ## 5.5) Air-2-Air missile attack range:
 --   * @{#CONTROLLABLE.OptionAAAttackRange}(): Defines the usage of A2A missiles against possible targets .
 --
--- ## 5.6) GROUND units attack range:
---   * @{#CONTROLLABLE.OptionEngageRange}(): Engage range limit in percent (a number between 0 and 100). Default 100. Defines the range at which a GROUND unit/group (e.g. a SAM site) is allowed to use its weapons automatically.
--- 
 -- @field #CONTROLLABLE
 CONTROLLABLE = {
   ClassName = "CONTROLLABLE",
@@ -1482,6 +1479,7 @@ end
 --- (AIR + GROUND) The task makes the controllable/unit a FAC and orders the FAC to control the target (enemy ground controllable) destruction.
 -- The killer is player-controlled allied CAS-aircraft that is in contact with the FAC.
 -- If the task is assigned to the controllable lead unit will be a FAC.
+-- It's important to note that depending on the type of unit that is being assigned the task (AIR or GROUND), you must choose the correct type of callsign enumerator. For airborne controllables use CALLSIGN.Aircraft and for ground based use CALLSIGN.JTAC enumerators.
 -- @param #CONTROLLABLE self
 -- @param Wrapper.Group#GROUP AttackGroup Target GROUP object.
 -- @param #number WeaponType Bitmask of weapon types, which are allowed to use.
@@ -1489,7 +1487,7 @@ end
 -- @param #boolean Datalink (Optional) Allows to use datalink to send the target information to attack aircraft. Enabled by default.
 -- @param #number Frequency Frequency in MHz used to communicate with the FAC. Default 133 MHz.
 -- @param #number Modulation Modulation of radio for communication. Default 0=AM.
--- @param #number CallsignName Callsign enumerator name of the FAC.
+-- @param #number CallsignName Callsign enumerator name of the FAC. (CALLSIGN.Aircraft.{name} for airborne controllables, CALLSIGN.JTACS.{name} for ground units)
 -- @param #number CallsignNumber Callsign number, e.g. Axeman-**1**.
 -- @return DCS#Task The DCS task structure.
 function CONTROLLABLE:TaskFAC_AttackGroup( AttackGroup, WeaponType, Designation, Datalink, Frequency, Modulation, CallsignName, CallsignNumber )
@@ -1853,7 +1851,26 @@ do -- Patrol methods
 
       -- Calculate the new Route.
       local FromCoord = PatrolGroup:GetCoordinate()
-      local From = FromCoord:WaypointGround( 120 )
+      
+      -- test for submarine
+      local depth = 0
+      local IsSub = false
+      if PatrolGroup:IsShip() then
+        local navalvec3 = FromCoord:GetVec3()
+        if navalvec3.y < 0 then 
+          depth = navalvec3.y
+          IsSub = true
+        end
+      end
+      
+     
+      local Waypoint = Waypoints[1]
+      local Speed = Waypoint.speed or (20 / 3.6)
+       local From = FromCoord:WaypointGround( Speed )
+       
+      if IsSub then 
+         From = FromCoord:WaypointNaval( Speed, Waypoint.alt )
+      end
       
       table.insert( Waypoints, 1, From )
 
@@ -1894,7 +1911,16 @@ do -- Patrol methods
       if ToWaypoint then
         FromWaypoint = ToWaypoint
       end
-
+      -- test for submarine
+      local depth = 0
+      local IsSub = false
+      if PatrolGroup:IsShip() then
+        local navalvec3 = FromCoord:GetVec3()
+        if navalvec3.y < 0 then 
+          depth = navalvec3.y
+          IsSub = true
+        end
+      end
       -- Loop until a waypoint has been found that is not the same as the current waypoint.
       -- Otherwise the object zon't move or drive in circles and the algorithm would not do exactly
       -- what it is supposed to do, which is making groups drive around.
@@ -1909,9 +1935,13 @@ do -- Patrol methods
       local ToCoord = COORDINATE:NewFromVec2( { x = Waypoint.x, y = Waypoint.y } )
       -- Create a "ground route point", which is a "point" structure that can be given as a parameter to a Task
       local Route = {}
+      if IsSub then
+        Route[#Route+1] = FromCoord:WaypointNaval( Speed, depth )
+        Route[#Route+1] = ToCoord:WaypointNaval( Speed, Waypoint.alt )
+      else
         Route[#Route+1] = FromCoord:WaypointGround( Speed, Formation )
         Route[#Route+1] = ToCoord:WaypointGround( Speed, Formation )
-
+      end
 
       local TaskRouteToZone = PatrolGroup:TaskFunction( "CONTROLLABLE.PatrolRouteRandom", Speed, Formation, ToWaypoint )
 
@@ -1956,15 +1986,30 @@ do -- Patrol methods
       -- Calculate the new Route.
       local FromCoord = PatrolGroup:GetCoordinate()
       
+      -- test for submarine
+      local depth = 0
+      local IsSub = false
+      if PatrolGroup:IsShip() then
+        local navalvec3 = FromCoord:GetVec3()
+        if navalvec3.y < 0 then 
+          depth = navalvec3.y
+          IsSub = true
+        end
+      end
+
       -- Select a random Zone and get the Coordinate of the new Zone.
       local RandomZone = ZoneList[ math.random( 1, #ZoneList ) ] -- Core.Zone#ZONE
       local ToCoord = RandomZone:GetRandomCoordinate( 10 )
 
       -- Create a "ground route point", which is a "point" structure that can be given as a parameter to a Task
       local Route = {}
+      if IsSub then
+        Route[#Route+1] = FromCoord:WaypointNaval( Speed, depth )
+        Route[#Route+1] = ToCoord:WaypointNaval( Speed, depth )
+      else
         Route[#Route+1] = FromCoord:WaypointGround( Speed, Formation )
         Route[#Route+1] = ToCoord:WaypointGround( Speed, Formation )
-
+      end
 
       local TaskRouteToZone = PatrolGroup:TaskFunction( "CONTROLLABLE.PatrolZones", ZoneList, Speed, Formation, DelayMin, DelayMax )
 
@@ -3772,10 +3817,30 @@ function CONTROLLABLE:OptionDisperseOnAttack(Seconds)
     local Controller = self:_GetController()
     if Controller then
      if self:IsGround() then
-        self:SetOption(AI.Option.GROUND.id.DISPERSE_ON_ATTACK, seconds)     
+        self:SetOption(AI.Option.Ground.id.DISPERSE_ON_ATTACK, seconds)
      end
     end
    return self
   end
   return nil
 end
+
+--- Returns if the unit is a submarine.
+-- @param #POSITIONABLE self
+-- @return #boolean Submarines attributes result.
+function POSITIONABLE:IsSubmarine()
+  self:F2()
+
+  local DCSUnit = self:GetDCSObject()
+
+  if DCSUnit then
+    local UnitDescriptor = DCSUnit:getDesc()
+        if UnitDescriptor.attributes["Submarines"] == true then
+            return true
+        else
+            return false
+        end
+  end
+
+  return nil
+end

README.md

@@ -30,7 +30,7 @@ This repository contains the source lua code of the MOOSE framework.
   
 ###   [MOOSE_INCLUDE](https://github.com/FlightControl-Master/MOOSE_INCLUDE) - For use and generated 
 
-This repository contains the Moose.lua file to be included within your missions.
+This repository contains the Moose.lua file to be included within your missions. Note that the Moose\_.lua is technically the same as Moose.lua, but without any commentary or unnecessary whitespace in it. You only need to load **one** of those at the beginning of your mission.
   
  
 ###   [MOOSE_DOCS](https://github.com/FlightControl-Master/MOOSE_DOCS) - Not for use