Skip to content

Zombie api gadget #5784

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Stiofan-K wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Zombie api gadget #5784

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c947738
zombie api gadget
Stiofan-K Jul 9, 2026
c33638a
more descriptive names
Stiofan-K Jul 11, 2026
c205f9f
Made random orders a direct export
Stiofan-K Jul 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
191 changes: 191 additions & 0 deletions LuaRules/Gadgets/api_zombie_helper.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------

Comment on lines +2 to +3

@sprunk sprunk Sep 3, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

needs a synced code check, same as zombies

function gadget:GetInfo()
return {
name = "Zombie helper api",
desc = "The place to handle your zombie esque needs!",
author = "Stiofan",
date = "June 2026",
Comment on lines +8 to +9

@sprunk sprunk Sep 3, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

largely just shuffling of existing code

Suggested change
author = "Stiofan",
date = "June 2026",
author = "TomFyuri, Stiofan",
date = "Mar 2014",

license = "GPL v2 or later",
layer = math.huge,
enabled = true
}
end

--------------------------------------------------------------------------------
--------------------------------------------------------------------------------

-- pathing tester. Is this the correct way to import these things?
VFS.Include("LuaRules/Configs/CAI/accessory/targetReachableTester.lua")

-- unsure if these are different, differentiating between gaia and "zombie" team somehow may be good?
local GaiaTeamID = Spring.GetGaiaTeamID()
local GaiaAllyTeamID = select(6, Spring.GetTeamInfo(GaiaTeamID, false))

local mapWidth
local mapHeight

local REZ_SOUND = "sounds/misc/resurrect.wav"

--unused, may be used depending on how things shake out
local ZOMBIE_SOUNDS = {
"sounds/misc/zombie_1.wav",
"sounds/misc/zombie_2.wav",
Comment on lines +31 to +34

@sprunk sprunk Sep 3, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sounds easy to copypaste if/when that happens

"sounds/misc/zombie_3.wav",
}




-- Zombie resurrect

-- unsure if necessary, seems like just an extra failsafe
local function GetFeatureResurrectData(featureID)
local featureDefName, facing = Spring.GetFeatureResurrect(featureID)
if featureDefName == "" then
local featureDef = FeatureDefs[Spring.GetFeatureDefID(featureID)]
local featureName = featureDef.name or ""
if featureDef.resurrectable == 1 then
featureDefName = featureName:gsub('(.*)_.*', '%1') --filter out _dead
facing = facing or 0
end
end
return featureDefName, facing
end

local function TurnFeatureIntoUnit(featureID,teamID,reclaimPercentHealth)

local featureDefName,facing = GetFeatureResurrectData(featureID)
local x, y, z = Spring.GetFeaturePosition(featureID)

if reclaimPercentHealth then
local currentMetal, maxMetal = Spring.GetFeatureResources(featureID)
if currentMetal and maxMetal and (maxMetal > 0) then
partialReclaim = currentMetal/maxMetal
Comment on lines +62 to +65

@sprunk sprunk Sep 3, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When the code does not enter these ifs then the partialReclaim var (which is a global btw) will be nil,

end
end

Spring.DestroyFeature(featureID)
local unitID = Spring.CreateUnit(featureDefName, x, y, z, facing, teamID)
Comment on lines +69 to +70

@sprunk sprunk Sep 3, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these could be swapped, would keep a brief window where they exist together to allow transferring some traits from the feature to the unit in the future, if needed


if (unitID) then
gadgetHandler:NotifyUnitCreatedByMechanic(unitID, false, "zombies")
local size = UnitDefNames[featureDefName].xsize
Spring.SpawnCEG("resurrect", x, y, z, 0, 0, 0, size)
Spring.GiveOrderToUnit(unitID, CMD.FIRE_STATE, 2, 0)
GG.PlayFogHiddenSound(REZ_SOUND, 12, x, y, z)
if partialReclaim ~= 1 then
local health = Spring.GetUnitHealth(unitID)
if health then
Spring.SetUnitHealth(unitID, health*partialReclaim)
Comment on lines +78 to +81

@sprunk sprunk Sep 3, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and since nil ~= 1 it will enter there and crash on health * partialReclaim due to multiplication by nil.

end
end
end

return unitID
end

-- Works on non zombie units too.
local function SetZombieSpeedMult(unitID,speedMult)
Spring.SetUnitRulesParam(unitID, "zombieSpeedMult", speedMult, LOS_ACCESS)

@sprunk sprunk Sep 3, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that it's an API it needs a bit more care around argument correctness, perhaps add something like

