Customize the scatter caused by aircraft attack mission (#1701)

* impl

* Update Hooks.Misc.cpp

* Update Hooks.Misc.cpp

* Update Hooks.Misc.cpp

* flag

* Update Hooks.Misc.cpp

* Update Hooks.Misc.cpp

* Update Hooks.Misc.cpp

* Update Hooks.Misc.cpp

* Update Hooks.cpp

* Update Hooks.cpp

* doc

* per techno

* Update Hooks.cpp

* Remove excess spaces

---------

Co-authored-by: TaranDahl <[email protected]>
Co-authored-by: 航味麻酱 <[email protected]>
Co-authored-by: Netsu_Negi <[email protected]>

Author: 2 people

CREDITS.md

@@ -519,6 +519,7 @@ This page lists all the individual contributions to the project by their author.
   - RadarInvisible for non-enemy house
   - Allow miners do area guard
   - Make harvesters do addtional scan after unload
+  - Customize the scatter caused by aircraft attack mission
 - **tyuah8**:
   - Drive/Jumpjet/Ship/Teleport locomotor did not power on when it is un-piggybacked bugfix
   - Destroyed unit leaves sensors bugfix

docs/Fixed-or-Improved-Logics.md

@@ -260,6 +260,16 @@ In `rulesmd.ini`:
 VoicePickup=    ; Sound entry
 ```
 
+### Customize the scatter caused by aircraft attack mission
+
+- In vanilla, when an aircraft attacks, it forces the target's cell to trigger a scatter. Now you can disable this behavior by setting the following flag to `false`.
+
+In `rulesmd.ini`:
+```ini
+[SOMEAIRCRAFT]            ; AircraftType
+FiringForceScatter=true   ; boolean
+```
+
 ### Extended Aircraft Missions
 
 - Aircraft will now be able to use waypoints.

docs/Whats-New.md

@@ -382,6 +382,7 @@ New:
 - [Customizable airstrike flare colors](Fixed-or-Improved-Logics.md#airstrike-flare-customizations) (by Starkku)
 - Allowed player's self-healing effects to be benefited by allied or `PlayerControl=true` houses (by Ollerus)
 - Exclusive SuperWeapon Sidebar (by NetsuNegi & CrimRecya)
+- Customize the scatter caused by aircraft attack mission (by TaranDahl)
 
 Vanilla fixes:
 - Fixed sidebar not updating queued unit numbers when adding or removing units when the production is on hold (by CrimRecya)

src/Ext/Aircraft/Hooks.cpp

@@ -253,6 +253,22 @@ void __fastcall AircraftClass_SetTarget_Wrapper(AircraftClass* pThis, void* _, A
 
 DEFINE_FUNCTION_JUMP(VTABLE, 0x7E266C, AircraftClass_SetTarget_Wrapper);
 
+DEFINE_HOOK_AGAIN(0x41882C, AircraftClass_MissionAttack_ScatterCell1, 0x6);
+DEFINE_HOOK_AGAIN(0x41893B, AircraftClass_MissionAttack_ScatterCell1, 0x6);
+DEFINE_HOOK_AGAIN(0x418A4A, AircraftClass_MissionAttack_ScatterCell1, 0x6);
+DEFINE_HOOK_AGAIN(0x418B46, AircraftClass_MissionAttack_ScatterCell1, 0x6);
+DEFINE_HOOK(0x41847E, AircraftClass_MissionAttack_ScatterCell1, 0x6)
+{
+	GET(AircraftClass*, pThis, ESI);
+	return TechnoTypeExt::ExtMap.Find(pThis->Type)->FiringForceScatter ? 0 : (R->Origin() + 0x44);
+}
+
+DEFINE_HOOK(0x4186DD, AircraftClass_MissionAttack_ScatterCell2, 0x5)
+{
+	GET(AircraftClass*, pThis, ESI);
+	return TechnoTypeExt::ExtMap.Find(pThis->Type)->FiringForceScatter ? 0 : (R->Origin() + 0x43);
+}
+
 #pragma endregion
 
 DEFINE_HOOK(0x414F10, AircraftClass_AI_Trailer, 0x5)

src/Ext/TechnoType/Body.cpp

@@ -644,6 +644,8 @@ void TechnoTypeExt::ExtData::LoadFromINIFile(CCINIClass* const pINI)
 	this->Harvester_CanGuardArea.Read(exINI, pSection, "Harvester.CanGuardArea");
 	this->HarvesterScanAfterUnload.Read(exINI, pSection, "HarvesterScanAfterUnload");
 
+	this->FiringForceScatter.Read(exINI, pSection, "FiringForceScatter");
+
 	// Ares 0.2
 	this->RadarJamRadius.Read(exINI, pSection, "RadarJamRadius");
 
@@ -1195,6 +1197,8 @@ void TechnoTypeExt::ExtData::Serialize(T& Stm)
 
 		.Process(this->FallingDownDamage)
 		.Process(this->FallingDownDamage_Water)
+
+		.Process(this->FiringForceScatter)
 		;
 }
 void TechnoTypeExt::ExtData::LoadFromStream(PhobosStreamReader& Stm)

src/Ext/TechnoType/Body.h

@@ -362,6 +362,8 @@ class TechnoTypeExt
 		Valueable<double> FallingDownDamage;
 		Nullable<double> FallingDownDamage_Water;
 
+		Valueable<bool> FiringForceScatter;
+
 		ExtData(TechnoTypeClass* OwnerObject) : Extension<TechnoTypeClass>(OwnerObject)
 			, HealthBar_Hide { false }
 			, UIDescription {}
@@ -674,6 +676,8 @@ class TechnoTypeExt
 
 			, FallingDownDamage { 1.0 }
 			, FallingDownDamage_Water {}
+
+			, FiringForceScatter { true }
 		{ }
 
 		virtual ~ExtData() = default;