Experimental version 1.4

Added ability to load different groups from a pickup zone
Re-organised radio options

CTLD.lua

@@ -13,7 +13,8 @@
 	Contributors:
 	    - Steggles - https://github.com/Bob7heBuilder
 
-    Version: 1.37 - 11/11/2015  - Added new callback interface
+    Version: 1.40 - 11/11/2015  - Added new callback interface
+                                - Added Different Pickup Groups for F10 and for the spawn group command
 
  ]]
 
@@ -335,6 +336,23 @@ ctld.vehicleTransportEnabled = {
     "C-130",
 }
 
+-- ************** INFANTRY GROUPS FOR PICKUP ******************
+-- Unit Types
+-- inf is normal infantry
+-- mg is M249
+-- at is RPG-16
+-- aa is Stinger or Igla
+-- mortar is a 2B11 mortar unit
+-- You must add a name to the group for it to work
+-- You can also add an optional coalition side to limit the group to one side
+-- for the side - 2 is BLUE and 1 is RED
+ctld.loadableGroups = {
+    {name = "Standard Group", inf = 5, mg = 3, at = 2 }, -- will make a loadable group with 5 infantry, 3 MGs and 2 anti-tank for both coalitions
+    {name = "Anti Air", inf = 2, aa = 3  },
+ --   {name = "Anti Tank", inf = 2, at = 6  },
+    {name = "Mortar Squad", inf = 2, mortar = 5 },
+   -- {name = "Mortar Squad Red", inf = 2, mortar = 5, side =1 }, --would make a group loadable by RED only
+}
 
 -- ************** SPAWNABLE CRATES ******************
 -- Weights must be unique as we use the weight to change the cargo to the correct unit