Suggested change
Spring.SetUnitRulesParam(unitID, "zombieSpeedMult", speedMult, LOS_ACCESS)
if type(speedMult) ~= 'number' or speedMult < 0 then
error("SetZombieSpeedMult: mult must be number >= 0")
end
Spring.SetUnitRulesParam(unitID, "zombieSpeedMult", speedMult, LOS_ACCESS)

GG.UpdateUnitAttributes(unitID)
end


-- Zombie commands

local function RandomFactoryOrders(unitID, unitDefID) -- give factory something to do
local buildopts = UnitDefs[unitDefID].buildOptions
if (not buildopts) or #buildopts <= 0 then
return
end
local orders = {}
for i = 1, math.random(10, 30) do
orders[#orders + 1] = {-buildopts[math.random(1, #buildopts)], 0, 0 }
end
if (#orders > 0) then
if not Spring.GetUnitIsDead(unitID) then
Comment on lines +107 to +108

@sprunk sprunk Sep 3, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

death checks could be done at the top, before rolling dice 30 times. the orders check is redundant since there's always at least 10 orders.

Spring.GiveOrderArrayToUnitArray({unitID}, orders)

@sprunk sprunk Sep 3, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the array always has just 1 unit, so could be just Spring.GiveOrderArrayToUnit

end
end
end


local function disSQ(x1, y1, x2, y2)
return (x1 - x2)^2 + (y1 - y2)^2
end
Comment on lines +115 to +117

@sprunk sprunk Sep 3, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could use math.diag for distance


local function GetUnitNearestAlly(unitID, range)
local best_ally
local best_dist
local x, y, z = Spring.GetUnitPosition(unitID)
local units = Spring.GetUnitsInCylinder(x, z, range)
for i = 1, #units do
local allyID = units[i]
local allyTeam = Spring.GetUnitTeam(allyID)
local allyDefID = Spring.GetUnitDefID(allyID)
if (allyID ~= unitID) and (allyTeam == GaiaTeamID) and (Spring.Utilities.getMovetype(UnitDefs[allyDefID]) ~= false) then
local ox, oy, oz = Spring.GetUnitPosition(allyID)
local dist = disSQ(x, z, ox ,oz)
if IsTargetReallyReachable(unitID, ox, oy, oz, x, y, z) and ((best_dist == nil) or (dist < best_dist)) then
best_ally = allyID
best_dist = dist
end
end
end
return best_ally
end

local function GiveZombiesRandomOrders(unitID)
local unitDefID = (not Spring.GetUnitIsDead(unitID)) and Spring.GetUnitDefID(unitID)
if not unitDefID then
return
end

local rx,rz,ry
local orders = {}
local near_ally
if (UnitDefs[unitDefID].canAttack) then
-- May be uncessecary, but it depends on the kind of behavior that is wanted. I suppose mirroring the previous behavior is the objective
near_ally = GetUnitNearestAlly(unitID, 300)
if (near_ally) then
if Spring.GetUnitCurrentCommand(near_ally) == CMD.GUARD then
near_ally = nil -- avoiding chain guards
end
end
end
local x,y,z = Spring.GetUnitPosition(unitID)
if (near_ally) and math.random(0, 5) < 4 then -- 60% chance to guard nearest ally
orders[#orders + 1] = {CMD.GUARD, {near_ally}, 0}
end
for i = 1, math.random(10, 30) do
rx = math.random(0, mapWidth)
rz = math.random(0, mapHeight)
ry = Spring.GetGroundHeight(rx,rz)
if IsTargetReallyReachable(unitID, rx, ry, rz, x, y, z) then
orders[#orders+1] = {CMD.FIGHT, {rx, ry, rz}, CMD.OPT_SHIFT}
end
end
if (#orders > 0) then
if not Spring.GetUnitIsDead(unitID) then
Spring.GiveOrderArrayToUnitArray({unitID},orders)
end
end
if (UnitDefs[unitDefID].isFactory) then
RandomFactoryOrders(unitID, unitDefID) -- give factory something to do
end
end

function gadget:Initialize()

mapWidth = Game.mapSizeX
mapHeight = Game.mapSizeZ

GG.Zombies = {
TurnFeatureIntoUnit = TurnFeatureIntoUnit,
SetZombieSpeedMult = SetZombieSpeedMult,
SetZombieBehavior = GiveZombiesRandomOrders,
GetFeatureResurrectData = GetFeatureResurrectData
}
end
138 changes: 8 additions & 130 deletions LuaRules/Gadgets/unit_zombies.lua → .../Gadgets/unit_global_zombie_resurrect.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ local spGetAllFeatures = Spring.GetAllFeatures
local spGiveOrderToUnit = Spring.GiveOrderToUnit
local spGetUnitCommandCount = Spring.GetUnitCommandCount
local spDestroyFeature = Spring.DestroyFeature
local spGetFeatureResurrect = Spring.GetFeatureResurrect
local spGetUnitIsDead = Spring.GetUnitIsDead
local spGiveOrderArrayToUnitArray = Spring.GiveOrderArrayToUnitArray
local spGetUnitsInCylinder = Spring.GetUnitsInCylinder
Expand Down Expand Up @@ -129,11 +128,6 @@ local function disSQ(x1, y1, x2, y2)
return (x1 - x2)^2 + (y1 - y2)^2
end

local function SetZombieSlow(unitID, slowed)
spSetUnitRulesParam(unitID, "zombieSpeedMult", (slowed and 0.5) or 1, LOS_ACCESS)
GG.UpdateUnitAttributes(unitID)
end

local function RemoveZombieToSpawn(featureID)
if not zombiesToSpawnMap[featureID] then
return false
Expand All @@ -153,44 +147,6 @@ local function RemoveZombieToSpawn(featureID)
return true
end

local function GetUnitNearestAlly(unitID, range)
local best_ally
local best_dist
local x, y, z = spGetUnitPosition(unitID)
local units = spGetUnitsInCylinder(x, z, range)
for i = 1, #units do
local allyID = units[i]
local allyTeam = spGetUnitTeam(allyID)
local allyDefID = spGetUnitDefID(allyID)
if (allyID ~= unitID) and (allyTeam == GaiaTeamID) and (getMovetype(UnitDefs[allyDefID]) ~= false) then
local ox, oy, oz = spGetUnitPosition(allyID)
local dist = disSQ(x, z, ox ,oz)
if IsTargetReallyReachable(unitID, ox, oy, oz, x, y, z) and ((best_dist == nil) or (dist < best_dist)) then
best_ally = allyID
best_dist = dist
end
end
end
return best_ally
end

local function OpenAllClownSlots(unitID, unitDefID) -- give factory something to do
local buildopts = UnitDefs[unitDefID].buildOptions
if (not buildopts) or #buildopts <= 0 then
return
end
local orders = {}
--local x,y,z = spGetUnitPosition(unitID)
for i = 1, random(10, 30) do
orders[#orders + 1] = {-buildopts[random(1, #buildopts)], 0, 0 }
end
if (#orders > 0) then
if not spGetUnitIsDead(unitID) then
spGiveOrderArrayToUnitArray({unitID}, orders)
end
end
end

-- reclaiming zombies 'causes delay in rez, basically you have to have about ZOMBIES_REZ_SPEED/2 or bigger BP to reclaim faster than it resurrects...
-- TODO do more math to figure out how to perform it better?
function gadget:AllowFeatureBuildStep(builderID, builderTeam, featureID, featureDefID, part)
Expand All @@ -202,68 +158,13 @@ function gadget:AllowFeatureBuildStep(builderID, builderTeam, featureID, feature
return true
end

-- in halloween gadget, sometimes giving order to unit would result in crash because unit happened to be dead at the time order was given
-- TODO probably same units in groups could get same orders...
local function BringingDownTheHeavens(unitID)
local unitDefID = (not spGetUnitIsDead(unitID)) and spGetUnitDefID(unitID)
if not unitDefID then
return
end

local rx,rz,ry
local orders = {}
local near_ally
if (UnitDefs[unitDefID].canAttack) then
near_ally = GetUnitNearestAlly(unitID, 300)
if (near_ally) then
if Spring.GetUnitCurrentCommand(near_ally) == CMD_GUARD then
near_ally = nil -- i dont want chain guards...
end
end
end
local x,y,z = spGetUnitPosition(unitID)
if (near_ally) and random(0, 5) < 4 then -- 60% chance to guard nearest ally
orders[#orders + 1] = {CMD_GUARD, {near_ally}, 0}
end
for i = 1, random(10, 30) do
rx = random(0, mapWidth)
rz = random(0, mapHeight)
ry = spGetGroundHeight(rx,rz)
if IsTargetReallyReachable(unitID, rx, ry, rz, x, y, z) then
orders[#orders+1] = {CMD_FIGHT, {rx, ry, rz}, CMD_OPT_SHIFT}
end
end
if (#orders > 0) then
if not spGetUnitIsDead(unitID) then
spGiveOrderArrayToUnitArray({unitID},orders)
end
end
if (UnitDefs[unitDefID].isFactory) then
OpenAllClownSlots(unitID, unitDefID) -- give factory something to do
zombies[unitID] = nil -- no need to update factory orders anymore
end
end

local function CheckZombieOrders() -- i can't rely on Idle because if for example unit is unloaded it doesnt count as idle... weird
for unitID, _ in pairs(zombies) do
local queueSize = spGetUnitCommandCount(unitID)
if not (queueSize) or not (queueSize > 0) then -- oh
BringingDownTheHeavens(unitID)
end
end
end

local function myGetFeatureRessurect(fId)
local resName, face = spGetFeatureResurrect(fId)
if resName == "" then
local featureDef = FeatureDefs[Spring.GetFeatureDefID(fId)]
local featureName = featureDef.name or ""
if featureDef.resurrectable == 1 then
resName = featureName:gsub('(.*)_.*', '%1') --filter out _dead
face = face or 0
if not (queueSize) or not (queueSize > 0) then
GG.Zombies.SetZombieBehavior(unitID)
end
end
return resName, face
end

function gadget:GameFrame(f)
Expand All @@ -280,33 +181,10 @@ function gadget:GameFrame(f)
if not RemoveZombieToSpawn(featureID) then
index = index + 1
end
local resName, face = myGetFeatureRessurect(featureID)
local partialReclaim = 1
if ZOMBIES_PARTIAL_RECLAIM then
local currentMetal, maxMetal = Spring.GetFeatureResources(featureID)
if currentMetal and maxMetal and (maxMetal > 0) then
partialReclaim = currentMetal/maxMetal
end
end
spDestroyFeature(featureID)
local unitID = spCreateUnit(resName, x, y, z, face, GaiaTeamID)
if (unitID) then
gadgetHandler:NotifyUnitCreatedByMechanic(unitID, false, "zombies")
local size = UnitDefNames[resName].xsize
spSpawnCEG("resurrect", x, y, z, 0, 0, 0, size)
Spring.GiveOrderToUnit(unitID, CMD.FIRE_STATE, 2, 0)
GG.PlayFogHiddenSound(REZ_SOUND, 12, x, y, z)
if partialReclaim ~= 1 then
local health = Spring.GetUnitHealth(unitID)
if health then
Spring.SetUnitHealth(unitID, health*partialReclaim)
--spSetUnitRulesParam(unitID, "zombie_partialReclaim", partialReclaim, PRIVATE_ACCESS)
end
end
end
GG.Zombies.TurnFeatureIntoUnit(featureID,GaiaTeamID,true)
else
local steps_to_spawn = floor((time_to_spawn - f) / 32)
local resName, face = myGetFeatureRessurect(featureID)
local resName, face = GG.Zombies.GetFeatureResurrectData(featureID)
if steps_to_spawn <= WARNING_TIME then
local r = Spring.GetFeatureRadius(featureID)

Expand Down Expand Up @@ -342,7 +220,7 @@ function gadget:UnitTaken(unitID, unitDefID, teamID, newTeamID)
zombies[unitID] = nil
-- taking away zombie from zombie team unpermaslows it
if ZOMBIES_PERMA_SLOW then
SetZombieSlow(unitID, false)
GG.Zombies.SetZombieSpeedMult(unitID, 1)
end
elseif newTeamID == GaiaTeamID then
gadget:UnitFinished(unitID, unitDefID, newTeamID)
Expand All @@ -360,7 +238,7 @@ function gadget:UnitFinished(unitID, unitDefID, teamID)
end

function gadget:FeatureCreated(featureID, allyTeam)
local resName, face = myGetFeatureRessurect(featureID)
local resName, face = GG.Zombies.GetFeatureResurrectData(featureID)
if resName and face and not zombies_to_spawn[featureID] then
local ud = resName and UnitDefNames[resName]
if ud and not NonZombies[resName] then
Expand Down Expand Up @@ -392,12 +270,12 @@ local function ReInit(reinit)
if (teamID == GaiaTeamID) and not (zombies[unitID]) then
spGiveOrderToUnit(unitID, CMD_REPEAT, 1, 0)
spGiveOrderToUnit(unitID, CMD_MOVE_STATE, 2, 0)
BringingDownTheHeavens(unitID)
GG.Zombies.SetZombieBehavior(unitID)
zombies[unitID] = true
if ZOMBIES_PERMA_SLOW then
local maxHealth = select(2, spGetUnitHealth(unitID))
if maxHealth then
SetZombieSlow(unitID, true)
GG.Zombies.SetZombieSpeedMult(unitID, ZOMBIES_PERMA_SLOW)
end
end
end
Expand Down