Various Building properties Deharcoded (#550)

### Customizable garrison and bunker properties

- You can now customize damage or ROF multipliers of a garrison or tank
bunker building.
- You can now customize enter or exit sound of a tank bunker building.

In `rulesmd.ini`:
```ini
[SOMEBUILDING]              ; BuildingType
OccupyDamageMultiplier=     ; floating point value, default to [CombatDamage] -> OccupyDamageMultiplier
OccupyROFMultiplier=        ; floating point value, default to [CombatDamage] -> OccupyROFMultiplier
BunkerDamageMultiplier=     ; floating point value, default to [CombatDamage] -> BunkerDamageMultiplier
BunkerROFMultMultiplier=    ; floating point value, default to [CombatDamage] -> BunkerROFMultMultiplier
BunkerWallsUpSound=         ; Sound entry, default to [AudioVisual] -> BunkerWallsUpSound
BunkerWallsDownSound=       ; Sound entry, default to [AudioVisual] -> BunkerWallsDownSound
```

### Disable DamageSound

- Now you can disable `DamageSound` of a building.

In `rulesmd.ini`:
```ini
[SOMEBUILDING]            ; BuildingType
DisableDamageSound=false  ; boolean
```

### Power plant damage factor

- It is possible to customize the power decrement of a power plant when
it's damaged. The actual power output for this plant will be: `Power`
minuses the product of original power decrement and
`Powerplant.DamageFactor`. Can't reduce power output lower than 0.
- Specifically, if the factor is set to 0.0, power output won't be
decreased by losing health for this power plant.

In `rulesmd.ini`:
```ini
[SOMEBUILDING]                     ; BuildingType
PowerPlant.DamageFactor=1.0        ; floating point value
```

---------

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

Author: 5 people

CREDITS.md

@@ -121,6 +121,9 @@ This page lists all the individual contributions to the project by their author.
   - Help with custom locomotors
   - Extension class optimization
   - Overload characteristic dehardcoded
+  - Customizable garrison and bunker properties
+  - Disable DamageSound for buildings
+  - Power plant damage factor
 - **FS-21**:
   - Dump Object Info enhancements
   - `Powered.KillSpawns`
@@ -490,6 +493,7 @@ This page lists all the individual contributions to the project by their author.
   - Passenger-based insignias
   - Use `InsigniaType` to set the properties of insignia in a batch
   - Allowed player's self-healing effects to be benefited by allied or `PlayerControl=true` houses
+  - Power plant damage factor
 - **NaotoYuuki** - Vertical & meteor trajectory projectile prototypes
 - **handama** - AI script action to `16005 Jump Back To Previous Script`
 - **TaranDahl (航味麻酱)**:

docs/Fixed-or-Improved-Logics.md

@@ -477,6 +477,22 @@ In `rulesmd.ini`:
 BarracksExitCell=  ; X,Y - cell offset
 ```
 
+### Customizable garrison and bunker properties
+
+- You can now customize damage or ROF multipliers of a garrison or tank bunker building.
+- You can now customize enter or exit sound of a tank bunker building.
+
+In `rulesmd.ini`:
+```ini
+[SOMEBUILDING]              ; BuildingType
+OccupyDamageMultiplier=     ; floating point value, default to [CombatDamage] -> OccupyDamageMultiplier
+OccupyROFMultiplier=        ; floating point value, default to [CombatDamage] -> OccupyROFMultiplier
+BunkerDamageMultiplier=     ; floating point value, default to [CombatDamage] -> BunkerDamageMultiplier
+BunkerROFMultMultiplier=    ; floating point value, default to [CombatDamage] -> BunkerROFMultMultiplier
+BunkerWallsUpSound=         ; Sound entry, default to [AudioVisual] -> BunkerWallsUpSound
+BunkerWallsDownSound=       ; Sound entry, default to [AudioVisual] -> BunkerWallsDownSound
+```
+
 ### Customizable selling buildup sequence length for buildings that can undeploy
 
 - By default buildings with `UndeploysInto` will only play 23 frames of their buildup sequence (in reverse starting from last frame) when being sold as opposed to being undeployed. This can now be customized via `SellBuildupLength`.
@@ -534,6 +550,16 @@ Overpower.ChargeWeapon=1  ; integer, negative values mean that weapons can never
 Ares' [Battery Super Weapon](https://ares-developers.github.io/Ares-docs/new/superweapons/types/battery.html) won't be affected by this.
 ```
 
+### Disable DamageSound
+
+- Now you can disable `DamageSound` of a building.
+
+In `rulesmd.ini`:
+```ini
+[SOMEBUILDING]            ; BuildingType
+DisableDamageSound=false  ; boolean
+```
+
 ### Exclude Factory from providing multiple factory bonus
 
 - It is now possible to exclude a building with `Factory` from counting towards `MultipleFactory` bonus.
@@ -544,6 +570,17 @@ In `rulesmd.ini`:
 ExcludeFromMultipleFactoryBonus=false  ; boolean
 ```
 
+### Power plant damage factor
+
+- It is possible to customize the power decrement of a power plant when it's damaged. The actual power output for this plant will be: `Power` minuses the product of original power decrement and `Powerplant.DamageFactor`. Can't reduce power output lower than 0.
+  - Specifically, if the factor is set to 0.0, power output won't be decreased by losing health for this power plant.
+
+In `rulesmd.ini`:
+```ini
+[SOMEBUILDING]                     ; BuildingType
+PowerPlant.DamageFactor=1.0        ; floating point value
+```
+
 ### Skip anim delay for burst fire
 
 - In Red Alert 1, the tesla coil will attack multiple times after charging animation. This is not possible in Red Alert 2, where the building must play the charge animation every time it fires.

docs/Whats-New.md

@@ -383,6 +383,9 @@ New:
 - 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)
+- [Customizable garrison and bunker properties](Fixed-or-Improved-Logics.md#customizable-garrison-and-bunker-properties) (by Otamaa)
+- [Disable DamageSound for buildings](Fixed-or-Improved-Logics.md#disable-damagesound) (by Otamaa)
+- [Power plant damage factor](New-or-Enhanced-Logics.md#power-plant-damage-factor) (by Otamaa and Ollerus)
 
 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

@@ -15,11 +15,11 @@ int BuildingTypeExt::ExtData::GetSuperWeaponCount() const
 
 int BuildingTypeExt::ExtData::GetSuperWeaponIndex(const int index, HouseClass* pHouse) const
 {
-	auto idxSW = this->GetSuperWeaponIndex(index);
+	const int idxSW = this->GetSuperWeaponIndex(index);
 
-	if (auto pSuper = pHouse->Supers.GetItemOrDefault(idxSW))
+	if (const auto pSuper = pHouse->Supers.GetItemOrDefault(idxSW))
 	{
-		auto pExt = SWTypeExt::ExtMap.Find(pSuper->Type);
+		const auto pExt = SWTypeExt::ExtMap.Find(pSuper->Type);
 
 		if (!pExt->IsAvailable(pHouse))
 			return -1;
@@ -50,7 +50,8 @@ int BuildingTypeExt::GetEnhancedPower(BuildingClass* pBuilding, HouseClass* pHou
 
 	for (const auto& [bTypeIdx, nCount] : pHouseExt->PowerPlantEnhancers)
 	{
-		auto bTypeExt = BuildingTypeExt::ExtMap.Find(BuildingTypeClass::Array[bTypeIdx]);
+		auto const bTypeExt = BuildingTypeExt::ExtMap.Find(BuildingTypeClass::Array[bTypeIdx]);
+
 		if (bTypeExt->PowerPlantEnhancer_Buildings.Contains(pBuilding->Type))
 		{
 			fFactor *= std::powf(bTypeExt->PowerPlantEnhancer_Factor, static_cast<float>(nCount));
@@ -61,6 +62,17 @@ int BuildingTypeExt::GetEnhancedPower(BuildingClass* pBuilding, HouseClass* pHou
 	return static_cast<int>(std::round(pBuilding->GetPowerOutput() * fFactor)) + nAmount;
 }
 
+void BuildingTypeExt::PlayBunkerSound(BuildingClass const* pThis, bool buildUp)
+{
+	auto const pTypeExt = BuildingTypeExt::ExtMap.Find(pThis->Type);
+	auto const nSound = buildUp
+		? pTypeExt->BunkerWallsUpSound.Get(RulesClass::Instance->BunkerWallsUpSound)
+		: pTypeExt->BunkerWallsDownSound.Get(RulesClass::Instance->BunkerWallsDownSound);
+
+	if (nSound != -1)
+		VocClass::PlayAt(nSound, pThis->Location);
+}
+
 int BuildingTypeExt::CountOwnedNowWithDeployOrUpgrade(BuildingTypeClass* pType, HouseClass* pHouse)
 {
 	const auto upgrades = BuildingTypeExt::GetUpgradesAmount(pType, pHouse);
@@ -78,7 +90,7 @@ int BuildingTypeExt::GetUpgradesAmount(BuildingTypeClass* pBuilding, HouseClass*
 {
 	int result = 0;
 	bool isUpgrade = false;
-	auto pPowersUp = pBuilding->PowersUpBuilding;
+	auto const pPowersUp = pBuilding->PowersUpBuilding;
 
 	auto checkUpgrade = [pHouse, pBuilding, &result, &isUpgrade](BuildingTypeClass* pTPowersUp)
 	{
@@ -102,7 +114,7 @@ int BuildingTypeExt::GetUpgradesAmount(BuildingTypeClass* pBuilding, HouseClass*
 			checkUpgrade(pTPowersUp);
 	}
 
-	if (auto pBuildingExt = BuildingTypeExt::ExtMap.Find(pBuilding))
+	if (auto const pBuildingExt = BuildingTypeExt::ExtMap.Find(pBuilding))
 	{
 		for (auto pTPowersUp : pBuildingExt->PowersUp_Buildings)
 			checkUpgrade(pTPowersUp);
@@ -132,6 +144,7 @@ void BuildingTypeExt::ExtData::LoadFromINIFile(CCINIClass* const pINI)
 
 	this->PowersUp_Owner.Read(exINI, pSection, "PowersUp.Owner");
 	this->PowersUp_Buildings.Read(exINI, pSection, "PowersUp.Buildings");
+	this->PowerPlant_DamageFactor.Read(exINI, pSection, "PowerPlant.DamageFactor");
 	this->PowerPlantEnhancer_Buildings.Read(exINI, pSection, "PowerPlantEnhancer.PowerPlants");
 	this->PowerPlantEnhancer_Amount.Read(exINI, pSection, "PowerPlantEnhancer.Amount");
 	this->PowerPlantEnhancer_Factor.Read(exINI, pSection, "PowerPlantEnhancer.Factor");
@@ -179,6 +192,15 @@ void BuildingTypeExt::ExtData::LoadFromINIFile(CCINIClass* const pINI)
 	this->Overpower_KeepOnline.Read(exINI, pSection, "Overpower.KeepOnline");
 	this->Overpower_ChargeWeapon.Read(exINI, pSection, "Overpower.ChargeWeapon");
 
+	this->DisableDamageSound.Read(exINI, pSection, "DisableDamageSound");
+
+	this->BuildingOccupyDamageMult.Read(exINI, pSection, "OccupyDamageMultiplier");
+	this->BuildingOccupyROFMult.Read(exINI, pSection, "OccupyROFMultiplier");
+	this->BuildingBunkerDamageMult.Read(exINI, pSection, "BunkerDamageMultiplier");
+	this->BuildingBunkerROFMult.Read(exINI, pSection, "BunkerROFMultMultiplier");
+	this->BunkerWallsUpSound.Read(exINI, pSection, "BunkerWallsUpSound");
+	this->BunkerWallsDownSound.Read(exINI, pSection, "BunkerWallsDownSound");
+
 	if (pThis->NumberOfDocks > 0)
 	{
 		this->AircraftDockingDirs.clear();
@@ -256,6 +278,7 @@ void BuildingTypeExt::ExtData::Serialize(T& Stm)
 	Stm
 		.Process(this->PowersUp_Owner)
 		.Process(this->PowersUp_Buildings)
+		.Process(this->PowerPlant_DamageFactor)
 		.Process(this->PowerPlantEnhancer_Buildings)
 		.Process(this->PowerPlantEnhancer_Amount)
 		.Process(this->PowerPlantEnhancer_Factor)
@@ -305,6 +328,11 @@ void BuildingTypeExt::ExtData::Serialize(T& Stm)
 		.Process(this->BarracksExitCell)
 		.Process(this->Overpower_KeepOnline)
 		.Process(this->Overpower_ChargeWeapon)
+		.Process(this->DisableDamageSound)
+		.Process(this->BuildingOccupyDamageMult)
+		.Process(this->BuildingOccupyROFMult)
+		.Process(this->BuildingBunkerDamageMult)
+		.Process(this->BuildingBunkerROFMult)
 		;
 }
 

src/Ext/BuildingType/Body.h

@@ -22,6 +22,7 @@ class BuildingTypeExt
 		ValueableVector<BuildingTypeClass*> PowersUp_Buildings;
 		ValueableIdxVector<SuperWeaponTypeClass> SuperWeapons;
 
+		Valueable<double> PowerPlant_DamageFactor;
 		ValueableVector<BuildingTypeClass*> PowerPlantEnhancer_Buildings;
 		Valueable<int> PowerPlantEnhancer_Amount;
 		Nullable<float> PowerPlantEnhancer_Factor;
@@ -84,9 +85,18 @@ class BuildingTypeExt
 		Valueable<int> Overpower_KeepOnline;
 		Valueable<int> Overpower_ChargeWeapon;
 
+		Valueable<bool> DisableDamageSound;
+		Nullable<float> BuildingOccupyDamageMult;
+		Nullable<float> BuildingOccupyROFMult;
+		Nullable<float> BuildingBunkerDamageMult;
+		Nullable<float> BuildingBunkerROFMult;
+		NullableIdx<VocClass> BunkerWallsUpSound;
+		NullableIdx<VocClass> BunkerWallsDownSound;
+
 		ExtData(BuildingTypeClass* OwnerObject) : Extension<BuildingTypeClass>(OwnerObject)
 			, PowersUp_Owner { AffectedHouse::Owner }
 			, PowersUp_Buildings {}
+			, PowerPlant_DamageFactor { 1.0 }
 			, PowerPlantEnhancer_Buildings {}
 			, PowerPlantEnhancer_Amount { 0 }
 			, PowerPlantEnhancer_Factor { 1.0 }
@@ -135,6 +145,13 @@ class BuildingTypeExt
 			, BarracksExitCell {}
 			, Overpower_KeepOnline { 2 }
 			, Overpower_ChargeWeapon { 1 }
+			, DisableDamageSound { false }
+			, BuildingOccupyDamageMult {}
+			, BuildingOccupyROFMult {}
+			, BuildingBunkerDamageMult {}
+			, BuildingBunkerROFMult {}
+			, BunkerWallsUpSound {}
+			, BunkerWallsDownSound {}
 		{ }
 
 		// Ares 0.A functions
@@ -171,6 +188,8 @@ class BuildingTypeExt
 	static bool LoadGlobals(PhobosStreamReader& Stm);
 	static bool SaveGlobals(PhobosStreamWriter& Stm);
 
+	static void PlayBunkerSound(BuildingClass const* pThis, bool buildUp = false);
+
 	static int GetEnhancedPower(BuildingClass* pBuilding, HouseClass* pHouse);
 	static bool CanUpgrade(BuildingClass* pBuilding, BuildingTypeClass* pUpgradeType, HouseClass* pUpgradeOwner);
 	static int CountOwnedNowWithDeployOrUpgrade(BuildingTypeClass* pBuilding, HouseClass* pHouse);