@jtff/miztemplate-lib 3.10.13 → 4.0.0

package/lua/src/110-set_clients.lua

@@ -1,15 +1,23 @@
 -- *****************************************************************************
---                     **                    Set_Client                       **
+--                     **                    ClientWatch                      **
 --                     *********************************************************
-Set_CLIENT = SET_CLIENT:New():FilterOnce()
-Set_CLIENT:HandleEvent(EVENTS.Refueling)
-Set_CLIENT:HandleEvent(EVENTS.RefuelingStop)
-Set_CLIENT:HandleEvent(EVENTS.PlayerEnterAircraft)
-function Set_CLIENT:OnEventPlayerEnterAircraft(EventData)
+Set_AllClients = SET_CLIENT:New():FilterOnce()
+Jtff_log.debug(string.format("Nbre Clients : %i", Set_AllClients:Count()),"GENERAL")
+Set_AllBlueClients = SET_CLIENT:New():FilterCoalitions(coalition.side.BLUE):FilterOnce()
+Jtff_log.debug(string.format("Nbre Blue Client : %i", Set_AllBlueClients:Count()),"GENERAL")
+Set_AllRedClients = SET_CLIENT:New():FilterCoalitions(coalition.side.RED):FilterOnce()
+Jtff_log.debug(string.format("Nbre Red Client : %i", Set_AllRedClients:Count()),"GENERAL")
+
+AllClientsWatch = CLIENTWATCH:New(Set_AllClients:GetSetNames())
+AllClientsWatch:HandleEvent(EVENTS.PlayerEnterAircraft)
+AllClientsWatch:HandleEvent(EVENTS.Refueling)
+AllClientsWatch:HandleEvent(EVENTS.RefuelingStop)
+
+function AllClientsWatch:OnEventPlayerEnterAircraft(EventData)
     if (EventData.IniGroupName) then
-        jtff_log.debug(string.format("OnEventPlayerEnterAircraft: IniGroupName = %s", EventData.IniGroupName),"GENERAL")
-        jtff_log.debug(string.format("OnEventPlayerEnterAircraft: IniPlayerName = %s", EventData.IniPlayerName),"GENERAL")
-        jtff_log.debug(string.format("OnEventPlayerEnterAircraft: IniUnitName = %s", net.lua2json(EventData.IniUnitName)),"GENERAL")
+        Jtff_log.debug(string.format("OnEventPlayerEnterAircraft: IniGroupName = %s", EventData.IniGroupName),"GENERAL")
+        Jtff_log.debug(string.format("OnEventPlayerEnterAircraft: IniPlayerName = %s", EventData.IniPlayerName),"GENERAL")
+        Jtff_log.debug(string.format("OnEventPlayerEnterAircraft: IniUnitName = %s", net.lua2json(EventData.IniUnitName)),"GENERAL")
         local clientGroup = GROUP:FindByName(EventData.IniGroupName)
         local clientUnit = UNIT:FindByName(EventData.IniUnitName)
         local clientSetting = SETTINGS:Set( EventData.IniPlayerName)
@@ -27,14 +35,14 @@ function Set_CLIENT:OnEventPlayerEnterAircraft(EventData)
                 end
             end
         end
-        jtff_log.debug(string.format("Add QRA Menu for group [%s], player name [%s]",EventData.IniGroupName , EventData.IniPlayerName),"QRA")
+        Jtff_log.debug(string.format("Add QRA Menu for group [%s], player name [%s]",EventData.IniGroupName , EventData.IniPlayerName),"QRA")
         if type(QRAArray) == 'table' then
             for index, objQRA in ipairs(QRAArray) do
