Ares Optional Fix -- Ability To Revert Ares Transport Cloak Behavior (#2110)

This pull request introduces a fix and new customization for the
decloaking behavior of open-topped transports, specifically when
passengers fire weapons with `DecloakToFire=yes`. The changes allow
modders to control whether passenger actions can decloak their
transporter, and revert a previous patch that forced decloaking under
certain conditions.

**Open-topped transport decloak behavior improvements:**

* Added the `OpenTopped.DecloakToFire` option to both `RulesExt` and
`TechnoTypeExt`, allowing global or per-unit control over whether
passengers firing with `DecloakToFire=yes` decloak their open-topped
transporter.

---------

Co-authored-by: Kerbiter <[email protected]>
Co-authored-by: Noble Fish <[email protected]>
Co-authored-by: Coronia <[email protected]>

Author: 4 people

CREDITS.md

@@ -770,3 +770,4 @@ This page lists all the individual contributions to the project by their author.
 - **RAZER**:
   - Wall overlay unit sell exploit fix
   - Multiplayer gamespeed fix for RealTimeTimers
+  - Revert Ares patch to allow OpenTopped transport customization

docs/Fixed-or-Improved-Logics.md

@@ -352,6 +352,7 @@ This page describes all ingame logics that are fixed or improved in Phobos witho
 - Fixed the bug that vehicle survivor can spawn on wrong position when transport has been destroyed.
 - Fixed the bug that building with `Explodes=yes` use Ares's rubble logic will cause it's owner cannot defeat normally.
 - Fixed an issue that retaliation will make the unit keep switching among multiple targets with the same amount of threat.
+- Fixed ares hook which stopped OpenTopped transports from firing if cloaked. This can now be customized.
 
 ## Newly added global settings
 

docs/New-or-Enhanced-Logics.md

@@ -1560,16 +1560,21 @@ DrainMoneyDisplay.OnTarget.UseDisplayIncome=        ; boolean
 - `OpenTopped.AllowFiringIfDeactivated` can be used to customize whether or not passengers can fire out when the transport is deactivated (EMP, powered unit etc).
 - `OpenTopped.ShareTransportTarget` controls whether or not the current target of the transport itself is passed to the passengers as well.
 - You can also customize range bonus and damage multiplier for passenger inside the transport with `OpenTransport.RangeBonus/DamageMultiplier`, which works independently from transport's `OpenTopped.RangeBonus/DamageMultiplier`.
+- `OpenTopped.DecloakToFire` can customize if a transport has to uncloak to have passengers fireout if transport is also OpenTopped.
 
 In `rulesmd.ini`:
 ```ini
+[General]
+OpenTopped.DecloakToFire=true             ; boolean
+
 [SOMETECHNO]                              ; TechnoType, transport with OpenTopped=yes
 OpenTopped.RangeBonus=                    ; integer, default to [CombatDamage] -> OpenToppedRangeBonus
 OpenTopped.DamageMultiplier=              ; floating point value, default to [CombatDamage] -> OpenToppedDamageMultiplier
 OpenTopped.WarpDistance=                  ; integer, default to [CombatDamage] -> OpenToppedWarpDistance
 OpenTopped.IgnoreRangefinding=false       ; boolean
 OpenTopped.AllowFiringIfDeactivated=true  ; boolean
 OpenTopped.ShareTransportTarget=true      ; boolean
+OpenTopped.DecloakToFire=                 ; boolean, defaults to [General] -> OpenTopped.DecloakToFire
 
 [SOMETECHNO]                              ; TechnoType, passenger
 OpenTransport.RangeBonus=0                ; integer

docs/Whats-New.md

@@ -667,6 +667,8 @@ Fixes / interactions with other extensions:
 - Fixed the issue that technos cannot spawn survivors due to non-probabilistic reasons when the tech type was destroyed (by NetsuNegi)
 - Fixed the bug that vehicle survivor can spawn on wrong position when transport has been destroyed (by NetsuNegi)
 - Fixed the bug that building with `Explodes=yes` use Ares's rubble logic will cause it's owner cannot defeat normally (by NetsuNegi)
+- Fixed ares hook which stopped OpenTopped transports from firing if cloaked. This can now be customized (by RAZER & Morton)
+
 ```
 
 ### 0.4.0.3

src/Ext/Rules/Body.cpp

@@ -344,6 +344,7 @@ void RulesExt::ExtData::LoadBeforeTypeData(RulesClass* pThis, CCINIClass* pINI)
 
 	this->FallingDownTargetingFix.Read(exINI, GameStrings::General, "FallingDownTargetingFix");
 	this->AIAirTargetingFix.Read(exINI, GameStrings::General, "AIAirTargetingFix");
+	this->OpenTopped_DecloakToFire.Read(exINI, GameStrings::General, "OpenTopped.DecloakToFire");
 
 	this->SortCameoByName.Read(exINI, GameStrings::General, "SortCameoByName");
 
@@ -658,6 +659,7 @@ void RulesExt::ExtData::Serialize(T& Stm)
 		.Process(this->IvanBombAttachToCenter)
 		.Process(this->FallingDownTargetingFix)
 		.Process(this->AIAirTargetingFix)
+		.Process(this->OpenTopped_DecloakToFire)
 		.Process(this->SortCameoByName)
 		.Process(this->MergeBuildingDamage)
 		.Process(this->BuildingRadioLink_SyncOwner)

src/Ext/Rules/Body.h

@@ -294,6 +294,7 @@ class RulesExt
 
 		Valueable<bool> FallingDownTargetingFix;
 		Valueable<bool> AIAirTargetingFix;
+		Valueable<bool> OpenTopped_DecloakToFire;
 
 		Valueable<bool> SortCameoByName;
 
@@ -557,6 +558,7 @@ class RulesExt
 
 			, FallingDownTargetingFix { false }
 			, AIAirTargetingFix { false }
+			, OpenTopped_DecloakToFire { false }
 
 			, SortCameoByName { false }
 

src/Ext/Techno/Hooks.Cloak.cpp

@@ -1,4 +1,5 @@
 #include "Body.h"
+#include <Ext/Rules/Body.h>
 
 namespace CloakTemp
 {
@@ -174,3 +175,41 @@ DEFINE_HOOK(0x4579A5, BuildingClass_ShouldNotCloak_Sensors, 0x6)
 
 	return Continue;
 }
+
+// NOTE: Overrides incorrect Ares hook at the same address.
+DEFINE_HOOK(0x6FCA26, TechnoClass_CanFire_RevertAresOpenTopCloakFix, 0x6)
+{
+	enum { Skip = 0x6FCA4F, Continue = 0x6FCA36, NotApplicable = 0x6FCA5E };
+
+	GET(WeaponTypeClass*, pWeapon, EBX);
+
+	if (!pWeapon->DecloakToFire)
+		return NotApplicable;
+
+	GET(TechnoClass*, pThis, ESI);
+
+	if (pThis->InOpenToppedTransport && pThis->Transporter)
+	{
+		auto const pTransporterTypeExt = TechnoExt::ExtMap.Find(pThis->Transporter)->TypeExtData;
+		if (pTransporterTypeExt->OpenTopped_DecloakToFire.Get(RulesExt::Global()->OpenTopped_DecloakToFire))
+			return NotApplicable;
+	}
+
+	R->EAX(pThis->CloakState);
+	return Continue;
+}
+
+DEFINE_HOOK(0x6FCD1D, TechnoClass_CanFire_OpenTopCloakFix, 0x5)
+{
+	GET(TechnoClass*, pThis, ESI);
+	GET_STACK(const bool, checkIfTargetInRange, STACK_OFFSET(0x20, 0xC));
+
+	if (checkIfTargetInRange && pThis->InOpenToppedTransport && pThis->Transporter)
+	{
+		auto const pTransporterTypeExt = TechnoExt::ExtMap.Find(pThis->Transporter)->TypeExtData;
+		if (pTransporterTypeExt->OpenTopped_DecloakToFire.Get(RulesExt::Global()->OpenTopped_DecloakToFire))
+			pThis->Transporter->Uncloak(true);
+	}
+
+	return 0;
+}

src/Ext/TechnoType/Body.cpp

@@ -855,6 +855,7 @@ void TechnoTypeExt::ExtData::LoadFromINIFile(CCINIClass* const pINI)
 	this->OpenTopped_ShareTransportTarget.Read(exINI, pSection, "OpenTopped.ShareTransportTarget");
 	this->OpenTopped_UseTransportRangeModifiers.Read(exINI, pSection, "OpenTopped.UseTransportRangeModifiers");
 	this->OpenTopped_CheckTransportDisableWeapons.Read(exINI, pSection, "OpenTopped.CheckTransportDisableWeapons");
+	this->OpenTopped_DecloakToFire.Read(exINI, pSection, "OpenTopped.DecloakToFire");
 	this->OpenTransport_RangeBonus.Read(exINI, pSection, "OpenTransport.RangeBonus");
 	this->OpenTransport_DamageMultiplier.Read(exINI, pSection, "OpenTransport.DamageMultiplier");
 
@@ -1580,6 +1581,7 @@ void TechnoTypeExt::ExtData::Serialize(T& Stm)
 		.Process(this->OpenTopped_ShareTransportTarget)
 		.Process(this->OpenTopped_UseTransportRangeModifiers)
 		.Process(this->OpenTopped_CheckTransportDisableWeapons)
+		.Process(this->OpenTopped_DecloakToFire)
 		.Process(this->OpenTransport_RangeBonus)
 		.Process(this->OpenTransport_DamageMultiplier)
 

src/Ext/TechnoType/Body.h

@@ -166,6 +166,7 @@ class TechnoTypeExt
 		Valueable<bool> OpenTopped_ShareTransportTarget;
 		Valueable<bool> OpenTopped_UseTransportRangeModifiers;
 		Valueable<bool> OpenTopped_CheckTransportDisableWeapons;
+		Nullable<bool> OpenTopped_DecloakToFire;
 		Valueable<int> OpenTransport_RangeBonus;
 		Valueable<float> OpenTransport_DamageMultiplier;
 
@@ -587,6 +588,7 @@ class TechnoTypeExt
 			, OpenTopped_ShareTransportTarget { true }
 			, OpenTopped_UseTransportRangeModifiers { false }
 			, OpenTopped_CheckTransportDisableWeapons { false }
+			, OpenTopped_DecloakToFire {}
 			, OpenTransport_RangeBonus { 0 }
 			, OpenTransport_DamageMultiplier { 1.0f }