Added optional despawn timers to JTAC and to Troops

CTLD.lua

@@ -16,15 +16,8 @@
 	    - jmontleon - https://github.com/jmontleon
 	    - emilianomolina - https://github.com/emilianomolina
 
-    Version: 1.72 - 18/02/2018
+    Version: 1.73 - 15/04/2018
-      - Bug fix for crate spam
+      - Allow minimum distance from friendly logistics to be set
-      - Improved JTAC Performance - priority & targeting
-      - Added JTAC report for in view
-      - Added ability to set maximum group size that can be carried
-      - Added new sling load crates
-      - Fixed bug where crates and / or groups would disappear
-      - Fixed bug where count in zone wouldn't work for mission crates
-      - Delayed config of F10 menu and other scheduled functions so they can be overwritten by mission if a user wants
  ]]
 
 ctld = {} -- DONT REMOVE!
@@ -52,6 +45,10 @@ ctld.maximumDistanceLogistic = 200 -- max distance from vehicle to logistics to
 ctld.maximumSearchDistance = 4000 -- max distance for troops to search for enemy
 ctld.maximumMoveDistance = 2000 -- max distance for troops to move from drop point if no enemy is nearby
 
+ctld.minimumDeployDistance = 1000 -- minimum distance from a friendly pickup zone where you can deploy a crate
+
+ctld.despawnTroopsTimer = -1 -- if this value is a positive number, any deployed troops will despawn after that amount of seconds have elapsed
+
 ctld.numberOfTroops = 10 -- default number of troops to load on a transport heli or C-130 
 							-- also works as maximum size of group that'll fit into a helicopter unless overridden
 ctld.enableFastRopeInsertion = true -- allows you to drop troops by fast rope
@@ -135,6 +132,8 @@ ctld.JTAC_location = true -- shows location of target in JTAC message
 
 ctld.JTAC_lock = "all" -- "vehicle" OR "troop" OR "all" forces JTAC to only lock vehicles or troops or all ground units
 
+ctld.JTAC_despawnTimer = -1 -- if this value is a positive number, any deployed JTACS will despawn after that amount of seconds have elapsed
+
 -- ***************** Pickup, dropoff and waypoint zones *****************
 
 -- Available colors (anything else like "none" disables smoke): "green", "red", "white", "orange", "blue", "none",
@@ -1660,6 +1659,32 @@ function ctld.troopsOnboard(_heli, _troops)
     end
 end
 
+-- tracks the troops dropped or JTACS
+-- stores group name and expiry time -- reset on redrop
+ctld.droppedTroopsTracker = {}
+
+function ctld.despawnTimer(groupName,despawnTimer)
+
+    if despawnTimer > 0 then
+
+        -- resets timer if time reused
+        ctld.droppedTroopsTracker[groupName] = (timer.getTime() +despawnTimer) - 1
+
+        timer.scheduleFunction(function()
+
+            -- checks timer hasnt been reset
+            if  ctld.droppedTroopsTracker[groupName] < timer.getTime() then
+                local group = Group.getByName(groupName)
+
+                if group then
+                    group:destroy()
+                end
+            end
+
+        end, nil, timer.getTime() + ctld.despawnTroopsTimer)
+    end
+end
+
 -- if its dropped by AI then there is no player name so return the type of unit
 function ctld.getPlayerNameOrType(_heli)
 
@@ -1756,6 +1781,9 @@ function ctld.deployTroops(_heli, _troops)
 
                     ctld.processCallback({unit = _heli, unloaded = _droppedTroops, action = "dropped_troops"})
 
+                    -- create timer
+                    ctld.despawnTimer(_droppedTroops:getName(),ctld.despawnTroopsTimer)
+
 
                 else
                     --extract zone!
@@ -1797,12 +1825,18 @@ function ctld.deployTroops(_heli, _troops)
 
                 ctld.processCallback({unit = _heli, unloaded = _droppedVehicles, action = "dropped_vehicles"})
 
+                -- create timer
+                ctld.despawnTimer(_droppedVehicles:getName(),ctld.despawnTroopsTimer)
+
+
                 trigger.action.outTextForCoalition(_heli:getCoalition(), ctld.getPlayerNameOrType(_heli) .. " dropped vehicles from " .. _heli:getTypeName() .. " into combat", 10)
             end
         end
     end
 end
 
+
+
 function ctld.insertIntoTroopsArray(_troopType,_count,_troopArray)
 
     for _i = 1, _count do
@@ -2888,6 +2922,16 @@ function ctld.unpackCrates(_arguments)
             local _crates = ctld.getCratesAndDistance(_heli)
             local _crate = ctld.getClosestCrate(_heli, _crates)
 
+
+            if ctld.inLogisticsZone(_heli) == true  or  ctld.farEnoughFromLogisticZone(_heli) == false then
+
+                ctld.displayMessageToGroup(_heli, "You can't unpack that here! Take it to where it's needed!", 20)
+
+                return
+            end
+
+
+
             if _crate ~= nil and _crate.dist < 750
                     and (_crate.details.unit == "FOB" or _crate.details.unit == "FOB-SMALL") then
 
@@ -2897,13 +2941,6 @@ function ctld.unpackCrates(_arguments)
 
             elseif _crate ~= nil and _crate.dist < 200 then
 
-                if ctld.inLogisticsZone(_heli) == true then
-
-                    ctld.displayMessageToGroup(_heli, "You can't unpack that here! Take it to where it's needed!", 20)
-
-                    return
-                end
-
                 if ctld.forceCrateToBeMoved and ctld.crateMove[_crate.crateUnit:getName()] then
                     ctld.displayMessageToGroup(_heli,"Sorry you must move this crate before you unpack it!", 20)
                     return
@@ -2966,6 +3003,9 @@ function ctld.unpackCrates(_arguments)
                         --put to the end
                         table.insert(ctld.jtacGeneratedLaserCodes, _code)
 
+                        -- create timer
+                        ctld.despawnTimer(_spawnedGroups:getName(),ctld.JTAC_despawnTimer)
+
                         ctld.JTACAutoLase(_spawnedGroups:getName(), _code) --(_jtacGroupName, _laserCode, _smoke, _lock, _colour)
                     end
                 end
@@ -4385,6 +4425,37 @@ function ctld.inLogisticsZone(_heli)
     return false
 end
 
+
+-- are far enough from a friendly logistics zone
+function ctld.farEnoughFromLogisticZone(_heli)
+
+    if ctld.inAir(_heli) then
+        return false
+    end
+
+    local _heliPoint = _heli:getPoint()
+
+    local _farEnough = true
+
+    for _, _name in pairs(ctld.logisticUnits) do
+
+        local _logistic = StaticObject.getByName(_name)
+
+        if _logistic ~= nil and _logistic:getCoalition() == _heli:getCoalition() then
+
+            --get distance
+            local _dist = ctld.getDistance(_heliPoint, _logistic:getPoint())
+            -- env.info("DIST ".._dist)
+            if _dist <= ctld.minimumDeployDistance then
+                -- env.info("TOO CLOSE ".._dist)
+                _farEnough = false
+            end
+        end
+    end
+
+    return _farEnough
+end
+
 function ctld.refreshSmoke()
 
     if ctld.disableAllSmoke == true then