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

-- File : /lua/defaultunits.lua

-- Author(s): John Comes, Gordon Duclos

-- Summary : Default definitions of units

-- Copyright © 2005 Gas Powered Games, Inc. All rights reserved.

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

local Unit = import('/lua/sim/Unit.lua').Unit

local explosion = import('defaultexplosions.lua')

local EffectUtil = import('EffectUtilities.lua')

local EffectTemplate = import('/lua/EffectTemplates.lua')

local ScenarioUtils = import('/lua/sim/ScenarioUtilities.lua')

local Buff = import('/lua/sim/Buff.lua')

local AdjacencyBuffs = import('/lua/sim/AdjacencyBuffs.lua')

local FireState = import('/lua/game.lua').FireState

local ScenarioFramework = import('/lua/ScenarioFramework.lua')

local teleportTime = {}

local CreateScaledBoom = function(unit, overkill, bone)

explosion.CreateDefaultHitExplosionAtBone(

unit,

bone or 0,

explosion.CreateUnitExplosionEntity(unit, overkill).Spec.BoundingXZRadius

)

end

-- MISC UNITS

DummyUnit = Class(Unit) {

OnStopBeingBuilt = function(self, builder, layer)

self:Destroy()

end,

}

-- STRUCTURE UNITS

StructureUnit = Class(Unit) {

LandBuiltHiddenBones = {'Floatation'},

MinConsumptionPerSecondEnergy = 1,

MinWeaponRequiresEnergy = 0,

-- Stucture unit specific damage effects and smoke

FxDamage1 = {EffectTemplate.DamageStructureSmoke01, EffectTemplate.DamageStructureSparks01},

FxDamage2 = {EffectTemplate.DamageStructureFireSmoke01, EffectTemplate.DamageStructureSparks01},

FxDamage3 = {EffectTemplate.DamageStructureFire01, EffectTemplate.DamageStructureSparks01},

OnCreate = function(self)

Unit.OnCreate(self)

self.WeaponMod = {}

self.FxBlinkingLightsBag = {}

if self:GetCurrentLayer() == 'Land' and self:GetBlueprint().Physics.FlattenSkirt then

self:FlattenSkirt()

end

end,

RotateTowardsEnemy = function(self)

local bp = self:GetBlueprint()

local brain = self:GetAIBrain()

local pos = self:GetPosition()

local x, y = GetMapSize()

local threats = {{pos = {x / 2, 0, y / 2}, dist = VDist2(pos[1], pos[3], x, y), threat = -1}}

local cats = EntityCategoryContains(categories.ANTIAIR, self) and categories.AIR or (categories.STRUCTURE + categories.LAND + categories.NAVAL)

local units = brain:GetUnitsAroundPoint(cats, pos, 2 * (bp.AI.GuardScanRadius or 100), 'Enemy')

for _, u in units do

local blip = u:GetBlip(self.Army)

if blip then

local on_radar = blip:IsOnRadar(self.Army)

local seen = blip:IsSeenEver(self.Army)

if on_radar or seen then

local epos = u:GetPosition()

local threat = seen and (u:GetBlueprint().Defense.SurfaceThreatLevel or 0) or 1

table.insert(threats, {pos = epos, threat = threat, dist = VDist2(pos[1], pos[3], epos[1], epos[3])})

end

end

end

table.sort(threats, function(a, b)

if a.threat <= 0 and b.threat <= 0 then

return a.threat == b.threat and a.dist < b.dist or a.threat > b.threat

elseif a.threat <= 0 then return false

elseif b.threat <= 0 then return true

else return a.dist < b.dist end

end)

local t = threats[1]

local rad = math.atan2(t.pos[1]-pos[1], t.pos[3]-pos[3])

local degrees = rad * (180 / math.pi)

if EntityCategoryContains(categories.ARTILLERY * (categories.TECH3 + categories.EXPERIMENTAL), self) then

degrees = math.floor((degrees + 45) / 90) * 90

end

self:SetRotation(degrees)

end,

OnStartBeingBuilt = function(self, builder, layer)

if EntityCategoryContains(categories.STRUCTURE * (categories.DIRECTFIRE + categories.INDIRECTFIRE) * (categories.DEFENSE + categories.ARTILLERY), self) then

self:RotateTowardsEnemy()

end

Unit.OnStartBeingBuilt(self, builder, layer)

local bp = self:GetBlueprint()

if bp.Physics.FlattenSkirt and not self:HasTarmac() and bp.General.FactionName ~= "Seraphim" then

if self.TarmacBag then

self:CreateTarmac(true, true, true, self.TarmacBag.Orientation, self.TarmacBag.CurrentBP)

else

self:CreateTarmac(true, true, true, false, false)

end

end

end,

OnStopBeingBuilt = function(self, builder, layer)

Unit.OnStopBeingBuilt(self, builder, layer)

-- Whaa why can't we have sane inheritance chains :/

if self:GetBlueprint().General.FactionName == "Seraphim" then

self:CreateTarmac(true, true, true, false, false)

end

self:PlayActiveAnimation()

end,

OnFailedToBeBuilt = function(self)

Unit.OnFailedToBeBuilt(self)

self:DestroyTarmac()

end,

FlattenSkirt = function(self)

local x, y, z = unpack(self:GetCachePosition())

local x0, z0, x1, z1 = self:GetSkirtRect()

x0, z0, x1, z1 = math.floor(x0), math.floor(z0), math.ceil(x1), math.ceil(z1)

FlattenMapRect(x0, z0, x1 - x0, z1 - z0, y)

end,

CreateTarmac = function(self, albedo, normal, glow, orientation, specTarmac, lifeTime)

if self:GetCurrentLayer() ~= 'Land' then return end

local tarmac

local bp = self:GetBlueprint().Display.Tarmacs

if not specTarmac then

if bp and table.getn(bp) > 0 then

local num = Random(1, table.getn(bp))

tarmac = bp[num]

else

return false

end

else

tarmac = specTarmac

end

local w = tarmac.Width

local l = tarmac.Length

local fadeout = tarmac.FadeOut

local x, y, z = unpack(self:GetPosition())

-- I'm disabling this for now since there are so many things wrong with it

local orient = orientation

if not orientation then

if tarmac.Orientations and table.getn(tarmac.Orientations) > 0 then

orient = tarmac.Orientations[Random(1, table.getn(tarmac.Orientations))]

orient = (0.01745 * orient)

else

orient = 0

end

end

if not self.TarmacBag then

self.TarmacBag = {

Decals = {},

Orientation = orient,

CurrentBP = tarmac,

}

end

local GetTarmac = import('/lua/tarmacs.lua').GetTarmacType

local terrain = GetTerrainType(x, z)

local terrainName

if terrain then

terrainName = terrain.Name

end

-- Players and AI can build buildings outside of their faction. Get the *building's* faction to determine the correct tarrain-specific tarmac

local factionTable = {e = 1, a = 2, r = 3, s = 4}

local faction = factionTable[string.sub(self.UnitId, 2, 2)]

if albedo and tarmac.Albedo then

local albedo2 = tarmac.Albedo2

if albedo2 then

albedo2 = albedo2 .. GetTarmac(faction, terrain)

end

local tarmacHndl = CreateDecal(self:GetPosition(), orient, tarmac.Albedo .. GetTarmac(faction, terrainName) , albedo2 or '', 'Albedo', w, l, fadeout, lifeTime or 0, self.Army, 0)

table.insert(self.TarmacBag.Decals, tarmacHndl)

if tarmac.RemoveWhenDead then

self.Trash:Add(tarmacHndl)

end

end

if normal and tarmac.Normal then

local tarmacHndl = CreateDecal(self:GetPosition(), orient, tarmac.Normal .. GetTarmac(faction, terrainName), '', 'Alpha Normals', w, l, fadeout, lifeTime or 0, self.Army, 0)

table.insert(self.TarmacBag.Decals, tarmacHndl)

if tarmac.RemoveWhenDead then

self.Trash:Add(tarmacHndl)

end

end

if glow and tarmac.Glow then

local tarmacHndl = CreateDecal(self:GetPosition(), orient, tarmac.Glow .. GetTarmac(faction, terrainName), '', 'Glow', w, l, fadeout, lifeTime or 0, self.Army, 0)

table.insert(self.TarmacBag.Decals, tarmacHndl)

if tarmac.RemoveWhenDead then

self.Trash:Add(tarmacHndl)

end

end

end,

DestroyTarmac = function(self)

if not self.TarmacBag then return end

for k, v in self.TarmacBag.Decals do

v:Destroy()

end

self.TarmacBag.Orientation = nil

self.TarmacBag.CurrentBP = nil

end,

HasTarmac = function(self)

if not self.TarmacBag then return false end

return table.getn(self.TarmacBag.Decals) ~= 0

end,

OnMassStorageStateChange = function(self, state)

end,

OnEnergyStorageStateChange = function(self, state)

end,

CreateBlinkingLights = function(self, color)

self:DestroyBlinkingLights()

local bp = self:GetBlueprint()

if bp.Display.BlinkingLights then

local fxbp = bp.Display.BlinkingLightsFx[color]

for _, v in bp.Display.BlinkingLights do

if type(v) == 'table' then

local fx = CreateAttachedEmitter(self, v.BLBone, self.Army, fxbp)

fx:OffsetEmitter(v.BLOffsetX or 0, v.BLOffsetY or 0, v.BLOffsetZ or 0)

fx:ScaleEmitter(v.BLScale or 1)

table.insert(self.FxBlinkingLightsBag, fx)

self.Trash:Add(fx)

end

end

end

end,

DestroyBlinkingLights = function(self)

for _, v in self.FxBlinkingLightsBag do

v:Destroy()

end

self.FxBlinkingLightsBag = {}

end,

CreateDestructionEffects = function(self, overkillRatio)

if explosion.GetAverageBoundingXZRadius(self) < 1.0 then

explosion.CreateScalableUnitExplosion(self, overkillRatio)

else

explosion.CreateTimedStuctureUnitExplosion(self)

WaitSeconds(0.5)

explosion.CreateScalableUnitExplosion(self, overkillRatio)

end

end,

-- Modified to use same upgrade logic as the ui. This adds more upgrade options via General.UpgradesFromBase blueprint option

OnStartBuild = function(self, unitBeingBuilt, order)

-- Check for death loop

if not Unit.OnStartBuild(self, unitBeingBuilt, order) then

return

end

self.UnitBeingBuilt = unitBeingBuilt

local builderBp = self:GetBlueprint()

local targetBp = unitBeingBuilt:GetBlueprint()

local performUpgrade = false

if targetBp.General.UpgradesFrom == builderBp.BlueprintId then

performUpgrade = true

elseif targetBp.General.UpgradesFrom == builderBp.General.UpgradesTo then

performUpgrade = true

elseif targetBp.General.UpgradesFromBase ~= "none" then

-- Try testing against the base

if targetBp.General.UpgradesFromBase == builderBp.BlueprintId then

performUpgrade = true

elseif targetBp.General.UpgradesFromBase == builderBp.General.UpgradesFromBase then

performUpgrade = true

end

end

if performUpgrade and order == 'Upgrade' then

ChangeState(self, self.UpgradingState)

end

end,

IdleState = State {

Main = function(self)

end,

},

UpgradingState = State {

Main = function(self)

self:StopRocking()

local bp = self:GetBlueprint().Display

self:DestroyTarmac()

self:PlayUnitSound('UpgradeStart')

self:DisableDefaultToggleCaps()

if bp.AnimationUpgrade then

local unitBuilding = self.UnitBeingBuilt

self.AnimatorUpgradeManip = CreateAnimator(self)

self.Trash:Add(self.AnimatorUpgradeManip)

local fractionOfComplete = 0

self:StartUpgradeEffects(unitBuilding)

self.AnimatorUpgradeManip:PlayAnim(bp.AnimationUpgrade, false):SetRate(0)

while fractionOfComplete < 1 and not self.Dead do

fractionOfComplete = unitBuilding:GetFractionComplete()

self.AnimatorUpgradeManip:SetAnimationFraction(fractionOfComplete)

WaitTicks(1)

end

if not self.Dead then

self.AnimatorUpgradeManip:SetRate(1)

end

end

end,

OnStopBuild = function(self, unitBuilding)

Unit.OnStopBuild(self, unitBuilding)

self:EnableDefaultToggleCaps()

if unitBuilding:GetFractionComplete() == 1 then

NotifyUpgrade(self, unitBuilding)

self:StopUpgradeEffects(unitBuilding)

self:PlayUnitSound('UpgradeEnd')

self:Destroy()

end

end,

OnFailedToBuild = function(self)

Unit.OnFailedToBuild(self)

self:EnableDefaultToggleCaps()

if self.AnimatorUpgradeManip then self.AnimatorUpgradeManip:Destroy() end

if self:GetCurrentLayer() == 'Water' then

self:StartRocking()

end

self:PlayUnitSound('UpgradeFailed')

self:PlayActiveAnimation()

self:CreateTarmac(true, true, true, self.TarmacBag.Orientation, self.TarmacBag.CurrentBP)

ChangeState(self, self.IdleState)

end,

},

StartBeingBuiltEffects = function(self, builder, layer)

Unit.StartBeingBuiltEffects(self, builder, layer)

local bp = self:GetBlueprint()

local FactionName = bp.General.FactionName

if FactionName == 'UEF' then

self:HideBone(0, true)

self.BeingBuiltShowBoneTriggered = false

if bp.General.UpgradesFrom ~= builder.UnitId then

self:ForkThread(EffectUtil.CreateBuildCubeThread, builder, self.OnBeingBuiltEffectsBag)

end

elseif FactionName == 'Aeon' then

if bp.General.UpgradesFrom ~= builder.UnitId then

self:ForkThread(EffectUtil.CreateAeonBuildBaseThread, builder, self.OnBeingBuiltEffectsBag)

end

elseif FactionName == 'Seraphim' then

if bp.General.UpgradesFrom ~= builder.UnitId then

self:ForkThread(EffectUtil.CreateSeraphimBuildBaseThread, builder, self.OnBeingBuiltEffectsBag)

end

end

end,

StopBeingBuiltEffects = function(self, builder, layer)

local FactionName = self:GetBlueprint().General.FactionName

if FactionName == 'Aeon' then

WaitSeconds(2.0)

elseif FactionName == 'UEF' and not self.BeingBuiltShowBoneTriggered then

self:ShowBone(0, true)

self:HideLandBones()

end

Unit.StopBeingBuiltEffects(self, builder, layer)

end,

StartBuildingEffects = function(self, unitBeingBuilt, order)

Unit.StartBuildingEffects(self, unitBeingBuilt, order)

end,

StopBuildingEffects = function(self, unitBeingBuilt)

Unit.StopBuildingEffects(self, unitBeingBuilt)

end,

StartUpgradeEffects = function(self, unitBeingBuilt)

unitBeingBuilt:HideBone(0, true)

end,

StopUpgradeEffects = function(self, unitBeingBuilt)

unitBeingBuilt:ShowBone(0, true)

end,

PlayActiveAnimation = function(self)

end,

-- Adding into OnDestroy the ability to destroy the tarmac but put a new one down that looks exactly like it but

-- will time out over the time spec'd or 300 seconds.

OnDestroy = function(self)

Unit.OnDestroy(self)

local orient = self.TarmacBag.Orientation

local currentBP = self.TarmacBag.CurrentBP

self:DestroyTarmac()

self:CreateTarmac(true, true, true, orient, currentBP, currentBP.DeathLifetime or 300)

end,

OnKilled = function(self, instigator, type, overkillRatio)

local scus = EntityCategoryFilterDown(categories.SUBCOMMANDER, self:GetGuards())

if scus[1] then

for _, u in scus do

u:SetFocusEntity(self)

self.Repairers[u.EntityId] = u

end

end

Unit.OnKilled(self, instigator, type, overkillRatio)

end,

CheckRepairersForRebuild = function(self, wreckage)

local units = {}

for id, u in self.Repairers do

if u:BeenDestroyed() then

self.Repairers[id] = nil

else

local focus = u:GetFocusUnit()

if focus == self and ((u:IsUnitState('Repairing') and not u:GetGuardedUnit()) or

EntityCategoryContains(categories.SUBCOMMANDER, u)) then

table.insert(units, u)

end

end

end

if not units[1] then return end

wreckage:Rebuild(units)

end,

CreateWreckage = function(self, overkillRatio)

local wreckage = Unit.CreateWreckage(self, overkillRatio)

if wreckage then

self:CheckRepairersForRebuild(wreckage)

end

return wreckage

end,

-- Adjacency

-- When we're adjacent, try to apply all the possible bonuses

OnAdjacentTo = function(self, adjacentUnit, triggerUnit) -- What is triggerUnit?

if self:IsBeingBuilt() then return end

if adjacentUnit:IsBeingBuilt() then return end

-- Does the unit have any adjacency buffs to use?

local adjBuffs = self:GetBlueprint().Adjacency

if not adjBuffs then return end

-- Apply each buff needed to you and/or adjacent unit

for k, v in AdjacencyBuffs[adjBuffs] do

Buff.ApplyBuff(adjacentUnit, v, self)

end

-- Keep track of adjacent units

if not self.AdjacentUnits then

self.AdjacentUnits = {}

end

table.insert(self.AdjacentUnits, adjacentUnit)

self:RequestRefreshUI()

adjacentUnit:RequestRefreshUI()

end,

-- When we're not adjacent, try to remove all the possible bonuses

OnNotAdjacentTo = function(self, adjacentUnit)

if not self.AdjacentUnits then

WARN("Precondition Failed: No AdjacentUnits registered for entity: " .. repr(self.GetEntityId))

return

end

local adjBuffs = self:GetBlueprint().Adjacency

if adjBuffs and AdjacencyBuffs[adjBuffs] then

for k, v in AdjacencyBuffs[adjBuffs] do

if Buff.HasBuff(adjacentUnit, v) then

Buff.RemoveBuff(adjacentUnit, v)

end

end

end

self:DestroyAdjacentEffects()

-- Keep track of units losing adjacent structures

for k, u in self.AdjacentUnits do

if u == adjacentUnit then

table.remove(self.AdjacentUnits, k)

adjacentUnit:RequestRefreshUI()

end

end

self:RequestRefreshUI()

end,

-- Add/Remove Adjacency Functionality

-- Applies all appropriate buffs to all adjacent units

ApplyAdjacencyBuffs = function(self)

local adjBuffs = self:GetBlueprint().Adjacency

if not adjBuffs then return end

-- There won't be any adjacentUnit if this is a producer just built...

if self.AdjacentUnits then

for k, adjacentUnit in self.AdjacentUnits do

for k, v in AdjacencyBuffs[adjBuffs] do

Buff.ApplyBuff(adjacentUnit, v, self)

adjacentUnit:RequestRefreshUI()

end

end

self:RequestRefreshUI()

end

end,

-- Removes all appropriate buffs from all adjacent units

RemoveAdjacencyBuffs = function(self)

local adjBuffs = self:GetBlueprint().Adjacency

if not adjBuffs then return end

if self.AdjacentUnits then

for k, adjacentUnit in self.AdjacentUnits do

for key, v in AdjacencyBuffs[adjBuffs] do

if Buff.HasBuff(adjacentUnit, v) then

Buff.RemoveBuff(adjacentUnit, v, false, self)

adjacentUnit:RequestRefreshUI()

end

end

end

self:RequestRefreshUI()

end

end,

-- Add/Remove Adjacency Effects

CreateAdjacentEffect = function(self, adjacentUnit)

-- Create trashbag to hold all these entities and beams

if not self.AdjacencyBeamsBag then

self.AdjacencyBeamsBag = {}

end

for k, v in self.AdjacencyBeamsBag do

if v.Unit.EntityId == adjacentUnit.EntityId then

return

end

end

self:ForkThread(EffectUtil.CreateAdjacencyBeams, adjacentUnit, self.AdjacencyBeamsBag)

end,

DestroyAdjacentEffects = function(self, adjacentUnit)

if not self.AdjacencyBeamsBag then return end

for k, v in self.AdjacencyBeamsBag do

if v.Unit:BeenDestroyed() or v.Unit.Dead then

v.Trash:Destroy()

self.AdjacencyBeamsBag[k] = nil

end

end

end,

DoTakeDamage = function(self, instigator, amount, vector, damageType)

-- Handle incoming OC damage

if damageType == 'Overcharge' then

local wep = instigator:GetWeaponByLabel('OverCharge')

amount = wep:GetBlueprint().Overcharge.structureDamage

end

Unit.DoTakeDamage(self, instigator, amount, vector, damageType)

end,

}

