Battle Points economy for super weapons

CREDITS.md

@@ -151,6 +151,7 @@ This page lists all the individual contributions to the project by their author.
   - Warhead activation target health thresholds enhancements
   - Event 606: AttachEffect is attaching to a Techno
   - Linked superweapons
+  - Battle Points economy for super weapons
 - **Starkku**:
   - Misc. minor bugfixes & improvements
   - AI script actions:

Phobos.vcxproj

@@ -30,6 +30,7 @@
     <ClCompile Include="src\Blowfish\blowfish.cpp" />
     <ClCompile Include="src\Blowfish\Hooks.Blowfish.cpp" />
     <ClCompile Include="src\Ext\Cell\Body.cpp" />
+    <ClCompile Include="src\Ext\HouseType\Body.cpp" />
     <ClCompile Include="src\Ext\House\Hooks.ForceEnemy.cpp" />
     <ClCompile Include="src\Commands\ToggleSWSidebar.cpp" />
     <ClCompile Include="src\Ext\Sidebar\SWSidebar\SWColumnClass.cpp" />
@@ -224,6 +225,7 @@
     <ClInclude Include="src\Ext\Sidebar\SWSidebar\SWSidebarClass.h" />
     <ClInclude Include="src\Ext\Sidebar\SWSidebar\SWButtonClass.h" />
     <ClInclude Include="src\Ext\Sidebar\SWSidebar\ToggleSWButtonClass.h" />
+    <ClInclude Include="src\Ext\HouseType\Body.h" />
     <ClInclude Include="src\New\Entity\AttachEffectClass.h" />
     <ClInclude Include="src\New\Type\Affiliated\TiberiumEaterTypeClass.h" />
     <ClInclude Include="src\New\Type\AttachEffectTypeClass.h" />

docs/New-or-Enhanced-Logics.md

