Fix subterranean harvester pathfinding

Author: Starkku

Phobos.vcxproj

@@ -63,6 +63,7 @@
     <ClCompile Include="src\Ext\TEvent\Body.cpp" />
     <ClCompile Include="src\Ext\Trigger\Hooks.cpp" />
     <ClCompile Include="src\Ext\Unit\Hooks.Crushing.cpp" />
+    <ClCompile Include="src\Ext\Unit\Hooks.Harvester.cpp" />
     <ClCompile Include="src\Locomotion\TestLocomotionClass.cpp" />
     <ClCompile Include="src\Misc\Hooks.Gamespeed.cpp" />
     <ClCompile Include="src\Misc\Hooks.Ares.cpp" />

docs/Fixed-or-Improved-Logics.md

@@ -190,6 +190,7 @@ This page describes all ingame logics that are fixed or improved in Phobos witho
 - Allowed `AuxBuilding` to count building upgrades.
 - Fix the bug that parasite will vanish if it missed its target when its previous cell is occupied.
 - Prevent the units with locomotors that cause problems from entering the tank bunker.
+- Fixed `MovementZone=Subterannean` harvesters being unable to find docks if in area enclosed by water, cliffs etc.
 
 ## Fixes / interactions with other extensions
 

docs/Whats-New.md

@@ -330,6 +330,7 @@ Vanilla fixes:
 - Aircraft will now behave as expected according to it's `MovementZone` and `SpeedType` when moving onto different surfaces. In particular, this fixes erratic behavior when vanilla aircraft is ordered to move onto water surface and instead the movement order changes to a shore nearby (by CrimRecya)
 - Fix the bug that parasite will vanish if it missed its target when its previous cell is occupied (by 航味麻酱)
 - Prevent the units with locomotors that cause problems from entering the tank bunker (by TaranDahl)
+- Fixed `MovementZone=Subterannean` harvesters being unable to find docks if in area enclosed by water, cliffs etc.
 
 Phobos fixes:
 - Type conversion on Warheads and Superweapons will no longer recursively convert units if applicable conversion pairs are listed, and only first applicable pair takes effect (by Starkku)

src/Ext/Techno/Body.cpp

@@ -485,6 +485,8 @@ void TechnoExt::ExtData::Serialize(T& Stm)
 		.Process(this->LaserTrails)
 		.Process(this->AttachedEffects)
 		.Process(this->AE)
+		.Process(this->SubterraneanHarvFreshFromFactory)
+		.Process(this->SubterraneanHarvRallyDest)
 		.Process(this->ReceiveDamage)
 		.Process(this->PassengerDeletionTimer)
 		.Process(this->CurrentShieldType)

src/Ext/Techno/Body.h

@@ -28,6 +28,8 @@ class TechnoExt
 		std::vector<LaserTrailClass> LaserTrails;
 		std::vector<std::unique_ptr<AttachEffectClass>> AttachedEffects;
 		AttachEffectTechnoProperties AE;
+		bool SubterraneanHarvFreshFromFactory;
+		AbstractClass* SubterraneanHarvRallyDest;
 		bool ReceiveDamage;
 		bool LastKillWasTeamTarget;
 		CDTimerClass PassengerDeletionTimer;
@@ -66,6 +68,8 @@ class TechnoExt
 			, LaserTrails {}
 			, AttachedEffects {}
 			, AE {}
+			, SubterraneanHarvFreshFromFactory { false }
+			, SubterraneanHarvRallyDest { nullptr }
 			, ReceiveDamage { false }
 			, LastKillWasTeamTarget { false }
 			, PassengerDeletionTimer {}

src/Ext/Techno/Hooks.Misc.cpp

@@ -455,4 +455,36 @@ DEFINE_HOOK(0x70FB73, FootClass_IsBunkerableNow_Dehardcode, 0x6)
 	auto const pTypeExt = TechnoTypeExt::ExtMap.Find(pType);
 	return pTypeExt->BunkerableAnyway ? CanEnter : 0;
 }
+
 #pragma endregion
+
+// issue #112 Make FireOnce=yes work on other TechnoTypes
+// Author: Starkku
+DEFINE_HOOK(0x4C7512, EventClass_Execute_StopCommand, 0x6)
+{
+	GET(TechnoClass* const, pThis, ESI);
+
+	auto const pUnit = abstract_cast<UnitClass*>(pThis);
+
+	if (pUnit)
+	{
+		// Reset target for deploy weapons.
+		if (pUnit->CurrentMission == Mission::Unload && pUnit->Type->DeployFire && !pUnit->Type->IsSimpleDeployer)
+		{
+			pUnit->SetTarget(nullptr);
+			pThis->QueueMission(Mission::Guard, true);
+		}
+
+		auto const pType = pUnit->Type;
+
+		// Reset subterranean harvester rally point info.
+		if ((pType->Harvester || pType->Weeder) && pType->MovementZone == MovementZone::Subterrannean)
+		{
+			auto const pExt = TechnoExt::ExtMap.Find(pUnit);
+			pExt->SubterraneanHarvFreshFromFactory = false;
+			pExt->SubterraneanHarvRallyDest = nullptr;
+		}
+	}
+
+	return 0;
+}