-- FACTORY UNITS

FactoryUnit = Class(StructureUnit) {

OnCreate = function(self)

-- Engymod addition: If a normal factory is created, we should check for research stations

if EntityCategoryContains(categories.FACTORY, self) then

self:updateBuildRestrictions()

end

StructureUnit.OnCreate(self)

-- Save build effect bones for faster access when creating build effects

self.BuildEffectBones = self:GetBlueprint().General.BuildBones.BuildEffectBones

self.BuildingUnit = false

self:SetFireState(FireState.GROUND_FIRE)

end,

DestroyUnitBeingBuilt = function(self)

if self.UnitBeingBuilt and not self.UnitBeingBuilt.Dead and self.UnitBeingBuilt:GetFractionComplete() < 1 then

if self.UnitBeingBuilt:GetFractionComplete() > 0.5 then

self.UnitBeingBuilt:Kill()

else

self.UnitBeingBuilt:Destroy()

end

end

end,

OnDestroy = function(self)

-- Figure out if we're a research station

if EntityCategoryContains(categories.RESEARCH, self) then

local aiBrain = self:GetAIBrain()

local buildRestrictionVictims = aiBrain:GetListOfUnits(categories.FACTORY + categories.ENGINEER, false)

for id, unit in buildRestrictionVictims do

unit:updateBuildRestrictions()

end

end

StructureUnit.OnDestroy(self)

self.DestroyUnitBeingBuilt(self)

end,

OnPaused = function(self)

-- When factory is paused take some action

if self:IsUnitState('Building') then

self:StopUnitAmbientSound('ConstructLoop')

StructureUnit.StopBuildingEffects(self, self.UnitBeingBuilt)

end

StructureUnit.OnPaused(self)

end,

OnUnpaused = function(self)

if self:IsUnitState('Building') then

self:PlayUnitAmbientSound('ConstructLoop')

StructureUnit.StartBuildingEffects(self, self.UnitBeingBuilt, self.UnitBuildOrder)

end

StructureUnit.OnUnpaused(self)

end,

OnStopBeingBuilt = function(self, builder, layer)

local aiBrain = GetArmyBrain(self.Army)

aiBrain:ESRegisterUnitMassStorage(self)

aiBrain:ESRegisterUnitEnergyStorage(self)

local curEnergy = aiBrain:GetEconomyStoredRatio('ENERGY')

local curMass = aiBrain:GetEconomyStoredRatio('MASS')

if curEnergy > 0.11 and curMass > 0.11 then

self:CreateBlinkingLights('Green')

self.BlinkingLightsState = 'Green'

else

self:CreateBlinkingLights('Red')

self.BlinkingLightsState = 'Red'

end

-- If we're a HQ, update build restrictions for all factories

if EntityCategoryContains(categories.RESEARCH, self) then

local buildRestrictionVictims = aiBrain:GetListOfUnits(categories.FACTORY + categories.ENGINEER, false)

for id, unit in buildRestrictionVictims do

unit:updateBuildRestrictions()

end

end

StructureUnit.OnStopBeingBuilt(self, builder, layer)

end,

ChangeBlinkingLights = function(self, state)

local bls = self.BlinkingLightsState

if state == 'Yellow' then

if bls == 'Green' then

self:CreateBlinkingLights('Yellow')

self.BlinkingLightsState = state

end

elseif state == 'Green' then

if bls == 'Yellow' then

self:CreateBlinkingLights('Green')

self.BlinkingLightsState = state

elseif bls == 'Red' then

local aiBrain = GetArmyBrain(self.Army)

local curEnergy = aiBrain:GetEconomyStoredRatio('ENERGY')

local curMass = aiBrain:GetEconomyStoredRatio('MASS')

if curEnergy > 0.11 and curMass > 0.11 then

if self:GetNumBuildOrders(categories.ALLUNITS) == 0 then

self:CreateBlinkingLights('Green')

self.BlinkingLightsState = state

else

self:CreateBlinkingLights('Yellow')

self.BlinkingLightsState = 'Yellow'

end

end

end

elseif state == 'Red' then

self:CreateBlinkingLights('Red')

self.BlinkingLightsState = state

end

end,

OnMassStorageStateChange = function(self, newState)

if newState == 'EconLowMassStore' then

self:ChangeBlinkingLights('Red')

else

self:ChangeBlinkingLights('Green')

end

end,

OnEnergyStorageStateChange = function(self, newState)

if newState == 'EconLowEnergyStore' then

self:ChangeBlinkingLights('Red')

else

self:ChangeBlinkingLights('Green')

end

end,

OnStartBuild = function(self, unitBeingBuilt, order)

self:ChangeBlinkingLights('Yellow')

StructureUnit.OnStartBuild(self, unitBeingBuilt, order)

self.BuildingUnit = true

if order ~= 'Upgrade' then

ChangeState(self, self.BuildingState)

self.BuildingUnit = false

elseif unitBeingBuilt:GetBlueprint().CategoriesHash.RESEARCH then

-- Removes assist command to prevent accidental cancellation when right-clicking on other factory

self:RemoveCommandCap('RULEUCC_Guard')

self.DisabledAssist = true

end

self.FactoryBuildFailed = false

end,

--- Introduce a rolloff delay, where defined.

OnStopBuild = function(self, unitBeingBuilt, order)

if self.DisabledAssist then

self:AddCommandCap('RULEUCC_Guard')

self.DisabledAssist = nil

end

local bp = self:GetBlueprint()

if bp.General.RolloffDelay and bp.General.RolloffDelay > 0 and not self.FactoryBuildFailed then

self:ForkThread(self.PauseThread, bp.General.RolloffDelay, unitBeingBuilt, order)

else

self:DoStopBuild(unitBeingBuilt, order)

end

end,

--- Adds a pause between unit productions

PauseThread = function(self, productionpause, unitBeingBuilt, order)

self:StopBuildFx()

self:SetBusy(true)

self:SetBlockCommandQueue(true)

WaitSeconds(productionpause)

self:SetBusy(false)

self:SetBlockCommandQueue(false)

self:DoStopBuild(unitBeingBuilt, order)

end,

DoStopBuild = function(self, unitBeingBuilt, order)

StructureUnit.OnStopBuild(self, unitBeingBuilt, order)

if not self.FactoryBuildFailed and not self.Dead then

if not EntityCategoryContains(categories.AIR, unitBeingBuilt) then

self:RollOffUnit()

end

self:StopBuildFx()

self:ForkThread(self.FinishBuildThread, unitBeingBuilt, order)

end

self.BuildingUnit = false

end,

FinishBuildThread = function(self, unitBeingBuilt, order)

self:SetBusy(true)

self:SetBlockCommandQueue(true)

local bp = self:GetBlueprint()

local bpAnim = bp.Display.AnimationFinishBuildLand

if bpAnim and EntityCategoryContains(categories.LAND, unitBeingBuilt) then

self.RollOffAnim = CreateAnimator(self):PlayAnim(bpAnim)

self.Trash:Add(self.RollOffAnim)

WaitTicks(1)

WaitFor(self.RollOffAnim)

end

if unitBeingBuilt and not unitBeingBuilt.Dead then

unitBeingBuilt:DetachFrom(true)

end

self:DetachAll(bp.Display.BuildAttachBone or 0)

self:DestroyBuildRotator()

if order ~= 'Upgrade' then

ChangeState(self, self.RollingOffState)

else

self:SetBusy(false)

self:SetBlockCommandQueue(false)

end

end,

CheckBuildRestriction = function(self, target_bp)

-- Check basic build restrictions first (Unit.CheckBuildRestriction but we only go up one inheritance level)

if not StructureUnit.CheckBuildRestriction(self, target_bp) then

return false

end

-- Factories never build factories (this does not break Upgrades since CheckBuildRestriction is never called for Upgrades)

-- Note: We check for the primary category, since e.g. AircraftCarriers have the FACTORY category.

-- TODO: This is a hotfix for --1043, remove when engymod design is properly fixed

return target_bp.General.Category ~= 'Factory'

end,

OnFailedToBuild = function(self)

self.FactoryBuildFailed = true

StructureUnit.OnFailedToBuild(self)

self:DestroyBuildRotator()

self:StopBuildFx()

ChangeState(self, self.IdleState)

end,

RollOffUnit = function(self)

local spin, x, y, z = self:CalculateRollOffPoint()

self.MoveCommand = IssueMove({self.UnitBeingBuilt}, Vector(x, y, z))

end,

CalculateRollOffPoint = function(self)

local bp = self:GetBlueprint().Physics.RollOffPoints

local px, py, pz = unpack(self:GetPosition())

if not bp then return 0, px, py, pz end

local vectorObj = self:GetRallyPoint()

local bpKey = 1

local distance, lowest = nil

for k, v in bp do

distance = VDist2(vectorObj[1], vectorObj[3], v.X + px, v.Z + pz)

if not lowest or distance < lowest then

bpKey = k

lowest = distance

end

end

local fx, fy, fz, spin

local bpP = bp[bpKey]

local unitBP = self.UnitBeingBuilt:GetBlueprint().Display.ForcedBuildSpin

if unitBP then

spin = unitBP

else

spin = bpP.UnitSpin

end

fx = bpP.X + px

fy = bpP.Y + py

fz = bpP.Z + pz

return spin, fx, fy, fz

end,

StartBuildFx = function(self, unitBeingBuilt)

end,

StopBuildFx = function(self)

end,

PlayFxRollOff = function(self)

end,

PlayFxRollOffEnd = function(self)

if self.RollOffAnim then

self.RollOffAnim:SetRate(-1)

WaitFor(self.RollOffAnim)

self.RollOffAnim:Destroy()

self.RollOffAnim = nil

end

end,

CreateBuildRotator = function(self)

if not self.BuildBoneRotator then

local spin = self:CalculateRollOffPoint()

local bp = self:GetBlueprint().Display

self.BuildBoneRotator = CreateRotator(self, bp.BuildAttachBone or 0, 'y', spin, 10000)

self.Trash:Add(self.BuildBoneRotator)

end

end,

DestroyBuildRotator = function(self)

if self.BuildBoneRotator then

self.BuildBoneRotator:Destroy()

self.BuildBoneRotator = nil

end

end,

RolloffBody = function(self)

self:SetBusy(true)

self:SetBlockCommandQueue(true)

self:PlayFxRollOff()

-- Wait until unit has left the factory

while not self.UnitBeingBuilt.Dead and self.MoveCommand and not IsCommandDone(self.MoveCommand) do

WaitSeconds(0.5)

end

self.MoveCommand = nil

self:PlayFxRollOffEnd()

self:SetBusy(false)

self:SetBlockCommandQueue(false)

ChangeState(self, self.IdleState)

end,

IdleState = State {

Main = function(self)

self:ChangeBlinkingLights('Green')

self:SetBusy(false)

self:SetBlockCommandQueue(false)

self:DestroyBuildRotator()

end,

},

BuildingState = State {

Main = function(self)

local unitBuilding = self.UnitBeingBuilt

local bp = self:GetBlueprint()

local bone = bp.Display.BuildAttachBone or 0

self:DetachAll(bone)

unitBuilding:AttachBoneTo(-2, self, bone)

self:CreateBuildRotator()

self:StartBuildFx(unitBuilding)

end,

},

RollingOffState = State {

Main = function(self)

self:RolloffBody()

end,

},

}