@@ -1037,6 +1037,54 @@ In `rulesmd.ini`:
 AISuperWeaponDelay=  ; integer, game frames
 ```
 
+### Battle Points economy for super weapons
+- This system displayes a new currency to be used (optionally) in Super Weapons.
+- The new currency will be modified by the kills against other players and the system is enabled.
+- If set `BattlePointsCollector` in any structure then the system will be enabled if the structure is built.
+- If set `BattlePoints` in houses they will have the system enabled by default.
+- If set [General] -> `BattlePoints` enables/disables the system for every player in the scenario, overriding the country preferences & `BattlePointsCollector` setting.
+- If set [General] -> `BattlePoints.DefaultValue` and the enemy destroyed object doesn't have a value then this generic value will be used instead.
+- If set [General] -> `BattlePoints.DefaultFriendlyValue` and the friendly destroyed object doesn't have a value then this generic value will be used instead. This tag doesn't work with the own objects of the player.
+- If is set `BattlePoints.CanUseStandardPoints` and the destroyed object doesn't have the `BattlePoints` value then the points are obtained from the `Points` tag of the destroyed object. If `BattlePoints.DefaultValue` is present then this will be ignored.
+- If set `BattlePoints` in the destroyed object the calculation is made with this value. Self-Kills done by the own player doesn't count in this system.
+- If `BattlePoints.Amount` is set with a value different from `0` then the super weapon is influenced by this system. If the value is positive then this super weapon won't be launched until the affected player gathered the required ammount.
+
+In `uimd.ini`:
+```ini
+[Sidebar]
+BattlePointsSidebar.Label=<none>                ; CSF entry key `★ <VALUE>`, code U+2605
+BattlePointsSidebar.Label.InvertPosition=false  ; bool, `<VALUE> ★`, code U+2605
+
+[ToolTips]
+BattlePoints.Label=<none>                       ; CSF entry key, default to `★: <VALUE>`, code U+2605
+```
+
+In `rulesmd.ini`:
+```ini
+[General]
+BattlePoints=                            ; bool
+BattlePoints.DefaultValue=               ; int
+BattlePoints.DefaultFriendlyValue=       ; int
+
+[SOMESIDE]                               ; Side
+Sidebar.BattlePoints.Offset=0,0          ; X,Y, pixels relative to default
+Sidebar.BattlePoints.Color=              ; integer - R,G,B
+Sidebar.BattlePoints.Align=Left          ; Left, Right, Center/Centre
+
+[SOMECOUNTRY]                            ; HouseType
+BattlePoints=false                       ; bool
+BattlePoints.CanUseStandardPoints=false  ; bool
+
+[SOMEBUILDING]                           ; BuildingType
+BattlePointsCollector=                   ; bool
+
+[SOMETECHNO]                             ; TechnoType
+BattlePoints=                            ; int
+
+[SOMESW]
+BattlePoints.Amount=0                    ; int
+```
+
 ### Convert TechnoType
 
 - Warheads can now change TechnoTypes of affected units to other Types in the same category (infantry to infantry, vehicles to vehicles, aircraft to aircraft).

docs/Whats-New.md

@@ -440,6 +440,7 @@ New:
 - [Customize hardcoded projectile initial facing behavior](Fixed-or-Improved-Logics.md#customizing-initial-facing-behavior) (by Starkku)
 - Health bar permanently displayed (by FlyStar)
 - [`IsSimpleDeployer` facing customization & directional deploy animations](Fixed-or-Improved-Logics.md#issimpleDeployer-facing-and-animation-customization) (by Starkku)
+- Battle Points economy for super weapons (by FS-21)
 
 Vanilla fixes:
 - Fixed sidebar not updating queued unit numbers when adding or removing units when the production is on hold (by CrimRecya)

src/Ext/BuildingType/Body.cpp

@@ -218,6 +218,8 @@ void BuildingTypeExt::ExtData::LoadFromINIFile(CCINIClass* const pINI)
 	}
 
 	this->Refinery_UseNormalActiveAnim.Read(exArtINI, pArtSection, "Refinery.UseNormalActiveAnim");
+
+	this->BattlePointsCollector.Read(exINI, pSection, "BattlePointsCollector");
 
 	// Ares tag
 	this->SpyEffect_Custom.Read(exINI, pSection, "SpyEffect.Custom");
@@ -334,6 +336,7 @@ void BuildingTypeExt::ExtData::Serialize(T& Stm)
 		.Process(this->BuildingRepairedSound)
 		.Process(this->Refinery_UseNormalActiveAnim)
 		.Process(this->HasPowerUpAnim)
+		.Process(this->BattlePointsCollector)
 		;
 }
 

src/Ext/BuildingType/Body.h

@@ -99,6 +99,8 @@ class BuildingTypeExt
 
 		ValueableVector<bool> HasPowerUpAnim;
 
+		Nullable<bool> BattlePointsCollector;
+
 		ExtData(BuildingTypeClass* OwnerObject) : Extension<BuildingTypeClass>(OwnerObject)
 			, PowersUp_Owner { AffectedHouse::Owner }
 			, PowersUp_Buildings {}
@@ -161,6 +163,7 @@ class BuildingTypeExt
 			, BuildingRepairedSound {}
 			, Refinery_UseNormalActiveAnim { false }
 			, HasPowerUpAnim {}
+			, BattlePointsCollector {}
 		{ }
 
 		// Ares 0.A functions

src/Ext/House/Body.cpp

@@ -3,6 +3,7 @@
 #include <Ext/SWType/Body.h>
 #include <Ext/TechnoType/Body.h>
 #include <Ext/Techno/Body.h>
+#include <Ext/HouseType/Body.h>
 
 #include <ScenarioClass.h>
 
@@ -653,6 +654,7 @@ void HouseExt::ExtData::Serialize(T& Stm)
 		.Process(this->SuspendedEMPulseSWs)
 		.Process(this->SuperExts)
 		.Process(this->ForceEnemyIndex)
+		.Process(this->BattlePoints)
 		;
 }
 
@@ -1101,3 +1103,54 @@ bool HouseExt::ReachedBuildLimit(const HouseClass* pHouse, const TechnoTypeClass
 	return false;
 }
 #pragma endregion
+
+void HouseExt::ExtData::UpdateBattlePoints(int modifier)
+{
+	this->BattlePoints += modifier;
+	this->BattlePoints = this->BattlePoints < 0 ? 0 : this->BattlePoints;
+}
+
+bool HouseExt::ExtData::AreBattlePointsEnabled()
+{
+	const auto pThis = this->OwnerObject();
+	const auto pOwnerTypeExt = HouseTypeExt::ExtMap.Find(pThis->Type);
+
+	// Global setting
+	if (RulesExt::Global()->BattlePoints.isset())
+		return RulesExt::Global()->BattlePoints.Get();
+
+	// House specific setting
+	if (!pOwnerTypeExt->BattlePoints)
+	{
+		// Structures can enable this logic overwriting the house's setting
+		for (const auto pBuilding : pThis->Buildings)
+		{
+			const auto pBuildingTypeExt = BuildingTypeExt::ExtMap.Find(pBuilding->Type);
+			if (pBuildingTypeExt->BattlePointsCollector.Get(false))
+				return true;
+		}
+
+		return false;
+	}
+
+	return true;
+}
+
+int HouseExt::ExtData::CalculateBattlePoints(TechnoClass* pTechno)
+{
+	if (!pTechno)
+		return 0;
+
+	const auto pThis = this->OwnerObject();
+	const auto pThisTypeExt = HouseTypeExt::ExtMap.Find(pThis->Type);
+	const auto pTechnoTypeExt = TechnoTypeExt::ExtMap.Find(pTechno->GetTechnoType());
+
+	int defaultValue = RulesExt::Global()->BattlePoints_DefaultValue.Get(0);
+	int defaultFriendlyValue = RulesExt::Global()->BattlePoints_DefaultFriendlyValue.Get(0);
+
+	int points = pThis->IsAlliedWith(pTechno)? defaultFriendlyValue : defaultValue;
+	points = pTechnoTypeExt->BattlePoints.Get(points);
+	points = points == 0 && pThisTypeExt->BattlePoints_CanUseStandardPoints ? pTechno->GetTechnoType()->Points : points;
+
+	return points;
+}

src/Ext/House/Body.h

@@ -66,6 +66,8 @@ class HouseExt
 
 		int ForceEnemyIndex;
 
+		int BattlePoints;
+
 		ExtData(HouseClass* OwnerObject) : Extension<HouseClass>(OwnerObject)
 			, PowerPlantEnhancers {}
 			, OwnedLimboDeliveredBuildings {}
@@ -94,6 +96,7 @@ class HouseExt
 			, SuspendedEMPulseSWs {}
 			, SuperExts(SuperWeaponTypeClass::Array.Count)
 			, ForceEnemyIndex(-1)
+			, BattlePoints(0)
 		{ }
 
 		bool OwnsLimboDeliveredBuilding(BuildingClass* pBuilding);
@@ -115,6 +118,10 @@ class HouseExt
 
 		void UpdateVehicleProduction();
 
+		void UpdateBattlePoints(int modifier);
+		bool AreBattlePointsEnabled();
+		int CalculateBattlePoints(TechnoClass* pTechno);
+
 		virtual void LoadFromStream(PhobosStreamReader& Stm) override;
 		virtual void SaveToStream(PhobosStreamWriter& Stm) override;
 

src/Ext/HouseType/Body.cpp

@@ -0,0 +1,141 @@
+#include "Body.h"
+
+#include <Utilities/GeneralUtils.h>
+
+static constexpr DWORD Canary = 0x1111111A;
+HouseTypeExt::ExtContainer HouseTypeExt::ExtMap;
+
+void HouseTypeExt::ExtData::Initialize()
+{
+}
+
+// =============================
+// load / save
+
+void HouseTypeExt::ExtData::LoadFromINIFile(CCINIClass* const pINI)
+{
+	auto pThis = this->OwnerObject();
+	const char* pSection = pThis->ID;
+
+	if (!pINI->GetSection(pSection))
+		return;
+
+	INI_EX exINI(pINI);
+
+	this->BattlePoints.Read(exINI, pSection, "BattlePoints");
+	this->BattlePoints_CanUseStandardPoints.Read(exINI, pSection, "BattlePoints.CanUseStandardPoints");
+}
+
+void HouseTypeExt::ExtData::CompleteInitialization()
+{
+	auto const pThis = this->OwnerObject();
+	UNREFERENCED_PARAMETER(pThis);
+}
+
+template <typename T>
+void HouseTypeExt::ExtData::Serialize(T& Stm)
+{
+	Stm
+		.Process(this->BattlePoints)
+		.Process(this->BattlePoints_CanUseStandardPoints)
+		;
+}
+
+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::ExtContainer::Load(HouseTypeClass* pThis, IStream* pStm)
+{
+	HouseTypeExt::ExtData* pData = this->LoadKey(pThis, pStm);
+	return pData != nullptr;
+};
+
+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.Allocate(pItem);
+
+	return 0;
+}
+
+DEFINE_HOOK(0x511643, HouseTypeClass_CTOR_2, 0x5)
+{
+	GET(HouseTypeClass*, pItem, EAX);
+
+	HouseTypeExt::ExtMap.Allocate(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;
+}