Generalize behavior of Salem that allows it to switch to land (#6499)

FAForever · Nov 7, 2024 · c69792c · c69792c
1 parent 5a55468
commit c69792c
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 17 deletions.
diff --git a/changelog/snippets/features.6499.md b/changelog/snippets/features.6499.md
@@ -0,0 +1,5 @@
+- (#6499) Allow Footprint locking for (modded) units
+
+With thanks to an assembly patch the footprint changes that were previously unique to the Cybran Tech 2 Destroyer can now be applied to any unit. For more details, see the pull request on GitHub. 
+
+Interested in how assembly patches work? Reach out to the game team. You can find us easiest via the official Discord server.
diff --git a/changelog/snippets/fix.6499.md b/changelog/snippets/fix.6499.md
@@ -0,0 +1,5 @@
+- (#6499) Fix hard crash when exiting the game when a Salem is on land
+
+The Cybran Tech 2 Destroyer (Salem) has the special ability to move from water onto land. There was a bug in a special, alternative implementation introduced by FAForever. Together with an assembly patch this bug is now fixed.
+
+Interested in how assembly patches work? Reach out to the game team. You can find us easiest via the official Discord server.
diff --git a/engine/Patches.lua b/engine/Patches.lua
diff --git a/engine/Sim/Unit.lua b/engine/Sim/Unit.lua
@@ -125,6 +125,11 @@ end
 function Unit:EnableManipulators(bone, Enable)
 end
 
+---Forces game to use AltFootprint for the unit
+---@param state boolean
+function Unit:ForceAltFootPrint(state)
+end
+
 --- Returns the unit's multiplier to a damage type
 ---@param damageTypeName DamageType
 ---@return number
@@ -269,7 +274,6 @@ end
 ---@param statName string
 ---@param defaultVal? number
 ---@return number
--- Special case for the Salem: GetStat("h1_SetSalemAmph", 0 or 1) will Disable/Enable amphibious mode
 function Unit:GetStat(statName, defaultVal)
 end
 

diff --git a/units/URS0201/URS0201_script.lua b/units/URS0201/URS0201_script.lua
@@ -173,7 +173,7 @@ URS0201 = ClassUnit(CSeaUnit) {
         CSeaUnit.OnScriptBitSet(self, bit)
         if bit == 1 then
             if self.Layer ~= 'Land' then
-                self:GetStat("h1_SetSalemAmph", 0)
+                self:ForceAltFootPrint(true)
             else
                 self:SetScriptBit('RULEUTC_WeaponToggle', false)
             end
@@ -183,7 +183,7 @@ URS0201 = ClassUnit(CSeaUnit) {
     OnScriptBitClear = function(self, bit)
         CSeaUnit.OnScriptBitClear(self, bit)
         if bit == 1 then
-            self:GetStat("h1_SetSalemAmph", 1)
+            self:ForceAltFootPrint(false)
         end
     end,
 }

diff --git a/units/URS0201/URS0201_unit.bp b/units/URS0201/URS0201_unit.bp
@@ -207,6 +207,13 @@ UnitBlueprint{
         BuildCostMass = 2250,
         BuildTime = 10000,
     },
+    AltFootprint = -- water only
+    {
+        SizeX = 2,
+        SizeZ = 8,
+        OccupancyCaps = 8,
+        MinWaterDepth = 1.5,
+    },
     Footprint = {
         SizeX = 2,
         SizeZ = 8,