-                if (MenuCoalitionQRA[clientUnit:GetCoalition()]) and (objQRA.customconfig.type == JTFF_QRA.Type.TangoAuto) then
+                if (MenuCoalitionQRA[UTILS.GetCoalitionName(clientUnit:GetCoalition())]) and (objQRA.customconfig.type == JTFF_QRA.Type.TangoAuto) then
                     objQRA.menu[clientUnit:GetCoalition()] = MENU_GROUP_COMMAND:New(
                         clientGroup,
                         "Trigger " .. objQRA.customconfig.name,
-                        MenuCoalitionQRA[clientUnit:GetCoalition()],
+                        MenuCoalitionQRA[UTILS.GetCoalitionName(clientUnit:GetCoalition())],
                         QRATrigger,
                         {
                             objQRA,
@@ -45,27 +53,34 @@ function Set_CLIENT:OnEventPlayerEnterAircraft(EventData)
                 end
             end
         end
-        jtff_log.debug(string.format("Add Tanker Menu for group [%s], player name [%s]",EventData.IniGroupName , EventData.IniPlayerName),"TANKER")
+        Jtff_log.debug(
+            string.format(
+                "Add Tanker Menu for group [%s], player name [%s]",
+                EventData.IniGroupName,
+                EventData.IniPlayerName
+            ),
+            "TANKER"
+        )
         if clientUnit:GetCoalition() == coalition.side.BLUE then
-            MENU_GROUP_COMMAND:New( clientGroup, "Nearest Tanker Info", MenuCoalitionTankerBlue, NearestTankerInfo, { clientUnit, clientGroup}  )
-            MENU_GROUP_COMMAND:New( clientGroup, "All Tankers Info", MenuCoalitionTankerBlue, AllTankersInfo, {clientUnit,clientGroup} )
+            MENU_GROUP_COMMAND:New( clientGroup, "Nearest Tanker Info", MenuCoalitionTankers[UTILS.GetCoalitionName(coalition.side.BLUE)], NearestTankerInfo, { clientUnit, clientGroup}  )
+            MENU_GROUP_COMMAND:New( clientGroup, "All Tankers Info", MenuCoalitionTankers[UTILS.GetCoalitionName(coalition.side.BLUE)], AllTankersInfo, {clientUnit,clientGroup} )
         else
-            MENU_GROUP_COMMAND:New( clientGroup, "Nearest Tanker Info", MenuCoalitionTankerRed, NearestTankerInfo, { clientUnit, clientGroup}  )
-            MENU_GROUP_COMMAND:New( clientGroup, "All Tankers Info", MenuCoalitionTankerRed, AllTankersInfo, {clientUnit,clientGroup} )
+            MENU_GROUP_COMMAND:New( clientGroup, "Nearest Tanker Info", MenuCoalitionTankers[UTILS.GetCoalitionName(coalition.side.RED)], NearestTankerInfo, { clientUnit, clientGroup}  )
+            MENU_GROUP_COMMAND:New( clientGroup, "All Tankers Info", MenuCoalitionTankers[UTILS.GetCoalitionName(coalition.side.RED)], AllTankersInfo, {clientUnit,clientGroup} )
         end
         local GroupMenu = MENU_GROUP:New( clientGroup, "My Group settings" )
-        jtff_log.debug(string.format("Add Immortal Menu for group [%s], player name [%s]",EventData.IniGroupName , EventData.IniPlayerName),"GENERAL")
+        Jtff_log.debug(string.format("Add Immortal Menu for group [%s], player name [%s]",EventData.IniGroupName , EventData.IniPlayerName),"GENERAL")
         BASE:SetState( clientGroup, "isImmortal", false )
         BASE:SetState( clientUnit, "isRefueling", false )
-        MENU_GROUP_COMMAND:New( clientGroup, "Switch immortal status", GroupMenu, switchGroupImmortalStatus, clientGroup )
+        MENU_GROUP_COMMAND:New( clientGroup, "Switch immortal status", GroupMenu, SwitchGroupImmortalStatus, clientGroup )
         if (type(AIRBOSSArray) == 'table') then
             if #AIRBOSSArray > 0 then
-                MENU_GROUP_COMMAND:New( clientGroup, "Switch Airboss subtitles", GroupMenu, switchGroupAirbossSubtitlesStatus, clientGroup )
+                MENU_GROUP_COMMAND:New( clientGroup, "Switch Airboss subtitles", GroupMenu, SwitchGroupAirbossSubtitlesStatus, clientGroup )
             end
         end
     end
 end
-function Set_CLIENT:OnEventRefueling(EventData)
+function AllClientsWatch:OnEventRefueling(EventData)
     if (EventData.initiator) then
         if NET:GetMyPlayerID() == 1 then
             --trigger.action.outText("Vous êtes en mode multijoueur.", 90)
@@ -99,12 +114,12 @@ function Set_CLIENT:OnEventRefueling(EventData)
                         --trigger.action.outText(string.format("testing unit %s for clientRefuelableSet",unit:GetName()), 90)
                         if type(clientRefueling) ~= 'nil' then
                             clientRefuelableSet:AddObject(clientRefueling)
-                            jtff_log.trace(string.format("adding %s to clientRefuelableSet (refuelable aicrafts near tanker)",clientRefueling:GetPlayer()),"TANKER")
+                            Jtff_log.trace(string.format("adding %s to clientRefuelableSet (refuelable aicrafts near tanker)",clientRefueling:GetPlayer()),"TANKER")
                         end
                     end
                 )
-                jtff_log.trace(string.format("refuelingUnitSet (refuelable aicrafts near tanker) : count = %d",refuelingUnitsSet:Count()),"TANKER")
-                jtff_log.trace(string.format("clientRefuelableSet (client refuelable aircrafts near tanker): count = %d",clientRefuelableSet:Count()),"TANKER")
+                Jtff_log.trace(string.format("refuelingUnitSet (refuelable aicrafts near tanker) : count = %d",refuelingUnitsSet:Count()),"TANKER")
+                Jtff_log.trace(string.format("clientRefuelableSet (client refuelable aircrafts near tanker): count = %d",clientRefuelableSet:Count()),"TANKER")
                 if clientRefuelableSet:Count() >= 1 then
                     if clientRefuelableSet:Count() >= 2 then
                         clientRefuelableSet:ForEachClient(
@@ -118,7 +133,7 @@ function Set_CLIENT:OnEventRefueling(EventData)
                                                 local clientNameString = clientObject:GetPlayer() or unit:GetName()
                                                 BASE:SetState( unit, "isRefueling", true )
                                                 BASE:SetState( unit, "FuelState", initialFuelState )
-                                                jtff_log.info(
+                                                Jtff_log.info(
                                                     string.format(
                                                         "[%s] Start refueling at the tanker [%s], current fuel : %.0f Lbs",
                                                         clientNameString,
@@ -145,19 +160,19 @@ function Set_CLIENT:OnEventRefueling(EventData)
                         clientName = client:GetPlayer() or clientUnit:GetName()
                         BASE:SetState( clientUnit, "FuelState", clientFuel )
                         BASE:SetState( clientUnit, "isRefueling", true )
-                        jtff_log.info(string.format("[%s] Start refueling at the tanker [%s], current fuel : %.0f Lbs", clientName, tankerUnitName, UTILS.kg2lbs(clientFuel)),"TANKER")
+                        Jtff_log.info(string.format("[%s] Start refueling at the tanker [%s], current fuel : %.0f Lbs", clientName, tankerUnitName, UTILS.kg2lbs(clientFuel)),"TANKER")
                     end
                 end
             else
-                jtff_log.error("tanker not found !!!","TANKER")
+                Jtff_log.error("tanker not found !!!","TANKER")
             end
         else
             --trigger.action.outText("Vous êtes en mode solo.", 90)
             local client = CLIENT:Find(EventData.initiator, true)
             if (type(client) ~= 'nil') then
-                local clientUnit = UNIT:Find(EventData.initiator)
+                local clientUnit = UNIT:Find(EventData.initiator) or {}
                 local clientFuel = clientUnit:GetFuel() * clientUnit:GetDesc().fuelMassMax
-                local tankerUnit = getNearestTankerfromPlayerUnit(clientUnit)
+                local tankerUnit = GetNearestTankerfromPlayerUnit(clientUnit)
                 local tankerUnitName = 'unknown'
                 if (type(tankerUnit) ~= 'nil') then
                     tankerUnitName = tankerUnit:GetName()
@@ -166,30 +181,30 @@ function Set_CLIENT:OnEventRefueling(EventData)
                 clientName = client:GetPlayer()
                 BASE:SetState( clientUnit, "FuelState", clientFuel )
                 BASE:SetState( clientUnit, "isRefueling", true )
-                jtff_log.info(string.format("[%s] Start refueling at the tanker [%s], current fuel : %.0f Lbs", clientName, tankerUnitName, UTILS.kg2lbs(clientFuel)),"TANKER")
+                Jtff_log.info(string.format("[%s] Start refueling at the tanker [%s], current fuel : %.0f Lbs", clientName, tankerUnitName, UTILS.kg2lbs(clientFuel)),"TANKER")
             end
         end
     end
 end
-function Set_CLIENT:OnEventRefuelingStop(EventData)
+function AllClientsWatch:OnEventRefuelingStop(EventData)
     if (EventData.initiator) then
         local client = CLIENT:Find(EventData.initiator, true)
         if (type(client) ~= 'nil') then
-            local clientUnit = UNIT:Find(EventData.initiator)
+            local clientUnit = UNIT:Find(EventData.initiator) or {}
             local clientFuel = clientUnit:GetFuel() * clientUnit:GetDesc().fuelMassMax
-            local tankerUnit = getNearestTankerfromPlayerUnit(clientUnit)
+            local tankerUnit = GetNearestTankerfromPlayerUnit(clientUnit)
             local tankerUnitName = 'unknown'
             if (type(tankerUnit) ~= 'nil') then
                 tankerUnitName = tankerUnit:GetName()
             end
             if not(BASE:GetState(clientUnit,"isRefueling")) then
-                jtff_log.error(string.format("impossible to determine accurately fuel taken by [%s] : trying anyway...",client:GetPlayer()),"TANKER")
+                Jtff_log.error(string.format("impossible to determine accurately fuel taken by [%s] : trying anyway...",client:GetPlayer()),"TANKER")
             end
             local clientFuelTaken = clientFuel - BASE:GetState(clientUnit,"FuelState")
             BASE:SetState( clientUnit, "FuelState", clientFuel )
             BASE:SetState( clientUnit, "isRefueling", false )
-            jtff_log.info(string.format("[%s] just finsihed refueling at the tanker [%s], taken %.0f Lbs",client:GetPlayer() , tankerUnitName, UTILS.kg2lbs(clientFuelTaken)),"TANKER")
-            if (type(dcsbot) ~= 'nil') then
+            Jtff_log.info(string.format("[%s] just finsihed refueling at the tanker [%s], taken %.0f Lbs",client:GetPlayer() , tankerUnitName, UTILS.kg2lbs(clientFuelTaken)),"TANKER")
+            if (type(Jtff_dcsbot) ~= 'nil') then
                 local title = string.format('End of Air refuel !')
                 local description = string.format("[%s] just finsihed refueling at the tanker [%s], taken %.0f Lbs",client:GetPlayer() , tankerUnitName, UTILS.kg2lbs(clientFuelTaken))
                 local img = 'https://cdn10.picryl.com/photo/2004/10/03/a-us-navy-usn-f-14b-tomcat-aircraft-assigned-to-fighter-squadron-one-zero-three-f5f749-1024.jpg'
@@ -199,13 +214,8 @@ function Set_CLIENT:OnEventRefuelingStop(EventData)
                     ['RefuelQty'] = string.format("%.0f Lbs", UTILS.kg2lbs(clientFuelTaken))
                 }
                 local footer = 'Sorry, tomcats took it all again...'
-                dcsbot.sendEmbed(title, description, img, fields, footer)
+                Jtff_dcsbot.sendEmbed(title, description, img, fields, footer)
             end
         end
     end
-end
-
-Set_CLIENT_Bleu = SET_CLIENT:New():FilterCoalitions(coalition.side.BLUE):FilterOnce()
-jtff_log.debug(string.format("Nbre Blue Client : %i", Set_CLIENT_Bleu:Count()),"GENERAL")
-Set_CLIENT_Red = SET_CLIENT:New():FilterCoalitions(coalition.side.RED):FilterOnce()
-jtff_log.debug(string.format("Nbre Red Client : %i", Set_CLIENT_Red:Count()),"GENERAL")
+end

package/lua/src/115-airbases.lua

@@ -0,0 +1,191 @@
+-- *****************************************************************************
+--                     **                    Root Commanders                  **
+--                     *********************************************************
+Commander = {}
+for _k,_coalition in pairs(coalition.side) do
+  Commander[UTILS.GetCoalitionName(_coalition)] = COMMANDER:New(_coalition,string.format('commander-%s', UTILS.GetCoalitionName(_coalition)))
+  Commander[UTILS.GetCoalitionName(_coalition)]:SetVerbosity(JTFF_verbosity_levels[JTFF_LOGLEVEL])
+  Commander[UTILS.GetCoalitionName(_coalition)]:Start()
+end
+
+
+-- *****************************************************************************
+--                     **                     Airbases                        **
+--                     *********************************************************
+
+-- region AirbaseConfigFunctions
+-- @type AirbaseConfig
+-- @field #string name Airbase name.
+-- @field #string warehouse Warehouse name.
+-- @field #boolean enable Enable airbase creation.
+-- @field #AirwingConfig airwing Airwing configuration.
+
+
+--- Parse Airbases config Object.
+-- @param #JsonObject config Config object to parse
+-- @return #AirbaseConfig airbaseConfigJson Parsed AirbaseConfig object
+function ParseAirbaseConfigJson(config)
+    local json = require('Scripts/json')
+    local parser_name = "AIRBASE"
+    -- **************************************************************************
+    --                             enable
+    -- **************************************************************************
+    local airbaseConfigJson = {
+        enable = config.enable or false,
+    }
+    -- **************************************************************************
+    --                             name
+    -- **************************************************************************
+    if type(config.name) == "string" then
+        airbaseConfigJson.name = config.name
+        if type(AIRBASE:FindByName(config.name)) == 'nil' then
+            Jtff_log.error(
+                string.format(
+                    "Airbase %s not found, skipping  its configuration",
+                    config.name
+                ),
+                parser_name
+            )
+            config.enable = false
+            return config
+        end
+    else
+        Jtff_log.error("Airbase name is not a string, skipping airbase configuration", parser_name)
+        config.enable = false
+        return config
+    end
+    -- **************************************************************************
+    --                             Warehouse name
+    -- **************************************************************************
+    if type(config.warehouse) == "string" then
+        airbaseConfigJson.warehouse = config.warehouse
+        if type(STATIC:FindByName(config.warehouse, false)) == 'nil'
+            and type(UNIT:FindByName(config.warehouse)) == 'nil' then
+            Jtff_log.error(
+                string.format(
+                    "Warehouse %s not found, skipping %s Airbase",
+                    config.warehouse,
+                    config.name or "unknown"
+                ),
+                parser_name
+            )
+            config.enable = false
+            return config
+        end
+    else
+        Jtff_log.error("Airbase warehouse is not a string", parser_name)
+        config.enable = false
+        return config
+    end
+    -- **************************************************************************
+    --                             AirWing
+    -- **************************************************************************
+    if type(config.airwing) == "table" then
+        airbaseConfigJson.airwing = ParseAirwingConfigJson(config.airwing, parser_name)
+    else
+        Jtff_log.error("Airbase airwing is not a table", parser_name)
+        config.enable = false
+        return config
+    end
+    Jtff_log.debug(
+        string.format(
+            "parsed Airbase config for %s Airbase, resulting config :\n%s",
+            config.name or "",
+            json:encode(
+                airbaseConfigJson,
+                { indent = true }
+            )
+        ),
+        parser_name
+    )
+    return airbaseConfigJson
+end
+
+-- endregion AirbaseConfigFunctions
+
+
+AirbasesArray = {}
+MenuCoalitionAirbases = {}
+for _k, _coalition in pairs(coalition.side) do
+    MenuCoalitionAirbases[UTILS.GetCoalitionName(_coalition)] = MENU_COALITION:New(_coalition, "Airbases", MenuCoalition[UTILS.GetCoalitionName(_coalition)])
+end
+local compteur = #AirbasesArray
+for _index, _currentAirbaseConfigObject in ipairs(AirBasesConfig) do
+    local airbaseconfig = ParseAirbaseConfigJson(_currentAirbaseConfigObject)
+    if airbaseconfig.enable == true then
+        compteur = compteur + 1
+        Jtff_log.info(
+            string.format(
+                'creation Airbase %s: Warehouse=%s ...',
+                airbaseconfig.name,
+                airbaseconfig.warehouse
+            ),
+            "AIRBASE"
+        )
+        local objAirbase = AIRBASE:FindByName(airbaseconfig.name)
+        objAirbase.airwing = AIRWING:New(
+            airbaseconfig.warehouse,
+            airbaseconfig.airwing.name
+        )
+        Commander[objAirbase.airwing:GetCoalitionName()]:AddAirwing(
+            objAirbase.airwing
+        )
+        for _, _squadronconfig in ipairs(airbaseconfig.airwing.squadrons) do
+            local squadronToCreate = SQUADRON:New(
+                _squadronconfig.template,
+                _squadronconfig.nb_aircrafts,
+                _squadronconfig.name
+            )
+            squadronToCreate:SetFuelLowThreshold(_squadronconfig.fuellowthreshold)
+            squadronToCreate:SetFuelLowRefuel(_squadronconfig.lowfuelrtb)
+            squadronToCreate:SetGrouping(_squadronconfig.grouping)
+            squadronToCreate:SetModex(_squadronconfig.modex)
+            squadronToCreate:SetRadio(_squadronconfig.radio.freq, _squadronconfig.radio.modulation)
+            squadronToCreate:SetSkill(_squadronconfig.skill)
+            squadronToCreate:SetVerbosity(
+                JTFF_verbosity_levels[JTFF_LOGLEVEL]
+            )
+            squadronToCreate:SetTurnoverTime(
+                _squadronconfig.turnovertime,
+                _squadronconfig.repairtime
+            )
+            if type(_squadronconfig.livery) == 'string' then
+                squadronToCreate:SetLivery(_squadronconfig.livery)
+            end
+            for _, _payload in ipairs(_squadronconfig.payloads) do
+                local payloadTemplateGroup = GROUP:FindByName(_payload.name)
+                if #(_payload.payloadconfigs) > 0 then
+                    for _, _payloadconfig in ipairs(_payload.payloadconfigs) do
+                        squadronToCreate:AddMissionCapability(_payloadconfig.roles)
+                        objAirbase.airwing:NewPayload(
+                            payloadTemplateGroup:GetUnit(1),
+                            _payloadconfig.qty,
+                            _payloadconfig.roles,
+                            _payloadconfig.perf
+                        )
+                    end
+                end
+            end
+            objAirbase.airwing:AddSquadron(
+                squadronToCreate
+            )
+        end
+        objAirbase.customconfig = airbaseconfig
+        AirbasesArray[compteur] = objAirbase
+        AirbasesArray[compteur].airwing:Start()
+        Jtff_log.debug(
+            string.format(
+                "Airbase %s added to AirbasesArray, index %d",
+                objAirbase.customconfig.name,
+                compteur
+            ),
+            "AIRBASE"
+        )
+    end
+end
+
+if #AirbasesArray == 0 then
+    for _k, _coalition in pairs(coalition.side) do
+        MenuCoalitionAirbases[UTILS.GetCoalitionName(_coalition)]:Remove()
+    end
+end