Spearhead/spearhead
3
0
Fork 0
Code Issues 20 Pull Requests 1 Actions Packages Releases 2 Wiki Activity

Merge pull request #2 from dutchie032/feature/configuration

Browse Source 
Feature/configuration
This commit is contained in:
dutchie031
2024-10-12 16:02:11 +02:00
committed by GitHub
parent 95bff0d0c0 9aa66eeb9d
commit 08023f4d97
17 changed files with 1326 additions and 1042 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/docs.yml
+12
View File
@@ -35,12 +35,24 @@ jobs:
run: git clone --single-branch --branch $branch https://github.com/$username/$repo
- name: ls
run: ls
- name: Replace string in file
run: |
import os
with open("./spearhead/config.lua", "r") as luaFile:
luaConfig = luaFile.read()
with open("./spearhead/_docs/Reference.md", "r+") as mdFile:
text = mdFile.read()
text = text.replace("##!config!##", luaConfig)
mdFile.write()
shell: python
- name: mkdir
run: mkdir -p ./$repo/Spearhead
- run: npm i markdown-to-html-cli -g
- run: markdown-to-html --title 'Spearhead' --dark-mode auto --keywords "dcs,spearhead,tdcs,mission,campaign,tactical dcs,tactical" --no-dark-mode --markdown-style-theme dark --source ./spearhead/_docs/$sourcefileA.md --output ./$repo/Spearhead/$sourcefileA.html
- run: markdown-to-html --title 'Spearhead' --dark-mode auto --keywords "dcs,spearhead,tdcs,mission,campaign,tactical dcs,tactical" --no-dark-mode --markdown-style-theme dark --source ./spearhead/_docs/$sourcefileB.md --output ./$repo/Spearhead/$sourcefileB.html
- run: python3 ./spearhead/SpearheadCompile.py "./spearhead" "./$repo/Spearhead/spearhead.lua"
- run: cp "./spearhead/config.lua" "./$repo/Spearhead/spearheadConfig.lua"
- run: cp -a ./spearhead/_docs/img/. ./$repo/Spearhead/img/
- name: ls
run: ls
SpearheadConfig.lua
-2
View File
@@ -1,2 +0,0 @@
---KEEP THIS LINE
if not SpearheadConfig then SpearheadConfig = {} end
_docs/Reference.md
+6 -1
View File
@@ -62,6 +62,12 @@ The initial version with basic functionality
- [ ] Persistance
## Configuration
```lua
##!config!##
```
## Stage
A stage is a logical part of a mission. It's isn't anything special per se, but everything revolves around stages in Spearhead. <br/>
@@ -118,7 +124,6 @@ TIP: You can click on the type to get more details
&emsp; <u>Completion logic</u> <br/>
&emsp; TODO: documentation: Completion logic
</details>
<details>
_miz/SPEARHEADDEV.miz
BIN
View File
Binary file not shown.
classes/capClasses/CapAirbase.lua
-15
View File
@@ -18,21 +18,6 @@ function CapBase:new(airbaseId, database, logger, capConfig, stageConfig)
o.logger = logger
o.activeStage = 0
o.capConfig = capConfig
if capConfig == nil then
capConfig = {}
Spearhead.AddMissionEditorWarning("CapConfig is nil")
else
if capConfig.minSpeed == nil then Spearhead.AddMissionEditorWarning("CapConfig.minSpeed is nil") end
if capConfig.maxSpeed == nil then Spearhead.AddMissionEditorWarning("CapConfig.maxSpeed is nil") end
if capConfig.minAlt == nil then Spearhead.AddMissionEditorWarning("CapConfig.minAlt is nil") end
if capConfig.maxAlt == nil then Spearhead.AddMissionEditorWarning("CapConfig.maxAlt is nil") end
if capConfig.minDurationOnStation == nil then Spearhead.AddMissionEditorWarning("CapConfig.minDurationOnStation is nil") end
if capConfig.maxDurationOnStation == nil then Spearhead.AddMissionEditorWarning("CapConfig.maxDurationOnStation is nil") end
if capConfig.rearmDelay == nil then Spearhead.AddMissionEditorWarning("CapConfig.rearmDelay is nil") end
if capConfig.deathDelay == nil then Spearhead.AddMissionEditorWarning("CapConfig.deathDelay is nil") end
end
o.activeCapStages = (stageConfig or {}).capActiveStages or 10
o.lastStatesByName = {}
classes/capClasses/CapGroup.lua
+11 -23
View File
@@ -116,6 +116,8 @@ function CapGroup:new(groupName, airbaseId, logger, database, capConfig)
local RESPAWN_AFTER_TOUCHDOWN_SECONDS = 180
Spearhead.DcsUtil.DestroyGroup(groupName)
-- initials
o.groupName = groupName
o.airbaseId = airbaseId
@@ -139,17 +141,7 @@ function CapGroup:new(groupName, airbaseId, logger, database, capConfig)
o.markedForDespawn = false
--config
o.capConfig = {}
if not capConfig then capConfig = {} end
o.capConfig.maxDeviationRange = capConfig.maxDeviationRange
o.capConfig.minSpeed = (capConfig.minSpeed or 400) * 0.514444
o.capConfig.maxSpeed = (capConfig.maxSpeed or 500) * 0.514444
o.capConfig.minAlt = (capConfig.minAlt or 8000) * 0.3048
o.capConfig.maxAlt = (capConfig.maxAlt or 27000) * 0.3048
o.capConfig.minDurationOnStation = capConfig.minDurationOnStation or 600
o.capConfig.maxDurationOnstation = capConfig.maxDurationOnStation or 1800
o.capConfig.rearmDelay = capConfig.rearmDelay or 300
o.capConfig = capConfig
---comment
---@param self table
@@ -167,7 +159,7 @@ function CapGroup:new(groupName, airbaseId, logger, database, capConfig)
o.StartRearm = function(self)
self:SpawnOnTheRamp()
self:SetState(CapGroup.GroupState.REARMING)
timer.scheduleFunction(SetReadyOnRampAsync, self, timer.getTime() + self.capConfig.rearmDelay - RESPAWN_AFTER_TOUCHDOWN_SECONDS)
timer.scheduleFunction(SetReadyOnRampAsync, self, timer.getTime() + self.capConfig:getRearmDelay() - RESPAWN_AFTER_TOUCHDOWN_SECONDS)
end
o.SpawnOnTheRamp = function(self)
@@ -202,7 +194,7 @@ function CapGroup:new(groupName, airbaseId, logger, database, capConfig)
o.SendRTB = function(self)
local group = Group.getByName(self.groupName)
if group and group:isExist() then
local speed = math.random(self.capConfig.minSpeed, self.capConfig.maxSpeed)
local speed = math.random(self.capConfig:getMinSpeed(), self.capConfig:getMaxSpeed())
local rtbTask, errormessage = Spearhead.RouteUtil.CreateRTBMission(self.groupName, self.airbaseId, speed)
if rtbTask then
timer.scheduleFunction(setTaskAsync, { task = rtbTask, groupName = self.groupName, logger = self.logger }, timer.getTime() + 3)
@@ -235,21 +227,17 @@ function CapGroup:new(groupName, airbaseId, logger, database, capConfig)
local controller = group:getController()
local capPoints = database:getCapRouteInZone(stageZoneNumber, self.airbaseId)
local altitude = math.random(self.capConfig.minAlt, self.capConfig.maxAlt)
local speed = math.random(self.capConfig.minSpeed, self.capConfig.maxSpeed)
local altitude = math.random(self.capConfig:getMinAlt(), self.capConfig:getMaxAlt())
local speed = math.random(self.capConfig:getMinSpeed(), self.capConfig:getMaxSpeed())
local attackHelos = false
local deviationDistance = self.capConfig.maxDeviationRange
local deviationDistance = self.capConfig:getMaxDeviationRange()
local capTask
if self.state == CapGroup.GroupState.ONRAMP or self.onStationSince == 0 then
controller:setCommand({
id = 'Start',
params = {}
})
local duration = math.random(self.capConfig.minDurationOnStation, self.capConfig
.maxDurationOnstation)
self.logger:debug("random schedule min: " ..
tostring(self.capConfig.minDurationOnStation or "nil") ..
" max: " .. tostring(self.capConfig.maxDurationOnstation or "nil") .. " actual " .. duration)
local duration = math.random(self.capConfig:getMinDurationOnStation(), self.capConfig:getmaxDurationOnStation())
self.currentCapTaskingDuration = duration
@@ -272,7 +260,7 @@ function CapGroup:new(groupName, airbaseId, logger, database, capConfig)
---@param airdomeId any
o.SendToAirbase = function(self, airdomeId)
self.airbaseId = airdomeId
local speed = math.random(self.capConfig.minSpeed, self.capConfig.maxSpeed)
local speed = math.random(self.capConfig:getMinSpeed(), self.capConfig:getMaxSpeed())
local rtbTask = Spearhead.RouteUtil.CreateRTBMission(self.groupName, airdomeId, speed)
local group = Group.getByName(self.groupName)
local controller = group:getController()
@@ -344,7 +332,7 @@ function CapGroup:new(groupName, airbaseId, logger, database, capConfig)
if self.markedForDespawn == true then
self:Despawn()
else
local delay = self.capConfig.deathDelay - self.capConfig.rearmDelay + RESPAWN_AFTER_TOUCHDOWN_SECONDS
local delay = self.capConfig:getDeathDelay() - self.capConfig:getRearmDelay() + RESPAWN_AFTER_TOUCHDOWN_SECONDS
timer.scheduleFunction(DelayedStartRearm, { self = self }, timer.getTime() + delay)
end
end
classes/configuration/CapConfig.lua
+57
View File
@@ -0,0 +1,57 @@
local CapConfig = {};
function CapConfig:new()
local o = {}
setmetatable(o, { __index = self })
if SpearheadConfig == nil then SpearheadConfig = {} end
if SpearheadConfig.CapConfig == nil then SpearheadConfig.CapConfig = {} end
local enabled = SpearheadConfig.CapConfig.enabled or true
---@return boolean
o.isEnabled = function(self) return enabled == true end
local minSpeed = (tonumber(SpearheadConfig.CapConfig.minSpeed) or 400) * 0.514444
---@return number
o.getMinSpeed = function(self) return minSpeed end
local maxSpeed = (tonumber(SpearheadConfig.CapConfig.maxSpeed) or 400) * 0.514444
---@return number
o.getMaxSpeed = function(self) return maxSpeed end
local minAlt = (tonumber(SpearheadConfig.CapConfig.minAlt) or 18000) * 0.3048
---@return number
o.getMinAlt = function(self) return minAlt end
local maxAlt = (tonumber(SpearheadConfig.CapConfig.maxAlt) or 28000) * 0.3048
---@return number
o.getMaxAlt = function(self) return maxAlt end
local minDurationOnStation = 1200
---@return number
o.getMinDurationOnStation = function(self) return minDurationOnStation end
local maxDurationOnStation = 2700
---@return number
o.getmaxDurationOnStation = function(self) return maxDurationOnStation end
local maxDeviationRange = 20 * 1852;
---@return number
o.getMaxDeviationRange = function(self) return maxDeviationRange end
local rearmDelay = tonumber(SpearheadConfig.CapConfig.rearmDelay) or 600
---@return number
o.getRearmDelay = function(self) return rearmDelay end
local deathDelay = tonumber(SpearheadConfig.CapConfig.deathDelay) or 1800
---@return number
o.getDeathDelay = function(self) return deathDelay end
o.logLevel = Spearhead.LoggerTemplate.LogLevelOptions.INFO
return o;
end
if not Spearhead.internal then Spearhead.internal = {} end
if not Spearhead.internal.configuration then Spearhead.internal.configuration = {} end
Spearhead.internal.configuration.CapConfig = CapConfig;
classes/configuration/StageConfig.lua
+31
View File
@@ -0,0 +1,31 @@
local StageConfig = {};
function StageConfig:new()
local o = {}
setmetatable(o, { __index = self })
if SpearheadConfig == nil then SpearheadConfig = {} end
if SpearheadConfig.StageConfig == nil then SpearheadConfig.StageConfig = {} end
local enabled = SpearheadConfig.StageConfig.enabled or true
---@return boolean
o.isEnabled = function(self) return enabled == true end
local drawStages = SpearheadConfig.StageConfig.drawStages or true
---@return boolean
o.isDrawStagesEnabled = function(self) return drawStages == true end
local autoStages = SpearheadConfig.StageConfig.autoStages or true
---@return boolean
o.isAutoStages = function(self) return autoStages end
local maxMissionsPerStage = SpearheadConfig.StageConfig.maxMissionStage
o.getMaxMissionsPerStage = function(self) return maxMissionsPerStage end
o.logLevel = Spearhead.LoggerTemplate.LogLevelOptions.INFO
return o;
end
if not Spearhead.internal then Spearhead.internal = {} end
if not Spearhead.internal.configuration then Spearhead.internal.configuration = {} end
Spearhead.internal.configuration.StageConfig = StageConfig;
classes/spearhead_base.lua
+154 -857
View File
File diff suppressed because it is too large Load Diff
classes/spearhead_db.lua
+125 -100
View File
@@ -2,13 +2,13 @@
local SpearheadDB = {}
do -- DB
local singleton = nil
---comment
---@param Logger table
---@return table
function SpearheadDB:new(Logger)
function SpearheadDB:new(Logger, debug)
if not debug then debug = false end
if singleton ~= nil then
Logger:info("Returning an already initiated instance of SpearheadDB")
return singleton
@@ -34,43 +34,41 @@ do -- DB
o.tables.stage_numberPerzone = {}
do -- INIT ZONE TABLES
if env.mission.triggers and env.mission.triggers.zones then
for zone_ind, zone_data in pairs(env.mission.triggers.zones) do
local zone_name = zone_data.name
local split_string = Spearhead.Util.split_string(zone_name, "_")
table.insert(o.tables.all_zones, zone_name)
for zone_ind, zone_data in pairs(Spearhead.DcsUtil.__trigger_zones) do
local zone_name = zone_data.name
local split_string = Spearhead.Util.split_string(zone_name, "_")
table.insert(o.tables.all_zones, zone_name)
if string.lower(split_string[1]) == "missionstage" then
table.insert(o.tables.stage_zones, zone_name)
if split_string[2] then
local stringified = tostring(split_string[2]) or "unknown"
if o.tables.stage_zonesByNumer[stringified] == nil then
o.tables.stage_zonesByNumer[stringified] = {}
end
table.insert(o.tables.stage_zonesByNumer[stringified], zone_name)
o.tables.stage_numberPerzone[zone_name] = stringified
if string.lower(split_string[1]) == "missionstage" then
table.insert(o.tables.stage_zones, zone_name)
if split_string[2] then
local stringified = tostring(split_string[2]) or "unknown"
if o.tables.stage_zonesByNumer[stringified] == nil then
o.tables.stage_zonesByNumer[stringified] = {}
end
table.insert(o.tables.stage_zonesByNumer[stringified], zone_name)
o.tables.stage_numberPerzone[zone_name] = stringified
end
end
if string.lower(split_string[1]) == "mission" then
table.insert(o.tables.mission_zones, zone_name)
end
if string.lower(split_string[1]) == "mission" then
table.insert(o.tables.mission_zones, zone_name)
end
if string.lower(split_string[1]) == "randommission" then
table.insert(o.tables.random_mission_zones, zone_name)
end
if string.lower(split_string[1]) == "randommission" then
table.insert(o.tables.random_mission_zones, zone_name)
end
if string.lower(split_string[1]) == "farp" then
table.insert(o.tables.farp_zones, zone_name)
end
if string.lower(split_string[1]) == "farp" then
table.insert(o.tables.farp_zones, zone_name)
end
if string.lower(split_string[1]) == "caproute" then
table.insert(o.tables.cap_route_zones, zone_name)
end
if string.lower(split_string[1]) == "caproute" then
table.insert(o.tables.cap_route_zones, zone_name)
end
if string.lower(split_string[1]) == "carrierroute" then
table.insert(o.tables.carrier_route_zones, zone_name)
end
if string.lower(split_string[1]) == "carrierroute" then
table.insert(o.tables.carrier_route_zones, zone_name)
end
end
end
@@ -82,7 +80,8 @@ do -- DB
for i, layer in pairs(env.mission.drawings.layers) do
if string.lower(layer.name) == "author" then
for key, layer_object in pairs(layer.objects) do
local inZone = Spearhead.DcsUtil.isPositionInZones(layer_object.mapX, layer_object.mapY, o.tables.mission_zones)
local inZone = Spearhead.DcsUtil.isPositionInZones(layer_object.mapX, layer_object.mapY,
o.tables.mission_zones)
if Spearhead.Util.tableLength(inZone) >= 1 then
local name = inZone[1]
if name ~= nil then
@@ -90,7 +89,8 @@ do -- DB
end
end
local inZone = Spearhead.DcsUtil.isPositionInZones(layer_object.mapX, layer_object.mapY, o.tables.random_mission_zones)
local inZone = Spearhead.DcsUtil.isPositionInZones(layer_object.mapX, layer_object.mapY,
o.tables.random_mission_zones)
if Spearhead.Util.tableLength(inZone) >= 1 then
local name = inZone[1]
if name ~= nil then
@@ -179,7 +179,7 @@ do -- DB
airbase:autoCapture(false)
table.insert(o.tables.farpIdsInFarpZones[farpZoneName], baseIdString)
end
i = i +1
i = i + 1
end
end
end
@@ -191,7 +191,7 @@ do -- DB
o.tables.farpZonesPerStage = {}
for _, farpZoneName in pairs(o.tables.farp_zones) do
local findFirst = function (farpZoneName)
local findFirst = function(farpZoneName)
for _, stage_zone in pairs(o.tables.stage_zones) do
if Spearhead.DcsUtil.isZoneInZone(farpZoneName, stage_zone) then
return stage_zone
@@ -202,7 +202,6 @@ do -- DB
local found = findFirst(farpZoneName)
if found then
if o.tables.farpZonesPerStage[found] == nil then
o.tables.farpZonesPerStage[found] = {}
end
@@ -248,10 +247,10 @@ do -- DB
for _, airbase in pairs(airbases) do
local baseId = airbase:getID()
local point = airbase:getPoint()
local zone = Spearhead.DcsUtil.getAirbaseZoneById(baseId) or
{ x = point.x, z = point.z, radius = 4000 }
o.tables.capGroupsOnAirbase[baseId] = {}
local groups = Spearhead.DcsUtil.areGroupsInCustomZone(all_groups,
{ x = point.x, z = point.z, radius = 2048 })
local groups = Spearhead.DcsUtil.areGroupsInCustomZone(all_groups, zone)
for _, groupName in pairs(groups) do
is_group_taken[groupName] = true
table.insert(o.tables.capGroupsOnAirbase[baseId], groupName)
@@ -273,19 +272,19 @@ do -- DB
end
end
--- missionZoneName <> groupname[]
o.tables.groupsInRandomMissions = {}
local loadRandomMissionzoneUnits = function()
local all_groups = getAvailableGroups()
for _, missionZoneName in pairs(o.tables.random_mission_zones) do
o.tables.groupsInRandomMissions[missionZoneName] = {}
local groups = Spearhead.DcsUtil.getGroupsInZone(all_groups, missionZoneName)
for _, groupName in pairs(groups) do
is_group_taken[groupName] = true
table.insert(o.tables.groupsInRandomMissions[missionZoneName], groupName)
end
end
end
--- missionZoneName <> groupname[]
o.tables.groupsInRandomMissions = {}
local loadRandomMissionzoneUnits = function()
local all_groups = getAvailableGroups()
for _, missionZoneName in pairs(o.tables.random_mission_zones) do
o.tables.groupsInRandomMissions[missionZoneName] = {}
local groups = Spearhead.DcsUtil.getGroupsInZone(all_groups, missionZoneName)
for _, groupName in pairs(groups) do
is_group_taken[groupName] = true
table.insert(o.tables.groupsInRandomMissions[missionZoneName], groupName)
end
end
end
--- farpZoneName <> groupname[]
o.tables.groupsInFarpZone = {}
@@ -310,13 +309,37 @@ do -- DB
for _, airbase in pairs(airbases) do
local baseId = tostring(airbase:getID())
local point = airbase:getPoint()
local airbaseZone = Spearhead.DcsUtil.getAirbaseZoneById(baseId) or
{ x = point.x, z = point.z, radius = 4000 }
if isAirbaseInZone[tostring(baseId) or "something"] == true and airbaseZone and airbase:getDesc().category == Airbase.Category.AIRDROME then
if debug then
if airbaseZone.zone_type == Spearhead.DcsUtil.ZoneType.Polygon then
local functionString = "trigger.action.markupToAll(7, -1, " .. baseId + 300 .. ","
for _, vecpoint in pairs(airbaseZone.verts) do
functionString = functionString .. " { x=" .. vecpoint.x .. ", y=0,z=" .. vecpoint.z ..
"},"
end
functionString = functionString .. "{0,1,0,1}, {0,1,0,1}, 1)"
env.info(functionString)
local f, err = loadstring(functionString)
if f then
f()
else
env.info(err)
end
else
trigger.action.circleToAll(-1, baseId, { x = point.x, y = 0, z = point.z }, 2048,
{ 1, 0, 0, 1 }, { 1, 0, 0, 0 }, 1, true)
end
end
if isAirbaseInZone[tostring(baseId) or "something" ] == true and airbase:getDesc().category == Airbase.Category.AIRDROME then
o.tables.redAirbaseGroupsPerAirbase[baseId] = {}
o.tables.blueAirbaseGroupsPerAirbase[baseId] = {}
local groups = Spearhead.DcsUtil.areGroupsInCustomZone(all_groups, { x = point.x, z = point.z, radius = 2048 })
local groups = Spearhead.DcsUtil.areGroupsInCustomZone(all_groups, airbaseZone)
for _, groupName in pairs(groups) do
if Spearhead.DcsUtil.IsGroupStatic(groupName) == true then
local object = StaticObject.getByName(groupName)
if object then
@@ -346,7 +369,7 @@ do -- DB
end
o.tables.miscGroupsInStages = {}
local loadMiscGroupsInStages = function ()
local loadMiscGroupsInStages = function()
local all_groups = getAvailableGroups()
for _, stage_zone in pairs(o.tables.stage_zones) do
o.tables.miscGroupsInStages[stage_zone] = {}
@@ -376,18 +399,18 @@ do -- DB
loadAirbaseGroups()
loadMiscGroupsInStages()
local cleanup = function () --CLean up all groups that are now managed inside zones by spearhead
-- local cleanup = function () --CLean up all groups that are now managed inside zones by spearhead
local count = 0
for name, taken in pairs(is_group_taken) do
if taken == true then
Spearhead.DcsUtil.DestroyGroup(name)
count = count + 1
end
end
Logger:info("Destroyed " .. count .. " units that are now managed in zones by Spearhead")
end
cleanup()
-- local count = 0
-- for name, taken in pairs(is_group_taken) do
-- if taken == true then
-- Spearhead.DcsUtil.DestroyGroup(name)
-- count = count + 1
-- end
-- end
-- Logger:info("Destroyed " .. count .. " units that are now managed in zones by Spearhead")
-- end
-- cleanup()
--- key: zoneName value: { current, routes = [ { point1, point2 } ] }
o.tables.capRoutesPerStageNumber = {}
@@ -406,7 +429,8 @@ do -- DB
local zone = Spearhead.DcsUtil.getZoneByName(cap_route_zone)
if zone then
if zone.zone_type == Spearhead.DcsUtil.ZoneType.Cilinder then
table.insert(o.tables.capRoutesPerStageNumber[number].routes, { point1 = { x = zone.x , z = zone.z }, point2 = nil } )
table.insert(o.tables.capRoutesPerStageNumber[number].routes,
{ point1 = { x = zone.x, z = zone.z }, point2 = nil })
else
local function getDist(a, b)
return math.sqrt((b.x - a.x) ^ 2 + (b.z - a.z) ^ 2)
@@ -416,12 +440,11 @@ do -- DB
local biggestA = nil
local biggestB = nil
for i=1, 3 do
for i = 1, 3 do
for ii = i + 1, 4 do
local a = zone.verts[i]
local b = zone.verts[ii]
local dist = getDist(a,b)
local dist = getDist(a, b)
if biggest == nil or dist > biggest then
biggestA = a
@@ -433,10 +456,10 @@ do -- DB
if biggestA and biggestB then
table.insert(o.tables.capRoutesPerStageNumber[number].routes,
{
point1 = { x = biggestA.x , z = biggestA.z },
point2 = { x = biggestB.x , z = biggestB.z }
})
{
point1 = { x = biggestA.x, z = biggestA.z },
point2 = { x = biggestB.x, z = biggestB.z }
})
end
end
end
@@ -456,7 +479,7 @@ do -- DB
o.getCapRouteInZone = function(self, stageNumber, baseId)
local stageNumber = tostring(stageNumber) or "nothing"
local routeData = self.tables.capRoutesPerStageNumber[stageNumber]
if routeData then
if routeData then
local count = Spearhead.Util.tableLength(routeData.routes)
if count > 0 then
routeData.current = routeData.current + 1
@@ -470,19 +493,21 @@ do -- DB
local function GetClosestPointOnCircle(pC, radius, p)
local vX = p.x - pC.x;
local vY = p.z - pC.z;
local magV = math.sqrt(vX*vX + vY*vY);
local magV = math.sqrt(vX * vX + vY * vY);
local aX = pC.x + vX / magV * radius;
local aY = pC.z + vY / magV * radius;
return { x = aX, z = aY }
end
local stageZoneName = Spearhead.Util.randomFromList(self.tables.stage_zonesByNumer[stageNumber]) or "none"
local stageZoneName = Spearhead.Util.randomFromList(self.tables.stage_zonesByNumer[stageNumber]) or
"none"
local stagezone = Spearhead.DcsUtil.getZoneByName(stageZoneName)
if stagezone then
local base = Spearhead.DcsUtil.getAirbaseById(baseId)
if base then
local closest = nil
if stagezone.zone_type == Spearhead.DcsUtil.ZoneType.Cilinder then
closest = GetClosestPointOnCircle({x = stagezone.x, z = stagezone.z}, stagezone.radius, base:getPoint())
closest = GetClosestPointOnCircle({ x = stagezone.x, z = stagezone.z }, stagezone.radius,
base:getPoint())
else
local function getDist(a, b)
return math.sqrt((b.x - a.x) ^ 2 + (b.z - a.z) ^ 2)
@@ -492,27 +517,26 @@ do -- DB
for _, vert in pairs(stagezone.verts) do
local distance = getDist(vert, base:getPoint())
if closestDistance == -1 or distance < closestDistance then
closestDistance = distance
closest = vert
closestDistance = distance
closest = vert
end
end
end
if math.random(1,2)%2 == 0 then
return { point1 = closest, point2 = {x = stagezone.x, z = stagezone.z} }
if math.random(1, 2) % 2 == 0 then
return { point1 = closest, point2 = { x = stagezone.x, z = stagezone.z } }
else
return { point1 = {x = stagezone.x, z = stagezone.z}, point2 = closest }
return { point1 = { x = stagezone.x, z = stagezone.z }, point2 = closest }
end
end
end
end
end
---comment
---@param self table
---@param number number
---@return string zoneName
o.getStageZonesByStageNumber = function (self, number)
o.getStageZonesByStageNumber = function(self, number)
local numberString = tostring(number)
return self.tables.stage_zonesByNumer[numberString]
end
@@ -520,15 +544,15 @@ do -- DB
---comment
---@param self table
---@return table result a list of stage zone names
o.getStagezoneNames = function (self)
o.getStagezoneNames = function(self)
return self.tables.stage_zones
end
o.getCarrierRouteZones = function (self)
o.getCarrierRouteZones = function(self)
return self.tables.carrier_route_zones
end
o.getMissionsForStage = function (self, stagename)
o.getMissionsForStage = function(self, stagename)
return self.tables.missionZonesPerStage[stagename] or {}
end
@@ -536,14 +560,14 @@ do -- DB
return self.tables.randomMissionZonesPerStage[stagename] or {}
end
o.getGroupsForMissionZone = function (self, missionZoneName)
o.getGroupsForMissionZone = function(self, missionZoneName)
if Spearhead.Util.startswith(missionZoneName, "RANDOMMISSION") == true then
return self.tables.groupsInRandomMissions[missionZoneName] or {}
return self.tables.groupsInRandomMissions[missionZoneName] or {}
end
return self.tables.groupsInMissionZone[missionZoneName] or {}
end
o.getMissionBriefingForMissionZone = function (self, missionZoneName)
o.getMissionBriefingForMissionZone = function(self, missionZoneName)
return self.tables.descriptions[missionZoneName] or ""
end
@@ -551,11 +575,11 @@ do -- DB
---@param self table
---@param stageName string
---@return table result airbase IDs. Use Spearhead.DcsUtil.getAirbaseById
o.getAirbaseIdsInStage = function (self, stageName)
o.getAirbaseIdsInStage = function(self, stageName)
return self.tables.airbasesPerStage[stageName] or {}
end
o.getFarpZonesInStage = function (self, stageName)
o.getFarpZonesInStage = function(self, stageName)
return self.tables.farpZonesPerStage[stageName]
end
@@ -567,12 +591,12 @@ do -- DB
return self.tables.capGroupsOnAirbase[airbaseId] or {}
end
o.getRedGroupsAtAirbase = function (self, airbaseId)
o.getRedGroupsAtAirbase = function(self, airbaseId)
local baseId = tostring(airbaseId)
return self.tables.redAirbaseGroupsPerAirbase[baseId] or {}
end
o.getBlueGroupsAtAirbase = function (self, airbaseId)
o.getBlueGroupsAtAirbase = function(self, airbaseId)
local baseId = tostring(airbaseId)
return self.tables.blueAirbaseGroupsPerAirbase[baseId] or {}
end
@@ -581,7 +605,7 @@ do -- DB
return self.tables.miscGroupsInStages[stageName] or {}
end
o.GetNewMissionCode = function (self)
o.GetNewMissionCode = function(self)
local code = nil
local tries = 0
while code == nil and tries < 10 do
@@ -610,16 +634,17 @@ do -- DB
for _, missionZone in pairs(o.tables.mission_zones) do
if o.tables.descriptions[missionZone] == nil then
Spearhead.AddMissionEditorWarning("Mission with zonename: " .. missionZone .. " does not have a briefing")
Spearhead.AddMissionEditorWarning("Mission with zonename: " ..
missionZone .. " does not have a briefing")
end
end
for _, randomMission in pairs(o.tables.random_mission_zones) do
if o.tables.descriptions[randomMission] == nil then
Spearhead.AddMissionEditorWarning("Mission with zonename: " .. randomMission .. " does not have a briefing")
Spearhead.AddMissionEditorWarning("Mission with zonename: " ..
randomMission .. " does not have a briefing")
end
end
end
singleton = o
return o
classes/spearhead_events.lua
+309
View File
@@ -0,0 +1,309 @@
local SpearheadEvents = {}
do
local SpearheadLogger = Spearhead.LoggerTemplate:new("Spearhead Events",
Spearhead.LoggerTemplate.LogLevelOptions.INFO)
do -- STAGE NUMBER CHANGED
local OnStageNumberChangedListeners = {}
local OnStageNumberChangedHandlers = {}
---Add a stage zone number changed listener
---@param listener table object with function OnStageNumberChanged(self, number)
SpearheadEvents.AddStageNumberChangedListener = function(listener)
if type(listener) ~= "table" then
SpearheadLogger:warn("Event listener not of type table, did you mean to use handler?")
return
end
table.insert(OnStageNumberChangedListeners, listener)
end
---Add a stage zone number changed listener
---@param handler function function(number)
SpearheadEvents.AddStageNumberChangedHandler = function(handler)
if type(handler) ~= "function" then
SpearheadLogger:warn("Event handler not of type function, did you mean to use listener?")
return
end
table.insert(OnStageNumberChangedHandlers, handler)
end
---@param newStageNumber number
SpearheadEvents.PublishStageNumberChanged = function(newStageNumber)
for _, callable in pairs(OnStageNumberChangedListeners) do
local succ, err = pcall(function()
callable:OnStageNumberChanged(newStageNumber)
end)
if err then
SpearheadLogger:error(err)
end
end
for _, callable in pairs(OnStageNumberChangedHandlers) do
local succ, err = pcall(callable, newStageNumber)
if err then
SpearheadLogger:error(err)
end
end
end
end
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)
SpearheadEvents.addOnUnitLandEventListener = function(unitName, landListener)
if type(landListener) ~= "table" then
SpearheadLogger:warn("Event handler not of type table/object")
return
end
SpearheadLogger:debug("Added Land event handler for unit: " .. unitName)
if onLandEventListeners[unitName] == nil then
onLandEventListeners[unitName] = {}
end
table.insert(onLandEventListeners[unitName], landListener)
end
local OnUnitLostListeners = {}
---This listener gets fired for any event that can indicate a loss of a unit.
---Such as: Eject, Crash, Dead, Unit_Lost,
---@param unitName any
---@param unitLostListener table Object with function: OnUnitLost(initiatorUnit)
SpearheadEvents.addOnUnitLostEventListener = function(unitName, unitLostListener)
if type(unitLostListener) ~= "table" then
SpearheadLogger:warn("Unit lost Event listener not of type table/object")
return
end
if OnUnitLostListeners[unitName] == nil then
OnUnitLostListeners[unitName] = {}
end
table.insert(OnUnitLostListeners[unitName], unitLostListener)
end
do -- ON RTB
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
---@param groupName string the groupname to expect
---@param handlingObject table object with OnGroupRTB(self, groupName)
SpearheadEvents.addOnGroupRTBListener = function(groupName, handlingObject)
if type(handlingObject) ~= "table" then
SpearheadLogger:warn("Event handler not of type table/object")
return
end
if OnGroupRTBListeners[groupName] == nil then
OnGroupRTBListeners[groupName] = {}
end
table.insert(OnGroupRTBListeners[groupName], handlingObject)
end
---Publish the Group to RTB
---@param groupName string
SpearheadEvents.PublishRTB = function(groupName)
SpearheadLogger:debug("Publishing RTB event for group " .. groupName)
if groupName ~= nil then
if OnGroupRTBListeners[groupName] then
for _, callable in pairs(OnGroupRTBListeners[groupName]) do
local succ, err = pcall(function()
callable:OnGroupRTB(groupName)
end)
if err then
SpearheadLogger:error(err)
end
end
end
end
end
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)
SpearheadEvents.addOnGroupRTBInTenListener = function(groupName, handlingObject)
if type(handlingObject) ~= "table" then
SpearheadLogger:warn("Event handler not of type table/object")
return
end
if OnGroupRTBInTenListeners[groupName] == nil then
OnGroupRTBInTenListeners[groupName] = {}
end
table.insert(OnGroupRTBInTenListeners[groupName], handlingObject)
end
---Publish the Group is RTB
---@param groupName string
SpearheadEvents.PublishRTBInTen = function(groupName)
SpearheadLogger:debug("Publishing RTB in TEN event for group " .. groupName)
if groupName ~= nil then
if OnGroupRTBInTenListeners[groupName] then
for _, callable in pairs(OnGroupRTBInTenListeners[groupName]) do
local succ, err = pcall(function()
callable:OnGroupRTBInTen(groupName)
end)
if err then
SpearheadLogger:error(err)
end
end
end
end
end
end
do -- ON Station
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
SpearheadEvents.addOnGroupOnStationListener = function(groupName, handlingObject)
if type(handlingObject) ~= "table" then
SpearheadLogger:warn("Event handler not of type table/object")
return
end
if OnGroupOnStationListeners[groupName] == nil then
OnGroupOnStationListeners[groupName] = {}
end
table.insert(OnGroupOnStationListeners[groupName], handlingObject)
end
---Publish the Group to RTB
---@param groupName string
SpearheadEvents.PublishOnStation = function(groupName)
SpearheadLogger:debug("Publishing onStation event for group " .. groupName)
if groupName ~= nil then
if OnGroupOnStationListeners[groupName] then
for _, callable in pairs(OnGroupOnStationListeners[groupName]) do
local succ, err = pcall(function()
callable:OnGroupOnStation(groupName)
end)
if err then
SpearheadLogger:error(err)
end
end
end
end
end
end
do --COMMANDS
do -- status updates
local onStatusRequestReceivedListeners = {}
---comment
---@param listener table object with OnStatusRequestReceived(self, groupId)
SpearheadEvents.AddOnStatusRequestReceivedListener = function(listener)
if type(listener) ~= "table" then
SpearheadLogger:warn("Unit lost Event listener not of type table/object")
return
end
table.insert(onStatusRequestReceivedListeners, listener)
end
local triggerStatusRequestReceived = function(groupId)
for _, callable in pairs(onStatusRequestReceivedListeners) do
local succ, err = pcall(function()
callable:OnStatusRequestReceived(groupId)
end)
end
end
SpearheadEvents.AddCommandsToGroup = function(groupId)
local base = "MISSIONS"
if groupId then
missionCommands.addCommandForGroup(groupId, "Stage Status", nil, triggerStatusRequestReceived,
groupId)
end
end
end
end
do -- PLAYER ENTER UNIT
local playerEnterUnitListeners = {}
---comment
---@param listener table object with OnPlayerEnterUnit(self, unit)
SpearheadEvents.AddOnPlayerEnterUnitListener = function(listener)
if type(listener) ~= "table" then
SpearheadLogger:warn("Unit lost Event listener not of type table/object")
return
end
table.insert(playerEnterUnitListeners, listener)
end
SpearheadEvents.TriggerPlayerEntersUnit = function(unit)
if unit ~= nil then
if playerEnterUnitListeners then
for _, callable in pairs(playerEnterUnitListeners) do
local succ, err = pcall(function()
callable:OnPlayerEnterUnit(unit)
end)
if err then
SpearheadLogger:error(err)
end
end
end
end
end
end
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
if unit ~= nil then
local name = unit:getName()
if onLandEventListeners[name] then
for _, callable in pairs(onLandEventListeners[name]) do
local succ, err = pcall(function()
callable:OnUnitLanded(unit, airbase)
end)
if err then
SpearheadLogger:error(err)
end
end
end
end
end
if event.id == world.event.S_EVENT_DEAD or
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
if object and object.getName and OnUnitLostListeners[object:getName()] then
for _, callable in pairs(OnUnitLostListeners[object:getName()]) do
local succ, err = pcall(function()
callable:OnUnitLost(object)
end)
if err then
SpearheadLogger:error(err)
end
end
end
end
if event.id == world.event.S_EVENT_PLAYER_ENTER_UNIT then
env.info("blaat player entering unit")
local groupId = event.initiator:getGroup():getID()
SpearheadEvents.AddCommandsToGroup(groupId)
end
end
world.addEventHandler(e)
end
if Spearhead == nil then Spearhead = {} end
Spearhead.Events = SpearheadEvents
classes/spearhead_routeutil.lua
+462
View File
@@ -0,0 +1,462 @@
local ROUTE_UTIL = {}
do --setup route util
---comment
---@param attackHelos boolean
---@return table
local function GetCAPTargetTypes(attackHelos)
local targetTypes = {
[1] = "Planes",
}
if attackHelos then
targetTypes[2] = "Helicopters"
end
return targetTypes
end
---comment
---@param airdromeId number
---@param basePoint table { x, z, y } (y == alt)
---@param speed number the speed
---@return table task
local RtbTask = function(airdromeId, basePoint, speed)
if basePoint == nil then
basePoint = Spearhead.Util.getAirbaseById(airdromeId):getPoint()
end
return {
alt = basePoint.y,
action = "Landing",
alt_type = "BARO",
speed = speed,
ETA = 0,
ETA_locked = false,
x = basePoint.x,
y = basePoint.z,
speed_locked = true,
formation_template = "",
airdromeId = airdromeId,
type = "Land",
task = {
id = "ComboTask",
params = {
tasks = {}
}
}
}
end
---comment
---@param groupName string
---@param position table { x, y}
---@param altitude number
---@param speed number
---@param duration number
---@param engageHelos boolean
---@param pattern string ["Race-Track"|"Circle"]
---@return table
local CapTask = function(groupName, position, altitude, speed, duration, engageHelos, deviationdistance, pattern)
local durationBefore10 = duration - 600
if durationBefore10 < 0 then durationBefore10 = 0 end
local durationAfter10 = 600
if duration < 600 then
durationAfter10 = duration
end
return {
alt = altitude,
action = "Turning Point",
alt_type = "BARO",
speed = speed,
ETA = 0,
ETA_locked = false,
x = position.x,
y = position.z,
speed_locked = true,
formation_template = "",
task = {
id = "ComboTask",
params = {
tasks = {
[1] = {
number = 1,
auto = false,
id = "WrappedAction",
enabled = "true",
params = {
action = {
id = "Script",
params = {
command = "pcall(Spearhead.Events.PublishOnStation, \"" .. groupName .. "\")"
}
}
}
},
[2] = {
id = 'EngageTargets',
params = {
maxDist = deviationdistance,
maxDistEnabled = deviationdistance >= 0, -- required to check maxDist
targetTypes = GetCAPTargetTypes(engageHelos),
priority = 0
}
},
[3] = {
number = 3,
auto = false,
id = "ControlledTask",
enabled = true,
params = {
task = {
id = "Orbit",
params = {
altitude = altitude,
pattern = pattern,
speed = speed,
}
},
stopCondition = {
duration = durationBefore10,
condition = "return Spearhead.DcsUtil.IsBingoFuel(\"" .. groupName .. "\", 0.10)",
}
}
},
[4] = {
number = 4,
auto = false,
id = "WrappedAction",
enabled = "true",
params = {
action = {
id = "Script",
params = {
command = "pcall(Spearhead.Events.PublishRTBInTen, \"" .. groupName .. "\")"
}
}
}
},
[5] = {
number = 5,
auto = false,
id = "ControlledTask",
enabled = true,
params = {
task = {
id = "Orbit",
params = {
altitude = altitude,
pattern = pattern,
speed = speed,
}
},
stopCondition = {
duration = durationAfter10,
condition = "return Spearhead.DcsUtil.IsBingoFuel(\"" .. groupName .. "\")",
}
}
},
[6] = {
number = 6,
auto = false,
id = "WrappedAction",
enabled = "true",
params = {
action = {
id = "Script",
params = {
command = "pcall(Spearhead.Events.PublishRTB, \"" .. groupName .. "\")"
}
}
}
}
}
}
}
}
end
---comment
---@param position table { x, y}
---@param altitude number
---@param speed number
---@param childTasks table
---@return table
local FlyToPointTask = function(position, altitude, speed, childTasks)
return {
alt = altitude,
action = "Turning Point",
alt_type = "BARO",
speed = speed,
ETA = 0,
ETA_locked = false,
x = position.x,
y = position.z,
speed_locked = true,
formation_template = "",
task = {
id = "ComboTask",
params = {
tasks = childTasks or {}
}
}
}
end
---comment
---@param groupName string groupName you're creating this route for
---@param airdromeId number airdromeId
---@param capPoint table { x, z }
---@param altitude number
---@param speed number
---@param durationOnStation number
---@param attackHelos boolean
---@param deviationDistance number
---@return table route
ROUTE_UTIL.createCapMission = function(groupName, airdromeId, capPoint, racetrackSecondPoint, altitude, speed,
durationOnStation, attackHelos, deviationDistance)
local baseName = Spearhead.DcsUtil.getAirbaseName(airdromeId)
if baseName == nil then
return {}
end
durationOnStation = durationOnStation or 1800
altitude = altitude or 3000
speed = speed or 130
attackHelos = attackHelos or false
deviationDistance = deviationDistance or 32186
local base = Airbase.getByName(baseName)
if base == nil then
return {}
end
local additionalFlyOverTasks = {
{
enabled = true,
auto = false,
id = "WrappedAction",
number = 1,
params = {
action = {
id = "Option",
params = {
variantIndex = 2,
name = AI.Option.Air.id.FORMATION,
formationIndex = 2,
value = 131074
}
}
}
}
}
local orbitType = "Circle"
if racetrackSecondPoint then orbitType = "Race-Track" end
local basePoint = base:getPoint()
local points = {}
if racetrackSecondPoint == nil then
points = {
[1] = FlyToPointTask(capPoint, altitude, speed, additionalFlyOverTasks),
[2] = CapTask(groupName, capPoint, altitude, speed, durationOnStation, attackHelos, deviationDistance,
orbitType),
[3] = RtbTask(airdromeId, basePoint, speed)
}
else
points = {
[1] = FlyToPointTask(capPoint, altitude, speed, additionalFlyOverTasks),
[2] = CapTask(groupName, capPoint, altitude, speed, durationOnStation, attackHelos, deviationDistance,
orbitType),
[3] = FlyToPointTask(racetrackSecondPoint, altitude, speed, {}),
[4] = RtbTask(airdromeId, basePoint, speed)
}
end
return {
id = 'Mission',
params = {
airborne = true,
route = {
points = points
}
}
}
end
---Creates an RTB task. The first point is to trigger the TDCS OnRTB Event, the second task will be the actual RTB point
---If any of the values are not met it will return nil
---@param groupName string
---@param airdromeId number
---@param speed number
---@return table?, string ComboTask
ROUTE_UTIL.CreateRTBMission = function(groupName, airdromeId, speed)
--[[
TODO: Test the creation and pubishing of event and the timing of said event
]] --
local base = Spearhead.DcsUtil.getAirbaseById(airdromeId)
if base == nil then
return nil, "No airbase found for ID " .. tostring(airdromeId)
end
local group = Group.getByName(groupName)
local pos;
local i = 1
local units = group:getUnits()
while pos == nil and i <= Spearhead.Util.tableLength(units) do
local unit = units[i]
if unit and unit:isExist() == true and unit:inAir() == true then
pos = unit:getPoint()
end
i = i + 1
end
speed = speed or 130
if pos == nil then
return nil, "Could not find any unit in the air to set the RTB task"
end
local additionalFlyOverTasks = {
{
enabled = true,
auto = false,
id = "WrappedAction",
number = 1,
params = {
action = {
id = "Option",
params = {
variantIndex = 2,
name = AI.Option.Air.id.FORMATION,
formationIndex = 2,
value = 131074
}
}
}
}
}
return {
id = "Mission",
params = {
airborne = true, -- RTB mission generally are given to airborne units
route = {
points = {
[1] = {
alt = pos.y,
action = "Turning Point",
alt_type = "BARO",
speed = speed,
ETA = 0,
ETA_locked = false,
x = pos.x,
y = pos.z,
speed_locked = true,
formation_template = "",
task = {
id = "ComboTask",
params = {
tasks = {
[1] = {
number = 1,
auto = false,
id = "WrappedAction",
enabled = "true",
params = {
action = {
id = "Script",
params = {
command = "pcall(Spearhead.Events.PublishRTB, \"" ..
groupName .. "\")"
}
}
}
}
}
}
}
},
[2] = FlyToPointTask(base:getPoint(), 600, speed, additionalFlyOverTasks),
[3] = RtbTask(airdromeId, base:getPoint(), speed)
}
}
}
}, ""
end
ROUTE_UTIL.CreateCarrierRacetrack = function(pointA, pointB)
return {
id = "Mission",
params = {
airborne = false,
route = {
points = {
[1] =
{
["alt"] = -0,
["type"] = "Turning Point",
["ETA"] = 0,
["alt_type"] = "BARO",
["formation_template"] = "",
["y"] = pointA.z,
["x"] = pointA.x,
["ETA_locked"] = false,
["speed"] = 13.88888,
["action"] = "Turning Point",
["task"] =
{
["id"] = "ComboTask",
["params"] =
{
["tasks"] = {},
}, -- end of ["params"]
}, -- end of ["task"]
["speed_locked"] = true,
},
[2] =
{
["alt"] = -0,
["type"] = "Turning Point",
["ETA"] = -0,
["alt_type"] = "BARO",
["formation_template"] = "",
["y"] = pointB.z,
["x"] = pointB.x,
["ETA_locked"] = false,
["speed"] = 13.88888,
["action"] = "Turning Point",
["task"] =
{
["id"] = "ComboTask",
["params"] =
{
["tasks"] =
{
[1] =
{
["enabled"] = true,
["auto"] = false,
["id"] = "GoToWaypoint",
["number"] = 1,
["params"] =
{
["fromWaypointIndex"] = 2,
["nWaypointIndx"] = 1,
},
},
},
},
},
["speed_locked"] = true,
}
}
}
}
}, ""
end
end
if Spearhead == nil then Spearhead = {} end
Spearhead.RouteUtil = ROUTE_UTIL
classes/stageClasses/GlobalStageManager.lua
+33 -8
View File
@@ -1,22 +1,47 @@
local StagesByName = {}
local StagesByIndex = {}
GlobalStageManager = {}
GlobalStageManager.start = function (database, stageConfig)
function GlobalStageManager:NewAndStart(database, stageConfig)
local o = {}
setmetatable(o, { __index = self })
o.onStageCompleted = function(stage)
local stageNumber = tostring(stage.stageNumber)
local anyActive = false
for _, stage in pairs(StagesByIndex[stageNumber] or {}) do
if stage.isActive then anyActive = true end
end
if anyActive == false and stageConfig:isAutoStages() == true then
Spearhead.Events.PublishStageNumberChanged(tonumber(stageNumber) + 1)
end
end
local logger = Spearhead.LoggerTemplate:new("StageManager", stageConfig.logLevel)
for _, stageName in pairs(database:getStagezoneNames()) do
local logger = Spearhead.LoggerTemplate:new(stageName, stageConfig.logLevel)
local stage = Spearhead.internal.Stage:new(stageName, database, logger)
StagesByName[stageName] = stage
local logger = Spearhead.LoggerTemplate:new("StageManager", stageConfig.logLevel)
logger:info("Initiated " .. Spearhead.Util.tableLength(StagesByName) .. " airbases for cap")
local stagelogger = Spearhead.LoggerTemplate:new(stageName, stageConfig.logLevel)
local stage = Spearhead.internal.Stage:new(stageName, database, stagelogger, stageConfig)
if stage then
stage:AddStageCompleteListener(o);
StagesByName[stageName] = stage
local indexString = tostring(stage.stageNumber)
if StagesByIndex[indexString] == nil then StagesByIndex[indexString] = {} end
table.insert(StagesByIndex[indexString], stage)
logger:info("Initiated " .. Spearhead.Util.tableLength(StagesByName) .. " airbases for cap")
end
end
return o
end
if not Spearhead.internal then Spearhead.internal = {} end
classes/stageClasses/Mission.lua
+1
View File
@@ -353,6 +353,7 @@ do -- INIT Mission Class
end
end
end
Spearhead.DcsUtil.DestroyGroup(group_name)
end
if Spearhead.Util.tableLength(self.targetAliveStates) > 0 then
classes/stageClasses/Stage.lua
+24 -8
View File
@@ -29,6 +29,7 @@ do --init STAGE DIRECTOR
end
o.stageNumber = orderNumber
o.isActive = false
o.database = database
o.logger = logger
o.db = {}
@@ -94,14 +95,21 @@ do --init STAGE DIRECTOR
for _, groupName in pairs(database:getRedGroupsAtAirbase(airbaseId)) do
table.insert(o.db.redAirbasegroups, groupName)
Spearhead.DcsUtil.DestroyGroup(groupName)
end
for _, groupName in pairs(database:getBlueGroupsAtAirbase(airbaseId)) do
table.insert(o.db.blueAirbasegroups, groupName)
Spearhead.DcsUtil.DestroyGroup(groupName)
end
end
end
local miscGroups = database:getMiscGroupsAtStage(o.zoneName)
for _, groupName in pairs(miscGroups) do
Spearhead.DcsUtil.DestroyGroup(groupName)
end
local farps = database:getFarpZonesInStage(o.zoneName)
if farps ~= nil and type(farps) == "table" then o.db.farps = farps end
end
@@ -109,7 +117,7 @@ do --init STAGE DIRECTOR
o.StageCompleteListeners = {}
---comment
---@param self table
---@param StageCompleteListener table a Object with tage
---@param StageCompleteListener table an Object with function onStageCompleted(stage)
o.AddStageCompleteListener = function(self, StageCompleteListener)
if type(StageCompleteListener) ~= "table" then
@@ -119,9 +127,15 @@ do --init STAGE DIRECTOR
end
local triggerStageCompleteListeners = function(self)
--[[
TODO: Trigger Stage complete
]]
self.isActive = false
for _, callable in pairs(self.MissionCompleteListeners) do
local succ, err = pcall( function()
callable:OnMissionComplete(self)
end)
if err then
self.logger:warn("Error in misstion complete listener:" .. err)
end
end
end
@@ -172,13 +186,13 @@ do --init STAGE DIRECTOR
end
local zone = Spearhead.DcsUtil.getZoneByName(self.zoneName)
if zone then
if zone and self.stageConfig:isDrawStagesEnabled() == true then
self.logger:debug("drawing stage")
if zone.zone_type == Spearhead.DcsUtil.ZoneType.Cilinder then
trigger.action.circleToAll(-1, self.stageDrawingId, {x = zone.x, y = 0 , z = zone.z}, zone.radius, {0,0,0,0}, {0,0,0,0},4, true)
else
--trigger.action.circleToAll(-1, self.stageDrawingId, {x = zone.x, y = 0 , z = zone.z}, zone.radius, { 1, 0,0, 1 }, {1,0,0,1},4, true)
trigger.action.quadToAll( -1, self.stageDrawingId, zone.verts[2], zone.verts[1], zone.verts[4], zone.verts[3], {0,0,0,0}, {0,0,0,0}, 4, true)
trigger.action.quadToAll( -1, self.stageDrawingId, zone.verts[1], zone.verts[2], zone.verts[3], zone.verts[4], {0,0,0,0}, {0,0,0,0}, 4, true)
end
trigger.action.setMarkupColorFill(self.stageDrawingId, fillColor)
@@ -187,6 +201,8 @@ do --init STAGE DIRECTOR
end
o.ActivateStage = function(self)
self.isActive = true;
pcall(function()
self:MarkStage()
end)
@@ -222,7 +238,7 @@ do --init STAGE DIRECTOR
end
end
local max = self.stageConfig.maxMissionsInStage or 10
local max = self.stageConfig:getMaxMissionsPerStage() or 10
local availableMissionsCount = Spearhead.Util.tableLength(availableMissions)
if activeCount < max and availableMissionsCount > 0 then
@@ -430,7 +446,7 @@ do --init STAGE DIRECTOR
timer.scheduleFunction(removeMissionCommandsDelayed, { self = self, mission = mission}, timer.getTime() + 20)
if(self:IsComplete()) then
timer.scheduleFunction(triggerStageCompleteListeners, self, timer.getTime() + 15)
else
timer.scheduleFunction(activateMissionsIfApplicableAsync, self, timer.getTime() + 10)
end
config.lua
+56
View File
@@ -0,0 +1,56 @@
SpearheadConfig = {
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 = 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
--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 = 10
}
}
main.lua
+33 -16
View File
@@ -1,22 +1,17 @@
--Single player purpose
local debug = false
local id = net.get_my_player_id()
if id == 0 then
debug = true
end
local dbLogger = Spearhead.LoggerTemplate:new("database", Spearhead.LoggerTemplate.LogLevelOptions.INFO)
local databaseManager = Spearhead.DB:new(dbLogger)
local databaseManager = Spearhead.DB:new(dbLogger, debug)
local capConfig = {
maxDeviationRange = 46300, --25NM -- max engagement distance
maxSpeed = 500,
minAlt = 18000,
maxAlt = 28000,
minDurationOnStation = 1800,
maxDurationOnStation = 2700,
rearmDelay = 600,
deathDelay = 1800,
logLevel = Spearhead.LoggerTemplate.LogLevelOptions.INFO
}
local stageConfig = {
logLevel = Spearhead.LoggerTemplate.LogLevelOptions.INFO
}
local capConfig = Spearhead.internal.configuration.CapConfig:new();
local stageConfig = Spearhead.internal.configuration.StageConfig:new();
Spearhead.internal.GlobalCapManager.start(databaseManager, capConfig, stageConfig)
Spearhead.internal.GlobalStageManager.start(databaseManager, stageConfig)
@@ -34,3 +29,25 @@ Spearhead.LoadingDone()
-- Get-ChildItem . -Include *.lua -Recurse | foreach {""+(Get-Content $_).Count + " => " + $_.name }; && GCI . -Include *.lua* -Recurse | foreach{(GC $_).Count} | measure-object -sum | % Sum
-- find . -name '*.lua' | xargs wc -l
--- ==================== DEBUG ORDER OR ZONE VEC ===========================
-- local zone = Spearhead.DcsUtil.getZoneByName("MISSIONSTAGE_99")
-- local count = Spearhead.Util.tableLength(zone.verts)
-- for i = 1, count - 1 do
-- local a = zone.verts[i]
-- local b = zone.verts[i+1]
-- local color = {0,0,0,1}
-- color[i] = 1
-- trigger.action.textToAll(-1, 46+i , { x= a.x, y = 0, z = a.z } , color, {0,0,0}, 24 , true , "" .. i )
-- trigger.action.lineToAll(-1 , 56+i , { x= a.x, y = 0, z = a.z } , { x = b.x, y = 0, z = b.z } , color , 1, true)
-- end