@@ -433,10 +451,6 @@ function ctld.spawnGroupAtTrigger(_groupSide, _number, _triggerName, _searchRadi
         _country = 2
     end
 
-    if _number < 1 then
-        _number = 1
-    end
-
     if _searchRadius < 0 then
         _searchRadius = 0
     end
@@ -882,11 +896,11 @@ function ctld.unloadTransport(_unitName)
     if _unit ~= nil  then
 
         if ctld.troopsOnboard(_unit, true) then
-            ctld.loadUnloadTroops({_unitName,true,"unload"})
+            ctld.unloadTroops({_unitName,true})
         end
 
         if ctld.unitCanCarryVehicles(_unit) and ctld.troopsOnboard(_unit, false) then
-            ctld.loadUnloadTroops({_unitName,false,"unload"})
+            ctld.unloadTroops({_unitName,false})
         end
     end
 
@@ -899,10 +913,10 @@ function ctld.loadTransport(_unitName)
 
     if _unit ~= nil  then
 
-        ctld.loadUnloadTroops({_unitName,true,"load"})
+        ctld.loadTroopsFromZone({ _unitName, true,"",true })
 
         if ctld.unitCanCarryVehicles(_unit)  then
-            ctld.loadUnloadTroops({_unitName,false,"load"})
+            ctld.loadTroopsFromZone({ _unitName, false,"",true })
         end
 
     end
@@ -1303,13 +1317,54 @@ function ctld.deployTroops(_heli, _troops)
     end
 end
 
+function ctld.insertIntoTroopsArray(_troopType,_count,_troopArray)
+
+    for _i = 1, _count do
+        local _unitId = mist.getNextUnitId()
+        table.insert(_troopArray, { type = _troopType, unitId = _unitId, name = string.format("Dropped %s #%i", _troopType, _unitId) })
+    end
+
+    return _troopArray
+
+end
 
 
-function ctld.generateTroopTypes(_side, _count, _country)
+function ctld.generateTroopTypes(_side, _countOrTemplate, _country)
 
     local _troops = {}
 
-    for _i = 1, _count do
+    if type(_countOrTemplate) == "table" then
+
+        if _countOrTemplate.aa then
+            if _side == 2 then
+                _troops = ctld.insertIntoTroopsArray("Stinger manpad",_countOrTemplate.aa,_troops)
+            else
+                _troops = ctld.insertIntoTroopsArray("SA-18 Igla manpad",_countOrTemplate.aa,_troops)
+            end
+        end
+
+        if _countOrTemplate.inf then
+            if _side == 2 then
+                _troops = ctld.insertIntoTroopsArray("Soldier M4",_countOrTemplate.inf,_troops)
+            else
+                _troops = ctld.insertIntoTroopsArray("Soldier AK",_countOrTemplate.inf,_troops)
+            end
+        end
+
+        if _countOrTemplate.mg then
+            _troops = ctld.insertIntoTroopsArray("Soldier M249",_countOrTemplate.mg,_troops)
+        end
+
+        if _countOrTemplate.at then
+            _troops = ctld.insertIntoTroopsArray("Paratrooper RPG-16",_countOrTemplate.at,_troops)
+        end
+
+        if _countOrTemplate.mortar then
+            _troops = ctld.insertIntoTroopsArray("2B11 mortar",_countOrTemplate.mortar,_troops)
+        end
+
+    else
+        for _i = 1, _countOrTemplate do
 
             local _unitType = "Soldier AK"
 
@@ -1342,6 +1397,7 @@ function ctld.generateTroopTypes(_side, _count, _country)
 
             _troops[_i] = { type = _unitType, unitId = _unitId, name = string.format("Dropped %s #%i", _unitType, _unitId) }
         end
+    end
 
     local _groupId = mist.getNextGroupId()
     local _details = { units = _troops, groupId = _groupId, groupName = string.format("Dropped Group %i", _groupId), side = _side, country = _country }
@@ -1350,7 +1406,7 @@ function ctld.generateTroopTypes(_side, _count, _country)
 end
 
 -- load troops onto vehicle
-function ctld.loadTroops(_heli, _troops, _number)
+function ctld.loadTroops(_heli, _troops, _numberOrTemplate)
 
     -- load troops + vehicles if c130 or herc
     -- "M1045 HMMWV TOW"
@@ -1358,8 +1414,8 @@ function ctld.loadTroops(_heli, _troops, _number)
     local _onboard = ctld.inTransitTroops[_heli:getName()]
 
     --number doesnt apply to vehicles
-    if _number == nil then
+    if _numberOrTemplate == nil then
-        _number = ctld.numberOfTroops
+        _numberOrTemplate = ctld.numberOfTroops
     end
 
     if _onboard == nil then
@@ -1375,9 +1431,9 @@ function ctld.loadTroops(_heli, _troops, _number)
 
     if _troops then
 
-        _onboard.troops = ctld.generateTroopTypes(_heli:getCoalition(), _number, _heli:getCountry())
+        _onboard.troops = ctld.generateTroopTypes(_heli:getCoalition(), _numberOrTemplate, _heli:getCountry())
 
-        trigger.action.outTextForCoalition(_heli:getCoalition(), ctld.getPlayerNameOrType(_heli) .. " loaded " .. _number .. " troops into " .. _heli:getTypeName(), 10)
+        trigger.action.outTextForCoalition(_heli:getCoalition(), ctld.getPlayerNameOrType(_heli) .. " loaded troops into " .. _heli:getTypeName(), 10)
 
         ctld.processCallback({unit = _heli, onboard = _onboard.troops, action = "load_troops"})
     else
@@ -1510,22 +1566,33 @@ function ctld.loadUnloadFOBCrate(_args)
     end
 end
 
-function ctld.loadUnloadTroops(_args)
+function ctld.loadTroopsFromZone(_args)
 
     local _heli = ctld.getTransportUnit(_args[1])
     local _troops = _args[2]
-    local _mode = _args[3] or ""
+    local _groupTemplate = _args[3] or ""
+    local _allowExtract = _args[4]
 
     if _heli == nil then
-        return
+        return false
     end
 
     local _zone = ctld.inPickupZone(_heli)
 
-    if not ctld.troopsOnboard(_heli, _troops) and (_mode == "load" or _mode == "") then
+    if ctld.troopsOnboard(_heli, _troops) then
+
+        if _troops then
+            ctld.displayMessageToGroup(_heli, "You already have troops onboard.", 10)
+        else
+            ctld.displayMessageToGroup(_heli, "You already have vehicles onboard.", 10)
+        end
+
+        return false
+    end
 
     local _extract
 
+    if _allowExtract then
         -- first check for extractable troops regardless of if we're in a zone or not
         if _troops then
             if _heli:getCoalition() == 1 then
@@ -1541,29 +1608,54 @@ function ctld.loadUnloadTroops(_args)
                 _extract = ctld.findNearestGroup(_heli, ctld.droppedVehiclesBLUE)
             end
         end
+    end
 
     if _extract ~= nil then
         -- search for nearest troops to pickup
-            ctld.extractTroops(_heli, _troops)
+        return ctld.extractTroops({_heli:getName(), _troops})
-
-            return -- stop
     elseif _zone.inZone == true then
 
         if _zone.limit - 1 >= 0 then
             -- decrease zone counter by 1
             ctld.updateZoneCounter(_zone.index, -1)
 
-                ctld.loadTroops(_heli, _troops)
+            ctld.loadTroops(_heli, _troops,_groupTemplate)
+
+            return true
         else
             ctld.displayMessageToGroup(_heli, "This area has no more reinforcements available!", 20)
+
+            return false
         end
 
     else
-            -- search for nearest troops to pickup
+        if _allowExtract then
-            ctld.extractTroops(_heli, _troops)
+            ctld.displayMessageToGroup(_heli, "You are not in a pickup zone and no one is nearby to extract", 10)
+        else
+            ctld.displayMessageToGroup(_heli, "You are not in a pickup zone", 10)
         end
 
-    elseif ( _mode == "unload" or _mode == "") then -- dont unload if we just want to force loading
+        return false
+    end
+end
+
+
+
+function ctld.unloadTroops(_args)
+
+    local _heli = ctld.getTransportUnit(_args[1])
+    local _troops = _args[2]
+
+    if _heli == nil then
+        return false
+    end
+
+    local _zone = ctld.inPickupZone(_heli)
+    if not ctld.troopsOnboard(_heli, _troops)  then
+        ctld.displayMessageToGroup(_heli, "No one to unload", 10)
+
+        return false
+    else
 
         -- troops must be onboard to get here
         if _zone.inZone == true  then
@@ -1586,18 +1678,37 @@ function ctld.loadUnloadTroops(_args)
             -- increase zone counter by 1
             ctld.updateZoneCounter(_zone.index, 1)
 
+            return true
+
         elseif _zone.inZone == false and ctld.troopsOnboard(_heli, _troops)  then
 
-            ctld.deployTroops(_heli, _troops)
+            return ctld.deployTroops(_heli, _troops)
         end
     end
 
 end
 
-function ctld.extractTroops(_heli, _troops)
+function ctld.extractTroops(_args)
+
+    local _heli = ctld.getTransportUnit(_args[1])
+    local _troops = _args[2]
+
+    if _heli == nil then
+        return false
+    end
 
     if ctld.inAir(_heli) then
-        return
+        return false
+    end
+
+    if  ctld.troopsOnboard(_heli, _troops)  then
+        if _troops then
+            ctld.displayMessageToGroup(_heli, "You already have troops onboard.", 10)
+        else
+            ctld.displayMessageToGroup(_heli, "You already have vehicles onboard.", 10)
+        end
+
+        return false
     end
 
     local _onboard = ctld.inTransitTroops[_heli:getName()]
@@ -1638,7 +1749,7 @@ function ctld.extractTroops(_heli, _troops)
             _extracted = true
         else
             _onboard.troops = nil
-            ctld.displayMessageToGroup(_heli, "No extractable troops nearby and not in a pickup zone", 20)
+            ctld.displayMessageToGroup(_heli, "No extractable troops nearby!", 20)
         end
 
     else
@@ -1674,7 +1785,7 @@ function ctld.extractTroops(_heli, _troops)
 
         else
             _onboard.vehicles = nil
-            ctld.displayMessageToGroup(_heli, "No extractable vehicles nearby and not in a pickup zone", 20)
+            ctld.displayMessageToGroup(_heli, "No extractable vehicles nearby!", 20)
         end
     end
 
@@ -3703,22 +3814,22 @@ function ctld.checkAIStatus()
 
             if _zone.inZone == true and not ctld.troopsOnboard(_unit, true) then
 
-                ctld.loadUnloadTroops({_unitName,true,"load"})
+                ctld.loadTroopsFromZone({ _unitName, true,"",true })
 
             elseif ctld.inDropoffZone(_unit) and ctld.troopsOnboard(_unit, true) then
 
-                ctld.loadUnloadTroops({_unitName,true,"unload"})
+                ctld.unloadTroops( { _unitName, true })
             end
 
             if ctld.unitCanCarryVehicles(_unit) then
 
                 if _zone.inZone == true and not ctld.troopsOnboard(_unit, false) then
 
-                    ctld.loadUnloadTroops({_unitName,false,"load"})
+                    ctld.loadTroopsFromZone({ _unitName, false,"",true })
 
                 elseif ctld.inDropoffZone(_unit) and ctld.troopsOnboard(_unit, false) then
 
-                    ctld.loadUnloadTroops({_unitName,false,"unload"})
+                    ctld.unloadTroops( { _unitName, false })
                 end
             end
         end
@@ -3750,20 +3861,32 @@ function ctld.addF10MenuOptions()
 
                         local _troopCommandsPath = missionCommands.addSubMenuForGroup(_groupId, "Troop Transport", _rootPath)
 
-                        missionCommands.addCommandForGroup(_groupId, "Load / Unload Troops", _troopCommandsPath, ctld.loadUnloadTroops, { _unitName, true })
+                        missionCommands.addCommandForGroup(_groupId, "Unload Troops", _troopCommandsPath, ctld.unloadTroops, { _unitName, true })
+                        missionCommands.addCommandForGroup(_groupId, "Extract Troops", _troopCommandsPath, ctld.extractTroops, { _unitName, true })
 
-                        if ctld.unitCanCarryVehicles(_unit) then
+                        for _,_loadGroup in pairs(ctld.loadableGroups) do
-
+                            if not _loadGroup.side or _loadGroup.side == _unit:getCoalition() then
-                            missionCommands.addCommandForGroup(_groupId, "Load / Unload Vehicles", _troopCommandsPath, ctld.loadUnloadTroops, { _unitName, false })
+                                missionCommands.addCommandForGroup(_groupId, "Load ".._loadGroup.name, _troopCommandsPath, ctld.loadTroopsFromZone, { _unitName, true,_loadGroup,false })
-
-                            if ctld.enabledFOBBuilding then
-
-                                missionCommands.addCommandForGroup(_groupId, "Load / Unload FOB Crate", _troopCommandsPath, ctld.loadUnloadFOBCrate, { _unitName, false })
                             end
                         end
 
                         missionCommands.addCommandForGroup(_groupId, "Check Cargo", _troopCommandsPath, ctld.checkTroopStatus, { _unitName })
 
+                        if ctld.unitCanCarryVehicles(_unit) then
+
+                            local _vehicleCommandsPath = missionCommands.addSubMenuForGroup(_groupId, "Vehicle / FOB Transport", _rootPath)
+
+                            missionCommands.addCommandForGroup(_groupId, "Unload Vehicles", _vehicleCommandsPath, ctld.unloadTroops, { _unitName, false })
+                            missionCommands.addCommandForGroup(_groupId, "Load / Extract Vehicles", _vehicleCommandsPath, ctld.loadTroopsFromZone, { _unitName, false,"",true })
+
+                            if ctld.enabledFOBBuilding then
+
+                                missionCommands.addCommandForGroup(_groupId, "Load / Unload FOB Crate", _vehicleCommandsPath, ctld.loadUnloadFOBCrate, { _unitName, false })
+                            end
+                            missionCommands.addCommandForGroup(_groupId, "Check Cargo", _vehicleCommandsPath, ctld.checkTroopStatus, { _unitName })
+                        end
+
+
                         if ctld.enableCrates then
 
                             if ctld.unitCanCarryVehicles(_unit) == false then
@@ -3785,7 +3908,6 @@ function ctld.addF10MenuOptions()
                             end
                         end
 
-
                         if ctld.enabledFOBBuilding or ctld.enableCrates then
                             local _crateCommands = missionCommands.addSubMenuForGroup(_groupId, "CTLD Commands", _rootPath)
                             missionCommands.addCommandForGroup(_groupId, "List Nearby Crates", _crateCommands, ctld.listNearbyCrates, { _unitName })