diff --git a/.gitea/workflows/pr.yml b/.gitea/workflows/pr.yml new file mode 100644 index 0000000..a16d922 --- /dev/null +++ b/.gitea/workflows/pr.yml @@ -0,0 +1,140 @@ +name: PR Prerequisites + +on: + pull_request: + branches: + - main + - develop + +env: + LUA_VERSION: "5.1" + LUA_LANGUAGE_SERVER_VERSION: "3.19.1" + +jobs: + bundles_without_error: + runs-on: ubuntu-latest + name: Bundles Without Errors + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up Lua + uses: leafo/gh-actions-lua@v13 + with: + luaVersion: ${{ env.LUA_VERSION }} + + - name: Compile Spearhead + uses: https://git.dutchie031.com/dutchie031/DcsMissionScriptingTools/github-actions/bundle-script@bundle-script/v1 + with: + source-root: ./src + output-file: ./output/spearhead.lua + + - name: Verify Compiled Lua Syntax + run: lua -e "assert(loadfile('./output/spearhead.lua'))" + + - name: Set up Luarocks + uses: leafo/gh-actions-luarocks@v4 + + - name: Install luacheck + run: luarocks install luacheck + + # "lfs", + # "setmetatable", "getmetatable", "table", "string", "math", "pairs", "ipairs", + # "require", "type", "tostring", "io", "error", "pcall", "tonumber", + # "loadstring", + + - name: Create LuaCheck Config + run: | + cat << EOF > .luacheckrc + + stds.spearhead_lib = { + globals = { + "SpearheadConfig", "SpearheadAPI", "GlobalCapCallBacks", + } + } + + stds.dcs_lib = { + globals = { + "env", "net", "trigger", "timer", "Object", "land", "coord", "coalition", + "Unit", "Group", "Airbase", "StaticObject", "SceneryObject", "world", + "country", "missionCommands", "Controller", "Weapon", "atmosphere", "country", + "lfs", "AI" + } + } + + std = "lua51c+spearhead_lib+dcs_lib" + self = false + + max_line_length = false + EOF + + - name: Show LuaCheck Config + run: cat .luacheckrc + + - name: Lint Compiled Output + run: luacheck ./output/spearhead.lua + + lua_check: + runs-on: ubuntu-latest + name: Lua Check + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up Lua + uses: leafo/gh-actions-lua@v13 + with: + luaVersion: ${{ env.LUA_VERSION }} + + - name: Install Dcs Plugins + uses: https://git.dutchie031.com/dutchie031/DcsMissionScriptingTools/github-actions/install-lua-addon@install-lua-addon/v1 + with: + destination-path: "./.vscode/lua-addons" ##same as local so .luarc.json can be the same + + - name: Verify Dcs Plugins Installation + run: ls -la ./.vscode/lua-addons + + - name: Install lua-language-server + run: | + mkdir -p ./luals + # For Ubuntu/Debian + wget https://github.com/LuaLS/lua-language-server/releases/download/${{ env.LUA_LANGUAGE_SERVER_VERSION }}/lua-language-server-${{ env.LUA_LANGUAGE_SERVER_VERSION }}-linux-x64.tar.gz + tar -xzf lua-language-server-*.tar.gz -C ./luals + rm lua-language-server-*.tar.gz + + - name: Verify Lua Language Server Installation + run: ./luals/bin/lua-language-server --version + + - name: Update Json + run: | + FULL_PATH=$(realpath ./.vscode/lua-addons) + echo "full-path: $FULL_PATH" + ls -R $FULL_PATH + + echo "Updating .luarc.json with full path" + jq --arg full_path "$FULL_PATH" '.workspace.library[0] = $full_path' ./.luarc.json > ./.luarc.tmp.json + mv ./.luarc.tmp.json ./.luarc.json + + - name: Show Config + run: cat ./.luarc.json + + - name: Run Lua Language Server + run: | + CONFIG_FULL_PATH=$(realpath ./.luarc.json) + echo "Config full path: $CONFIG_FULL_PATH" + + + ./luals/bin/lua-language-server \ + --check ./src \ + --checklevel=Warning \ + --loglevel=trace \ + --logpath="./luals/logs" \ + --configpath="$CONFIG_FULL_PATH" \ + # --develop + + - name: Show Log + if: failure() + run: | + ls -R ./luals/logs + + cat ./luals/logs/* || true diff --git a/.gitignore b/.gitignore index 5d688a1..1886557 100644 --- a/.gitignore +++ b/.gitignore @@ -3,5 +3,6 @@ /dist +.vscode/lua-addons .vscode/settings.json **\settings.json \ No newline at end of file diff --git a/.luarc.json b/.luarc.json new file mode 100644 index 0000000..d7c6e39 --- /dev/null +++ b/.luarc.json @@ -0,0 +1,51 @@ +{ + "$schema": "https://raw.githubusercontent.com/LuaLS/vscode-lua/master/setting/schema.json", + "runtime": { + "version": "Lua 5.1" + }, + "workspace": { + "checkThirdParty": false, + "maxPreload": 1600, + "preloadFileSize": 1000, + "ignoreDir": [ "config.lua" ] + }, + "diagnostics": { + "enable": true, + "globals": [ + "lfs" + ], + "groupSeverity": { + "duplicate": "Warning", + "global":"Warning", + "luadoc": "Warning", + "redefined": "Warning", + "strong": "Warning", + "type-check": "Warning", + "unbalanced" : "Warning", + "ambiguity": "Warning", + "strict": "Warning", + "unused": "Warning" + }, + "groupFileStatus": { + "ambiguity": "Any", + "await": "Any", + "duplicate": "Any", + "global": "Any", + "luadoc": "Any", + "redefined": "Any", + "strict": "Any", + "type-check": "Any", + "unbalanced": "Any", + "unused": "Any", + "strong": "Any" + }, + "ignoredFiles": "Opened", + "libraryFiles": "Opened" + }, + "hint": { + "enable": false + }, + "completion": { + "enable": true + } +} \ No newline at end of file diff --git a/.vscode/extensions.json b/.vscode/extensions.json index a12ed18..02af72a 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -1,5 +1,6 @@ -{ - "recommendations": [ - "sumneko.lua" - ] +{ + "recommendations": [ + "dutchie031.dutchies-dcs-scripting-tools", + "sumneko.lua", + ] } \ No newline at end of file diff --git a/config.lua b/config.lua index 14af0b5..f463f95 100644 --- a/config.lua +++ b/config.lua @@ -15,7 +15,7 @@ SpearheadConfig = { --quickly enable of disable the entire CAP Logic --(you can also just rename all units to not be named "CAP_") enabled = true, -- default true - + --min ground speed for CAP aircraft during patrol -- unit: knots minSpeed = 400, -- default 400 @@ -62,7 +62,7 @@ SpearheadConfig = { deathDelay = 1800, -- default 1800 }, StageConfig = { - + -- management of stages and its missions. -- This is not related to CAP managers which will continue to work even if stage management is disabled enabled = true, -- default true @@ -98,7 +98,7 @@ SpearheadConfig = { }, Persistence = { --- io and lfs cannot be sanitized in the MissionScripting.lua - + --- enables or disables the persistence logic in spearhead enabled = false, diff --git a/dev/dev_classes.lua b/dev/dev_classes.lua deleted file mode 100644 index 8e2a55b..0000000 --- a/dev/dev_classes.lua +++ /dev/null @@ -1,73 +0,0 @@ - - - ---assert(loadfile("C:\\Repos\\DCS\\Spearhead\\dev\\dev_classes.lua"))() - -local basePath = "C:\\Repos\\DCS\\Spearhead\\" -local classPath = basePath .. "classes\\" - -assert(loadfile(classPath .. "_baseClasses\\Queue.lua"))() - -assert(loadfile(classPath .. "spearhead_base.lua"))() -assert(loadfile(classPath .. "spearhead_routeutil.lua"))() -assert(loadfile(classPath .. "spearhead_events.lua"))() -assert(loadfile(classPath .. "spearhead_db.lua"))() - -assert(loadfile(classPath .. "fleetClasses\\FleetGroup.lua"))() -assert(loadfile(classPath .. "fleetClasses\\GlobalFleetManager.lua"))() - -assert(loadfile(classPath .. "helpers\\MizGroupsManager.lua"))() -assert(loadfile(classPath .. "helpers\\SpawnManager.lua"))() - -assert(loadfile(classPath .. "configuration\\CapConfig.lua"))() -assert(loadfile(classPath .. "configuration\\StageConfig.lua"))() - -assert(loadfile(classPath .. "stageClasses\\GlobalStageManager.lua"))() -assert(loadfile(classPath .. "stageClasses\\missions\\baseMissions\\Mission.lua"))() -assert(loadfile(classPath .. "stageClasses\\missions\\ZoneMission.lua"))() -assert(loadfile(classPath .. "stageClasses\\missions\\RunwayStrikeMission.lua"))() -assert(loadfile(classPath .. "stageClasses\\missions\\BuildableMission.lua"))() - - -assert(loadfile(classPath .. "stageClasses\\Stages\\BaseStage\\Stage.lua"))() -assert(loadfile(classPath .. "stageClasses\\Stages\\PrimaryStage.lua"))() -assert(loadfile(classPath .. "stageClasses\\Stages\\ExtraStage.lua"))() -assert(loadfile(classPath .. "stageClasses\\Stages\\WaitingStage.lua"))() - - -assert(loadfile(classPath .. "stageClasses\\Groups\\SpearheadGroup.lua"))() -assert(loadfile(classPath .. "stageClasses\\Groups\\SpearheadSceneryObject.lua"))() - - -assert(loadfile(classPath .. "stageClasses\\helpers\\MissionCommandsHelper.lua"))() -assert(loadfile(classPath .. "stageClasses\\helpers\\SupplyConfig.lua"))() -assert(loadfile(classPath .. "stageClasses\\helpers\\SupplyUnitsTracker.lua"))() -assert(loadfile(classPath .. "stageClasses\\helpers\\BattleManager.lua"))() - -assert(loadfile(classPath .. "stageClasses\\SpecialZones\\abstract\\BuildableZone.lua"))() -assert(loadfile(classPath .. "stageClasses\\SpecialZones\\StageBase.lua"))() -assert(loadfile(classPath .. "stageClasses\\SpecialZones\\BlueSam.lua"))() -assert(loadfile(classPath .. "stageClasses\\SpecialZones\\FarpZone.lua"))() -assert(loadfile(classPath .. "stageClasses\\SpecialZones\\SupplyHub.lua"))() - -assert(loadfile(classPath .. "capClasses\\taskings\\RTB.lua"))() -assert(loadfile(classPath .. "capClasses\\taskings\\CAP.lua"))() -assert(loadfile(classPath .. "capClasses\\taskings\\SWEEP.lua"))() -assert(loadfile(classPath .. "capClasses\\taskings\\INTERCEPT.lua"))() -assert(loadfile(classPath .. "capClasses\\airGroups\\AirGroup.lua"))() -assert(loadfile(classPath .. "capClasses\\airGroups\\CapGroup.lua"))() -assert(loadfile(classPath .. "capClasses\\airGroups\\SweepGroup.lua"))() -assert(loadfile(classPath .. "capClasses\\airGroups\\InterceptGroup.lua"))() -assert(loadfile(classPath .. "capClasses\\detection\\DetectionManager.lua"))() -assert(loadfile(classPath .. "capClasses\\GlobalCapManager.lua"))() -assert(loadfile(classPath .. "capClasses\\CapAirbase.lua"))() -assert(loadfile(classPath .. "capClasses\\runwayBombing\\RunwayBombingTracker.lua"))() - -assert(loadfile(classPath .. "persistence\\Persistence.lua"))() - --- Startup: - - - -assert(loadfile(basePath .. "main.lua"))() - diff --git a/dev/dev_config.lua b/dev/dev_config.lua deleted file mode 100644 index cc1c608..0000000 --- a/dev/dev_config.lua +++ /dev/null @@ -1,79 +0,0 @@ - -SpearheadConfig = { - - debugEnabled = true, - CapConfig = { - --quickly enable of disable the entire CAP Logic - --(you can also just rename all units to not be named "CAP_") - enabled = true, -- default true - - --min ground speed for CAP aircraft during patrol - -- unit: knots - minSpeed = 400, -- default 400 - - --max speed for CAP aircraft during patrol - -- unit: knots - maxSpeed = 500, -- default 500 - - --minAlt for aircraft on patrol - -- unit: feet - minAlt = 18000, -- default 18000 - - --maxAlt for aircraft on patrol - -- unit: feet - maxAlt = 28000, -- default 28000 - - --Delay for aircraft from touchdown to off the chocks. - -- unit: seconds - rearmDelay = 180, -- default 600 - repairDelay = 600, -- default 600 - --Delay for aircraft from death to takeoff. - --When the seconds remaining is the same at the rearmDelay it will be spawned on the ramp and follow the rearm logic. - -- !! Can not be lower than rearmDelay - -- unit: seconds - deathDelay = 1800, -- default 1800 - }, - StageConfig = { - - -- management of stages and its missions. - -- This is not related to CAP managers which will continue to work even if stage management is disabled - enabled = true, -- default true - - --Will draw the active and the next stage - drawStages = true, -- default true - drawPreActivated = true, - markLastContact = true, - - --AutoStages will continue to the next stage automatically on completion of the missions within the stage. - -- If you want to make it so the next stage triggers only when you want to disable it here and manually implement the actions needed. - --[[ - TODO: Add manual stage transition documentation - ]] - autoStages = true, --default true - - --Maximum missions per stage (includes all types of missions) - maxMissionStage = 100, - - --Stage starting number - startingStage = 1, - - ---DEBUG logging. Consider keeping this disabled - debugEnabled = true - }, - Persistence = { - --- io and lfs cannot be sanitized in the MissionScripting.lua - - --- enables or disables the persistence logic in spearhead - enabled = true, - - --- sets the directory where the persistence file is stored - --- if nil then lfs.writedir() will be used. - --- which will - directory = nil , - - --- the filename of the persistence file. Should end with .json for convention, but any text extension should do. - fileName = "Spearhead_Persistence_Dev" - - } -} - diff --git a/src/classes/_baseClasses/Queue.lua b/src/classes/_baseClasses/Queue.lua deleted file mode 100644 index 44b0a92..0000000 --- a/src/classes/_baseClasses/Queue.lua +++ /dev/null @@ -1,47 +0,0 @@ - ----@class Queue ----@field private _items Array ----@field private _first number ----@field private _last number -local Queue = {} -Queue.__index = Queue - ----@return Queue -function Queue.new() - - local self = setmetatable({}, Queue) - self._items = {} - self._first = 1 - self._last = 0 - return self -end - ----@return nil -function Queue:push(item) - self._last = self._last + 1 - self._items[self._last] = item -end - ----@return any? -function Queue:pop() - if self._first > self._last then - return nil - end - - local item = self._items[self._first] - self._items[self._first] = nil - self._first = self._first + 1 - return item -end - - ----@return Array -function Queue:toList() - local items = {} - for i = self._first, self._last do - items[#items + 1] = self._items[i] - end - return items -end - -return Queue \ No newline at end of file diff --git a/src/classes/capClasses/CapAirbase.lua b/src/classes/capClasses/CapAirbase.lua index 80390a3..1a5c2d4 100644 --- a/src/classes/capClasses/CapAirbase.lua +++ b/src/classes/capClasses/CapAirbase.lua @@ -2,7 +2,6 @@ local Util = require("classes.util.Util") local CapGroup = require("classes.capClasses.airGroups.CapGroup") local SweepGroup = require("classes.capClasses.airGroups.SweepGroup") local InterceptGroup = require("classes.capClasses.airGroups.InterceptGroup") -local RunwayBombingTracker = require("classes.capClasses.runwayBombing.RunwayBombingTracker") local SpearheadEvents = require("classes.spearhead_events") local RunwayStrikeMission = require("classes.stageClasses.missions.RunwayStrikeMission") @@ -37,12 +36,11 @@ end ---@param database Database ---@param logger table ---@param capConfig table ----@param stageConfig table ---@param runwayBombingTracker RunwayBombingTracker ---@param detectionManager DetectionManager ---@param spawnManager SpawnManager ---@return CapBase -function CapBase.new(airbaseName, database, logger, capConfig, stageConfig, runwayBombingTracker, detectionManager, spawnManager) +function CapBase.new(airbaseName, database, logger, capConfig, runwayBombingTracker, detectionManager, spawnManager) CapBase.__index = CapBase local self = setmetatable({}, { __index = CapBase }) --[[@as CapBase]] @@ -61,7 +59,7 @@ function CapBase.new(airbaseName, database, logger, capConfig, stageConfig, runw local baseData = database:getAirbaseDataForZone(airbaseName) if baseData and baseData.CapGroups then - for key, name in pairs(baseData.CapGroups) do + for _, name in pairs(baseData.CapGroups) do local capGroup = CapGroup.New(name, capConfig, logger, spawnManager) if capGroup then self.capGroupsByName[name] = capGroup @@ -70,7 +68,7 @@ function CapBase.new(airbaseName, database, logger, capConfig, stageConfig, runw end if baseData and baseData.SweepGroups then - for key, name in pairs(baseData.SweepGroups) do + for _, name in pairs(baseData.SweepGroups) do local sweepGroup = SweepGroup.New(name, capConfig, logger, spawnManager) if sweepGroup then self.sweepGroupsByName[name] = sweepGroup @@ -79,7 +77,7 @@ function CapBase.new(airbaseName, database, logger, capConfig, stageConfig, runw end if baseData and baseData.InterceptGroups then - for key, name in pairs(baseData.InterceptGroups) do + for _, name in pairs(baseData.InterceptGroups) do local interceptGroup = InterceptGroup.New(name, capConfig, logger, detectionManager, spawnManager) if interceptGroup then self.interceptGroupsByName[name] = interceptGroup @@ -97,7 +95,6 @@ function CapBase.new(airbaseName, database, logger, capConfig, stageConfig, runw SpearheadEvents.AddStageNumberChangedListener(self) timer.scheduleFunction(CheckStateContinuous, self, timer.getTime() + 15) - return self end @@ -127,7 +124,7 @@ end function CapBase:SpawnIfApplicable() self.logger:debug("Check spawns for airbase " .. self.airbaseName) - for groupName, capGroup in pairs(self.capGroupsByName) do + for _, capGroup in pairs(self.capGroupsByName) do local targetStage = capGroup:GetZoneIDWhenStageID(tostring(self.activeStage)) if targetStage ~= nil and capGroup:GetState() == "UnSpawned" then @@ -135,7 +132,7 @@ function CapBase:SpawnIfApplicable() end end - for groupName, sweepGroup in pairs(self.sweepGroupsByName) do + for _, sweepGroup in pairs(self.sweepGroupsByName) do local targetStage = sweepGroup:GetZoneIDWhenStageID(tostring(self.activeStage)) if targetStage ~= nil and sweepGroup:GetState() == "UnSpawned" then @@ -143,7 +140,7 @@ function CapBase:SpawnIfApplicable() end end - for groupName, interceptGroup in pairs(self.interceptGroupsByName) do + for _, interceptGroup in pairs(self.interceptGroupsByName) do local targetStage = interceptGroup:GetZoneIDWhenStageID(tostring(self.activeStage)) if targetStage ~= nil and interceptGroup:GetState() == "UnSpawned" then @@ -154,8 +151,9 @@ end function CapBase:CheckAndScheduleCAP() self.logger:debug("Check taskings for airbase " .. self.airbaseName) - + ---@type table local countPerStage = {} + ---@type table local requiredPerStage = {} local airbase = Airbase.getByName(self.airbaseName) @@ -170,7 +168,7 @@ function CapBase:CheckAndScheduleCAP() if group:IsBackup() == true then local state = group:GetState() if state == "InTransit" or state == "OnStation" or state == "RtbInTen" then - + local supposedTargetZoneID = group:GetZoneIDWhenStageID(activeStageID) local currentTargetZone = group:GetCurrentTargetZoneID() @@ -192,7 +190,7 @@ function CapBase:CheckAndScheduleCAP() end end end - + if countPerStage[supposedTargetZoneID] == nil then countPerStage[supposedTargetZoneID] = 0 end @@ -231,7 +229,7 @@ function CapBase:CheckAndScheduleCAP() countPerStage[supposedZone] = countPerStage[supposedZone] + 1 end elseif state == "InTransit" or state == "OnStation" then - + if supposedZone ~= group:GetCurrentTargetZoneID() then if countPerStage[supposedZone] < requiredPerStage[supposedZone] then local triggerZone = self.database:GetCapZoneForZoneID(supposedZone) @@ -273,7 +271,7 @@ function CapBase:CheckAndScheduleCAP() if triggerZone then group:SendToZone(triggerZone, supposedZone, airbase) end - + countPerStage[supposedZone] = countPerStage[supposedZone] + 1 end end @@ -312,8 +310,7 @@ function CapBase:CheckAndScheduleIntercept() self.logger:debug("Check intercept taskings for airbase " .. self.airbaseName) - local interceptZoneIDs = {} - + ---@type table local interceptZoneIDs = {} local airbase = Airbase.getByName(self.airbaseName) @@ -321,7 +318,7 @@ function CapBase:CheckAndScheduleIntercept() return nil end - for name, group in pairs(self.interceptGroupsByName) do + for _, group in pairs(self.interceptGroupsByName) do local targetZoneID = group:GetZoneIDWhenStageID(tostring(self.activeStage)) if targetZoneID then interceptZoneIDs[targetZoneID] = true @@ -357,7 +354,7 @@ function CapBase:CheckAndScheduleIntercept() end end end - + ---RATIO. Amount of enemy fighters required per zone before another group gets added. local ratio = 4 -- Ratio of units to intercept per zone, can be adjusted @@ -379,7 +376,6 @@ function CapBase:CheckAndScheduleIntercept() if total < required then for _, group in pairs(self.interceptGroupsByName) do if total < required then - local zoneID = group:GetZoneIDWhenStageID(tostring(self.activeStage)) if group:GetState() == "ReadyOnTheRamp" then group:SendToInterceptUnits(targets, name, airbase) total = total + 1 diff --git a/src/classes/capClasses/GlobalCapManager.lua b/src/classes/capClasses/GlobalCapManager.lua index 88f3edc..e5ed0f0 100644 --- a/src/classes/capClasses/GlobalCapManager.lua +++ b/src/classes/capClasses/GlobalCapManager.lua @@ -6,21 +6,19 @@ local CapAirbase = require("classes.capClasses.CapAirbase") ---@class GlobalCapManager local GlobalCapManager = {} do + ---@type table local airbasesPerStage = {} + ---@type table local allAirbasesByName = {} - local activeAirbasesPerActiveStage = {} - local unitsPerzonePerStage = {} - local initiated = false ---comment ---@param database Database ---@param capConfig table - ---@param stageConfig StageConfig ---@param detectionManager DetectionManager ---@param logLevel LogLevel ---@param spawnManager SpawnManager - function GlobalCapManager.start(database, capConfig, detectionManager, stageConfig, logLevel, spawnManager) + function GlobalCapManager.start(database, capConfig, detectionManager, logLevel, spawnManager) if initiated == true then return end local logger = Logger.new("AirbaseManager", logLevel) @@ -29,7 +27,7 @@ do local zones = database:getStagezoneNames() if zones then - for key, stageName in pairs(zones) do + for _, stageName in pairs(zones) do if airbasesPerStage[stageName] == nil then airbasesPerStage[stageName] = {} end @@ -39,9 +37,8 @@ do for _, airbaseName in pairs(airbaseNames) do if airbaseName then local airbaseSpecificLogger = Logger.new("CAP_" .. airbaseName, logLevel) - - local airbase = CapAirbase.new(airbaseName, database, airbaseSpecificLogger, capConfig, stageConfig, runwayBombingTracker, detectionManager, spawnManager) - + + local airbase = CapAirbase.new(airbaseName, database, airbaseSpecificLogger, capConfig, runwayBombingTracker, detectionManager, spawnManager) if airbase then table.insert(airbasesPerStage[stageName], airbase) allAirbasesByName[airbaseName] = airbase diff --git a/src/classes/capClasses/airGroups/AirGroup.lua b/src/classes/capClasses/airGroups/AirGroup.lua index 2e3456a..c0c272c 100644 --- a/src/classes/capClasses/airGroups/AirGroup.lua +++ b/src/classes/capClasses/airGroups/AirGroup.lua @@ -1,12 +1,11 @@ local SpearheadEvents = require("classes.spearhead_events") local RTBMission = require("classes.capClasses.taskings.RTB") local Util = require("classes.util.Util") -local DcsUtil = require("classes.util.DcsUtil") local GlobalConfig = require("classes.configuration.GlobalConfig") local CustomDrawing = require("classes.stageClasses.drawings.CustomDrawing") local DrawingHelper = require("classes.stageClasses.drawings.helper.DrawingHelper") ----@class AirGroup : OnUnitLostListener +---@class AirGroup : OnUnitLostListener, OnGroupRTBListener, OnGroupRTBInTenListener, OnLandEventListener, OnGroupOnStationListener ---@field protected _logger Logger ---@field protected _groupName string ---@field protected _groupType AirGroupType @@ -81,7 +80,7 @@ function AirGroup:SetMission(mission) end end - local setMissionDelayed = function(data, time) + local setMissionDelayed = function(data, _) data.self:SetMissionPrivate(data.mission) end @@ -108,8 +107,9 @@ function AirGroup:SetMissionPrivate(mission) local points = {} if mission and mission.params and mission.params.route and mission.params.route.points then - for _, wp in pairs(mission.params.route.points) do - if wp.x and wp.y then + local routePoints = mission.params.route.points --[[@as Array ]] + for _, wp in pairs(routePoints) do + if wp and wp.x and wp.y then table.insert(points, { x = wp.x, y = wp.y }) end end @@ -199,6 +199,8 @@ function AirGroup:SpawnInternal(force, withoutLoadout) end ---@param selfA AirGroup + ---@param time number + ---@return number? local function CheckLivenessTask(selfA, time) local interval = selfA:CheckLiveness() if not interval then return end @@ -264,6 +266,7 @@ function AirGroup:OnLastUnitLanded() ---@param data CheckGroupForRestartData ---@param time number + ---@return number? local checkGroupForRestart = function(data, time) local group = Group.getByName(data.self:GetName()) if not group then @@ -357,7 +360,7 @@ do --- RESPAWN FUNCTIONS self:SetState("Dead") ---@param selfA AirGroup - local respawnTask = function(selfA, time) + local respawnTask = function(selfA, _) selfA:StartRepair() end @@ -376,8 +379,7 @@ do --- RESPAWN FUNCTIONS end ---comment - ---@param selfA AirGroup - local rearmTask = function(selfA, time) + local rearmTask = function(_, _) self:StartRearm() end @@ -402,7 +404,7 @@ do --- RESPAWN FUNCTIONS end ---@param selfA AirGroup - local rearmTask = function(selfA, time) + local rearmTask = function(selfA, _) selfA:MarkRearmComplete() end @@ -415,6 +417,7 @@ end do --EVENT LISTENERS ---@param unit Unit function AirGroup:OnUnitLost(unit) + if unit == nil then return end self:CheckLiveness() end @@ -434,7 +437,7 @@ do --EVENT LISTENERS end end - function AirGroup:OnUnitLanded(unit, airbase) + function AirGroup:OnUnitLanded(_, _) local anyInAir = false local group = Group.getByName(self._groupName) if group then diff --git a/src/classes/capClasses/airGroups/CapGroup.lua b/src/classes/capClasses/airGroups/CapGroup.lua index 40319bb..edefc93 100644 --- a/src/classes/capClasses/airGroups/CapGroup.lua +++ b/src/classes/capClasses/airGroups/CapGroup.lua @@ -34,9 +34,10 @@ function CapGroup:IsBackup() return self._isBackup end +---@param stageID string ---@return string? function CapGroup:GetZoneIDWhenStageID(stageID) - return self._targetZoneIdPerStage[stageID] + return self._targetZoneIdPerStage[tostring(stageID)] end ---@return string? @@ -103,17 +104,17 @@ function CapGroup:InitWithName(groupName) return end - + local subsplit = Util.split_string(configPart, "|") if subsplit then - for key, value in pairs(subsplit) do + for _, value in pairs(subsplit) do local keySplit = Util.split_string(value, "]") local targetZone = keySplit[2] local allActives = string.sub(keySplit[1], 2, #keySplit[1]) local commaSeperated = Util.split_string(allActives, ",") - for _, value in pairs(commaSeperated) do - local dashSeperated = Util.split_string(value, "-") + for _, childValue in pairs(commaSeperated) do + local dashSeperated = Util.split_string(childValue, "-") if Util.tableLength(dashSeperated) > 1 then local from = tonumber(dashSeperated[1]) local till = tonumber(dashSeperated[2]) diff --git a/src/classes/capClasses/airGroups/InterceptGroup.lua b/src/classes/capClasses/airGroups/InterceptGroup.lua index bfe98fa..aceff83 100644 --- a/src/classes/capClasses/airGroups/InterceptGroup.lua +++ b/src/classes/capClasses/airGroups/InterceptGroup.lua @@ -60,6 +60,7 @@ end ---comment ---@param units Array +---@param zoneName string ---@param homeAirbase Airbase function InterceptGroup:SendToInterceptUnits(units, zoneName, homeAirbase) @@ -68,9 +69,10 @@ function InterceptGroup:SendToInterceptUnits(units, zoneName, homeAirbase) self:SetTargetUnits(units) end +---@param stageID string ---@return string? function InterceptGroup:GetZoneIDWhenStageID(stageID) - return self._targetZoneIdPerStage[stageID] + return self._targetZoneIdPerStage[tostring(stageID)] end ---@return string? @@ -91,6 +93,9 @@ function InterceptGroup:SetTargetUnits(unitNames) end) end + ---@param selfA InterceptGroup + ---@param time number + ---@return number? local updateContinous = function(selfA, time) local next = selfA:UpdateTask() if next then @@ -102,6 +107,7 @@ function InterceptGroup:SetTargetUnits(unitNames) self._updateTaskID = timer.scheduleFunction(updateContinous, self, timer.getTime() + 30) end +---@param unit Unit function InterceptGroup:RemoveTargetUnit(unit) if not unit then return end @@ -190,7 +196,7 @@ function InterceptGroup:UpdateTask() self:SendRTB(self._airbase) return nil -- Return to base if bingo fuel end - + if selfDetected and self:IsInAir() == true then if self._currentTargetName and self._currentTargetName == closestUnit:getName() then local distance = Util.VectorDistance3d(closestUnit:getPoint(), groupPoint) @@ -213,8 +219,6 @@ function InterceptGroup:UpdateTask() self._currentTargetName = nil end - - local speed = self._config:getMaxSpeed() local interceptPoint = self:GetInterceptPoint(groupPoint, speed, closestUnit) @@ -222,7 +226,8 @@ function InterceptGroup:UpdateTask() return 30 -- Return to base if no intercept point could be calculated end - local mission = nil + ---@type table + local mission if self:IsInAir() == true then -- If the group is in the air, create an intercept mission mission = INTERCEPT.getMissionFromInAir( @@ -323,13 +328,13 @@ function InterceptGroup:InitWithName(groupName) configPart = string.sub(configPart, 2, #configPart) local subsplit = Util.split_string(configPart, "|") if subsplit then - for key, value in pairs(subsplit) do + for _, value in pairs(subsplit) do local keySplit = Util.split_string(value, "]") local targetZone = keySplit[2] local allActives = string.sub(keySplit[1], 2, #keySplit[1]) local commaSeperated = Util.split_string(allActives, ",") - for _, value in pairs(commaSeperated) do - local dashSeperated = Util.split_string(value, "-") + for _, childValue in pairs(commaSeperated) do + local dashSeperated = Util.split_string(childValue, "-") if Util.tableLength(dashSeperated) > 1 then local from = tonumber(dashSeperated[1]) local till = tonumber(dashSeperated[2]) diff --git a/src/classes/capClasses/airGroups/SweepGroup.lua b/src/classes/capClasses/airGroups/SweepGroup.lua index 4ad1812..bfc1d0b 100644 --- a/src/classes/capClasses/airGroups/SweepGroup.lua +++ b/src/classes/capClasses/airGroups/SweepGroup.lua @@ -4,7 +4,7 @@ local Util = require("classes.util.Util") local MissionEditorWarner = require("classes.util.MissionEditorWarnings") ---@class SweepGroup : AirGroup ----@field _targetZoneIdPerStage table +---@field _targetZoneIdPerStage table ---@field _currentTargetZoneID string? local SweepGroup = {} SweepGroup.__index = SweepGroup @@ -26,9 +26,10 @@ function SweepGroup.New(groupName, config, logger, spawnManager) return self end +---@param stageID string ---@return string? function SweepGroup:GetZoneIDWhenStageID(stageID) - return self._targetZoneIdPerStage[stageID] + return self._targetZoneIdPerStage[tostring(stageID)] end ---@return string? @@ -41,7 +42,7 @@ end ---@field self SweepGroup ---@param params SetTaskParams -local setMissionDelayedTask = function(params, time) +local setMissionDelayedTask = function(params, _) params.self:SetMissionPrivate(params.task) end @@ -50,8 +51,6 @@ function SweepGroup:SendToZone(zone, targetZoneID, airbase) self._currentTargetZoneID = targetZoneID - local group = Group.getByName(self._groupName) - local mission = SWEEP.getAsMissionFromAirbase(self._groupName, airbase, zone, self._config) if mission then ---@type SetTaskParams @@ -79,16 +78,16 @@ function SweepGroup:InitWithName(groupName) local configPart = split_string[2] configPart = string.sub(configPart, 2, #configPart) - + local subsplit = Util.split_string(configPart, "|") if subsplit then - for key, value in pairs(subsplit) do + for _, value in pairs(subsplit) do local keySplit = Util.split_string(value, "]") local targetZone = keySplit[2] local allActives = string.sub(keySplit[1], 2, #keySplit[1]) local commaSeperated = Util.split_string(allActives, ",") - for _, value in pairs(commaSeperated) do - local dashSeperated = Util.split_string(value, "-") + for _, childValue in pairs(commaSeperated) do + local dashSeperated = Util.split_string(childValue, "-") if Util.tableLength(dashSeperated) > 1 then local from = tonumber(dashSeperated[1]) local till = tonumber(dashSeperated[2]) diff --git a/src/classes/capClasses/detection/DetectionManager.lua b/src/classes/capClasses/detection/DetectionManager.lua index 50b16b4..b9873e9 100644 --- a/src/classes/capClasses/detection/DetectionManager.lua +++ b/src/classes/capClasses/detection/DetectionManager.lua @@ -8,6 +8,7 @@ DetectionManager.__index = DetectionManager ---@param logger Logger +---@return DetectionManager function DetectionManager.New(logger) local self = setmetatable({}, DetectionManager) @@ -24,6 +25,7 @@ function DetectionManager.New(logger) ---@param selfA DetectionManager ---@param time number + ---@return number? local updateDetectingUnitsTask = function(selfA, time) selfA:UpdateDetectingUnits() return time + 120 @@ -32,18 +34,19 @@ function DetectionManager.New(logger) ---@param selfA DetectionManager ---@param time number + ---@return number? local updateDetected = function(selfA, time) selfA:UpdateDetectedUnits() return time + 10 end timer.scheduleFunction(updateDetected, self, timer.getTime() + 130) - return self end ---@param unitName string ---@param coalitionSide CoalitionSide +---@return boolean function DetectionManager:IsUnitDetectedBy(unitName, coalitionSide) local coalitionString = tostring(coalitionSide) if not self._detectedUnits[coalitionString] then @@ -57,7 +60,8 @@ function DetectionManager:IsUnitDetectedBy(unitName, coalitionSide) return timer.getTime() - self._detectedUnits[coalitionString][unitName] < 20 end ----@return Array +---@param coalitionSide CoalitionSide +---@return Array detectedUnits function DetectionManager:GetDetectedUnitsBy(coalitionSide) local coalitionString = tostring(coalitionSide) if not self._detectedUnits[coalitionString] then diff --git a/src/classes/capClasses/runwayBombing/RunwayBombingTracker.lua b/src/classes/capClasses/runwayBombing/RunwayBombingTracker.lua index a8366ae..185f8d2 100644 --- a/src/classes/capClasses/runwayBombing/RunwayBombingTracker.lua +++ b/src/classes/capClasses/runwayBombing/RunwayBombingTracker.lua @@ -21,7 +21,7 @@ end ---comment ---@param weapon Weapon -function RunwayBombingTracker:OnWeaponFired(unit, weapon, target) +function RunwayBombingTracker:OnWeaponFired(_, weapon, _) if weapon == nil then return @@ -30,7 +30,7 @@ function RunwayBombingTracker:OnWeaponFired(unit, weapon, target) local desc = weapon:getDesc() local isTrackable = desc.category == Weapon.Category.BOMB or (desc.category == Weapon.Category.MISSILE and desc.missileCategory == Weapon.MissileCategory.CRUISE) if isTrackable == true then - + ---@type WeaponTrackingArgs local weaponTrackingArgs = { weapon = weapon, @@ -56,12 +56,14 @@ end ---@field self RunwayBombingTracker ---@private +---@param time number ---@param weaponTrackingArgs WeaponTrackingArgs +---@return number? function RunwayBombingTracker.trackWeaponTask(weaponTrackingArgs, time) local weapon = weaponTrackingArgs.weapon local self = weaponTrackingArgs.self - + if not weapon or weapon:isExist() == false then return nil end local pos = weapon:getPoint() @@ -83,11 +85,7 @@ function RunwayBombingTracker.trackWeaponTask(weaponTrackingArgs, time) x = pos.x + velocity.x * nextInterval, y = pos.z + velocity.z * nextInterval } - - self:OnWeaponImpact(weapon:getDesc(), impactPoint) - - return nil end @@ -106,11 +104,10 @@ function RunwayBombingTracker:OnWeaponImpact(weaponDesc, impactPoint) self._logger:debug("RunwayBombingTracker:OnWeaponImpact") - local warhead = weaponDesc.warhead - local explosiveMass = warhead.explosiveMass or warhead.shapedExplosiveMass - - for runway, strikeMission in pairs(self.trackedRunways) do + local warhead = weaponDesc.warhead --[[@as table]] + local explosiveMass = (warhead.explosiveMass or warhead.shapedExplosiveMass) --[[@as number]] + for _, strikeMission in pairs(self.trackedRunways) do local zone= strikeMission:GetRunwayZone() if Util.is3dPointInZone({ x = impactPoint.x, z = impactPoint.y, y = 0 }, zone) then diff --git a/src/classes/capClasses/taskings/CAP.lua b/src/classes/capClasses/taskings/CAP.lua index cb53bd2..174b8d3 100644 --- a/src/classes/capClasses/taskings/CAP.lua +++ b/src/classes/capClasses/taskings/CAP.lua @@ -7,6 +7,7 @@ local CAP = {} ---@param attackHelos boolean ---@return table local function GetCAPTargetTypes(attackHelos) + ---@type Array local targetTypes = { [1] = "Planes", } @@ -33,9 +34,6 @@ local function GetCAPPointFromTriggerZone(airBase, capZone) local furthestA = nil local furthestB = nil - local furthestFromBase = nil - local furthestFromBaseDistance = 0 - local furthestDistance = 0 for indexA, pointA in ipairs(capZone.verts) do @@ -56,7 +54,10 @@ local function GetCAPPointFromTriggerZone(airBase, capZone) ---@type Vec2 local baseVec2 = { x = baseVec3.x, y = baseVec3.z } + ---@type Vec2 local pointA = capZone.verts[furthestA] + + ---@type Vec2 local pointB = capZone.verts[furthestB] local furthest = pointA local closest = pointB @@ -87,6 +88,7 @@ end ---@param airbase Airbase ---@param capZone SpearheadTriggerZone ---@param capConfig CapConfig +---@return table local GetOutboundTask = function(airbase, capZone, capConfig) local airbaseVec3 = airbase:getPoint() local airbaseVec2 = { x = airbaseVec3.x, y = airbaseVec3.z } @@ -128,6 +130,7 @@ end ---@param airbase Airbase ---@param capZone SpearheadTriggerZone ---@param capConfig CapConfig +---@return table function CAP.getAsMissionFromAirbase(groupName, airbase, capZone, capConfig) local points = { [1] = GetOutboundTask(airbase, capZone, capConfig), @@ -155,6 +158,7 @@ end ---@param airbase Airbase ---@param capZone SpearheadTriggerZone ---@param capConfig CapConfig +---@return table function CAP.getAsMission(groupName, airbase, capZone, capConfig) local points = { [1] = CAP.getAsTasking(groupName, airbase, capZone, capConfig), @@ -181,6 +185,7 @@ end ---@param airbase Airbase ---@param capZone SpearheadTriggerZone ---@param capConfig CapConfig +---@return table function CAP.getAsTasking(groupName, airbase, capZone, capConfig) local duration = math.random(capConfig:getMinDurationOnStation(), capConfig:getMaxDurationOnStation()) or 1500 diff --git a/src/classes/capClasses/taskings/INTERCEPT.lua b/src/classes/capClasses/taskings/INTERCEPT.lua index e6cdc8d..d801f38 100644 --- a/src/classes/capClasses/taskings/INTERCEPT.lua +++ b/src/classes/capClasses/taskings/INTERCEPT.lua @@ -11,6 +11,7 @@ local INTERCEPT = {} ---@param speed number? ---@param alt number? ---@param config CapConfig +---@return table function INTERCEPT.getMissionFromAirbase(groupName, interceptPoint, airbase, config, speed, alt) local airbaseVec3 = airbase:getPoint() @@ -38,7 +39,7 @@ function INTERCEPT.getMissionFromAirbase(groupName, interceptPoint, airbase, con id = 'Mission', params = { airborne = true, - route = { + route = { points = points } } @@ -92,7 +93,7 @@ end ---@param currentPoint Vec2 ---@param targetPosition Vec2 ---@param targetUnit Unit ----@param airbase any +---@param airbase Airbase ---@param config any ---@param speed number? ---@param alt number? @@ -159,10 +160,10 @@ function INTERCEPT.getInterceptTaskPoint(groupName, currentPoint, targetPoint, a params = { tasks = { id = 'EngageTargetsInZone', - params = { + params = { point = targetPoint, zoneRadius = 10 * 1852, -- 10 NM, point will be updated, so target should be in this zone. - targetTypes = { + targetTypes = { [1] = "Planes", }, priority = 0 @@ -188,10 +189,10 @@ function INTERCEPT.getInterceptTaskPoint(groupName, currentPoint, targetPoint, a params = { tasks = { id = 'EngageTargetsInZone', - params = { + params = { point = targetPoint, zoneRadius = 10 * 1852, -- 10 NM, point will be updated, so target should be in this zone. - targetTypes = { + targetTypes = { [1] = "Planes", }, priority = 0 diff --git a/src/classes/capClasses/taskings/RTB.lua b/src/classes/capClasses/taskings/RTB.lua index 7ebfa5a..dda92b7 100644 --- a/src/classes/capClasses/taskings/RTB.lua +++ b/src/classes/capClasses/taskings/RTB.lua @@ -7,6 +7,7 @@ local RTB = {} ---@param airbase Airbase ---@param missionPoint Vec2 ---@param capConfig CapConfig +---@return table function RTB.getAsMission(airbase, missionPoint, capConfig) return { id = "Mission", @@ -47,7 +48,7 @@ local getRunwayIntoWindCourseRad = function(airbase) else rad = 0 - rad end - + local runwayVec = {x = math.cos(rad), z = math.sin(rad), y = 0} local alignment = Util.vectorAlignment(windVec, runwayVec) @@ -60,14 +61,14 @@ local getRunwayIntoWindCourseRad = function(airbase) do --inverse local degree = math.deg(runway.course) degree = (degree + 180) % 360 - + local rad = math.rad(degree) if rad < 0 then rad = math.abs(rad) else rad = 0 - rad end - + local runwayVec = {x = math.cos(rad), z = math.sin(rad), y = 0} local alignment = Util.vectorAlignment(windVec, runwayVec) @@ -113,6 +114,7 @@ end ---comment ---@param airbase Airbase ---@param missionPoint Vec2 +---@return table ---@param capConfig CapConfig function RTB.getApproachPoint(airbase, missionPoint, capConfig) @@ -147,6 +149,7 @@ function RTB.getApproachPoint(airbase, missionPoint, capConfig) end ---@param airbase Airbase +---@return table function RTB.getInitialPoint(airbase) local point = calcInitialPoint(airbase) return { @@ -170,6 +173,8 @@ function RTB.getInitialPoint(airbase) } end +---@param airbase Airbase +---@return table function RTB.getLandingPoint(airbase) local basePoint = airbase:getPoint() return { diff --git a/src/classes/capClasses/taskings/SWEEP.lua b/src/classes/capClasses/taskings/SWEEP.lua index 61e12aa..a77425a 100644 --- a/src/classes/capClasses/taskings/SWEEP.lua +++ b/src/classes/capClasses/taskings/SWEEP.lua @@ -7,6 +7,7 @@ local SWEEP = {} ---@param attackHelos boolean ---@return table local function GetCAPTargetTypes(attackHelos) + ---@type Array local targetTypes = { [1] = "Planes", } @@ -49,7 +50,9 @@ local function GetCAPPointFromTriggerZone(airBase, capZone) ---@type Vec2 local baseVec2 = { x = baseVec3.x, y = baseVec3.z } + ---@type Vec2 local pointA = capZone.verts[furthestA] + ---@type Vec2 local pointB = capZone.verts[furthestB] local furthest = pointA local closest = pointB @@ -80,6 +83,7 @@ end ---@param airbase Airbase ---@param capZone SpearheadTriggerZone ---@param capConfig CapConfig +---@return table local GetOutboundTask = function(airbase, capZone, capConfig) local airbaseVec3 = airbase:getPoint() local airbaseVec2 = { x = airbaseVec3.x, y = airbaseVec3.z } @@ -121,6 +125,7 @@ end ---@param airbase Airbase ---@param capZone SpearheadTriggerZone ---@param capConfig CapConfig +---@return table function SWEEP.getAsMissionFromAirbase(groupName, airbase, capZone, capConfig) local pointA, pointB, pointC = SWEEP.getAsTasking(groupName, airbase, capZone, capConfig) diff --git a/src/classes/configuration/CapConfig.lua b/src/classes/configuration/CapConfig.lua index cd81a3f..3984c0a 100644 --- a/src/classes/configuration/CapConfig.lua +++ b/src/classes/configuration/CapConfig.lua @@ -21,6 +21,10 @@ function CapConfig.new() if SpearheadConfig == nil then SpearheadConfig = {} end if SpearheadConfig.CapConfig == nil then SpearheadConfig.CapConfig = {} end + if type(SpearheadConfig.CapConfig.enabled) ~= "boolean" then + SpearheadConfig.CapConfig.enabled = true + end + local enabled = SpearheadConfig.CapConfig.enabled if enabled == nil then enabled = true end self._isEnabled = enabled diff --git a/src/classes/configuration/GlobalConfig.lua b/src/classes/configuration/GlobalConfig.lua index d4c19d8..370baea 100644 --- a/src/classes/configuration/GlobalConfig.lua +++ b/src/classes/configuration/GlobalConfig.lua @@ -1,8 +1,4 @@ - - -local briefingMessageTime = nil - ---@class GlobalConfig ---@field private _briefingTime number ---@field private _debugEnabled boolean diff --git a/src/classes/configuration/StageConfig.lua b/src/classes/configuration/StageConfig.lua index 94590db..54eb580 100644 --- a/src/classes/configuration/StageConfig.lua +++ b/src/classes/configuration/StageConfig.lua @@ -18,7 +18,7 @@ local _logger = Logger.new("StageConfig", Logger.LogLevel) ---@return StageConfig local function new() - if SpearheadConfig == nil then + if SpearheadConfig == nil then _logger:warn("SpearheadConfig is nil, creating default SpearheadConfig") SpearheadConfig = {} end diff --git a/src/classes/debug/DebugMenu.lua b/src/classes/debug/DebugMenu.lua index 564679d..b6002ad 100644 --- a/src/classes/debug/DebugMenu.lua +++ b/src/classes/debug/DebugMenu.lua @@ -1,5 +1,4 @@ local Logger = require("classes.util.Logger") -local Util = require("classes.util.Util") local StageRepository = require("classes.stageClasses.StageRepository") ---@class DebugMenu @@ -22,7 +21,7 @@ function DebugMenu:RegisterMenus() missionCommands.addSubMenu(menuName, {}) local refresh = function(params) - local selfA = params.self + local selfA = params.self --[[@as DebugMenu]] selfA:RefreshMenu() end missionCommands.addCommand("Refresh Menu", debugMenuPath, refresh, { self = self }) diff --git a/src/classes/definitions/aliases.lua b/src/classes/definitions/aliases.lua deleted file mode 100644 index 1971941..0000000 --- a/src/classes/definitions/aliases.lua +++ /dev/null @@ -1,19 +0,0 @@ - - - -do -- mission aliases - - --- @alias LogLevel - --- | "DEBUG" - --- | "INFO" - --- | "WARN" - --- | "ERROR" - --- | "NONE" - - ---@class Array: { [integer]: T } - -end - ----@class KeyValuePair ----@field key string ----@field value any diff --git a/src/classes/fleetClasses/FleetGroup.lua b/src/classes/fleetClasses/FleetGroup.lua index 48d7671..28f124d 100644 --- a/src/classes/fleetClasses/FleetGroup.lua +++ b/src/classes/fleetClasses/FleetGroup.lua @@ -4,37 +4,43 @@ local MissionEditorWarning = require("classes.util.MissionEditorWarnings") local RouteUtil = require("classes.spearhead_routeutil") local SpearheadEvents = require("classes.spearhead_events") ----@class FleetGroup +---@class FleetGroup : OnStageChangedListener +---@field private fleetGroupName string +---@field private logger Logger +---@field private fleetNameIdentifier string +---@field private targetZonePerStage table +---@field private currentTargetZone string +---@field private pointsPerZone table local FleetGroup = {} +FleetGroup.__index = FleetGroup ---comment ---@param fleetGroupName string ---@param database Database ---@param logger Logger ----@return nil -function FleetGroup:new(fleetGroupName, database, logger) - local o = {} +---@return FleetGroup? +function FleetGroup.new(fleetGroupName, database, logger) - setmetatable(o, { __index = self }) + local self = setmetatable({}, FleetGroup) - o.fleetGroupName = fleetGroupName - o.logger = logger + self.fleetGroupName = fleetGroupName + self.logger = logger local split_name = Util.split_string(fleetGroupName, "_") if Util.tableLength(split_name) < 2 then MissionEditorWarning.Add("CARRIERGROUP should have at least 2 parts. CARRIERGROUP_") return nil end - o.fleetNameIdentifier = split_name[2] + self.fleetNameIdentifier = split_name[2] - o.targetZonePerStage = {} - o.currentTargetZone = nil - o.pointsPerZone = {} + self.targetZonePerStage = {} + self.currentTargetZone = nil + self.pointsPerZone = {} do --INIT local carrierRouteZones = database:getCarrierRouteZones() for _, zoneName in pairs(carrierRouteZones) do - if Util.strContains(string.lower(zoneName), "_".. string.lower(o.fleetNameIdentifier) .. "_" ) == true then + if Util.strContains(string.lower(zoneName), "_".. string.lower(self.fleetNameIdentifier) .. "_" ) == true then local zone = DcsUtil.getZoneByName(zoneName) if zone and zone.zone_type == DcsUtil.ZoneType.Polygon then local split_string = Util.split_string(zoneName, "_") @@ -43,18 +49,18 @@ function FleetGroup:new(fleetGroupName, database, logger) "CARRIERROUTE should at least have 3 parts. Check the documentation for: " .. zoneName) else - ---@param zone SpearheadTriggerZone + ---@param zoneA SpearheadTriggerZone ---@return Vec2, Vec2 - local function GetTwoFurthestPoints(zone) + local function GetTwoFurthestPoints(zoneA) local biggest = nil - local biggestA = zone.verts[1] - local biggestB = zone.verts[2] + local biggestA = zoneA.verts[1] + local biggestB = zoneA.verts[2] for i = 1, 3 do for ii = i + 1, 4 do - local a = zone.verts[i] - local b = zone.verts[ii] + local a = zoneA.verts[i] + local b = zoneA.verts[ii] local dist = Util.VectorDistance2d(a, b) if biggest == nil or dist > biggest then @@ -100,9 +106,15 @@ function FleetGroup:new(fleetGroupName, database, logger) local first, second = getMinMaxStage(split_string[3]) if first ~= nil and second ~= nil then for i = first, second do - o.targetZonePerStage[tostring(i)] = zoneName + self.targetZonePerStage[tostring(i)] = zoneName end - o.pointsPerZone[zoneName] = { pointA = { x = pointA.x, z = pointA.y, y = 0 }, pointB = { x = pointB.x, z = pointB.y, y = 0} } + ---@type {pointA: Vec3, pointB: Vec3} + local entry = { + pointA = {x = pointA.x, z = pointA.y, y = 0}, + pointB = {x = pointB.x, z = pointB.y, y = 0} + } + + self.pointsPerZone[zoneName] = entry else MissionEditorWarning.Add("CARRIERROUTE zone stage numbers not in the format _[-]: " .. zoneName) end @@ -114,32 +126,32 @@ function FleetGroup:new(fleetGroupName, database, logger) end end - local SetTaskAsync = function(input, time) - local targetZone = input.targetZone - local task = input.task - local groupName = input.groupName - local logger = input.logger + SpearheadEvents.AddStageNumberChangedListener(self) + return self +end - local group = Group.getByName(groupName) - if group then - logger:info("Sending " .. groupName .. " to " .. targetZone) - group:getController():setTask(task) - end +local SetTaskAsync = function(input, _) + local targetZone = input.targetZone --[[@as string]] + local task = input.task --[[@as table]] + local groupName = input.groupName --[[@as string]] + local l_logger = input.logger --[[@as Logger]] + + local group = Group.getByName(groupName) + if group then + l_logger:info("Sending " .. groupName .. " to " .. targetZone) + group:getController():setTask(task) end +end - o.OnStageNumberChanged = function(self, number, laneIdentifier) - -- only react on "main" lane changes, ignore other lanes for now - if laneIdentifier ~= nil then return end - local targetZone = self.targetZonePerStage[tostring(number)] - if targetZone and targetZone ~= self.currentTargetZone then - local points = self.pointsPerZone[targetZone] - local task = RouteUtil.CreateCarrierRacetrack(points.pointA, points.pointB) - timer.scheduleFunction(SetTaskAsync, { task = task, targetZone = targetZone, groupName = self.fleetGroupName, logger = self.logger }, timer.getTime() + 5) - end +function FleetGroup:OnStageNumberChanged(number, laneIdentifier) + -- only react on "main" lane changes, ignore other lanes for now + if laneIdentifier ~= nil then return end + local targetZone = self.targetZonePerStage[tostring(number)] + if targetZone and targetZone ~= self.currentTargetZone then + local points = self.pointsPerZone[targetZone] + local task = RouteUtil.CreateCarrierRacetrack(points.pointA, points.pointB) + timer.scheduleFunction(SetTaskAsync, { task = task, targetZone = targetZone, groupName = self.fleetGroupName, logger = self.logger }, timer.getTime() + 5) end - - SpearheadEvents.AddStageNumberChangedListener(o) - return o end return FleetGroup diff --git a/src/classes/fleetClasses/GlobalFleetManager.lua b/src/classes/fleetClasses/GlobalFleetManager.lua index 11aa78c..b987dc8 100644 --- a/src/classes/fleetClasses/GlobalFleetManager.lua +++ b/src/classes/fleetClasses/GlobalFleetManager.lua @@ -17,7 +17,7 @@ GlobalFleetManager.start = function(database) for _, groupName in pairs(all_groups) do if Util.startswith(string.lower(groupName), "carriergroup" ) == true then logger:info("Registering " .. groupName .. " as a managed fleet") - local carrierGroup = FleetGroup:new(groupName, database, logger) + local carrierGroup = FleetGroup.new(groupName, database, logger) table.insert(fleetGroups, carrierGroup) end end diff --git a/src/classes/helpers/MizGroupsManager.lua b/src/classes/helpers/MizGroupsManager.lua index 1e03b9a..c5aef3a 100644 --- a/src/classes/helpers/MizGroupsManager.lua +++ b/src/classes/helpers/MizGroupsManager.lua @@ -15,24 +15,45 @@ MizGroupsManager._groupNames = {} MizGroupsManager._spawnTemplateData = {} do --init - for coalition_name, coalition_data in pairs(env.mission.coalition) do - local coalition_nr = DcsUtil.stringToCoalition(coalition_name) + + ---@param coalition_name string + ---@return Coalition + local getCoalitionData = function(coalition_name) + return env.mission.coalition[coalition_name] + end + + ---@param country Country + ---@param key string + ---@return Groups? + local getGroupsData = function(country, key) + if key == "planes" then return country.plane end + if key == "helicopters" then return country.helicopter end + if key == "ground" then return country.vehicle end + if key == "ships" then return country.ship end + if key == "statics" then return country.static end + return nil + end + + for _, coalition_name in ipairs({"neutral", "blue", "red"}) do + local coalition_data = getCoalitionData(coalition_name) if coalition_data.country then - for country_index, country_data in pairs(coalition_data.country) do - for category_name, categorydata in pairs(country_data) do + for _, country_data in pairs(coalition_data.country) do + for _, category_name in pairs(DcsUtil.getAllGroupCategoryNames()) do local category_id = DcsUtil.stringToGroupCategory(category_name) - if category_id ~= nil and type(categorydata) == "table" and categorydata.group ~= nil and type(categorydata.group) == "table" then - for group_index, group in pairs(categorydata.group) do - local name = group.name + local groups_data = getGroupsData(country_data, category_name) + + if category_id ~= nil and type(groups_data) == "table" and groups_data.group ~= nil and type(groups_data.group) == "table" then + for _, group in pairs(groups_data.group) do + local name = group.name --[[@as string]] local skippable = false local isStatic = false if category_id == DcsUtil.GroupCategory.STATIC then isStatic = true - local unit = group.units[1] + local unit = group.units[1] --[[@as table]] if unit and unit.category == "Heliports" then skippable = true elseif unit and unit.name then - name = unit.name + name = unit.name --[[@as string]] else env.error("Group " .. name .. " has no units, skipping it.") skippable = true @@ -72,6 +93,7 @@ function MizGroupsManager.IsGroupStatic(groupName) return nil end +---@param groupName string ---@return SpawnData? function MizGroupsManager.getSpawnTemplateData(groupName) return MizGroupsManager._spawnTemplateData[groupName] diff --git a/src/classes/helpers/SpawnManager.lua b/src/classes/helpers/SpawnManager.lua index 14f4686..76b33de 100644 --- a/src/classes/helpers/SpawnManager.lua +++ b/src/classes/helpers/SpawnManager.lua @@ -16,11 +16,11 @@ SpawnManager.__index = SpawnManager ---@field uncontrolled boolean? Sets the group to be uncontrolled on spawn ---@param logger Logger +---@return SpawnManager function SpawnManager.new(logger) local self = setmetatable({}, SpawnManager) self._logger = logger - self._persistedUnits = {} -- Stores units that should be persisted by name return self @@ -33,7 +33,7 @@ end ---@return StaticObject|Group|nil spawned ---@return boolean isStatic function SpawnManager:SpawnGroup(groupName, overrides, isGroupPersistant) - + local spawnData = MizGroupsManager.getSpawnTemplateData(groupName) if spawnData == nil then @@ -44,13 +44,13 @@ function SpawnManager:SpawnGroup(groupName, overrides, isGroupPersistant) if spawnData.isStatic == true then return self:SpawnStaticInternal(groupName, spawnData, overrides, isGroupPersistant), true else - return self:SpawnGroupInternal(groupName, spawnData, overrides, isGroupPersistant), false + return self:SpawnGroupInternal(spawnData, overrides, isGroupPersistant), false end end function SpawnManager:DestroyGroup(groupName) if groupName == nil then return end - + if self:IsGroupStatic(groupName) == true then local object = StaticObject.getByName(groupName) if object ~= nil then @@ -103,20 +103,20 @@ function SpawnManager:OnUnitLost(object) end end +---@param groupName string function SpawnManager:SpawnCorpsesOnly(groupName) + if groupName == nil then return end end do --- privates ---@private - ---@param groupName string ---@param spawnData SpawnData ---@param override SpawnOverrides? ---@param isPersistent boolean? ---@return Group|nil - function SpawnManager:SpawnGroupInternal(groupName, spawnData, override, isPersistent) - + function SpawnManager:SpawnGroupInternal(spawnData, override, isPersistent) if not spawnData then return end local country = spawnData.country @@ -125,37 +125,31 @@ do --- privates end local spawnTemplate = Util.deepCopyTable(spawnData.groupTemplate) - ---@type Array - local removeableUnitNames = {} --[[ TODO: Spawn units at "current"/LastKnown position with them going to the next waypoint. ONLY when perstable data is found. ]] if spawnTemplate and spawnTemplate["units"] then - for _, unit in pairs(spawnTemplate["units"]) do - local name = unit["name"] + local units = spawnTemplate["units"] --[[@as Array]] + for _, unit in pairs(units) do + local name = unit["name"] --[[@as string]] SpearheadEvents.addOnUnitLostEventListener(name, self) - local state = Persistence.UnitState(name) - if state then - if state.isDead == true then - removeableUnitNames[#removeableUnitNames+1] = name - end - end if override and override.emptyLoadouts == true then if unit["payload"] and unit["payload"]["pylons"] then - unit["payload"]["pylons"] = {} + local payload = unit["payload"] --[[@as table]] + payload["pylons"] = {} --[[@as table]] end end if unit["parking"] then - unit["parking_landing"] = unit["parking"] + unit["parking_landing"] = unit["parking"] --[[@as number]] end if unit["parking_id"] then - unit["parking_landing_id"] = unit["parking_id"] + unit["parking_landing_id"] = unit["parking_id"] --[[@as number]] end end @@ -169,7 +163,6 @@ do --- privates local group = coalition.addGroup(country, spawnData.category, spawnTemplate) - for _, unit in pairs(group:getUnits()) do self:CheckUnitAndReplaceIfPersistentDead(unit) if isPersistent == true then @@ -181,7 +174,6 @@ do --- privates return group end - return nil end @@ -211,9 +203,11 @@ do --- privates spawnTemplate["x"] = persistentState.pos.x spawnTemplate["y"] = persistentState.pos.z if spawnTemplate["units"] and spawnTemplate["units"][1] then - spawnTemplate["units"][1]["x"] = persistentState.pos.x - spawnTemplate["units"][1]["y"] = persistentState.pos.z - spawnTemplate["units"][1]["heading"] = persistentState.heading or 0 + local units = spawnTemplate["units"] --[[@as Array
]] + local firstUnit = units[1] --[[@as table]] + firstUnit["x"] = persistentState.pos.x --[[@as number]] + firstUnit["y"] = persistentState.pos.z --[[@as number]] + firstUnit["heading"] = persistentState.heading or 0 --[[@as number]] end end end diff --git a/src/classes/persistence/Persistence.lua b/src/classes/persistence/Persistence.lua index d96f3cf..eea895c 100644 --- a/src/classes/persistence/Persistence.lua +++ b/src/classes/persistence/Persistence.lua @@ -89,7 +89,7 @@ do else logger:error("Could not load persistence file, using default tables") end - + if tables.version == nil then tables.version = version end end @@ -112,9 +112,9 @@ do logger:info("Wrote persistence data to file") end - local UpdateContinuous = function(null, time) + local UpdateContinuous = function(_, time) env.info("[Spearhead][Persistence] Checking up on persistence state...") - if Persistence._updateRequired == true then + if Persistence._updateRequired == true then local status, result = pcall(writeToFile) if status == false then env.error("[Spearhead][Persistence] Could not write state to file: " .. result) @@ -135,13 +135,15 @@ do end - local warnForNonPersistenceContinous = function(null, time) + local warnForNonPersistenceContinous = function(_, time) trigger.action.outText("Persistence was enabeld, however, io and lfs are not available and no persistence will be done. Make sure to either disable persistence or fix the issues before continuing.", 10) return time + 9 end ---@param dir string @BaseDirectory - ---@return string + ---@param startsWith string + ---@param default string? + ---@return string? local getLastFileOrDefault = function(dir, startsWith, default) local latestFile, lastNumber = default, 0 @@ -181,11 +183,14 @@ do local fileName = "Spearhead_Persistence.0.spearhead" if SpearheadConfig and SpearheadConfig.Persistence then if SpearheadConfig.Persistence.fileName then - + if type(SpearheadConfig.Persistence.fileName) ~= "string" then + SpearheadConfig.Persistence.fileName = "Spearhead_Persistence.0.spearhead" + end local userFileName = SpearheadConfig.Persistence.fileName local split = Util.split_string(userFileName, ".") - if not split and #split < 3 then + if not split or #split < 3 then + split = split or {} split[#split+1] = "0" split[#split+1] = "spearhead" end @@ -194,11 +199,14 @@ do split[#split+1] = "0" split[#split+1] = "spearhead" end - + fileName = table.concat(split, ".") end - if SpearheadConfig.Persistence.directory ~= nil then + if SpearheadConfig.Persistence.directory then + if type(SpearheadConfig.Persistence.directory) ~= "string" then + SpearheadConfig.Persistence.directory = lfs.writedir() .. "\\Data" + end dir = SpearheadConfig.Persistence.directory end end @@ -208,6 +216,10 @@ do local lastFile = getLastFileOrDefault(dir--[[@as string]], matchingPart, fileName) + if lastFile == nil then + lastFile = fileName + end + local fileSplit = Util.split_string(lastFile, ".") fileSplit[#fileSplit-1] = tostring(tonumber(fileSplit[#fileSplit-1]) + 1) fileName = table.concat(fileSplit, ".") @@ -218,12 +230,12 @@ do logger:info("No previous persistence file found, using default: " .. fileName) end - + logger:info("New Persistence file name: " .. tostring(fileName)) local lastPath = dir .. "\\" .. lastFile local path = dir .. "\\" .. fileName Persistence._path = path - + createFileIfNotExists(path) loadTablesFromFile(lastPath) timer.scheduleFunction(UpdateContinuous, nil, timer.getTime() + 120) diff --git a/src/classes/spearhead_db.lua b/src/classes/spearhead_db.lua index c60bc0b..e62312a 100644 --- a/src/classes/spearhead_db.lua +++ b/src/classes/spearhead_db.lua @@ -121,7 +121,7 @@ function Database.New(Logger) self._logger:debug("Initiating tables") do -- INIT ZONE TABLES - for zone_ind, zone_data in pairs(DcsUtil.__trigger_zones) do + for _, zone_data in pairs(DcsUtil.__trigger_zones) do local zone_name = zone_data.name ---@type Vec2 @@ -208,15 +208,18 @@ function Database.New(Logger) self._logger:debug("initiated zone tables, continuing with descriptions") do --load markers if env.mission.drawings and env.mission.drawings.layers then - for i, layer in pairs(env.mission.drawings.layers) do + for _, layer in pairs(env.mission.drawings.layers) do if string.lower(layer.name) == "author" then - for key, layer_object in pairs(layer.objects) do + for _, layer_object in pairs(layer.objects) do if Util.startswith(string.lower(layer_object.name), "buildable", true) == true then local airbaseData = self:getAirbaseDataForDrawLayer(layer_object) if airbaseData then self._logger:debug("found airbase data for " .. layer_object.name) - local number = tonumber(layer_object.text) - airbaseData.buildingKilos = number + if layer_object.primitiveType == "TextBox" then + layer_object = layer_object --[[@as TextBox]] + local number = tonumber(layer_object.text) + airbaseData.buildingKilos = number + end end end end @@ -228,9 +231,9 @@ function Database.New(Logger) ---@type table do -- custom drawings if env.mission.drawings and env.mission.drawings.layers then - for i, layer in pairs(env.mission.drawings.layers) do + for _, layer in pairs(env.mission.drawings.layers) do if string.lower(layer.name) == "author" then - for key, layer_object in pairs(layer.objects) do + for _, layer_object in pairs(layer.objects) do if Util.startswith(layer_object.name, "drawing_", true) then local object = layer_object --[[@as DrawingObject]] local stageDrawing = StageDrawing.New(object) @@ -256,16 +259,19 @@ function Database.New(Logger) -- Find and add Briefing if env.mission.drawings and env.mission.drawings.layers then - for i, layer in pairs(env.mission.drawings.layers) do + for _, layer in pairs(env.mission.drawings.layers) do if string.lower(layer.name) == "author" then - for key, layer_object in pairs(layer.objects) do + for _, layer_object in pairs(layer.objects) do if Util.startswith(string.lower(layer_object.name), "stagebriefing_", true) == true then local zone = DcsUtil.getZoneByName(stageZoneName) local vec2 = { x = layer_object.mapX, y = layer_object.mapY } if zone and Util.is2dPointInZone(vec2, zone) == true then - local description = layer_object.text - if description and description ~= "" then - stageData.StageBriefing = description + if layer_object.primitiveType == "TextBox" then + layer_object = layer_object --[[@as TextBox]] + local description = layer_object.text + if description and description ~= "" then + stageData.StageBriefing = description + end end end end @@ -339,14 +345,14 @@ function Database.New(Logger) end -- fill missions - for key, missionZone in pairs(self._tables.MissionZones) do + for _, missionZone in pairs(self._tables.MissionZones) do if DcsUtil.isZoneInZone(missionZone, stageZoneName) == true then table.insert(stageData.MissionZones, missionZone) end end -- fill random missions - for key, missionZone in pairs(self._tables.RandomMissionZones) do + for _, missionZone in pairs(self._tables.RandomMissionZones) do if DcsUtil.isZoneInZone(missionZone, stageZoneName) == true then table.insert(stageData.RandomMissionZones, missionZone) end @@ -468,6 +474,7 @@ function Database.New(Logger) return self end +---@type table local is_group_taken = {} local getAvailableGroups = function() @@ -620,13 +627,14 @@ function Database:loadBlueSamUnits() samData.buildingKilos = number if env.mission.drawings and env.mission.drawings.layers then - for i, layer in pairs(env.mission.drawings.layers) do + for _, layer in pairs(env.mission.drawings.layers) do if string.lower(layer.name) == "author" then - for key, layer_object in pairs(layer.objects) do + for _, layer_object in pairs(layer.objects) do local vec2 = { x = layer_object.mapX, y = layer_object.mapY } - if triggerZone and Util.is2dPointInZone(vec2, triggerZone) then + if layer_object.primitiveType == "TextBox" and triggerZone and Util.is2dPointInZone(vec2, triggerZone) then if layer_object.name and Util.startswith(layer_object.name, "supplybriefing_", true) then + layer_object = layer_object --[[@as TextBox]] local description = layer_object.text if description and description ~= "" then samData.briefing = description @@ -637,7 +645,7 @@ function Database:loadBlueSamUnits() end end end - else + else MissionEditorWarnings.Add("Buildable number for " .. blueSamZone .. " is invalid") end end @@ -670,13 +678,13 @@ function Database:LoadZoneData(missionZoneName) for _, groupName in pairs(groups) do if MizGroupsManager.IsGroupStatic(groupName) == true then local object = StaticObject.getByName(groupName) - + if object and object:getCoalition() == coalition.side.RED then table.insert(self._tables.MissionZoneData[missionZoneName].RedGroups, groupName) elseif object then table.insert(self._tables.MissionZoneData[missionZoneName].BlueGroups, groupName) end - + else local group = Group.getByName(groupName) if group and group:getCoalition() == coalition.side.RED then @@ -720,13 +728,14 @@ function Database:LoadZoneData(missionZoneName) ---Adds Briefings if env.mission.drawings and env.mission.drawings.layers then - for i, layer in pairs(env.mission.drawings.layers) do + for _, layer in pairs(env.mission.drawings.layers) do if string.lower(layer.name) == "author" then - for key, layer_object in pairs(layer.objects) do + for _, layer_object in pairs(layer.objects) do local vec2 = { x = layer_object.mapX, y = layer_object.mapY } - if triggerZone and Util.is2dPointInZone(vec2, triggerZone) then + if layer_object.primitiveType == "TextBox" and triggerZone and Util.is2dPointInZone(vec2, triggerZone) then if layer_object.name and Util.startswith(layer_object.name, "briefing_", true) then + layer_object = layer_object --[[@as TextBox]] local description = layer_object.text if description and description ~= "" then self._tables.MissionZoneData[missionZoneName].description = description @@ -776,12 +785,13 @@ function Database:loadFarpData() -- check briefings if env.mission.drawings and env.mission.drawings.layers then - for i, layer in pairs(env.mission.drawings.layers) do + for _, layer in pairs(env.mission.drawings.layers) do if string.lower(layer.name) == "author" then - for key, layer_object in pairs(layer.objects) do + for _, layer_object in pairs(layer.objects) do local vec2 = { x = layer_object.mapX, y = layer_object.mapY } - if triggerZone and Util.is2dPointInZone(vec2, triggerZone) then + if layer_object.primitiveType == "TextBox" and triggerZone and Util.is2dPointInZone(vec2, triggerZone) then + layer_object = layer_object --[[@as TextBox]] if layer_object.name and Util.startswith(layer_object.name, "supplybriefing_", true) then local description = layer_object.text if description and description ~= "" then @@ -796,8 +806,6 @@ function Database:loadFarpData() else MissionEditorWarnings.Add("Buildable number for " .. farpZone .. " is invalid.") end - - end end end @@ -952,6 +960,7 @@ function Database:getBriefingForStage(stagename) return stageZone.StageBriefing or "" end +---@param stagename string ---@return Array function Database:getMissionsForStage(stagename) local stageZone = self._tables.StageZones[stagename] @@ -959,6 +968,7 @@ function Database:getMissionsForStage(stagename) return stageZone.MissionZones end +---@param stagename string ---@return Array function Database:getRandomMissionsForStage(stagename) local stageZone = self._tables.StageZones[stagename] @@ -966,13 +976,14 @@ function Database:getRandomMissionsForStage(stagename) return stageZone.RandomMissionZones end +---@param missionZoneName string ---@return MissionZoneData? function Database:getMissionDataForZone(missionZoneName) return self._tables.MissionZoneData[missionZoneName] end ---@param stageName string ----@return table result airbase Names +---@return Array result airbase Names function Database:getAirbaseNamesInStage(stageName) local stageData = self._tables.StageZones[stageName] if not stageData then return {} end @@ -986,6 +997,7 @@ function Database:getFarpNamesInStage(stageName) return stageData.FarpZones or {} end +---@param farpZoneName string ---@return FarpZoneData? function Database:getFarpDataForZone(farpZoneName) local farpData = self._tables.FarpZoneData[farpZoneName] @@ -1001,6 +1013,7 @@ function Database:getAirbaseDataForZone(baseName) return baseData end +---@param stageName string ---@return string? function Database:getStageBriefingForStage(stageName) local stageData = self._tables.StageZones[stageName] diff --git a/src/classes/spearhead_events.lua b/src/classes/spearhead_events.lua index 92ec417..83fb992 100644 --- a/src/classes/spearhead_events.lua +++ b/src/classes/spearhead_events.lua @@ -32,7 +32,9 @@ do ---@field OnStageNumberChanged fun(self:OnStageChangedListener, number:integer, laneIdentifier:string?) do -- STAGE NUMBER CHANGED + ---@type Array local OnStageNumberChangedListeners = {} + ---@type Array local OnStageNumberChangedHandlers = {} ---Add a stage zone number changed listener ---@param listener OnStageChangedListener object with function OnStageNumberChanged(self, number, stageLaneIdentifier) @@ -46,7 +48,8 @@ do ---@class OnStageNumberChangeCompleteListener ---@field OnStageNumberChangeComplete fun(self:OnStageNumberChangeCompleteListener, number:integer, laneIdentifier:string?) - + + ---@type Array local OnStageNumberChangeCompleteListeners = {} ---@param listener OnStageNumberChangeCompleteListener SpearheadEvents.AddStageNumberChangeCompleteListener = function(listener) @@ -65,7 +68,7 @@ do end) for _, callable in pairs(OnStageNumberChangedListeners) do - local succ, err = pcall(function() + local _, err = pcall(function() callable:OnStageNumberChanged(newStageNumber, laneIdentifier) end) if err then @@ -74,14 +77,14 @@ do end for _, callable in pairs(OnStageNumberChangedHandlers) do - local succ, err = pcall(callable, newStageNumber, laneIdentifier) + local _, err = pcall(callable, newStageNumber, laneIdentifier) if err then logError(err) end end for _, callable in pairs(OnStageNumberChangeCompleteListeners) do - local succ, err = pcall(function() + local _, err = pcall(function() callable:OnStageNumberChangeComplete(newStageNumber, laneIdentifier) end) if err then @@ -110,9 +113,12 @@ do table.insert(onWeaponFiredListeners, weaponFiredListener) end + ---@param unit Unit + ---@param weapon Weapon + ---@param target Unit? local triggerWeaponFired = function(unit, weapon, target) for _, callable in pairs(onWeaponFiredListeners) do - local succ, err = pcall(function() + local _, err = pcall(function() callable:OnWeaponFired(unit, weapon, target) end) @@ -121,12 +127,15 @@ do end end end - + ---@class OnLandEventListener + ---@field OnUnitLanded fun(self:OnLandEventListener, initiatorUnit:Unit, airbase:Airbase) + + ---@type table> local onLandEventListeners = {} ---Add an event listener to a specific unit ---@param unitName string to call when the unit lands - ---@param landListener table table with function OnUnitLanded(self, initiatorUnit, airbase) + ---@param landListener OnLandEventListener table with function OnUnitLanded(self, initiatorUnit, airbase) SpearheadEvents.addOnUnitLandEventListener = function(unitName, landListener) if type(landListener) ~= "table" then warn("Event handler not of type table/object") @@ -162,6 +171,11 @@ do end do -- ON RTB + + ---@class OnGroupRTBListener + ---@field OnGroupRTB fun(self:OnGroupRTBListener, groupName:string) + + ---@type table> local OnGroupRTBListeners = {} ---Adds a function to the events listener that triggers when a group publishes themselves RTB. ---This is only available when a ROUTE is created via the Spearhead.RouteUtil @@ -186,7 +200,7 @@ do if groupName ~= nil then if OnGroupRTBListeners[groupName] then for _, callable in pairs(OnGroupRTBListeners[groupName]) do - local succ, err = pcall(function() + local _, err = pcall(function() callable:OnGroupRTB(groupName) end) if err then @@ -197,11 +211,15 @@ do end end + ---@class OnGroupRTBInTenListener + ---@field OnGroupRTBInTen fun(self:OnGroupRTBInTenListener, groupName:string) + + ---@type table> local OnGroupRTBInTenListeners = {} ---Adds a function to the events listener that triggers when a group publishes themselves RTB. ---This is only available when a ROUTE is created via the Spearhead.RouteUtil ---@param groupName string the groupname to expect - ---@param handlingObject table object with OnGroupRTBInTen(self, groupName) + ---@param handlingObject OnGroupRTBInTenListener object with OnGroupRTBInTen(self, groupName) SpearheadEvents.addOnGroupRTBInTenListener = function(groupName, handlingObject) if type(handlingObject) ~= "table" then warn("Event handler not of type table/object") @@ -221,7 +239,7 @@ do if groupName ~= nil then if OnGroupRTBInTenListeners[groupName] then for _, callable in pairs(OnGroupRTBInTenListeners[groupName]) do - local succ, err = pcall(function() + local _, err = pcall(function() callable:OnGroupRTBInTen(groupName) end) if err then @@ -234,10 +252,17 @@ do end do -- ON Station + + ---@class OnGroupOnStationListener + ---@field OnGroupOnStation fun(self:OnGroupOnStationListener, groupName:string) + + ---@type table> local OnGroupOnStationListeners = {} + ---Adds a function to the events listener that triggers when a group publishes themselves RTB. ---This is only available when a ROUTE is created via the Spearhead.RouteUtil ---@param groupName string the groupname to expect + ---@param handlingObject OnGroupOnStationListener object with OnGroupOnStation(self, groupName) SpearheadEvents.addOnGroupOnStationListener = function(groupName, handlingObject) if type(handlingObject) ~= "table" then warn("Event handler not of type table/object") @@ -257,7 +282,7 @@ do if groupName ~= nil then if OnGroupOnStationListeners[groupName] then for _, callable in pairs(OnGroupOnStationListeners[groupName]) do - local succ, err = pcall(function() + local _, err = pcall(function() callable:OnGroupOnStation(groupName) end) if err then @@ -270,15 +295,18 @@ do end do -- PLAYER ENTER UNIT + ---@class OnPlayerEnterUnitListener + ---@field OnPlayerEntersUnit fun(self:OnPlayerEnterUnitListener, unit:Unit) + + ---@type Array local playerEnterUnitListeners = {} ---comment - ---@param listener table object with OnPlayerEntersUnit(self, unit) + ---@param listener OnPlayerEnterUnitListener object with OnPlayerEntersUnit(self, unit) SpearheadEvents.AddOnPlayerEnterUnitListener = function(listener) if type(listener) ~= "table" then warn("Unit lost Event listener not of type table/object") return end - table.insert(playerEnterUnitListeners, listener) end @@ -286,7 +314,7 @@ do if unit ~= nil then if playerEnterUnitListeners then for _, callable in pairs(playerEnterUnitListeners) do - local succ, err = pcall(function() + local _, err = pcall(function() callable:OnPlayerEntersUnit(unit) end) if err then @@ -299,7 +327,7 @@ do end do -- Ejection events - + local unitEjectListeners = {} SpearheadEvents.AddOnUnitEjectedListener = function(listener) if type(listener) ~= "table" then @@ -315,13 +343,13 @@ do local e = {} function e:onEvent(event) if event.id == world.event.S_EVENT_LAND or event.id == world.event.S_EVENT_RUNWAY_TOUCH then - local unit = event.initiator - local airbase = event.place + local unit = event.initiator --[[@as Unit]] + local airbase = event.place --[[@as Airbase]] if unit ~= nil then local name = unit:getName() if onLandEventListeners[name] then for _, callable in pairs(onLandEventListeners[name]) do - local succ, err = pcall(function() + local _, err = pcall(function() callable:OnUnitLanded(unit, airbase) end) if err then @@ -336,15 +364,15 @@ do event.id == world.event.S_EVENT_CRASH or event.id == world.event.S_EVENT_EJECTION or event.id == world.event.S_EVENT_UNIT_LOST then - local object = event.initiator + local object = event.initiator --[[@as Unit]] if object and object.getName then logDebug("Receiving death event from: " .. object:getName()) end - + if object and object.getName and OnUnitLostListeners[object:getName()] then for _, callable in pairs(OnUnitLostListeners[object:getName()]) do - local succ, err = pcall(function() + local _, err = pcall(function() callable:OnUnitLost(object) end) @@ -355,15 +383,11 @@ do end end - if event.id == world.event.S_EVENT_EJECTION then - - end - if event.id == world.event.S_EVENT_SHOT then - - local shooter = event.initiator - local weapon = event.weapon - local target = event.target + + local shooter = event.initiator --[[@as Unit]] + local weapon = event.weapon --[[@as Weapon]] + local target = event.target --[[@as Unit?]] triggerWeaponFired(shooter, weapon, target) end @@ -372,28 +396,32 @@ do Persistence.UpdateNow() end + ---@type table local AI_GROUPS = {} - local function CheckAndTriggerSpawnAsync(unit, time) - - local function isPlayer(unit) - if unit == nil then return false, "unit is nil" end - if unit.getGroup == nil then return false, 'no get group function in unit object, most likely static' end - if Object.getCategory(unit) ~= Object.Category.UNIT then + ---@param unit Unit + ---@param _ any + local function CheckAndTriggerSpawnAsync(unit, _) + ---@param checkUnit Unit + ---@return boolean, string? + local function isPlayer(checkUnit) + if checkUnit == nil then return false, "unit is nil" end + if checkUnit.getGroup == nil then return false, 'no get group function in unit object, most likely static' end + if Object.getCategory(checkUnit) ~= Object.Category.UNIT then return false, "object is not a unit" end - if unit:isExist() ~= true then return false, "unit does not exist" end - local group = unit:getGroup() + if checkUnit:isExist() ~= true then return false, "unit does not exist" end + local group = checkUnit:getGroup() if group ~= nil then if AI_GROUPS[group:getName()] == true then return false end local players = DcsUtil.getAllPlayerUnits() - local unitName = unit:getName() - for i, unit in pairs(players) do - if unit:getName() == unitName then + local unitName = checkUnit:getName() + for _, playerUnit in pairs(players) do + if playerUnit:getName() == unitName then return true end end @@ -403,11 +431,8 @@ do end if isPlayer(unit) == true then - local groupId = unit:getGroup():getID() SpearheadEvents.TriggerPlayerEntersUnit(unit) end - - return nil end if event.id == world.event.S_EVENT_BIRTH then diff --git a/src/classes/spearhead_routeutil.lua b/src/classes/spearhead_routeutil.lua index 717ee5b..a345b55 100644 --- a/src/classes/spearhead_routeutil.lua +++ b/src/classes/spearhead_routeutil.lua @@ -8,6 +8,7 @@ do --setup route util ---@param attackHelos boolean ---@return table local function GetCAPTargetTypes(attackHelos) + ---@type table local targetTypes = { [1] = "Planes", } @@ -53,8 +54,9 @@ do --setup route util ---comment ---@param groupName string - ---@param position table { x, y} + ---@param position Vec3 ---@param altitude number + ---@param deviationdistance number ---@param speed number ---@param duration number ---@param engageHelos boolean @@ -181,7 +183,7 @@ do --setup route util end ---comment - ---@param position table { x, y} + ---@param position Vec3 ---@param altitude number ---@param speed number ---@param childTasks table @@ -210,7 +212,8 @@ do --setup route util ---comment ---@param groupName string groupName you're creating this route for ---@param airdromeId number airdromeId - ---@param capPoint table { x, z } + ---@param capPoint Vec3 + ---@param racetrackSecondPoint Vec3? ---@param altitude number ---@param speed number ---@param durationOnStation number @@ -258,7 +261,8 @@ do --setup route util if racetrackSecondPoint then orbitType = "Race-Track" end local basePoint = base:getPoint() - local points = {} + ---@type Array
+ local points if racetrackSecondPoint == nil then points = { [1] = FlyToPointTask(capPoint, altitude, speed, additionalFlyOverTasks), @@ -304,6 +308,7 @@ do --setup route util end local group = Group.getByName(groupName) + ---@type Vec3? local pos; local i = 1 if group == nil then @@ -393,6 +398,9 @@ do --setup route util }, "" end + ---@param pointA Vec3 + ---@param pointB Vec3 + ---@return table, string? ROUTE_UTIL.CreateCarrierRacetrack = function(pointA, pointB) return { id = "Mission", @@ -461,7 +469,7 @@ do --setup route util } } } - }, "" + }, nil end end diff --git a/src/classes/stageClasses/GlobalStageManager.lua b/src/classes/stageClasses/GlobalStageManager.lua index 658c9f3..879ea93 100644 --- a/src/classes/stageClasses/GlobalStageManager.lua +++ b/src/classes/stageClasses/GlobalStageManager.lua @@ -2,7 +2,6 @@ local Events = require("classes.spearhead_events") local Util = require("classes.util.Util") local DcsUtil = require("classes.util.DcsUtil") local Logger = require("classes.util.Logger") -local MissionEditorWarnings = require("classes.util.MissionEditorWarnings") local PersistenceConfig = require("classes.configuration.PersistenceConfig") local ExtraStage = require("classes.stageClasses.Stages.ExtraStage") local PrimaryStage = require("classes.stageClasses.Stages.PrimaryStage") @@ -35,7 +34,6 @@ local singletonInstance = nil ---@param spawnManager SpawnManager ---@return GlobalStageManager function GlobalStageManager.new(database, stageConfig, logLevel, spawnManager) - if singletonInstance ~= nil then return singletonInstance end @@ -44,7 +42,7 @@ function GlobalStageManager.new(database, stageConfig, logLevel, spawnManager) logger:info("Using Stage Log Level: " .. logLevel) local self = setmetatable({}, GlobalStageManager) singletonInstance = self - + self.database = database self.stageConfig = stageConfig self._missionCommandsHelper = MissionCommandsHelper.getOrCreate() @@ -52,14 +50,15 @@ function GlobalStageManager.new(database, stageConfig, logLevel, spawnManager) self.logger = logger if stageConfig.isAutoStages ~= true then - logger:warn("Spearhead will not automatically progress stages due to the given settings. If you manually have implemented this, please ignore this message") + logger:warn( + "Spearhead will not automatically progress stages due to the given settings. If you manually have implemented this, please ignore this message") end Events.AddStageNumberChangedListener(self) for _, stageName in pairs(database:getStagezoneNames()) do logger:debug("Found stage zone with name: " .. stageName) - + local parseResult = self:ParseStageName(stageName) if parseResult.isValid == false then logger:warn("Stage zone with name " .. stageName .. " is not valid: " .. parseResult.invalidReason) @@ -81,12 +80,12 @@ function GlobalStageManager.new(database, stageConfig, logLevel, spawnManager) stage:AddStageCompleteListener(self) self._stageRepository:AddStage(stage) elseif parseResult.stageType == "WaitingStage" then - local waitingStage = WaitingStage.New(database, stageConfig, logger, initData, parseResult.waitingStageSeconds, spawnManager) + local waitingStage = WaitingStage.New(database, stageConfig, logger, initData, + parseResult.waitingStageSeconds, spawnManager) waitingStage:AddStageCompleteListener(self) self._stageRepository:AddStage(waitingStage) end end - end singletonInstance = self @@ -103,11 +102,11 @@ function GlobalStageManager:Start() local stageLanes = self._stageRepository:getAllStageLanes() for _, stageLane in pairs(stageLanes) do - local stageLaneIdentifier = stageLane:GetStageLaneIdentifier() local persistedStage = Persistence.GetActiveStage(stageLaneIdentifier) if persistedStage then - self.logger:info("Loaded persisted stage " .. persistedStage .. " for lane " .. (stageLaneIdentifier or "default")) + self.logger:info("Loaded persisted stage " .. + persistedStage .. " for lane " .. (stageLaneIdentifier or "default")) stageLane:SetActiveStageIndex(persistedStage) Events.PublishStageNumberChanged(persistedStage, stageLaneIdentifier) else @@ -139,17 +138,16 @@ end ---@param stageName string ---@return StageNameParseResult function GlobalStageManager:ParseStageName(stageName) - local split = Util.split_string(stageName, "_") if Util.tableLength(split) < 3 then - return { isValid = false, invalidReason = "Stage zone with name " .. stageName .. " does not have a order number or valid format" } + return { isValid = false, invalidReason = "Stage zone with name " .. + stageName .. " does not have a order number or valid format" } end local typePart = string.lower(split[1]) if typePart == "missionstage" then - local orderNumberString = string.lower(split[2]) ---@type StageType local stageType = "PrimaryStage" @@ -161,15 +159,16 @@ function GlobalStageManager:ParseStageName(stageName) local first = orderNumberString:sub(1, 1) if tonumber(first) == nil then -- first character is the lane identifier only if it's not a number stageLaneIdentifier = string.lower(first) - + orderNumberString = orderNumberString:sub(2) end local orderNumber = tonumber(orderNumberString) if orderNumber == nil then - return { isValid = false, invalidReason = "Stage zone with name " .. stageName .. " does not have a valid order number : " .. orderNumberString } + return { isValid = false, invalidReason = "Stage zone with name " .. + stageName .. " does not have a valid order number : " .. orderNumberString } end - + local stageDisplayName = split[3] ---@type StageNameParseResult local result = { @@ -182,18 +181,19 @@ function GlobalStageManager:ParseStageName(stageName) } return result elseif typePart == "waitingstage" then - local stageType = "WaitingStage" local orderNumberString = split[2] local orderNumber = tonumber(orderNumberString) if orderNumber == nil then - return { isValid = false, invalidReason = "Waiting Stage zone with name " .. stageName .. " does not have a valid order number : " .. orderNumberString } + return { isValid = false, invalidReason = "Waiting Stage zone with name " .. + stageName .. " does not have a valid order number : " .. orderNumberString } end local waitingSecondsString = split[3] local waitingSeconds = tonumber(waitingSecondsString) if waitingSeconds == nil then - return { isValid = false, invalidReason = "Waiting Stage zone with name " .. stageName .. " does not have a valid amount of seconds parameter : " .. waitingSecondsString } + return { isValid = false, invalidReason = "Waiting Stage zone with name " .. + stageName .. " does not have a valid amount of seconds parameter : " .. waitingSecondsString } end local stageDisplayName = "Waiting Stage " .. orderNumber @@ -209,9 +209,9 @@ function GlobalStageManager:ParseStageName(stageName) waitingStageSeconds = waitingSeconds } return result - end - return { isValid = false, invalidReason = "Stage zone with name " .. stageName .. " has an unrecognized type: " .. typePart } + return { isValid = false, invalidReason = "Stage zone with name " .. + stageName .. " has an unrecognized type: " .. typePart } end ---@param stage Stage @@ -223,7 +223,8 @@ function GlobalStageManager:OnStageComplete(stage) local stageLane = self._stageRepository:getStageLane(laneIdentifier) if not stageLane or not stageLane:IsCurrentStageIndexComplete() then - self.logger:debug("Stage lane " .. (laneIdentifier or "default") .. " is not complete for stage index " .. stageIndex) + self.logger:debug("Stage lane " .. + (laneIdentifier or "default") .. " is not complete for stage index " .. stageIndex) return end @@ -234,7 +235,7 @@ function GlobalStageManager:OnStageComplete(stage) stageLane:SetActiveStageIndex(nextStageIndex) if stageLane:IsDefaultStageLane() then - -- COMPLETION IN THE DEFAULT LANE + -- COMPLETION IN THE DEFAULT LANE -- 1. Check if any lane is at status "BetweenChapters" and the next chapter start is "next stage index" local allLanes = self._stageRepository:getAllStageLanes() @@ -242,7 +243,9 @@ function GlobalStageManager:OnStageComplete(stage) if lane:GetStageLaneIdentifier() ~= StageLane.DefaultLaneKey and lane:GetStageLaneState() == "BetweenChapters" then local nextChapterStart = lane:GetNextChapterStart() if nextChapterStart == nextStageIndex then - self.logger:debug("Lane " .. (lane:GetStageLaneIdentifier() or "default") .. " is at chapter start for next stage index " .. nextStageIndex) + self.logger:debug("Lane " .. + (lane:GetStageLaneIdentifier() or "default") .. + " is at chapter start for next stage index " .. nextStageIndex) Events.PublishStageNumberChanged(nextStageIndex, lane:GetStageLaneIdentifier()) lane:SetActiveStageIndex(nextStageIndex) end @@ -256,7 +259,6 @@ function GlobalStageManager:OnStageComplete(stage) if defaultStageLane and defaultStageLane:GetStageLaneState() == "BetweenChapters" then local nextChapterStart = defaultStageLane:GetNextChapterStart() if nextChapterStart == nextStageIndex then - -- 2. Check if all side lanes are at or beyond the next chapter starts local allLanes = self._stageRepository:getAllStageLanes() local allSideLanesReady = true @@ -265,15 +267,19 @@ function GlobalStageManager:OnStageComplete(stage) -- Check if the lane is at or beyond the next chapter starts when "InChapter" eq "Active" if lane:GetStageLaneState() == "InChapter" and lane:GetActiveStageIndex() < nextStageIndex then allSideLanesReady = false - self.logger:debug("Lane " .. (lane:GetStageLaneIdentifier() or "default") .. " is not ready for next stage index " .. nextStageIndex) + self.logger:debug("Lane " .. + (lane:GetStageLaneIdentifier() or "default") .. + " is not ready for next stage index " .. nextStageIndex) break - -- When in between chapters, check if the next chapter start is less than the next stage index, meaning there is still stages to be completed before the main lane can be activated again + -- When in between chapters, check if the next chapter start is less than the next stage index, meaning there is still stages to be completed before the main lane can be activated again elseif lane:GetStageLaneState() == "BetweenChapters" then local nextChapter = lane:GetNextChapterStart() if nextChapter and nextChapter < nextStageIndex then allSideLanesReady = false - self.logger:debug("Lane " .. (lane:GetStageLaneIdentifier() or "default") .. " is not ready for next stage index " .. nextStageIndex) + self.logger:debug("Lane " .. + (lane:GetStageLaneIdentifier() or "default") .. + " is not ready for next stage index " .. nextStageIndex) break end end @@ -281,13 +287,14 @@ function GlobalStageManager:OnStageComplete(stage) end if allSideLanesReady then - self.logger:debug("All side lanes are ready for next stage index " .. nextStageIndex .. ", activating default lane") + self.logger:debug("All side lanes are ready for next stage index " .. + nextStageIndex .. ", activating default lane") Events.PublishStageNumberChanged(nextStageIndex, nil) defaultStageLane:SetActiveStageIndex(nextStageIndex) else - self.logger:debug("Not all side lanes are ready for next stage index " .. nextStageIndex .. ", default lane will not be activated") + self.logger:debug("Not all side lanes are ready for next stage index " .. + nextStageIndex .. ", default lane will not be activated") end - end end end @@ -308,7 +315,6 @@ end ---@public function GlobalStageManager:OnStageNumberChanged(stageNumber, stageLaneIdentifier) - -- only react on "main" lane changes, ignore other lanes for now if stageLaneIdentifier ~= nil then return end @@ -321,13 +327,13 @@ function GlobalStageManager:OnStageNumberChangeComplete(stageNumber, stageLaneId if stageLaneIdentifier ~= nil then return end self.logger:debug("Stage number change complete to: " .. tostring(stageNumber)) - + ---@type Array local groups = {} for _, player in pairs(DcsUtil.getAllPlayerUnits()) do local group = player:getGroup() if group then - groups[group:getID()] = group + table.insert(groups, group) end end @@ -349,91 +355,98 @@ function GlobalStageManager:UpdateDrawings(stageNumber, stageLaneIdentifier) if laneIdentifier == stageLaneIdentifier then if stageNumber >= startStage and stageNumber < stopStage then - self.logger:debug("Drawing " .. drawing:GetName() .. " is active for stage number: " .. tostring(stageNumber)) + self.logger:debug("Drawing " .. + drawing:GetName() .. " is active for stage number: " .. tostring(stageNumber)) drawing:Draw() else - self.logger:debug("Drawing " .. drawing:GetName() .. " is not active for stage number: " .. tostring(stageNumber)) + self.logger:debug("Drawing " .. + drawing:GetName() .. " is not active for stage number: " .. tostring(stageNumber)) drawing:Remove() end end end end - function GlobalStageManager:PrintMermaidStage() local lanes = self._stageRepository:getAllStageLanes() - + + ---@type table local nodes = {} + ---@type table local edges = {} + ---@type table> local stageIndicesByLane = {} -- Track all stage indices per lane local mainLaneId = "default" - + -- Color palette for lanes (26 vibrant colors optimized for dark mode) local laneColors = { - "#FF6B6B", -- 1: Red - "#4ECDC4", -- 2: Teal - "#45B7D1", -- 3: Blue - "#FFA502", -- 4: Orange - "#95E1D3", -- 5: Mint - "#F38181", -- 6: Coral - "#AA96DA", -- 7: Purple - "#FCBAD3", -- 8: Pink - "#A8E6CF", -- 9: Light green - "#FFD3B6", -- 10: Peach - "#FFAAA5", -- 11: Light red - "#FF8B94", -- 12: Rose - "#FFEAA7", -- 13: Butter - "#DFE6E9", -- 14: Gray - "#00B894", -- 15: Emerald - "#0984E3", -- 16: Cobalt - "#6C5CE7", -- 17: Indigo - "#A29BFE", -- 18: Lavender - "#FD79A8", -- 19: Magenta - "#FDCB6E", -- 20: Gold - "#6C757D", -- 21: Slate - "#20C997", -- 22: Seafoam - "#E74C3C", -- 23: Scarlet - "#3498DB", -- 24: Dodger blue - "#9B59B6", -- 25: Amethyst - "#1ABC9C", -- 26: Turquoise + "#FF6B6B", -- 1: Red + "#4ECDC4", -- 2: Teal + "#45B7D1", -- 3: Blue + "#FFA502", -- 4: Orange + "#95E1D3", -- 5: Mint + "#F38181", -- 6: Coral + "#AA96DA", -- 7: Purple + "#FCBAD3", -- 8: Pink + "#A8E6CF", -- 9: Light green + "#FFD3B6", -- 10: Peach + "#FFAAA5", -- 11: Light red + "#FF8B94", -- 12: Rose + "#FFEAA7", -- 13: Butter + "#DFE6E9", -- 14: Gray + "#00B894", -- 15: Emerald + "#0984E3", -- 16: Cobalt + "#6C5CE7", -- 17: Indigo + "#A29BFE", -- 18: Lavender + "#FD79A8", -- 19: Magenta + "#FDCB6E", -- 20: Gold + "#6C757D", -- 21: Slate + "#20C997", -- 22: Seafoam + "#E74C3C", -- 23: Scarlet + "#3498DB", -- 24: Dodger blue + "#9B59B6", -- 25: Amethyst + "#1ABC9C", -- 26: Turquoise } + ---@type table local laneColorMap = {} -- Map lane ID to color + ---@type number local colorIndex = 1 - + -- Build nodes and collect all stage indices per lane for _, lane in ipairs(lanes) do local laneId = lane:GetStageLaneIdentifier() or "default" local stageIndices = lane:GetAllStageIndices() stageIndicesByLane[laneId] = stageIndices - + -- Assign color to this lane laneColorMap[laneId] = laneColors[colorIndex] colorIndex = colorIndex + 1 if colorIndex > #laneColors then colorIndex = 1 end - + -- Create nodes for each stage index in this lane for _, stageIndex in ipairs(stageIndices) do local stages = lane:GetStagesAtIndex(stageIndex) - + if stages then for _, stage in ipairs(stages) do local nodeId = laneId .. "_" .. stageIndex local stageType = stage:GetStageType() local stageName = stage.stageName or stage.zoneName - + -- Generate bracket label: [1], [2] for default, [w1], [e2] for other lanes + ---@type string local bracketLabel if laneId == "default" then bracketLabel = "[" .. stageIndex .. "]" else bracketLabel = "[" .. laneId .. stageIndex .. "]" end - + -- Combined label: [bracket] Name local label = bracketLabel .. " " .. stageName - + -- Different node shapes for different stage types local nodeShape = "[" local nodeEnd = "]" @@ -444,14 +457,14 @@ function GlobalStageManager:PrintMermaidStage() nodeShape = "[[" nodeEnd = "]]" end - - nodes[nodeId] = string.format(' %s%s"%s"%s', + + nodes[nodeId] = string.format(' %s%s"%s"%s', nodeId, nodeShape, label, nodeEnd) end end end end - + -- Add edges for sequential stages within the same lane for laneId, stageIndices in pairs(stageIndicesByLane) do for i = 1, #stageIndices - 1 do @@ -459,7 +472,7 @@ function GlobalStageManager:PrintMermaidStage() local toIdx = stageIndices[i + 1] local fromNodeId = laneId .. "_" .. fromIdx local toNodeId = laneId .. "_" .. toIdx - + -- Check if this is a chapter boundary (gap) local isChapter = false for _, lane in ipairs(lanes) do @@ -469,12 +482,12 @@ function GlobalStageManager:PrintMermaidStage() break end end - + local label = isChapter and "|chapter|" or "" table.insert(edges, string.format(' %s -->%s %s', fromNodeId, label, toNodeId)) end end - + -- Get main lane reference local mainStageLane = nil for _, lane in ipairs(lanes) do @@ -483,15 +496,15 @@ function GlobalStageManager:PrintMermaidStage() break end end - + -- Add dependencies from DEFAULT lane to SIDE lanes at chapter starts -- Side lanes activate when main completes the stage BEFORE the chapter start if mainStageLane then for _, lane in ipairs(lanes) do if lane:IsDefaultStageLane() == false then local sideId = lane:GetStageLaneIdentifier() - local sideIndices = stageIndicesByLane[sideId] - + local sideIndices = stageIndicesByLane[sideId] or {} --[[@as Array]] + -- For each stage in the side lane for _, stageIdx in ipairs(sideIndices) do -- Check if this is a chapter start in the side lane @@ -506,40 +519,40 @@ function GlobalStageManager:PrintMermaidStage() end end end - + -- Add dependencies from SIDE lanes gating the MAIN lane at chapter boundaries -- Main cannot advance to the next chapter until ALL side lanes are at or above that chapter index if mainStageLane then local mainIndices = stageIndicesByLane[mainLaneId] - + -- For each chapter start in main lane (skip first one) for i = 2, #mainIndices do local nextIdx = mainIndices[i] - + -- Check if nextIdx is a chapter start (there's a gap before it) if mainStageLane:IsChapterStart(nextIdx) then -- Before main can progress to nextIdx, all side lanes must be at >= nextIdx for _, lane in ipairs(lanes) do if lane:IsDefaultStageLane() == false then local sideId = lane:GetStageLaneIdentifier() - local sideIndices = stageIndicesByLane[sideId] - + local sideIndices = stageIndicesByLane[sideId] or {} --[[@as Array]] + -- Find the appropriate gate node for this side lane -- Use first stage >= nextIdx if it exists, otherwise use the highest stage local gateStageIdx = nil - + for _, idx in ipairs(sideIndices) do if idx >= nextIdx then gateStageIdx = idx break end end - + -- If no stage >= nextIdx, use the highest stage in this lane if gateStageIdx == nil and #sideIndices > 0 then gateStageIdx = sideIndices[#sideIndices] end - + if gateStageIdx then local fromNodeId = sideId .. "_" .. gateStageIdx local toNodeId = mainLaneId .. "_" .. nextIdx @@ -550,25 +563,26 @@ function GlobalStageManager:PrintMermaidStage() end end end - + -- Build complete Mermaid diagram - local diagramLines = {"graph TD"} - + local diagramLines = { "graph TD" } + -- Add class definitions for each lane with colors and contrasting text for laneId, color in pairs(laneColorMap) do - table.insert(diagramLines, string.format(' classDef lane_%s fill:%s,stroke:#333,stroke-width:2px,color:#000', laneId, color)) + table.insert(diagramLines, + string.format(' classDef lane_%s fill:%s,stroke:#333,stroke-width:2px,color:#000', laneId, color)) end - + -- Add nodes for _, nodeStr in pairs(nodes) do table.insert(diagramLines, nodeStr) end - + -- Add edges for _, edgeStr in pairs(edges) do table.insert(diagramLines, edgeStr) end - + -- Apply classes to nodes for nodeId in pairs(nodes) do local laneId = nodeId:match("(.+)_[0-9]+$") @@ -576,9 +590,10 @@ function GlobalStageManager:PrintMermaidStage() table.insert(diagramLines, string.format(' class %s lane_%s', nodeId, laneId)) end end - + -- Print as single multi-line message - local diagram = "========== STAGE FLOW DIAGRAM ==========\n" .. table.concat(diagramLines, "\n") .. "\n========== END DIAGRAM ==========" + local diagram = "========== STAGE FLOW DIAGRAM ==========\n" .. + table.concat(diagramLines, "\n") .. "\n========== END DIAGRAM ==========" self.logger:info(diagram) end @@ -586,10 +601,10 @@ end ---@param stageNumber number ---@param stageLaneIdentifier string? nil for default lan ---@return boolean | nil -GlobalStageManager.isStageComplete = function (stageNumber, stageLaneIdentifier) - +GlobalStageManager.isStageComplete = function(stageNumber, stageLaneIdentifier) if singletonInstance == nil then - Logger.new("StageManager", "INFO"):warn("GlobalStageManager.isStageComplete called before GlobalStageManager was initialized. Returning nil") + Logger.new("StageManager", "INFO"):warn( + "GlobalStageManager.isStageComplete called before GlobalStageManager was initialized. Returning nil") return nil end diff --git a/src/classes/stageClasses/Groups/SpearheadGroup.lua b/src/classes/stageClasses/Groups/SpearheadGroup.lua index efccb30..a1e17d2 100644 --- a/src/classes/stageClasses/Groups/SpearheadGroup.lua +++ b/src/classes/stageClasses/Groups/SpearheadGroup.lua @@ -41,7 +41,7 @@ end function SpearheadGroup:SpawnCorpsesOnly() if self._isSpawned == true then return end - + self._spawnManager:SpawnCorpsesOnly(self._groupName) self._isSpawned = true @@ -57,7 +57,7 @@ function SpearheadGroup:Spawn(lateStart) uncontrolled = lateStart, } - local spawnedObject, isStatic = self._spawnManager:SpawnGroup(self._groupName, overrides, self._isPersistent) + local _, isStatic = self._spawnManager:SpawnGroup(self._groupName, overrides, self._isPersistent) self._isStatic = isStatic self._isSpawned = true end @@ -91,13 +91,13 @@ function SpearheadGroup:GetCoalition() end ---comment ----@return table result list of objects +---@return Array result list of objects function SpearheadGroup:GetObjects() - + ---@type Array local result = {} if self._isStatic == true then local staticObject = StaticObject.getByName(self._groupName) - if staticObject then + if staticObject then table.insert(result, staticObject) end else @@ -105,7 +105,7 @@ function SpearheadGroup:GetObjects() if not group then return {} end for _, unit in pairs(group:getUnits()) do table.insert(result, unit) - end + end end return result end @@ -123,7 +123,7 @@ function SpearheadGroup:GetAsUnits() if not group then return {} end for _, unit in pairs(group:getUnits()) do table.insert(result, unit) - end + end return result end @@ -133,7 +133,7 @@ function SpearheadGroup:GetAllUnitPositions() local result = {} if self._isStatic == true then local staticObject = StaticObject.getByName(self._groupName) - if staticObject then + if staticObject then table.insert(result, staticObject:getPoint()) end else @@ -141,7 +141,7 @@ function SpearheadGroup:GetAllUnitPositions() if not group then return {} end for _, unit in pairs(group:getUnits()) do table.insert(result, unit:getPoint()) - end + end end return result end diff --git a/src/classes/stageClasses/SpecialZones/BlueSam.lua b/src/classes/stageClasses/SpecialZones/BlueSam.lua index 1723fec..5e19b78 100644 --- a/src/classes/stageClasses/SpecialZones/BlueSam.lua +++ b/src/classes/stageClasses/SpecialZones/BlueSam.lua @@ -50,16 +50,10 @@ function BlueSam.New(database, logger, zoneName, spawnManager) ---@type table local redUnitsPos = {} - - local buildable = false - if self._buildableCrateKilos and self._buildableCrateKilos > 0 then - buildable = true - end - for _, groupName in pairs(blueSamData.groups) do local spearheadGroup = SpearheadGroup.New(groupName, spawnManager, true) if spearheadGroup then - + if spearheadGroup:GetCoalition() == 2 or spearheadGroup:GetCoalition() == 0 then table.insert(self._blueGroups, spearheadGroup) end @@ -78,7 +72,7 @@ function BlueSam.New(database, logger, zoneName, spawnManager) --Cleanup units local cleanup_distance = 5 - for blueUnitName, blueUnitPos in pairs(blueUnitsPos) do + for _, blueUnitPos in pairs(blueUnitsPos) do for redUnitName, redUnitPos in pairs(redUnitsPos) do local distance = Util.VectorDistance3d(blueUnitPos, redUnitPos) if distance <= cleanup_distance then @@ -140,7 +134,9 @@ end function BlueSam:SpawnGroups() for unitName, needsCleanup in pairs(self._cleanupUnits) do - DcsUtil.DestroyUnit(unitName) + if needsCleanup then + DcsUtil.DestroyUnit(unitName) + end end for _, group in pairs(self._blueGroups) do diff --git a/src/classes/stageClasses/SpecialZones/FarpZone.lua b/src/classes/stageClasses/SpecialZones/FarpZone.lua index 74b329d..b888fd5 100644 --- a/src/classes/stageClasses/SpecialZones/FarpZone.lua +++ b/src/classes/stageClasses/SpecialZones/FarpZone.lua @@ -42,11 +42,11 @@ function FarpZone.New(database, logger, zoneName, spawnManager) self._groups = {} self._padNames = {} self._supplyHubs = {} - + if farpData then self._padNames = farpData.padNames - + for _, supplyHubName in pairs(farpData.supplyHubNames) do local supplyHub = SupplyHub.new(database, logger, supplyHubName) if supplyHub then @@ -55,7 +55,7 @@ function FarpZone.New(database, logger, zoneName, spawnManager) end - for _, groupName in pairs(farpData.groups) do + for _, groupName in pairs(farpData.groups) do local group = SpearheadGroup.New(groupName, spawnManager, true) table.insert(self._groups, group) group:Destroy() diff --git a/src/classes/stageClasses/SpecialZones/StageBase.lua b/src/classes/stageClasses/SpecialZones/StageBase.lua index 552b98f..7e35f69 100644 --- a/src/classes/stageClasses/SpecialZones/StageBase.lua +++ b/src/classes/stageClasses/SpecialZones/StageBase.lua @@ -90,7 +90,7 @@ function StageBase.New(databaseManager, logger, airbaseName, spawnManager) local cleanup_distance = 5 - for blueUnitName, blueUnitPos in pairs(blueUnitsPos) do + for _, blueUnitPos in pairs(blueUnitsPos) do for redUnitName, redUnitPos in pairs(redUnitsPos) do local distance = Util.VectorDistance3d(blueUnitPos, redUnitPos) if distance <= cleanup_distance then @@ -113,6 +113,7 @@ end function StageBase:SpawnRedUnits() ---comment ---@param groups Array + ---@return number|nil local spawnAsync = function(groups) for _, group in pairs(groups) do group:Spawn() @@ -142,6 +143,7 @@ end function StageBase:SpawnBlueUnits() ---comment ---@param groups Array + ---@return number|nil local spawnAsync = function(groups) for _, group in pairs(groups) do group:Spawn() @@ -172,7 +174,7 @@ function StageBase:ActivateBlueStage() else self:FinaliseBlueStage() end - + end function StageBase:FinaliseBlueStage() diff --git a/src/classes/stageClasses/SpecialZones/SupplyHub.lua b/src/classes/stageClasses/SpecialZones/SupplyHub.lua index c05aba5..b9d49dd 100644 --- a/src/classes/stageClasses/SpecialZones/SupplyHub.lua +++ b/src/classes/stageClasses/SpecialZones/SupplyHub.lua @@ -42,7 +42,7 @@ function SupplyHub.new(database, logger, zoneName) end self._zone = DcsUtil.getZoneByName(zoneName) - + self._supplyUnitsTracker = SupplyUnitsTracker.getOrCreate() self._inZone = {} self._missionCommandsHelper = MissionCommandsHelper.getOrCreate() diff --git a/src/classes/stageClasses/SpecialZones/abstract/BuildableZone.lua b/src/classes/stageClasses/SpecialZones/abstract/BuildableZone.lua index 38fcada..abff446 100644 --- a/src/classes/stageClasses/SpecialZones/abstract/BuildableZone.lua +++ b/src/classes/stageClasses/SpecialZones/abstract/BuildableZone.lua @@ -37,6 +37,7 @@ function BuildableZone:New(targetZone, kilosRequired, crateType, buildableGroup ---@param params UnpackCrateParam ---@param time number + ---@return number|nil local startUnpackingCrate = function(params, time) local unpacked = params.unpackedKilos + (params.kilosPerSecond * 2) local alreadySpawned = params.unpackedItems / params.groupsPerKilo @@ -50,7 +51,7 @@ function BuildableZone:New(targetZone, kilosRequired, crateType, buildableGroup if params.unpackedKilos >= params.kilos or spawned == false then return end - + return time + 0.5 end @@ -76,8 +77,6 @@ function BuildableZone:New(targetZone, kilosRequired, crateType, buildableGroup self._buildableMission = nil end - - if self._buildableMission == nil then self._buildableLogger:debug("No buildable mission for zone: " .. targetZone.name) end @@ -99,25 +98,14 @@ function BuildableZone:OnBuildingComplete() end ---@field unpackedItems number ---@field unpackedKilos number ----@param mission BuildableMission? +---@param _ BuildableMission? ---@param kilos number -function BuildableZone:OnCrateDroppedOff(mission, kilos) +function BuildableZone:OnCrateDroppedOff(_, kilos) self._buildableLogger:debug("Crate dropped off in zone: " .. self._targetZone.name) - local timeToUnpack = (kilos / 500) * 15 - - ---@type UnpackCrateParam - local params = { - self = self, - groupsPerKilo = self._groupsPerKilo, - unpackedItems = 0, - kilosPerSecond = kilos/timeToUnpack, - unpackedKilos = 0, - kilos = kilos - } - ---@param params UnpackCrateParam ---@param time number + ---@return number|nil local startUnpackingCrate = function(params, time) local unpacked = params.unpackedKilos + (params.kilosPerSecond * 2) local alreadySpawned = params.unpackedItems / params.groupsPerKilo @@ -132,10 +120,21 @@ function BuildableZone:OnCrateDroppedOff(mission, kilos) params.self:FinaliseCrate(params.kilos) return end - + return time + 2 end + local timeToUnpack = (kilos / 500) * 15 + ---@type UnpackCrateParam + local params = { + self = self, + groupsPerKilo = self._groupsPerKilo, + unpackedItems = 0, + kilosPerSecond = kilos/timeToUnpack, + unpackedKilos = 0, + kilos = kilos + } + timer.scheduleFunction(startUnpackingCrate, params, timer.getTime() + 2) end @@ -190,7 +189,7 @@ function BuildableZone:SpawnAmount(amount) return nil end - for i = 1, amount do + for _ = 1, amount do local spawned = spawnOne() if spawned ~= true then self._buildableLogger:debug("No more groups to spawn in zone: " .. self._targetZone.name) diff --git a/src/classes/stageClasses/StageLane.lua b/src/classes/stageClasses/StageLane.lua index c8a6441..74448ba 100644 --- a/src/classes/stageClasses/StageLane.lua +++ b/src/classes/stageClasses/StageLane.lua @@ -4,8 +4,8 @@ ---@field private _isDefaultStageLane boolean ---@field private _stageLaneIdentifier string ---@field private _activeStageIndex number ----@field private _stagesInLaneByIndex table> ----@field private _chapterStarts table? +---@field private _stagesInLaneByIndex table> +---@field private _chapterStarts table? ---@field private _stageLaneState StageLaneState ---@field private _maxStageIndex number local StageLane = {} @@ -16,6 +16,7 @@ StageLane.__index = StageLane ---| "BetweenChapters" ---| "Completed" +---@type string? StageLane.DefaultLaneKey = nil function StageLane.New(laneIdentifier) @@ -37,21 +38,21 @@ end ---@param stage Stage function StageLane:AddStage(stage) local stageIndex = stage:GetStageIndex() - if not self._stagesInLaneByIndex[stageIndex] then - self._stagesInLaneByIndex[stageIndex] = {} + if not self._stagesInLaneByIndex[tostring(stageIndex)] then + self._stagesInLaneByIndex[tostring(stageIndex)] = {} end if not self._maxStageIndex or stageIndex > self._maxStageIndex then self._maxStageIndex = stageIndex end - table.insert(self._stagesInLaneByIndex[stageIndex], stage) + table.insert(self._stagesInLaneByIndex[tostring(stageIndex)], stage) end ---@param stageNumber number ---@return boolean? function StageLane:IsStageIndexComplete(stageNumber) - local stages = self._stagesInLaneByIndex[stageNumber] + local stages = self._stagesInLaneByIndex[tostring(stageNumber)] if not stages then return nil end @@ -88,7 +89,7 @@ end ---@param stageNumber number function StageLane:SetActiveStageIndex(stageNumber) - if self._stagesInLaneByIndex[stageNumber] == nil then + if self._stagesInLaneByIndex[tostring(stageNumber)] == nil then self._stageLaneState = "BetweenChapters" -- stage number is not in this lane, so we are between chapters elseif stageNumber > self._maxStageIndex then self._stageLaneState = "Completed" -- stage number is beyond the max stage index @@ -108,6 +109,7 @@ end --- Chapter starts are the first StageIndex after a gap in stage numbers.
--- For example, if the stage numbers are 1, 2, 3, 5, 6, 7, then stage number 5 is a chapter start because there is a gap between 3 and 5.
---@param stageNumber number +---@return boolean function StageLane:IsChapterStart(stageNumber) if self._chapterStarts == nil then @@ -123,13 +125,14 @@ end function StageLane:FillChapterStarts() local previousIndex = nil + ---@type table local stageIndices = {} for stageIndex, _ in pairs(self._stagesInLaneByIndex) do table.insert(stageIndices, tonumber(stageIndex)) end table.sort(stageIndices) - self._chapterStarts = self._chapterStarts or {} + if self._chapterStarts == nil then self._chapterStarts = {} end for _, stageIndex in ipairs(stageIndices) do if previousIndex == nil then -- First stage is always a chapter start @@ -158,7 +161,7 @@ end ---@param stageIndex number ---@return Array? function StageLane:GetStagesAtIndex(stageIndex) - return self._stagesInLaneByIndex[stageIndex] + return self._stagesInLaneByIndex[tostring(stageIndex)] end ---@return number? diff --git a/src/classes/stageClasses/StageRepository.lua b/src/classes/stageClasses/StageRepository.lua index 31f8840..a66ab5e 100644 --- a/src/classes/stageClasses/StageRepository.lua +++ b/src/classes/stageClasses/StageRepository.lua @@ -49,7 +49,6 @@ end function StageRepository:AddStage(stage) local stageLaneIdentifier = stage:GetStageLaneIdentifier() or StageLane.DefaultLaneKey - if self.StageLanes[tostring(stageLaneIdentifier)] == nil then self.StageLanes[tostring(stageLaneIdentifier)] = StageLane.New(stageLaneIdentifier) end diff --git a/src/classes/stageClasses/Stages/BaseStage/Stage.lua b/src/classes/stageClasses/Stages/BaseStage/Stage.lua index 69d2f4f..2a14a3d 100644 --- a/src/classes/stageClasses/Stages/BaseStage/Stage.lua +++ b/src/classes/stageClasses/Stages/BaseStage/Stage.lua @@ -105,7 +105,7 @@ function Stage:superNew(database, stageConfig, logger, initData, stageType, miss end self.stageName = initData.stageDisplayName self._stageType = stageType - + self.OnPostStageComplete = nil self.OnPostBlueActivated = nil @@ -160,25 +160,26 @@ function Stage:superNew(database, stageConfig, logger, initData, stageType, miss self._logger:info("Initiating new Stage with name: " .. self.zoneName) ---comment - ---@param self Stage + ---@param selfA Stage ---@param time number? - self.CheckContinuousAsync = function (self, time) - - self:CheckAndUpdateSelf() - if self:IsComplete() == true then - self:NotifyComplete() + ---@return number|nil + self.CheckContinuousAsync = function (selfA, time) + + selfA:CheckAndUpdateSelf() + if selfA:IsComplete() == true then + selfA:NotifyComplete() return nil end return time + 20 end - + do -- load tables local missionZones = database:getMissionsForStage(self.zoneName) self._logger:debug("Found " .. Util.tableLength(missionZones) .. " mission zones for stage: " .. self.zoneName) for _, missionZone in pairs(missionZones) do - + local mission = ZoneMission.new(missionZone, self._missionPriority, database, logger, self, spawnManager) if mission then self._db.missionsByCode[mission.code] = mission @@ -233,7 +234,7 @@ function Stage:superNew(database, stageConfig, logger, initData, stageType, miss table.insert(self._db.missions, mission) end end - else + else self._logger:info("Using persisted random mission with name: " .. missionName .. " and zone: " .. missionZonePicked) for _, mission in pairs(missions) do if string.lower(mission.zoneName) == string.lower(missionZonePicked) then @@ -284,14 +285,14 @@ end function Stage:IsComplete() if self._currentStageState >= StageState.Blue then return true end - for i, mission in pairs(self._db.sams) do + for _, mission in pairs(self._db.sams) do local state = mission:getState() if state == "ACTIVE" or state == "NEW" or state =="WAITING" then return false end end - for i, mission in pairs(self._db.missions) do + for _, mission in pairs(self._db.missions) do local state = mission:getState() if state == "ACTIVE" or state == "NEW" then return false @@ -325,7 +326,9 @@ function Stage:GetStageName() return self.stageName end +---@return Array function Stage:GetMissions() + ---@type Array local missions = {} for _, mission in pairs(self._db.missions) do table.insert(missions, mission) @@ -370,9 +373,9 @@ function Stage:CheckAndUpdateSelf() local availableMissionsCount = Util.tableLength(getAvailableMissions()) local activeCount = getActiveMissionsCount() if activeCount < max and availableMissionsCount > 0 then - for i = activeCount+1, max do + for _ = activeCount+1, max do if availableMissionsCount == 0 then - i = max+1 --exits this loop + break else local mission = Util.randomFromList(getAvailableMissions()) --[[@as Mission]] if mission then @@ -426,7 +429,7 @@ function Stage:PreActivate() end self._currentStageState = StageState.PreActivated - for key, mission in pairs(self._db.sams) do + for _, mission in pairs(self._db.sams) do if mission then mission:SpawnInactive() end @@ -473,7 +476,7 @@ function Stage:MarkStage() drawing.colorString = DrawingHelper.ColorTableToColorString(Stage.StageColors.INVISIBLE) drawing.style = "no line" end - + return drawing end) self._customDrawing:Draw() @@ -585,12 +588,12 @@ function Stage:OnStageNumberChanged(number, stageLaneIdentifier) if needsBlueActivation() == true then self:ActivateBlueStage() end - + end ---@param self Stage ----@param mission Mission -Stage.OnMissionComplete = function(self, mission) +---@param _ Mission +Stage.OnMissionComplete = function(self, _) self:CheckAndUpdateSelf() end @@ -645,7 +648,7 @@ function Stage:GetStageStats() end end - for _, mission in pairs(self._db.sams) do + for _, _ in pairs(self._db.sams) do dead = dead + 1 end @@ -673,13 +676,14 @@ function Stage:ActivateBlueStage() miscGroup:Spawn() end - ---@param self Stage - local ActivateBlueAsync = function(self) + ---@param selfA Stage + ---@return number|nil + local ActivateBlueAsync = function(selfA) pcall(function() - self:MarkStage() + selfA:MarkStage() end) - self:ActivateBlueGroups() + selfA:ActivateBlueGroups() return nil end diff --git a/src/classes/stageClasses/Stages/ExtraStage.lua b/src/classes/stageClasses/Stages/ExtraStage.lua index b14bd17..d8dc033 100644 --- a/src/classes/stageClasses/Stages/ExtraStage.lua +++ b/src/classes/stageClasses/Stages/ExtraStage.lua @@ -23,10 +23,9 @@ function ExtraStage.New(database, stageConfig, logger, initData, spawnManager) self:superNew(database, stageConfig, logger, initData, "ExtraStage", "secondary", spawnManager) self.OnPostBlueActivated = function (selfStage) - selfStage:MarkStage() end - + self.OnPostStageComplete = function (selfStage) selfStage:ActivateBlueStage() end @@ -48,7 +47,6 @@ function ExtraStage:OnStageNumberChanged(number, stageLaneIdentifier) return end - local previousActive = self._activeStage self._activeStage = number if self.stageNumber - self._activeStage == self._stageConfig.AmountPreactivateStage then @@ -62,7 +60,7 @@ function ExtraStage:OnStageNumberChanged(number, stageLaneIdentifier) self:ActivateStage() end - if self._currentStageState == StageState.BLUE then + if self._currentStageState == StageState.Blue then self:ActivateBlueStage() end diff --git a/src/classes/stageClasses/Stages/WaitingStage.lua b/src/classes/stageClasses/Stages/WaitingStage.lua index a803a8a..4b722b6 100644 --- a/src/classes/stageClasses/Stages/WaitingStage.lua +++ b/src/classes/stageClasses/Stages/WaitingStage.lua @@ -25,7 +25,7 @@ function WaitingStage.New(database, stageConfig, logger, initData, waitingSecond self._startTime = nil self.CheckContinuousAsync = function (selfA, time) - + if selfA:IsComplete() == true then selfA:NotifyComplete() return nil @@ -47,7 +47,7 @@ function WaitingStage:ActivateStage() timer.scheduleFunction(self.CheckContinuousAsync, self, self._startTime + self._waitTimeSeconds) end -function WaitingStage:IsComplete() +function WaitingStage:IsComplete() if timer.getTime() > (self._startTime + self._waitTimeSeconds) then return true end return false end @@ -56,12 +56,12 @@ function WaitingStage:OnStageNumberChanged() self._logger:debug("Waiting Stage OnStageNumberChanged override") end -function WaitingStage:MarkStage(stageColor) +function WaitingStage:MarkStage(_) self._logger:debug("Waiting Stage MarkStage override") end function WaitingStage:GetExpectedTime() - return self._startTime + self._waitTimeSeconds + return self._startTime + self._waitTimeSeconds end return WaitingStage diff --git a/src/classes/stageClasses/drawings/CustomDrawing.lua b/src/classes/stageClasses/drawings/CustomDrawing.lua index e902158..a768145 100644 --- a/src/classes/stageClasses/drawings/CustomDrawing.lua +++ b/src/classes/stageClasses/drawings/CustomDrawing.lua @@ -1,7 +1,5 @@ local DrawingHelper = require("classes.stageClasses.drawings.helper.DrawingHelper") -local Util = require("classes.util.Util") local Logger = require("classes.util.Logger") -local MissionEditorWarnings = require("classes.util.MissionEditorWarnings") local drawingLogger = Logger.new("CustomDrawing") diff --git a/src/classes/stageClasses/drawings/helper/DrawingHelper.lua b/src/classes/stageClasses/drawings/helper/DrawingHelper.lua index d356d59..8c7a59c 100644 --- a/src/classes/stageClasses/drawings/helper/DrawingHelper.lua +++ b/src/classes/stageClasses/drawings/helper/DrawingHelper.lua @@ -1,4 +1,3 @@ -local Util = require("classes.util.Util") local DcsUtil = require("classes.util.DcsUtil") local Logger = require("classes.util.Logger") local GlobalConfig = require("classes.configuration.GlobalConfig") @@ -55,7 +54,7 @@ local function MarkupToAll(shapeID, drawID, points, fillColor, lineColor, lineS if lineThickness == nil or lineThickness <= 0 then lineStyle = 0 end - + ---@type string local functionString = "trigger.action.markupToAll(" .. shapeID .. ", -1, " .. drawID .. "," for _, point in pairs(points) do @@ -78,7 +77,7 @@ local function MarkupToAll(shapeID, drawID, points, fillColor, lineColor, lineS end trigger.action.setMarkupColor(drawID, lineColor) trigger.action.setMarkupTypeLine(drawID, lineStyle) - + end ---@private @@ -126,14 +125,14 @@ function DrawingHelper.DrawPolygon(object) local fillColor = DrawingHelper.ColorToColorTable(free.fillColorString) local color = DrawingHelper.ColorToColorTable(free.colorString) local lineStyle = DrawingHelper.ToLineStyleInteger(free.style) - + ---@type Array local keys = {} for k, _ in pairs(free.points) do table.insert(keys, k) end table.sort(keys, function(a, b) return a < b end) - + ---@type Array local points = {} for _, k in ipairs(keys) do local point = free.points[k] @@ -201,7 +200,7 @@ function DrawingHelper.DrawLine(object) ---@type Array local points = {} - local ids = {} + local ids = {} for _, point in ipairs(object.points) do table.insert(points, { x = object.mapX + point.x, y = 0, z = object.mapY + point.y } ) @@ -265,7 +264,7 @@ function DrawingHelper.ColorTableToColorString(rgba) logger:warn("ColorTableToColorString called with invalid rgba table, returning default color string '0x00000000'") return "0x00000000" end - + local r = string.format("%02X", math.floor(rgba[1] * 255)) local g = string.format("%02X", math.floor(rgba[2] * 255)) local b = string.format("%02X", math.floor(rgba[3] * 255)) @@ -275,6 +274,7 @@ function DrawingHelper.ColorTableToColorString(rgba) end ---@param lineStyle string +---@return integer function DrawingHelper.ToLineStyleInteger(lineStyle) lineStyle = lineStyle:lower() if lineStyle == "no line" then diff --git a/src/classes/stageClasses/helpers/BattleManager.lua b/src/classes/stageClasses/helpers/BattleManager.lua index dc855bb..1af72fd 100644 --- a/src/classes/stageClasses/helpers/BattleManager.lua +++ b/src/classes/stageClasses/helpers/BattleManager.lua @@ -1,6 +1,5 @@ local Logger = require("classes.util.Logger") local Util = require("classes.util.Util") -local DcsUtil = require("classes.util.DcsUtil") ---@class BattleManager ---@field private _name string @@ -13,8 +12,6 @@ local DcsUtil = require("classes.util.DcsUtil") local BattleManager = {} BattleManager.__index = BattleManager -local debugDrawing = false - ---@param redGroups Array ---@param blueGroups Array ---@param name string @@ -30,8 +27,8 @@ function BattleManager.New(redGroups, blueGroups, name, logLevel) self._redGroups = redGroups self._blueGroups = blueGroups - self._logger:debug("BattleManager created with name: " .. self._name - .. ", red groups: " .. #self._redGroups + self._logger:debug("BattleManager created with name: " .. self._name + .. ", red groups: " .. #self._redGroups .. ", blue groups: " .. #self._blueGroups) return self @@ -39,6 +36,7 @@ end ---@param self BattleManager ---@param time number +---@return number? local function CheckTask(self, time) local interval = self:Update() if not interval then return end @@ -90,8 +88,6 @@ function BattleManager:Update() self._logger:debug("BattleManager Update called for " .. self._name) - local shootChance = 1 -- Adjust this value to control the shooting probability (0.0 to 1.0) - self:LetUnitsShoot(self._redGroups, self._blueGroups) self:LetUnitsShoot(self._blueGroups, self._redGroups) @@ -136,7 +132,7 @@ function BattleManager:LetUnitsShoot(groups, targetGroups) expendQtyEnabled = true } } - + local controller = unit:getController() if controller then controller:setTask(shootTask) @@ -146,14 +142,14 @@ function BattleManager:LetUnitsShoot(groups, targetGroups) end end end -end +end ---@param unit Unit ---@return number ---@return number function BattleManager:getBestAmmo(unit) - local ammo = unit:getAmmo() + local ammo = unit:getAmmo() --[[@as table]] if not ammo then return 3221225470, 1 end -- Default ammo if no ammo is found @@ -167,9 +163,9 @@ function BattleManager:getBestAmmo(unit) end end - local entry = Util.randomFromList(shells) + local entry = Util.randomFromList(shells) --[[@as table]] if entry and entry.desc and entry.desc.warhead then - local caliber = entry.desc.warhead.caliber + local caliber = entry.desc.warhead.caliber --[[@as number]] if caliber > 50 then return 258503344128, 1 else @@ -196,7 +192,7 @@ function BattleManager:IsUnitApplicable(unit) end return true - + end ---@private @@ -214,6 +210,7 @@ function BattleManager:ToShootingHulls(groups) end local hulls = Util.getSeparatedConvexHulls(points, 50) + ---@type Array> local enlargedHulls = {} for _, hull in pairs(hulls) do local enlarged = Util.enlargeConvexHull(hull, 25) @@ -236,7 +233,7 @@ end ---@param groupHulls Array> ---@return Vec2? function BattleManager:GetRandomPoint(origin, groupHulls) - + local hull = Util.randomFromList(groupHulls) --[[@as Array]] if not hull then return nil end local shootPoints = Util.GetTangentHullPointsFromOrigin(hull, origin) diff --git a/src/classes/stageClasses/helpers/MissionCommandsHelper.lua b/src/classes/stageClasses/helpers/MissionCommandsHelper.lua index b9f33fb..ff7798c 100644 --- a/src/classes/stageClasses/helpers/MissionCommandsHelper.lua +++ b/src/classes/stageClasses/helpers/MissionCommandsHelper.lua @@ -7,7 +7,7 @@ local SupplyConfigHelper = require("classes.stageClasses.helpers.SupplyConfigHel local StageConfig = require("classes.configuration.StageConfig") ----@class MissionCommandsHelper +---@class MissionCommandsHelper : OnPlayerEnterUnitListener ---@field missionsByCode table @table of missions by their code ---@field enabledByCode table @table of enabled missions by their code ---@field updateNeeded boolean @flag to indicate if an update is needed @@ -31,8 +31,6 @@ local function sortMissions(list, groupPos) end) end -local id = 0 - local instance = nil ---@return MissionCommandsHelper @@ -57,16 +55,16 @@ function MissionCommandsHelper.getOrCreate() instance._supplyUnitsTracker:AddOnSupplyUnitEventListener( { - enteredSupplyHub = function(self, unit) + enteredSupplyHub = function(_, unit) if unit == nil then return end instance.updateNeeded = true instance:updateCommandsForGroup(unit:getGroup():getID()) end, - exitedSupplyHub = function(self, unit) + exitedSupplyHub = function(_, unit) instance.updateNeeded = true instance:updateCommandsForGroup(unit:getGroup():getID()) end, - supplyUnitSpawned = function(self, unit) + supplyUnitSpawned = function(_, unit) instance.updateNeeded = true instance:updateCommandsForGroup(unit:getGroup():getID()) end @@ -371,7 +369,7 @@ function MissionCommandsHelper:AddAllMissionCommandsToGroup(groupID) do --- secondary missions local count = 0 local path = { [1] = folderNames.secondary } - + ---@type Array local secondaryMissions = {} for code, enabled in pairs(self.enabledByCode) do if enabled == true then @@ -509,7 +507,6 @@ function MissionCommandsHelper:AddCargoCommands(groupID) local unloadCargoCommand = function(params) local unitID = params.unitID local crateType = params.crateType - local supplyUnitsTracker = params.supplyUnitsTracker params.supplyUnitsTracker:UnloadRequested(unitID, crateType, params.commandHelper) end @@ -518,7 +515,7 @@ function MissionCommandsHelper:AddCargoCommands(groupID) for cargoType, amount in pairs(cargo) do local cargoConfig = SupplyConfigHelper.getSupplyConfig(cargoType) if cargoConfig then - for i = 1, amount do + for _ = 1, amount do local path = { [1] = folderNames.cargo } ---@type UnloadCargoCommandParams local params = { unitID = unit:getID(), crateType = cargoType, supplyUnitsTracker = self diff --git a/src/classes/stageClasses/helpers/SupplyConfigHelper.lua b/src/classes/stageClasses/helpers/SupplyConfigHelper.lua index 885bd87..379a795 100644 --- a/src/classes/stageClasses/helpers/SupplyConfigHelper.lua +++ b/src/classes/stageClasses/helpers/SupplyConfigHelper.lua @@ -83,7 +83,8 @@ function SupplyConfigHelper.fromObjectName(name) return nil end ----@param type CrateType +---@param type CrateType +---@return SupplyConfig? function SupplyConfigHelper.getSupplyConfig(type) return SupplyConfig[type] end diff --git a/src/classes/stageClasses/helpers/SupplyLoadConfig.lua b/src/classes/stageClasses/helpers/SupplyLoadConfig.lua index 90b42db..dd0d528 100644 --- a/src/classes/stageClasses/helpers/SupplyLoadConfig.lua +++ b/src/classes/stageClasses/helpers/SupplyLoadConfig.lua @@ -29,7 +29,7 @@ local SupplyLoadConfig = { { centerAngle = 270, angleWidth = 60, minRadius = 15, maxRadius = 50, spacing = 5 }, { centerAngle = 90, angleWidth = 60, minRadius = 15, maxRadius = 50, spacing = 5 }, } - }, + }, ["UH-1H"] = { maxInternalLoad = 2000, dropZones = { diff --git a/src/classes/stageClasses/helpers/SupplyUnitsTracker.lua b/src/classes/stageClasses/helpers/SupplyUnitsTracker.lua index e83a582..092bbc0 100644 --- a/src/classes/stageClasses/helpers/SupplyUnitsTracker.lua +++ b/src/classes/stageClasses/helpers/SupplyUnitsTracker.lua @@ -10,7 +10,7 @@ local SupplyLoadConfig = require("classes.stageClasses.helpers.SupplyLoadConfig" ---@field enteredSupplyHub fun(self:SupplyUnitEventListener, unit:Unit, hub:SupplyHub) | nil ---@field exitedSupplyHub fun(self:SupplyUnitEventListener, unit:Unit, hub:SupplyHub) | nil ----@class SupplyUnitsTracker +---@class SupplyUnitsTracker : OnPlayerEnterUnitListener ---@field private _supplyUnitsByName table ---@field private _cargoInUnits table> ---@field private _logger Logger @@ -43,6 +43,8 @@ function SupplyUnitsTracker.getOrCreate() SpearheadEvents.AddOnPlayerEnterUnitListener(singleton) ---@param selfA SupplyUnitsTracker + ---@param time number + ---@return number? local function updateTask(selfA, time) selfA:Update() @@ -134,6 +136,7 @@ end ---@private ---@param unit Unit +---@return boolean function SupplyUnitsTracker:IsSupplyUnit(unit) if unit == nil then return false end @@ -158,15 +161,17 @@ function SupplyUnitsTracker:AddCargoToUnit(unitID, crateType) local unit = DcsUtil.GetPlayerUnitByID(unitID) if unit == nil then return end - if self._cargoInUnits[unitID] == nil then - self._cargoInUnits[unitID] = {} + local unitIdStr = tostring(unitID) + + if self._cargoInUnits[unitIdStr] == nil then + self._cargoInUnits[unitIdStr] = {} end - if self._cargoInUnits[unitID][crateType] == nil then - self._cargoInUnits[unitID][crateType] = 0 + if self._cargoInUnits[unitIdStr][crateType] == nil then + self._cargoInUnits[unitIdStr][crateType] = 0 end - self._cargoInUnits[unitID][crateType] = self._cargoInUnits[unitID][crateType] + 1 + self._cargoInUnits[unitIdStr][crateType] = self._cargoInUnits[unitIdStr][crateType] + 1 end @@ -185,7 +190,7 @@ function SupplyUnitsTracker:RemoveCargoFromUnit(unitID, crateType) self._cargoInUnits[unitIDStr][crateType] = self._cargoInUnits[unitIDStr][crateType] - 1 local hasCargo = false - for type, count in pairs(self._cargoInUnits[unitIDStr]) do + for _, count in pairs(self._cargoInUnits[unitIDStr]) do if count > 0 then hasCargo = true break @@ -216,13 +221,11 @@ end function SupplyUnitsTracker:CheckUnitsInZones() - for name, unit in pairs(self._supplyUnitsByName) do + for _, unit in pairs(self._supplyUnitsByName) do if unit ~= nil and unit:isExist() == true then self._logger:debug("Checking unit: " .. unit:getName()) local pos = unit:getPoint() - local group = unit:getGroup() - for hub, enabled in pairs(self._registeredHubs) do if enabled == true then local zone = hub:GetZone() @@ -238,7 +241,7 @@ function SupplyUnitsTracker:CheckUnitsInZones() end) end end - + else if self._unitInSupplyHub[tostring(unit:getID())] == true then self._unitInSupplyHub[tostring(unit:getID())] = false @@ -255,7 +258,7 @@ function SupplyUnitsTracker:CheckUnitsInZones() end end - self._unitPositions[unit:getID()] = pos + self._unitPositions[tostring(unit:getID())] = pos end end end @@ -292,11 +295,11 @@ local cargoCount = 0 ---@param crateType CrateType ---@param missionCommandsHelper MissionCommandsHelper function SupplyUnitsTracker:UnloadRequested(unitID, crateType, missionCommandsHelper) - + self._logger:debug("Unload requested for unit: " .. unitID .. " crateType: " .. crateType) local unit = DcsUtil.GetPlayerUnitByID(unitID) - if unit == nil or unit:isExist() == false then + if unit == nil or unit:isExist() == false then self._logger:warn("Unload requested for non-existent unit: " .. unitID) return end @@ -305,7 +308,7 @@ function SupplyUnitsTracker:UnloadRequested(unitID, crateType, missionCommandsHe self._logger:warn("Unload requested for unit with no group: " .. unit:getName()) return end - + local cargoConfig = SupplyConfigHelper.getSupplyConfig(crateType) if cargoConfig == nil then @@ -325,6 +328,7 @@ function SupplyUnitsTracker:UnloadRequested(unitID, crateType, missionCommandsHe self:UpdateWeightForUnit(unit) cargoCount = cargoCount + 1 + ---@type {name: string, type: string, x: number, y: number} local cargoSpawnObject = { name = crateType .. "_" .. cargoCount, type = cargoConfig.staticType, @@ -362,11 +366,11 @@ function SupplyUnitsTracker:UnitRequestCrateLoading(groupID, crateType, missionC end local unit = group:getUnit(1) - + if unit == nil then return end if unit:isExist() == false then return end - + if unit:inAir() == true then trigger.action.outTextForUnit(unit:getID(), "Land first before crates can be loaded", 10) return @@ -383,7 +387,7 @@ function SupplyUnitsTracker:UnitRequestCrateLoading(groupID, crateType, missionC ---@param params LoadCargoParams local LoadCrateTask = function(params) - + local loaded = params.self:TryLoadCrateInUnit(params.unit, params.crateType, params.commandHelper) if loaded ~= false then trigger.action.outTextForUnit(unit:getID(), "Loaded crate :" .. params.crateType, 10) @@ -410,7 +414,7 @@ end ---@param commandHelper MissionCommandsHelper ---@return boolean function SupplyUnitsTracker:TryLoadCrateInUnit(unit, crateType, commandHelper) - + local crateConfigA = SupplyConfigHelper.getSupplyConfig(crateType) if crateConfigA == nil then trigger.action.outTextForUnit(unit:getID(), "Invalid crate type: " .. crateType, 5) @@ -444,7 +448,7 @@ function SupplyUnitsTracker:TryLoadCrateInUnit(unit, crateType, commandHelper) if group == nil then return false end local groupID = group:getID() commandHelper:updateCommandsForGroup(groupID) - + return true end @@ -462,7 +466,7 @@ function SupplyUnitsTracker:UnitRequestCrateSpawn(groupID, crateType) return end - + end end @@ -484,11 +488,11 @@ function SupplyUnitsTracker:GetBoundingBoxes(foundObject) if desc == nil or desc.box == nil then return nil end - + local objPos = foundObject:getPoint() - local box = desc.box + local box = desc.box --[[@type table]] local heading = 0 - + -- Try to get object heading from position vector's forward direction -- This works for units and other objects that support getPosition pcall(function() @@ -497,13 +501,13 @@ function SupplyUnitsTracker:GetBoundingBoxes(foundObject) heading = math.atan2(objPosition.x.z, objPosition.x.x) end end) - + -- For rotated objects, we need to rotate the bounding box - local minX = box.min.x - local maxX = box.max.x - local minZ = box.min.z - local maxZ = box.max.z - + local minX = box.min.x --[[@as number]] + local maxX = box.max.x --[[@as number]] + local minZ = box.min.z --[[@as number]] + local maxZ = box.max.z --[[@as number]] + -- If object has significant rotation, apply rotation to bbox corners if math.abs(heading) > 0.1 then -- Get all 4 corners of bbox in local space @@ -513,21 +517,21 @@ function SupplyUnitsTracker:GetBoundingBoxes(foundObject) {maxX, minZ}, {maxX, maxZ} } - + -- Rotate corners and find new min/max minX, maxX = math.huge, -math.huge minZ, maxZ = math.huge, -math.huge - + for _, corner in ipairs(corners) do - local rotX = corner[1] * math.cos(heading) - corner[2] * math.sin(heading) - local rotZ = corner[1] * math.sin(heading) + corner[2] * math.cos(heading) + local rotX = corner[1] * math.cos(heading) - corner[2] * math.sin(heading) --[[@as number]] + local rotZ = corner[1] * math.sin(heading) + corner[2] * math.cos(heading) --[[@as number]] minX = math.min(minX, rotX) maxX = math.max(maxX, rotX) minZ = math.min(minZ, rotZ) maxZ = math.max(maxZ, rotZ) end end - + -- Convert relative bbox to world space by adding object position ---@type SupplyUnitsBoundingBox return { @@ -551,7 +555,7 @@ end ---@param safetyMargin number Safety margin around objects ---@return boolean True if collision detected function SupplyUnitsTracker:CheckBBoxCollision(crateBBox, objBBox, safetyMargin) - + -- Apply safety margin to object bbox local objMin = { x = objBBox.min.x - safetyMargin, @@ -563,7 +567,7 @@ function SupplyUnitsTracker:CheckBBoxCollision(crateBBox, objBBox, safetyMargin) y = objBBox.max.y + safetyMargin, z = objBBox.max.z + safetyMargin } - + -- AABB collision detection return crateBBox.min.x <= objMax.x and crateBBox.max.x >= objMin.x and crateBBox.min.y <= objMax.y and crateBBox.max.y >= objMin.y and @@ -577,7 +581,7 @@ end function SupplyUnitsTracker:GetCargoPlacePosition(unit, crateTypeName) local unitPos = unit:getPosition() - + -- Get unit's heading from the forward vector (x component) -- Heading is calculated as: atan2(forward.z, forward.x) local unitHeading = math.atan2(unitPos.x.z, unitPos.x.x) @@ -588,14 +592,14 @@ function SupplyUnitsTracker:GetCargoPlacePosition(unit, crateTypeName) self._logger:error("Could not get bbox for crate type: " .. crateTypeName) return nil end - - local crateRelativeBBox = crateDesc.box + + local crateRelativeBBox = crateDesc.box --[[@as table]] -- Get drop zone config for this unit local dropZones = { { centerAngle = 180, angleWidth = 60, minRadius = 15, maxRadius = 50, spacing = 5 } } - + if SupplyLoadConfig[unit:getTypeName()] ~= nil then dropZones = SupplyLoadConfig[unit:getTypeName()].dropZones end @@ -612,9 +616,12 @@ function SupplyUnitsTracker:GetCargoPlacePosition(unit, crateTypeName) radius = 100 -- Search a large area } } - + ---@type Array<{ pos: { x: number, y: number, z: number }, bbox: { min: { x: number, y: number, z: number }, max: { x: number, y: number, z: number } } }> local occupiedObjects = {} - local found = function(foundItem, val) + + ---@param foundItem Object + ---@param _ any + local found = function(foundItem, _) local bbox = self:GetBoundingBoxes(foundItem) if bbox then self._logger:debug("Found object: " .. foundItem:getTypeName() .. " at (" .. foundItem:getPoint().x .. ", " .. foundItem:getPoint().z .. ")") @@ -648,20 +655,21 @@ function SupplyUnitsTracker:GetCargoPlacePosition(unit, crateTypeName) for distance = zone.minRadius, zone.maxRadius, zone.spacing do -- Check multiple positions within the angular slice local angleStep = math.min(15, zone.angleWidth / 3) -- Divide slice into sections - + for angle = minAngle, maxAngle, angleStep do local radians = math.rad(angle) - + -- Calculate position at this angle and distance, relative to unit's heading -- Angle 0 = forward, 90 = right, 180 = rear, 270 = left -- Apply unit heading to make angles relative to unit orientation local worldAngle = radians + unitHeading - + local candidateX = unitPos.p.x + distance * math.sin(worldAngle) local candidateZ = unitPos.p.z + distance * math.cos(worldAngle) local candidateY = land.getHeight({ x = candidateX, y = candidateZ }) -- Convert crate's relative bbox to world space at this position + ---@type { min: { x: number, y: number, z: number }, max: { x: number, y: number, z: number } } local crateBBoxWorldSpace = { min = { x = candidateX + crateRelativeBBox.min.x, diff --git a/src/classes/stageClasses/missions/BuildableMission.lua b/src/classes/stageClasses/missions/BuildableMission.lua index cc0b5b7..b8d0948 100644 --- a/src/classes/stageClasses/missions/BuildableMission.lua +++ b/src/classes/stageClasses/missions/BuildableMission.lua @@ -25,7 +25,9 @@ local DrawingHelper = require("classes.stageClasses.drawings.helper.DrawingHelpe local BuildableMission = {} BuildableMission.__index = BuildableMission - +---@param siteType string +---@param coords string +---@return string local function getDefaultBriefing(siteType, coords) return "We've dispatched forward units to find a proper spot for a new " .. siteType .. "." .. "\nYou will need to drop off supplies so they can start building." .. @@ -43,12 +45,13 @@ end ---@param noLandingZone SpearheadTriggerZone? ---@param logger Logger ---@param briefing string? +---@return BuildableMission function BuildableMission.new(database, logger, targetZone, noLandingZone, requiredKilos, requiredCrateType, briefing) setmetatable(BuildableMission, Mission) local self = setmetatable({}, { __index = BuildableMission }) - + self._targetZone = targetZone self._database = database self._requiredKilos = requiredKilos @@ -75,7 +78,7 @@ function BuildableMission.new(database, logger, targetZone, noLandingZone, requi end self.code = tostring(database:GetNewMissionCode()) - + local splitTargetZoneName = Util.split_string(targetZone.name, "_") if splitTargetZoneName and splitTargetZoneName[3] and splitTargetZoneName[3] ~= "" then self.name = splitTargetZoneName[3] @@ -83,13 +86,6 @@ function BuildableMission.new(database, logger, targetZone, noLandingZone, requi self.name = "Resupply" end - local type = "site" - if requiredCrateType == "SAM_CRATE" then - type = "SAM site" - elseif requiredCrateType == "FARP_CRATE" then - type = "FARP" - end - self.zoneName = targetZone.name .. "_supply" self._logger = logger self._onCrateDroppedOfListeners = {} @@ -124,6 +120,7 @@ function BuildableMission:ShowBriefing(groupID) local unitType = DcsUtil.getUnitTypeFromGroup(group) local coords = DcsUtil.convertVec2ToUnitUsableType(self.location, unitType) + if coords == nil then coords = "Could not make conversion" end local siteType = "FARP" if self._crateType == "SAM_CRATE" then @@ -139,7 +136,7 @@ function BuildableMission:ShowBriefing(groupID) briefingPart = getDefaultBriefing(siteType, coords) end - local briefing = "Mission [" .. self.code .. "] " .. self.name .. + local briefing = "Mission [" .. self.code .. "] " .. self.name .. "\n \n" .. briefingPart .. "\n\n" .. @@ -150,17 +147,20 @@ function BuildableMission:ShowBriefing(groupID) trigger.action.outTextForGroup(groupID, briefing, GlobalConfig:getBriefingTime()) end +---@param groupID number function BuildableMission:MarkMissionAreaToGroup(groupID) - if self._markIDsPerGroup[groupID] then - DcsUtil.RemoveMark(self._markIDsPerGroup[groupID]) - end + local groupIdStr = tostring(groupID) + if self._markIDsPerGroup[groupIdStr] then + DcsUtil.RemoveMark(self._markIDsPerGroup[groupIdStr]) + end + ---@type string local text = "[" .. self.code .. "] " .. self.name .. " | " .. self._crateType local location = { x= self.location.x, y=land.getHeight(self.location), z=self.location.y } local markID = DcsUtil.AddMarkToGroup(groupID, text, location) - self._markIDsPerGroup[groupID] = markID + self._markIDsPerGroup[groupIdStr] = markID end ---@private @@ -201,9 +201,10 @@ function BuildableMission:SpawnActive() local fillColor2 = DrawingHelper.ColorTableToColorString({ 0, 0, 1, 0}) self._dropOffZoneDrawing = CustomDrawing.FromZone(self._dropOffZone, lineColor2, fillColor2, 2, 6) self._dropOffZoneDrawing:Draw() - + ---@param selfA BuildableMission ---@param time number + ---@return number? local checkForCrateTasks = function (selfA, time) selfA:CheckCratesInZone() @@ -266,8 +267,8 @@ function BuildableMission:CheckCratesInZone() end end end - - for _, foundCrate in pairs(foundCrates) do + + for _, foundCrate in pairs(foundCrates) do local crateConfig = SupplyConfigHelper.fromObjectName(foundCrate:getName()) if crateConfig then self._droppedKilos = self._droppedKilos + crateConfig.weight @@ -282,7 +283,7 @@ function BuildableMission:CheckCratesInZone() self:NotifyMissionComplete() self._state = "COMPLETED" end - + if self._state == "COMPLETED" then for groupID, markID in pairs(self._markIDsPerGroup) do if markID then diff --git a/src/classes/stageClasses/missions/RunwayStrikeMission.lua b/src/classes/stageClasses/missions/RunwayStrikeMission.lua index e3119de..4cbd019 100644 --- a/src/classes/stageClasses/missions/RunwayStrikeMission.lua +++ b/src/classes/stageClasses/missions/RunwayStrikeMission.lua @@ -24,6 +24,7 @@ local RunwayStrikeMission = {} ---@param runway Runway ---@param database Database ---@param logger Logger +---@param airbaseName string ---@param runwayBombingTracker RunwayBombingTracker ---@return RunwayStrikeMission? function RunwayStrikeMission.new(runway, airbaseName, database, logger, runwayBombingTracker) @@ -42,7 +43,7 @@ function RunwayStrikeMission.new(runway, airbaseName, database, logger, runwayBo self._runwayZone = self:RunwayToSpearheadZone(runway) self._repairInProgress = false self._minKilosForDamage = 100 - + local sections = self:ToSections(runway, 5) --[[ +-----------+-----------+-----------+-----------+-----------+ @@ -84,7 +85,6 @@ function RunwayStrikeMission:RunwayHit(impactPoint, explosiveMass) self._logger:debug("Runway hit: " .. self._airportName .. ":" .. self._runway.Name) for _, section in pairs(self._runwaySections) do - local zone = self:SectionToSpearheadZone(section) if Util.is3dPointInZone({ x = impactPoint.x, z = impactPoint.y, y = 0 }, zone) then if section.kilosHit == nil then @@ -96,7 +96,7 @@ function RunwayStrikeMission:RunwayHit(impactPoint, explosiveMass) end ---@param selfA RunwayStrikeMission - local updateState = function(selfA, time) + local updateState = function(selfA, _) selfA:UpdateState() end @@ -154,7 +154,7 @@ function RunwayStrikeMission:Draw() if runwaySection.drawID == nil then local zone = self:SectionToSpearheadZone(runwaySection) - + ---@type Free local drawObject = { primitiveType = "Polygon", @@ -206,17 +206,18 @@ function RunwayStrikeMission:StartRepair() self._repairInProgress = true self._logger:debug("Starting repair of runway strike mission " .. self._airportName .. ":" .. self._runway.Name) ---comment - ---@param selfA any - ---@return unknown + ---@param selfA RunwayStrikeMission + ---@param time number + ---@return number? local repairTask = function (selfA, time) local interval = selfA:DoRepairCycle() if interval == nil then return nil end return time + interval end - timer.scheduleFunction(repairTask, self, timer.getTime() + 5) end +---@return number? function RunwayStrikeMission:DoRepairCycle() local interval = 5 @@ -249,12 +250,14 @@ function RunwayStrikeMission:DoRepairCycle() end ----@class StaticSpawn +---@class StaticSpawn : table ---@field category string ---@field type string ---@field y number ---@field x number ---@field heading number +---@field name string? +---@field hidden boolean? local counter = 1 @@ -443,6 +446,7 @@ end ---@private ---@param runway Runway +---@param numSections number ---@return Array function RunwayStrikeMission:ToSections(runway, numSections) diff --git a/src/classes/stageClasses/missions/ZoneMission.lua b/src/classes/stageClasses/missions/ZoneMission.lua index 8be5f72..4acfaff 100644 --- a/src/classes/stageClasses/missions/ZoneMission.lua +++ b/src/classes/stageClasses/missions/ZoneMission.lua @@ -66,8 +66,6 @@ local function ParseZoneName(input) } end -MINIMAL_UNITS_ALIVE_RATIO = 0.21 - ---comment ---@param zoneName string ---@param priority MissionPriority @@ -211,7 +209,7 @@ end ---@return boolean function ZoneMission:AllDependenciesMet() local allDependenciesMet = true - for missionName, value in pairs(self._dependencies) do + for missionName, _ in pairs(self._dependencies) do if self._parentStage:IsMissionComplete(missionName) == false then allDependenciesMet = false self._dependencies[missionName] = false @@ -229,10 +227,9 @@ end ---@internal ---@param checkHealth boolean ----@param messageIfDone boolean -function ZoneMission:UpdateState(checkHealth, messageIfDone) +---@param _ boolean +function ZoneMission:UpdateState(checkHealth, _) if checkHealth == nil then checkHealth = false end - if messageIfDone == false then messageIfDone = true end if checkHealth == true then @@ -240,7 +237,7 @@ function ZoneMission:UpdateState(checkHealth, messageIfDone) local staticObject = StaticObject.getByName(unitName) if staticObject then if staticObject:isExist() == true then - local life0 = staticObject:getDesc().life + local life0 = staticObject:getDesc().life --[[@as number]] if staticObject:getLife() / life0 < 0.3 then self._logger:debug("exploding unit") trigger.action.explosion(staticObject:getPoint(), 100) @@ -286,7 +283,9 @@ function ZoneMission:UpdateState(checkHealth, messageIfDone) end if self._missionGroups.hasTargets == true then + ---@type number local total = 0 + ---@type number local alive = 0 for _, units in pairs(self._missionGroups.targetsAlive) do @@ -299,13 +298,13 @@ function ZoneMission:UpdateState(checkHealth, messageIfDone) end for _, sceneryObject in pairs(self._missionGroups.sceneryTargets) do - total = total + 1 + total = total + 1 --[[@as number]] if sceneryObject:IsAlive() == true then alive = alive + 1 end end - local deadRatio = (total - alive) / total + local deadRatio = (total - alive) / total --[[@as number]] if deadRatio >= self._completeAtIndex then self._logger:debug("Dead ratio " .. self.zoneName .. deadRatio .. " >= " .. self._completeAtIndex) self._state = "COMPLETED" @@ -477,6 +476,7 @@ function ZoneMission:OnUnitLost(object) local category = Object.getCategory(object) if category == Object.Category.UNIT then + object = object --[[@as Unit]] local unitName = object:getName() self._logger:debug("UnitName:" .. unitName) @@ -487,6 +487,7 @@ function ZoneMission:OnUnitLost(object) self._missionGroups.targetsAlive[groupName][unitName] = false end elseif category == Object.Category.STATIC then + object = object --[[@as StaticObject]] local name = object:getName() self._missionGroups.unitsAlive[name][name] = false @@ -503,12 +504,12 @@ end ---@param unit Object function ZoneMission:MarkLastContact(unit) - if not unit then + if not unit then self._logger:error("MarkLastContact called with nil unit") return end - local point = unit:getPoint() + local point = unit:getPoint() if not point then self._logger:error("MarkLastContact called with unit without point") return diff --git a/src/classes/stageClasses/missions/baseMissions/Mission.lua b/src/classes/stageClasses/missions/baseMissions/Mission.lua index f5272b7..1ef76d8 100644 --- a/src/classes/stageClasses/missions/baseMissions/Mission.lua +++ b/src/classes/stageClasses/missions/baseMissions/Mission.lua @@ -51,7 +51,7 @@ function Mission.newSuper(self, zoneName, missionName, missionType, missionBrief self.location = database:GetLocationForMissionZone(zoneName) self.missionTypeDisplay = self.missionType - + self._missionCommandsHelper = MissionCommandsHelper.getOrCreate() return true, "success" @@ -68,9 +68,10 @@ function Mission:SpawnPersistedState() end function Mission:SpawnActive() end ---comment ----@param checkHealth boolean ----@param messageIfDone boolean -function Mission:UpdateState(checkHealth, messageIfDone) end +---@param _checkHealth boolean +---@param _messageIfDone boolean +---@diagnostic disable-next-line: unused-local +function Mission:UpdateState(_checkHealth, _messageIfDone) end function Mission:StartCheckingContinuous() end function Mission:PercentageComplete() @@ -85,6 +86,7 @@ function Mission:ShowBriefing(groupId) local unitType = DcsUtil.getUnitTypeFromGroup(group) local coords = DcsUtil.convertVec2ToUnitUsableType(self.location, unitType) + if coords == nil then coords = "Could not make conversion" end self._logger:debug("Coords converted: " .. coords) local stateString = self:ToStateString() @@ -120,7 +122,7 @@ function Mission:NotifyMissionComplete() end) end - local succ, err = pcall(function() + local _, _ = pcall(function() SpearheadAPI.Internal.notifyMissionComplete(self.zoneName) end) @@ -131,7 +133,9 @@ function Mission:ForceMissionComplete() self:NotifyMissionComplete() end -function Mission:MarkMissionAreaToGroup(groupId) end +---@param _groupId number +---@diagnostic disable-next-line: unused-local +function Mission:MarkMissionAreaToGroup(_groupId) end ---endregion @@ -143,29 +147,26 @@ function Mission:ToStateString() return "status: in progress" end --endregion -do --aliases +--- @alias MissionPriority +--- | "none" +--- | "primary" +--- | "secondary" - --- @alias MissionPriority - --- | "none" - --- | "primary" - --- | "secondary" +--- @alias MissionType +--- | "nil" +--- | "STRIKE" +--- | "CAS" +--- | "BAI" +--- | "DEAD" +--- | "SAM" +--- | "OCA" +--- | "LOGISTICS" - --- @alias MissionType - --- | "nil" - --- | "STRIKE" - --- | "CAS" - --- | "BAI" - --- | "DEAD" - --- | "SAM" - --- | "OCA" - --- | "LOGISTICS" +--- @alias MissionState +--- | "NEW" +--- | "WAITING" +--- | "ACTIVE" +--- | "COMPLETED" - --- @alias MissionState - --- | "NEW" - --- | "WAITING" - --- | "ACTIVE" - --- | "COMPLETED" - -end return Mission \ No newline at end of file diff --git a/src/classes/util/DcsUtil.lua b/src/classes/util/DcsUtil.lua index c314c0b..2a1ef77 100644 --- a/src/classes/util/DcsUtil.lua +++ b/src/classes/util/DcsUtil.lua @@ -32,6 +32,10 @@ do -- INIT DCS_UTIL ---| "Cilinder" ---| "Polygon" + ---@class KeyValuePair + ---@field key string + ---@field value any + ---@class SpearheadTriggerZone ---@field name string ---@field location Vec2 @@ -40,7 +44,7 @@ do -- INIT DCS_UTIL ---@field zone_type SpearheadTriggerZoneType ---@field properties Array? - ---@type Array + ---@type table DCS_UTIL.__trigger_zones = {} end @@ -66,18 +70,21 @@ do -- INIT DCS_UTIL STATIC = 5 --CUSTOM CATEGORY } + ---@type table DCS_UTIL.__airbaseNamesById = {} ---@type table DCS_UTIL.__airbaseZonesByName = {} + ---@type table DCS_UTIL.__airportsStartingCoalition = {} + ---@type table DCS_UTIL.__warehouseStartingCoalition = {} function DCS_UTIL.__INIT() do -- INITS ALL TABLES WITH DATA THAT's from the MIZ environment do --init trigger zones - for i, trigger_zone in pairs(env.mission.triggers.zones) do + for _, trigger_zone in pairs(env.mission.triggers.zones) do -- reorder verts as they are not ordered correctly in the ME local verts = {} if Util.tableLength(trigger_zone.verticies) >= 4 then @@ -104,8 +111,8 @@ do -- INIT DCS_UTIL if trigger_zone.properties then for _, kvPair in pairs(trigger_zone.properties) do - local key = kvPair["key"] - local value = kvPair["value"] + local key = kvPair.key + local value = kvPair.value zone.properties[#zone.properties + 1] = { key = key, value = value } end end @@ -116,6 +123,7 @@ do -- INIT DCS_UTIL do -- init airports and warehouses if env.warehouses.airports then + env.warehouses.airports = env.warehouses.airports --[[@as table]] for warehouse_id, value in pairs(env.warehouses.airports) do if warehouse_id ~= nil then warehouse_id = tostring(warehouse_id) or "nil" @@ -126,12 +134,12 @@ do -- INIT DCS_UTIL end if env.warehouses.warehouses then - DCS_UTIL.__warehouseStartingCoalition[-1] = "placeholder" + env.warehouses.warehouses = env.warehouses.warehouses --[[@as table]] for warehouse_id, value in pairs(env.warehouses.warehouses) do if warehouse_id ~= nil then - warehouse_id = tostring(warehouse_id) or "nil" + local warehouse_id_str = tostring(warehouse_id) or "nil" local coalitionNumber = DCS_UTIL.stringToCoalition(value.coalition) - DCS_UTIL.__warehouseStartingCoalition[warehouse_id] = coalitionNumber + DCS_UTIL.__warehouseStartingCoalition[warehouse_id_str] = coalitionNumber end end end @@ -192,7 +200,7 @@ do -- INIT DCS_UTIL BLUE = 2 } ]] -- - local input = string.lower(input) + input = string.lower(input) if input == 'neutrals' or input == "neutral" or input == "0" then return DCS_UTIL.Coalition.NEUTRAL end @@ -218,11 +226,13 @@ do -- INIT DCS_UTIL end end + --- takes a list of units and returns all the units that are in any of the zones - ---@param unit_names table unit names - ---@param zone_names table zone names - ---@return table unit list of objects { unit = UNIT, zone_name = zoneName} + ---@param unit_names Array unit names + ---@param zone_names Array zone names + ---@return table function DCS_UTIL.getUnitsInZones(unit_names, zone_names) + ---@type Array local units = {} ---@type Array @@ -235,20 +245,25 @@ do -- INIT DCS_UTIL end end - for index, zone_name in pairs(zone_names) do + for _, zone_name in pairs(zone_names) do local zone = DCS_UTIL.__trigger_zones[zone_name] if zone then zones[#zones + 1] = zone end end - + ---@type table local in_zone_units = {} for units_ind = 1, #units do local lUnit = units[units_ind] - local unit_pos = lUnit:getPosition().p + local isActive = true local lCat = Object.getCategory(lUnit) - for zone_name, zone in pairs(zones) do - if unit_pos and ((lCat == 1 and lUnit:isActive() == true) or lCat ~= 1) then -- it is a unit and is active or it is not a unit + if lCat == Object.Category.UNIT then + local unit = lUnit --[[@as Unit]] + isActive = unit:isActive() == true + end + local unit_pos = lUnit:getPosition().p + for _, zone in pairs(zones) do + if unit_pos and isActive == true then -- it is a unit and is active or it is not a unit local isInZone = Util.is3dPointInZone(unit_pos, zone) if isInZone == true then in_zone_units[#in_zone_units + 1] = { unit = lUnit, zone_name = zone.name } @@ -262,9 +277,9 @@ do -- INIT DCS_UTIL --- takes a list of groups and returns all the group leaders that are in any of the zones ---@param group_names table unit names ---@param zone_name string zone names - ---@return table groupnames list of group names + ---@return Array groupnames list of group names function DCS_UTIL.getGroupsInZone(group_names, zone_name) - local zone = DCS_UTIL.__trigger_zones[zone_name] + local zone = DCS_UTIL.__trigger_zones[zone_name] --[[@as SpearheadTriggerZone?]] if zone == nil then return {} end @@ -277,11 +292,13 @@ do -- INIT DCS_UTIL ---@param zone SpearheadTriggerZone ---@return Array groupnames list of groups that are in the zone function DCS_UTIL.areGroupsInCustomZone(group_names, zone) + ---@type Array<{ unit : Unit|StaticObject, groupname: string }> local units = {} if Util.tableLength(group_names) < 1 then return {} end for k = 1, #group_names do - local entry = nil + ---@type { unit : Unit|StaticObject|nil, groupname: string }|nil + local entry local group = Group.getByName(group_names[k]) if group ~= nil then entry = { unit = group:getUnit(1), groupname = group_names[k] } @@ -290,7 +307,7 @@ do -- INIT DCS_UTIL end if entry and entry.unit and entry.unit:isExist() == true then - units[#units + 1] = entry + units[#units + 1] = { groupname = entry.groupname, unit = entry.unit } end end @@ -308,20 +325,20 @@ do -- INIT DCS_UTIL --- takes a x, y poistion and checks if it is inside any of the zones ---@param x number North South position ---@param z number West East position - ---@param zone_names table zone names - ---@return table zones list of objects { zone_name = zoneName} + ---@param zone_names Array zone names + ---@return Array zones list of objects { zone_name = zoneName} function DCS_UTIL.isPositionInZones(x, z, zone_names) ---@type Array local zones = {} - for index, zone_name in pairs(zone_names) do + for _, zone_name in pairs(zone_names) do local zone = DCS_UTIL.__trigger_zones[zone_name] if zone then zones[#zones + 1] = zone end end - + ---@type Array local result_zones = {} - for zone_name, zone in pairs(zones) do + for _, zone in pairs(zones) do if Util.is3dPointInZone({ x = x, z = z, y = 0 }, zone) == true then result_zones[#result_zones + 1] = zone.name end @@ -396,6 +413,18 @@ do -- INIT DCS_UTIL return nil; end + ---@return Array + function DCS_UTIL.getAllGroupCategoryNames() + return { + "airplane", + "helicopter", + "ground", + "ship", + "train", + "static" + } + end + ---@type table local config = { @@ -408,13 +437,14 @@ do -- INIT DCS_UTIL ---@param location Vec2 - ---@param unitType string + ---@param unitType string? + ---@return string? function DCS_UTIL.convertVec2ToUnitUsableType(location, unitType) local height = land.getHeight(location) local vec3 = { x = location.x, y = height, z = location.y } - local unitType = string.lower(unitType or "") + unitType = string.lower(unitType or "") local conversionType = config[unitType] if not conversionType then conversionType = "DDM" end @@ -429,6 +459,7 @@ do -- INIT DCS_UTIL ---@private ---@param location Vec3 ---@param coordType CoordType + ---@return string? function DCS_UTIL.convertToDisplayCoord(location, coordType) local lattitude, longitude, altitude = coord.LOtoLL(location) @@ -440,7 +471,7 @@ do -- INIT DCS_UTIL -- Convert DD to DDM (Degrees Decimal Minutes) local function dd_to_ddm(dd) local degrees = math.floor(math.abs(dd)) - local minutes = (math.abs(dd) - degrees) * 60 + local minutes = (math.abs(dd) - degrees) * 60 --[[@as number]] local sign = dd >= 0 and 1 or -1 return degrees * sign, minutes end @@ -471,7 +502,7 @@ do -- INIT DCS_UTIL lon_hemisphere, math.abs(lon_deg), lon_min_display, lon_sec_display, altitude * 3,28084) end - + end ---@param zone SpearheadTriggerZone @@ -559,6 +590,7 @@ do -- INIT DCS_UTIL end ---@param group Group + ---@return string? unit type name function DCS_UTIL.getUnitTypeFromGroup(group) for _, unit in pairs(group:getUnits()) do if unit and unit:isExist() then @@ -571,10 +603,11 @@ do -- INIT DCS_UTIL ---comment Get all units that are players ---@return Array units function DCS_UTIL.getAllPlayerUnits() + ---@type Array local units = {} for i = 0, 2 do local players = coalition.getPlayers(i) - for key, unit in pairs(players) do + for _, unit in pairs(players) do units[#units + 1] = unit end end @@ -616,9 +649,9 @@ do -- INIT DCS_UTIL return result end + ---@param unitName string function DCS_UTIL.CleanCorpse(unitName) - local unitName = "dead_" .. unitName - + unitName = "dead_" .. unitName local object = StaticObject.getByName(unitName) if object then @@ -632,11 +665,11 @@ do -- INIT DCS_UTIL ---@field b number ---@field a number - local drawID = 4210 + local __drawID = 4210 function DCS_UTIL.GetNextDrawID() - drawID = drawID + 1 - return drawID + __drawID = __drawID + 1 + return __drawID end ---@param groupID number @@ -644,9 +677,9 @@ do -- INIT DCS_UTIL ---@param location Vec3 ---@return number markID function DCS_UTIL.AddMarkToGroup(groupID, text, location) - local drawID = DCS_UTIL.GetNextDrawID() - trigger.action.markToGroup(drawID, text, location, groupID, true, nil) - return drawID + local nextId = DCS_UTIL.GetNextDrawID() + trigger.action.markToGroup(nextId, text, location, groupID, true, nil) + return nextId end ---comment @@ -654,9 +687,9 @@ do -- INIT DCS_UTIL ---@param location Vec3 ---@return integer function DCS_UTIL.AddMarkToAll(text, location) - local drawID = DCS_UTIL.GetNextDrawID() - trigger.action.markToAll(drawID, text, location, true, nil) - return drawID + local nextId = DCS_UTIL.GetNextDrawID() + trigger.action.markToAll(nextId, text, location, true, nil) + return nextId end ---@param markId number @@ -705,7 +738,7 @@ do -- INIT DCS_UTIL ---@return number? id function DCS_UTIL.GetNeutralCountry() - for name, id in pairs(country.id) do + for _, id in pairs(country.id) do if coalition.getCountryCoalition(id) == DCS_UTIL.Coalition.NEUTRAL then return id end @@ -735,6 +768,8 @@ do -- INIT DCS_UTIL return false end + ---@param groupName string + ---@param offset number? ---@return boolean function DCS_UTIL.IsBingoFuel(groupName, offset) if offset == nil then offset = 0 end @@ -759,7 +794,7 @@ do -- INIT DCS_UTIL function DCS_UTIL.GetPlayerGroupByGroupID(groupId) for i = 0, 2 do local players = coalition.getPlayers(i) - for key, unit in pairs(players) do + for _, unit in pairs(players) do if unit and unit:isExist() == true then local group = unit:getGroup() if group and group:getID() == groupId then @@ -775,7 +810,7 @@ do -- INIT DCS_UTIL function DCS_UTIL.GetPlayerUnitByID(unitID) for i = 0, 2 do local players = coalition.getPlayers(i) - for key, unit in pairs(players) do + for _, unit in pairs(players) do if unit and unit:getID() == unitID then return unit end diff --git a/src/classes/util/Logger.lua b/src/classes/util/Logger.lua index 5016cc7..6977d22 100644 --- a/src/classes/util/Logger.lua +++ b/src/classes/util/Logger.lua @@ -3,6 +3,13 @@ local Util = require("classes.util.Util") local SpearheadConfig = require("classes.configuration.GlobalConfig") +--- @alias LogLevel +--- | "DEBUG" +--- | "INFO" +--- | "WARN" +--- | "ERROR" +--- | "NONE" + ---@type LogLevel local defaultLogLevel = "INFO" diff --git a/src/classes/util/MissionEditorWarnings.lua b/src/classes/util/MissionEditorWarnings.lua index a5ff7ea..88b1fdd 100644 --- a/src/classes/util/MissionEditorWarnings.lua +++ b/src/classes/util/MissionEditorWarnings.lua @@ -1,8 +1,12 @@ ---@class MissionEditingWarnings local MissionEditingWarnings = {} + +---@type table +MissionEditingWarnings.warnings = {} + function MissionEditingWarnings.Add(warningMessage) - table.insert(MissionEditingWarnings, warningMessage or "skip") + table.insert(MissionEditingWarnings.warnings, warningMessage or "skip") end ---@param logger Logger @@ -12,12 +16,12 @@ function MissionEditingWarnings.WriteAll(logger) return end - if not MissionEditingWarnings or #MissionEditingWarnings == 0 then + if not MissionEditingWarnings.warnings or #MissionEditingWarnings.warnings == 0 then return end logger:warn("Mission Editor Warnings:") - for _, warning in ipairs(MissionEditingWarnings) do + for _, warning in ipairs(MissionEditingWarnings.warnings) do logger:warn("- " .. warning) end diff --git a/src/classes/util/Util.lua b/src/classes/util/Util.lua index f8366c4..23688c3 100644 --- a/src/classes/util/Util.lua +++ b/src/classes/util/Util.lua @@ -4,7 +4,7 @@ do -- INIT UTIL ---splits a string in sub parts by seperator ---@param input string ---@param seperator string - ---@return table result list of strings + ---@return Array result list of strings function UTIL.split_string(input, seperator) if seperator == nil then seperator = " " @@ -22,7 +22,7 @@ do -- INIT UTIL end ---comment - ---@param table any + ---@param table table ---@return number function UTIL.tableLength(table) if table == nil then return 0 end @@ -35,23 +35,34 @@ do -- INIT UTIL ---@param orig table ---@return table copy function UTIL.deepCopyTable(orig) - local orig_type = type(orig) - local copy - if orig_type == 'table' then - copy = {} - for orig_key, orig_value in next, orig, nil do - copy[UTIL.deepCopyTable(orig_key)] = UTIL.deepCopyTable(orig_value) + + ---@param original any + ---@return any + local function deepCopy(original) + local orig_type = type(original) + ---@type any + local copy + if orig_type == 'table' then + original = original --[[@as table]] + copy = {} --[[@as table]] + for orig_key, orig_value in pairs(original) do + local copiedKey = deepCopy(orig_key) --[[@as any]] + copy[copiedKey] = deepCopy(orig_value) + end + setmetatable(copy, deepCopy(getmetatable(original))) + else -- number, string, boolean, etc + copy = original --[[@as any]] end - setmetatable(copy, UTIL.deepCopyTable(getmetatable(orig))) - else -- number, string, boolean, etc - copy = orig + return copy end - return copy + + return deepCopy(orig) end ---Gets a random from the list - ---@param list Array - ---@return any @random element from the list + ---@generic T + ---@param list Array + ---@return T @random element from the list function UTIL.randomFromList(list) local max = #list @@ -65,11 +76,13 @@ do -- INIT UTIL return list[random] end - ---@param list Array + ---@generic T + ---@param list Array ---@param start number start ---@param n number length - ---@return Array + ---@return Array function UTIL.sublist(list, start, n) + ---@type table local result = {} for i = start, n do result[#result + 1] = list[i] @@ -90,9 +103,10 @@ do -- INIT UTIL end local function table_print(tt, indent, done) - done = done or {} + done = done or {} --[[@as table]] indent = indent or 0 if type(tt) == "table" then + tt = tt --[[@as table]] local sb = {} for key, value in pairs(tt) do table.insert(sb, string.rep(" ", indent)) -- indent it @@ -146,10 +160,10 @@ do -- INIT UTIL ---comment ---@param str string - ---@param findableTable table + ---@param findableTable table ---@return boolean UTIL.startswithAny = function(str, findableTable) - for key, value in pairs(findableTable) do + for _, value in pairs(findableTable) do if type(value) == "string" and UTIL.startswith(str, value) then return true end end return false @@ -238,7 +252,13 @@ do -- INIT UTIL return ((vec1Norm.x * vec2Norm.x) + (vec1Norm.y * vec2Norm.y) + (vec1Norm.z * vec2Norm.z)) end + ---@param polygon Array of pairs { x, y } + ---@param x number X location + ---@param y number Y location + ---@return boolean local function isInComplexPolygon(polygon, x, y) + ---@param poly Array of pairs { x, y } + ---@return Array<{ x1: number, z1: number, x2: number, z2: number }> local function getEdges(poly) local result = {} for i = 1, #poly do @@ -275,6 +295,7 @@ do -- INIT UTIL ---@param point Vec3 ---@param zone SpearheadTriggerZone + ---@return boolean function UTIL.is3dPointInZone(point, zone) if zone.zone_type == "Polygon" and zone.verts then if UTIL.IsPointInPolygon(zone.verts, point.x, point.z) == true then @@ -291,6 +312,7 @@ do -- INIT UTIL ---@param point Vec2 ---@param zone SpearheadTriggerZone + ---@return boolean function UTIL.is2dPointInZone(point, zone) if zone.zone_type == "Polygon" and zone.verts then if UTIL.IsPointInPolygon(zone.verts, point.x, point.y) == true then @@ -399,7 +421,9 @@ do -- INIT UTIL if #points == 0 then return {} end -- Simple clustering: group points that are within minSeparation of each other + ---@type Array> local clusters = {} + ---@type table local assigned = {} for i, p in ipairs(points) do @@ -440,6 +464,8 @@ do -- INIT UTIL end ---@param points Array + ---@param meters number + ---@return Array function UTIL.enlargeConvexHull(points, meters) if points == nil or #points == 0 then return {} @@ -517,6 +543,10 @@ function UTIL.GetTangentHullPointsFromOrigin(hull, origin) return {} end + ---@param a Vec2 + ---@param b Vec2 + ---@param c Vec2 + ---@return number local function orientation(a, b, c) -- Returns >0 if c is to the left of ab, <0 if to the right, 0 if colinear return (b.x - a.x) * (c.y - a.y) - (b.y - a.y) * (c.x - a.x) diff --git a/src/main.lua b/src/main.lua index 56e3f69..fe6ab7c 100644 --- a/src/main.lua +++ b/src/main.lua @@ -1,7 +1,6 @@ --Single player purpose local Logger = require("classes.util.Logger") -local DcsUtil = require("classes.util.DcsUtil") local Database = require("classes.spearhead_db") local SpearheadEvents = require("classes.spearhead_events") local MissionCommandsHelper = require("classes.stageClasses.helpers.MissionCommandsHelper") @@ -47,7 +46,7 @@ local spawnManager = SpawnManager.new(spawnLogger) local detectionLogger = Logger.new("DetectionManager", defaultLogLevel) local detectionManager = DetectionManager.New(detectionLogger) -GlobalCapManager.start(databaseManager, capConfig, detectionManager, stageConfig, defaultLogLevel, spawnManager) +GlobalCapManager.start(databaseManager, capConfig, detectionManager, defaultLogLevel, spawnManager) local globalStageManager = GlobalStageManager.new(databaseManager, stageConfig, defaultLogLevel, spawnManager) GlobalFleetManager.start(databaseManager)