-- AIR FACTORY UNITS

AirFactoryUnit = Class(FactoryUnit) {}

-- AIR STAGING PLATFORMS UNITS

AirStagingPlatformUnit = Class(StructureUnit) {

LandBuiltHiddenBones = {'Floatation'},

OnStopBeingBuilt = function(self, builder, layer)

StructureUnit.OnStopBeingBuilt(self, builder, layer)

self:SetMaintenanceConsumptionActive()

end,

}

-- ENERGY CREATION UNITS

ConcreteStructureUnit = Class(StructureUnit) {

OnCreate = function(self)

StructureUnit.OnCreate(self)

self:Destroy()

end

}

-- ENERGY CREATION UNITS

EnergyCreationUnit = Class(StructureUnit) {

LandBuiltHiddenBones = {'Floatation'},

}

-- ENERGY STORAGE UNITS

EnergyStorageUnit = Class(StructureUnit) {

LandBuiltHiddenBones = {'Floatation'},

OnStopBeingBuilt = function(self, builder, layer)

StructureUnit.OnStopBeingBuilt(self, builder, layer)

local aiBrain = GetArmyBrain(self.Army)

aiBrain:ESRegisterUnitEnergyStorage(self)

local curEnergy = aiBrain:GetEconomyStoredRatio('ENERGY')

if curEnergy > 0.11 then

self:CreateBlinkingLights('Yellow')

else

self:CreateBlinkingLights('Red')

end

end,

OnEnergyStorageStateChange = function(self, newState)

if newState == 'EconLowEnergyStore' then

self:CreateBlinkingLights('Red')

elseif newState == 'EconMidEnergyStore' then

self:CreateBlinkingLights('Yellow')

elseif newState == 'EconFullEnergyStore' then

self:CreateBlinkingLights('Green')

end

end,

}

-- LAND FACTORY UNITS

LandFactoryUnit = Class(FactoryUnit) {}

-- MASS COLLECTION UNITS

MassCollectionUnit = Class(StructureUnit) {

LandBuiltHiddenBones = {'Floatation'},

OnConsumptionActive = function(self)

StructureUnit.OnConsumptionActive(self)