Annotate shield assist mechanics and max jammer blips (#6109)

FAForever · Apr 24, 2024 · f404996 · f404996
1 parent 89e6eb6
commit f404996
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 4 deletions.
diff --git a/changelog/3810.md b/changelog/3810.md
@@ -108,6 +108,8 @@
 
 - (#6042) Improve annotations for `OnMotionHorzEventChange` and `OnMotionVertEventChange`
 
+- (#6109) Annotate the shield assist mechanics of `RegenAssistMult`
+
 - (#6086) Ensure that the Cooper's hitbox aligns with its model
 
 - (#6091) Count cargo for veterancy when a transport or carrier is killed

diff --git a/engine/Core/Blueprints/UnitBlueprint.lua b/engine/Core/Blueprints/UnitBlueprint.lua
@@ -410,7 +410,9 @@
 --- stunning).
 --- Should not be defined with `AntiArtilleryShield`, `PersonalBubble`, or `TransportShield`.
 ---@field PersonalShield? boolean
---- an efficacy multiplier applied to units assisting the shield to regenerate its health
+--- How much buildpower is required to provide 1x of the shield's regen rate.
+--- The cost of assisting a shield is `repairCostRate / RegenAssistMult`,
+--- where repairCostRate is determined by Unit:UpdateConsumptionValues
 ---@field RegenAssistMult? number
 --- The amount of time the shield takes to come back online when its disabled due to insufficient
 --- energy. Defaults to `10` in the shield spec.
@@ -857,7 +859,9 @@
 ---@field OwnerShieldMesh string
 --- Personal shiled toggle
 ---@field PersonalShield boolean
---- an efficacy multiplier applied to units assisting the shield to regenerate its health
+--- How much buildpower is required to provide 1x of the shield's regen rate.
+--- The cost of assisting a shield is `repairCostRate / RegenAssistMult`,
+--- where repairCostRate is determined by Unit:UpdateConsumptionValues
 ---@field RegenAssistMult number
 --- The amount of time the shield takes to come back online when its disabled due to insufficient energy. Defaults to 10 in the shield spec.
 ---@field ShieldEnergyDrainRechargeTime number
@@ -1002,7 +1006,7 @@
 ---@field IntelDurationOnDeath? number
 --- how far we create fake blips
 ---@field JamRadius { Max: number, Min: number }
---- how many blips does a jammer produce
+--- How many blips a jammer produces. Maximum 255
 ---@field JammerBlips number
 --- used by the Soothsayer
 ---@field MaxVisionRadius? number

diff --git a/lua/sim/Unit.lua b/lua/sim/Unit.lua
@@ -1172,7 +1172,7 @@ Unit = ClassUnit(moho.unit_methods, IntelComponent, VeterancyComponent) {
                     mass = (mass / siloBuildRate) * (self:GetBuildRate() or 0)
                 else
                     time, energy, mass = self:GetBuildCosts(focus:GetBlueprint())
-                    if self:IsUnitState('Repairing') and focus.isFinishedUnit then
+                    if self:IsUnitState('Repairing') and focus.isFinishedUnit then -- also applies to shield assisting
                         energy = energy * repairRatio
                         mass = mass * repairRatio
                     end