Country-specific EVAType (#2195)

- You can now set the `EVA.Tag` for a specific country.
  > 现在可以自定义指定国家的`EVA.Tag`。

- `EVAIndex` now supports saving and loading game states.
  > `EVAIndex` 支持存读档。

---------

Co-authored-by: Fly-Star <100747645+a851903106@users.noreply.github.com>
Co-authored-by: Noble_Fish <1065703286@qq.com>
Co-authored-by: Coronia <2217891145@qq.com>

Author: 3 people

CREDITS.md

@@ -421,6 +421,7 @@ This page lists all the individual contributions to the project by their author.
   - Custom hover vehicles shutdown drowning death
   - SHP turret vehicles support the use of `*tur.shp` files
   - Fix a bug where game will crash after loading if a techno with `AlphaImage` converts to a type without it, or an anim with `AlphaImage` changes to a type without it through `Next`
+  - `EVA.Tag` already supports being set for specific countries, and `EVAIndex` is no longer reset after load game
 - **NetsuNegi**:
   - Forbidding parallel AI queues by type
   - Jumpjet crash speed fix when crashing onto building

Phobos.vcxproj

@@ -22,6 +22,8 @@
     <ClCompile Include="src\Commands\DeselectObject.cpp" />
     <ClCompile Include="src\Ext\Cell\Hooks.cpp" />
     <ClCompile Include="src\Ext\Event\Body.cpp" />
+    <ClCompile Include="src\Ext\HouseType\Body.cpp" />
+    <ClCompile Include="src\Ext\HouseType\Hooks.cpp" />
     <ClCompile Include="src\Ext\Infantry\Hooks.cpp" />
     <ClCompile Include="src\Ext\Infantry\Hooks.Firing.cpp" />
     <ClCompile Include="src\Ext\TechnoType\Hooks.MultiWeapon.cpp" />
@@ -225,6 +227,7 @@
     <ClInclude Include="src\Commands\DeselectObject.h" />
     <ClInclude Include="src\Ext\EBolt\Body.h" />
     <ClInclude Include="src\Ext\Event\Body.h" />
+    <ClInclude Include="src\Ext\HouseType\Body.h" />
     <ClInclude Include="src\New\Entity\Ares\RadarJammerClass.h" />
     <ClInclude Include="src\New\Type\Affiliated\CreateUnitTypeClass.h" />
     <ClInclude Include="src\Blowfish\blowfish.h" />
@@ -275,6 +278,7 @@
     <ClInclude Include="src\New\Type\Affiliated\TypeConvertGroup.h" />
     <ClInclude Include="src\New\Type\Affiliated\DroppodTypeClass.h" />
     <ClInclude Include="src\New\Type\DigitalDisplayTypeClass.h" />
+    <ClInclude Include="src\New\Type\EVATypeClass.h" />
     <ClInclude Include="src\New\Type\InsigniaTypeClass.h" />
     <ClInclude Include="src\New\Type\RadTypeClass.h" />
     <ClInclude Include="src\New\Type\SelectBoxTypeClass.h" />

docs/Fixed-or-Improved-Logics.md

@@ -373,6 +373,7 @@ This page describes all ingame logics that are fixed or improved in Phobos witho
 - Fixed a bug where passengers created by the InitialPayload logic or TeamType with `Full=true` would fail to fire when the transport unit with `OpenTopped=yes` moved to an area that the passengers' `MovementZone` cannot move into.
 - Fixed a bug where game will crash after loading if a techno with `AlphaImage` converts to a type without it, or an anim with `AlphaImage` changes to a type without it through `Next`.
 - Fixed the issue that `BombSight` not being updated correctly in techno conversion.
+- `EVA.Tag` already supports being set for specific countries, and `EVAIndex` is no longer reset after load game.
 
 ## Newly added global settings
 

docs/Whats-New.md

@@ -720,6 +720,7 @@ Fixes / interactions with other extensions:
 - Fixed a bug where passengers created by the InitialPayload logic or TeamType with `Full=true` would fail to fire when the transport unit with `OpenTopped=yes` moved to an area that the passengers' `MovementZone` cannot move into (by NetsuNegi)
 - Fixed a bug where game will crash after loading if a techno with `AlphaImage` converts to a type without it, or an anim with `AlphaImage` changes to a type without it through `Next` (by NetsuNegi & FlyStar)
 - Fixed the issue that `BombSight` not being updated correctly in techno conversion (by TaranDahl)
+- `EVA.Tag` already supports being set for specific countries, and `EVAIndex` is no longer reset after load game (by FlyStar)
 ```
 
 ### 0.4.0.3

src/Ext/HouseType/Body.cpp

@@ -0,0 +1,120 @@
+#include "Body.h"
+
+#include <Ext/Side/Body.h>
+#include <Utilities/GeneralUtils.h>
+
+HouseTypeExt::ExtContainer HouseTypeExt::ExtMap;
+
+void HouseTypeExt::ExtData::Initialize() { }
+
+void HouseTypeExt::ExtData::LoadFromINIFile(CCINIClass* pINI)
+{
+	auto pThis = this->OwnerObject();
+	const char* pSection = pThis->ID;
+
+	if (!pINI->GetSection(pSection))
+		return;
+
+	INI_EX exINI(pINI);
+
+	this->EVATag.Read(pINI, pSection, "EVA.Tag");
+}
+
+template <typename T>
+void HouseTypeExt::ExtData::Serialize(T& Stm)
+{
+	Stm
+		.Process(this->EVATag)
+		;
+}
+
+void HouseTypeExt::ExtData::LoadFromStream(PhobosStreamReader& Stm)
+{
+	Extension<HouseTypeClass>::LoadFromStream(Stm);
+	this->Serialize(Stm);
+}
+
+void HouseTypeExt::ExtData::SaveToStream(PhobosStreamWriter& Stm)
+{
+	Extension<HouseTypeClass>::SaveToStream(Stm);
+	this->Serialize(Stm);
+}
+
+bool HouseTypeExt::LoadGlobals(PhobosStreamReader& Stm)
+{
+	return Stm
+		.Success();
+}
+
+bool HouseTypeExt::SaveGlobals(PhobosStreamWriter& Stm)
+{
+	return Stm
+		.Success();
+}
+
+// =============================
+// container
+
+HouseTypeExt::ExtContainer::ExtContainer() : Container("HouseTypeClass") { }
+HouseTypeExt::ExtContainer::~ExtContainer() = default;
+
+// =============================
+// container hooks
+
+DEFINE_HOOK(0x511635, HouseTypeClass_CTOR_1, 0x5)
+{
+	GET(HouseTypeClass*, pItem, EAX);
+
+	HouseTypeExt::ExtMap.TryAllocate(pItem);
+	return 0;
+}
+
+DEFINE_HOOK(0x511643, HouseTypeClass_CTOR_2, 0x5)
+{
+	GET(HouseTypeClass*, pItem, EAX);
+
+	HouseTypeExt::ExtMap.TryAllocate(pItem);
+	return 0;
+}
+
+DEFINE_HOOK(0x5127CF, HouseTypeClass_DTOR, 0x6)
+{
+	GET(HouseTypeClass*, pItem, ESI);
+
+	HouseTypeExt::ExtMap.Remove(pItem);
+	return 0;
+}
+
+DEFINE_HOOK_AGAIN(0x512480, HouseTypeClass_SaveLoad_Prefix, 0x5)
+DEFINE_HOOK(0x512290, HouseTypeClass_SaveLoad_Prefix, 0x5)
+{
+	GET_STACK(HouseTypeClass*, pItem, 0x4);
+	GET_STACK(IStream*, pStm, 0x8);
+
+	HouseTypeExt::ExtMap.PrepareStream(pItem, pStm);
+
+	return 0;
+}
+
+DEFINE_HOOK(0x51246D, HouseTypeClass_Load_Suffix, 0x5)
+{
+
+	HouseTypeExt::ExtMap.LoadStatic();
+	return 0;
+}
+
+DEFINE_HOOK(0x51255C, HouseTypeClass_Save_Suffix, 0x5)
+{
+	HouseTypeExt::ExtMap.SaveStatic();
+	return 0;
+}
+
+DEFINE_HOOK_AGAIN(0x51215A, HouseTypeClass_LoadFromINI, 0x5)
+DEFINE_HOOK(0x51214F, HouseTypeClass_LoadFromINI, 0x5)
+{
+	GET(HouseTypeClass*, pItem, EBX);
+	GET_BASE(CCINIClass*, pINI, 0x8);
+
+	HouseTypeExt::ExtMap.LoadFromINI(pItem, pINI);
+	return 0;
+}

src/Ext/HouseType/Body.h

@@ -0,0 +1,52 @@
+#pragma once
+
+#include <HouseTypeClass.h>
+
+#include <Utilities/Container.h>
+#include <Utilities/TemplateDef.h>
+
+#include <New/Type/EVATypeClass.h>
+
+class HouseTypeExt
+{
+public:
+	using base_type = HouseTypeClass;
+
+	static constexpr DWORD Canary = 0xAFFEAFFE;
+	static constexpr size_t ExtPointerOffset = 0x1AC;
+
+	class ExtData final : public Extension<HouseTypeClass>
+	{
+	public:
+		EVAType EVATag;
+
+		ExtData(HouseTypeClass* OwnerObject) : Extension<HouseTypeClass>(OwnerObject)
+			, EVATag { -2 }
+		{ }
+
+		virtual ~ExtData() = default;
+
+		virtual void LoadFromINIFile(CCINIClass* pINI) override;
+		virtual void Initialize() override;
+		virtual void InvalidatePointer(void* ptr, bool bRemoved) override { }
+
+		virtual void LoadFromStream(PhobosStreamReader& Stm) override;
+		virtual void SaveToStream(PhobosStreamWriter& Stm) override;
+
+	private:
+		template <typename T>
+		void Serialize(T& Stm);
+	};
+
+	class ExtContainer final : public Container<HouseTypeExt>
+	{
+	public:
+		ExtContainer();
+		~ExtContainer();
+	};
+
+	static bool LoadGlobals(PhobosStreamReader& Stm);
+	static bool SaveGlobals(PhobosStreamWriter& Stm);
+
+	static ExtContainer ExtMap;
+};

src/Ext/HouseType/Hooks.cpp

@@ -0,0 +1,37 @@
+#include "Body.h"
+
+#include <Ext/Scenario/Body.h>
+
+DEFINE_HOOK(0x535005, ScenarioClass_LoadSide_SetEVAIndex, 0x6)
+{
+	if (ScenarioExt::Global()->EVAIndex != -2)
+	{
+		VoxClass::EVAIndex = ScenarioExt::Global()->EVAIndex;
+	}
+	// I don't know why, but if you don't do it this way, it might not work.
+	else if (SessionClass::Instance.IsCampaign())
+	{
+		if (const auto pHouse = HouseClass::CurrentPlayer)
+		{
+			const int EVAIndex = HouseTypeExt::ExtMap.Find(pHouse->Type)->EVATag;
+
+			if (EVAIndex != -2)
+				VoxClass::EVAIndex = EVAIndex;
+		}
+	}
+
+	return 0;
+}
+
+DEFINE_HOOK(0x68AD0C, ScenarioClass_ReadMap_SetEVAIndex, 0x7)
+{
+	if (const auto pHouse = HouseClass::CurrentPlayer)
+	{
+		const int EVAIndex = HouseTypeExt::ExtMap.Find(pHouse->Type)->EVATag;
+
+		if (EVAIndex != -2)
+			VoxClass::EVAIndex = EVAIndex;
+	}
+
+	return 0;
+}

src/Ext/Scenario/Body.cpp

@@ -177,6 +177,7 @@ void ScenarioExt::ExtData::Serialize(T& Stm)
 		.Process(this->UndergroundTracker)
 		.Process(this->SpecialTracker)
 		.Process(this->FallingDownTracker)
+		.Process(this->EVAIndex)
 		;
 }
 
@@ -188,6 +189,8 @@ void ScenarioExt::ExtData::LoadFromStream(PhobosStreamReader& Stm)
 
 void ScenarioExt::ExtData::SaveToStream(PhobosStreamWriter& Stm)
 {
+	Global()->EVAIndex = VoxClass::EVAIndex;
+
 	Extension<ScenarioClass>::SaveToStream(Stm);
 	this->Serialize(Stm);
 }

src/Ext/Scenario/Body.h

@@ -48,6 +48,8 @@ class ScenarioExt
 		DynamicVectorClass<TechnoClass*> SpecialTracker; // For special purposes, like tracking technos that are forced moving. Currently unused.
 		DynamicVectorClass<TechnoClass*> FallingDownTracker; // Technos that are falling down, parachutes and land technos falling from bridge.
 
+		int EVAIndex;
+
 		ExtData(ScenarioClass* OwnerObject) : Extension<ScenarioClass>(OwnerObject)
 			, ShowBriefing { false }
 			, BriefingTheme { -1 }
@@ -65,6 +67,7 @@ class ScenarioExt
 			, UndergroundTracker {}
 			, SpecialTracker {}
 			, FallingDownTracker {}
+			, EVAIndex { -2 }
 		{ }
 
 		static void SetVariableToByID(bool bIsGlobal, int nIndex, char bState);

src/New/Type/EVATypeClass.h

@@ -0,0 +1,48 @@
+#pragma once
+
+#include <Utilities/Enumerable.h>
+#include <Utilities/TemplateDef.h>
+#include <Utilities/AresFunctions.h>
+#include <Utilities/AresHelper.h>
+
+class EVAType : public Valueable<int>
+{
+public:
+	template <typename T>
+	EVAType(T value)
+	{
+		this->Value = (int)std::move(value);
+	}
+
+	template <typename T>
+	EVAType& operator = (T value)
+	{
+		this->Value = std::move(value);
+		return *this;
+	}
+
+	bool Read(CCINIClass* pINI, const char* pSection, const char* pKey)
+	{
+		int buffer = this->Value;
+
+		if (pINI->ReadString(pSection, pKey, "", Phobos::readBuffer))
+		{
+			if (AresHelper::CanUseAres)
+				buffer = AresFunctions::FindEVAIndex(Phobos::readBuffer);
+			else if (!strcmp(Phobos::readBuffer, "Allied"))
+				buffer = 0;
+			else if (!strcmp(Phobos::readBuffer, "Russian"))
+				buffer = 1;
+			else if (!strcmp(Phobos::readBuffer, "Yuri"))
+				buffer = 2;
+		}
+
+		if (buffer >= 0 || INIClass::IsBlank(Phobos::readBuffer))
+		{
+			this->Value = buffer;
+			return true;
+		}
+
+		return false;
+	}
+};