src/Ext/Unit/Hooks.DeployFire.cpp

@@ -3,23 +3,7 @@
 #include <Ext/Techno/Body.h>
 #include <Utilities/Macro.h>
 
-// issue #112 Make FireOnce=yes work on other TechnoTypes
-// Author: Starkku
-DEFINE_HOOK(0x4C7512, EventClass_Execute_StopUnitDeployFire, 0x6)
-{
-	GET(TechnoClass* const, pThis, ESI);
-
-	auto const pUnit = abstract_cast<UnitClass*>(pThis);
-	if (pUnit && pUnit->CurrentMission == Mission::Unload && pUnit->Type->DeployFire && !pUnit->Type->IsSimpleDeployer)
-	{
-		pUnit->SetTarget(nullptr);
-		pThis->QueueMission(Mission::Guard, true);
-	}
-
-	return 0;
-}
-
-DEFINE_HOOK(0x4C77E4, EventClass_Execute_UnitDeployFire, 0x6)
+DEFINE_HOOK(0x4C77E4, EventClass_Execute_DeployCommand, 0x6)
 {
 	enum { DoNotExecute = 0x4C8109 };
 

src/Ext/Unit/Hooks.Harvester.cpp

@@ -0,0 +1,94 @@
+#include <Ext/Techno/Body.h>
+
+// Hooks that allow harvesters / weeders to work correctly with MovementZone=Subterannean (sic) - Starkku
+#pragma region SubterraneanHarvesters
+
+// Allow scanning for docks in all map zones.
+DEFINE_HOOK(0x4DEFC6, FootClass_FindDock_SubterraneanHarvester, 0x5)
+{
+	GET(TechnoTypeClass*, pTechnoType, EAX);
+
+	if (auto const pUnitType = abstract_cast<UnitTypeClass*>(pTechnoType))
+	{
+		if ((pUnitType->Harvester || pUnitType->Weeder) && pUnitType->MovementZone == MovementZone::Subterrannean)
+			R->ECX(MovementZone::Fly);
+	}
+
+	return 0;
+}
+
+// Allow scanning for ore in all map zones.
+DEFINE_HOOK(0x4DCF86, FootClass_FindTiberium_SubterraneanHarvester, 0x5)
+{
+	enum { SkipGameCode = 0x4DCF9B };
+
+	GET(MovementZone, mZone, ECX);
+
+	if (mZone == MovementZone::Subterrannean)
+		R->ECX(MovementZone::Fly);
+
+	return 0;
+}
+
+// Allow scanning for weeds in all map zones.
+DEFINE_HOOK(0x4DDB23, FootClass_FindWeeds_SubterraneanHarvester, 0x5)
+{
+	enum { SkipGameCode = 0x4DCF9B };
+
+	GET(MovementZone, mZone, EAX);
+
+	if (mZone == MovementZone::Subterrannean)
+		R->EAX(MovementZone::Fly);
+
+	return 0;
+}
+
+// Set rally point.
+DEFINE_HOOK(0x44459A, BuildingClass_ExitObject_SubterraneanHarvester, 0x5)
+{
+	GET(TechnoClass*, pThis, EDI);
+
+	if (auto const pUnit = abstract_cast<UnitClass*>(pThis))
+	{
+		auto const pType = pUnit->Type;
+
+		if ((pType->Harvester || pType->Weeder) && pType->MovementZone == MovementZone::Subterrannean)
+		{
+			auto const pExt = TechnoExt::ExtMap.Find(pUnit);
+			pExt->SubterraneanHarvFreshFromFactory = true;
+			pExt->SubterraneanHarvRallyDest = pUnit->ArchiveTarget;
+		}
+	}
+
+	return 0;
+}
+
+// Handle rally point once idle.
+DEFINE_HOOK(0x7389B1, UnitClass_EnterIdleMode_SubterraneanHarvester, 0x6)
+{
+	enum { ReturnFromFunction = 0x738D21 };
+
+	GET(UnitClass*, pThis, ESI);
+
+	auto const pExt = TechnoExt::ExtMap.Find(pThis);
+
+	if (pExt->SubterraneanHarvFreshFromFactory)
+	{
+		pThis->SetArchiveTarget(nullptr);
+		pThis->ClearNavQueue();
+
+		if (pThis->Destination && pExt->SubterraneanHarvRallyDest && pThis->Destination != pExt->SubterraneanHarvRallyDest && pThis->DistanceFrom(pThis->Destination) > Unsorted::LeptonsPerCell)
+			pThis->SetDestination(pExt->SubterraneanHarvRallyDest, false);
+		else
+			pThis->SetDestination(nullptr, false);
+
+		pExt->SubterraneanHarvFreshFromFactory = false;
+		pExt->SubterraneanHarvRallyDest = nullptr;
+
+		return ReturnFromFunction;
+	}
+
+	return 0;
+}
+
+#pragma endregion