Units AutoDeploy/DeployBlock on Ammo change

CREDITS.md

@@ -475,6 +475,7 @@ This page lists all the individual contributions to the project by their author.
   - `TurretOffset` support for SHP vehicles
 - **Fryone**
   - Customizable ElectricBolt Arcs
+  - Auto-deploy/Deploy block on ammo change
 - **ZivDero**
   - Allow giving ownership of buildings to players in Skirmish and MP using <Player @ A-H>
 - **Ares developers**

Phobos.vcxproj

@@ -119,6 +119,7 @@
     <ClCompile Include="src\Ext\Unit\Hooks.DeployFire.cpp" />
     <ClCompile Include="src\Ext\Unit\Hooks.DisallowMoving.cpp" />
     <ClCompile Include="src\Ext\Unit\Hooks.Jumpjet.cpp" />
+    <ClCompile Include="src\Ext\Unit\Hooks.Unload.cpp" />
     <ClCompile Include="src\Ext\WarheadType\Detonate.cpp" />
     <ClCompile Include="src\Ext\Tiberium\Body.cpp" />
     <ClCompile Include="src\Ext\Tiberium\Hooks.cpp" />

docs/Fixed-or-Improved-Logics.md

@@ -511,6 +511,7 @@ In `rulesmd.ini`:
 [SOMETECHNO]    ; TechnoType
 JumpjetRotateOnCrash=true  ; boolean
 ```
+
 ```{warning}
 This may subject to further changes.
 ```
@@ -747,6 +748,34 @@ In `artmd.ini`:
 TurretShadow=   ; boolean
 ```
 
+### `IsSimpleDeployer` vehicle auto-deploy / deploy block on ammo change
+
+- Vehicle deployment can now be affected by ammo count.
+  - `Ammo.AutoDeployAmount` determines the minimal number of ammo at which a vehicle converts/deploys automatically.
+  - `Ammo.DeployUnlockAmount` determines the minimal number of ammo that unlocks issuing vehicle converting/deploying command.
+
+In `rulesmd.ini`:
+```ini
+[SOMEVEHICLE]                   ; VehicleType
+Ammo.DeployUnlockAmount=-1      ; integer
+Ammo.AutoDeployAmount=-1        ; integer
+```
+
+```{warning}
+`Ammo.AutoDeployAmount` feature requires `Convert.Deploy` from [Ares’ Type Conversion](https://ares-developers.github.io/Ares-docs/new/typeconversion.html) to change type. Unit without it will constantly use deploy command on self until ammo is changed.
+```
+
+### `IsSimpleDeployer` vehicle ammo change on deploy
+
+- `Ammo.AddOnDeploy` determines the number of ammo added or substracted on unit deploy.
+
+In `rulesmd.ini`:
+```ini
+[SOMEVEHICLE]           ; VehicleType
+Ammo.AddOnDeploy=0      ; integer
+```
+
+
 ## VoxelAnims
 
 ### Customizable debris & meteor impact and warhead detonation behaviour

docs/Whats-New.md

@@ -321,11 +321,12 @@ New:
 - Vehicle voxel turret shadows & body multi-section shadows (by TwinkleStar)
 - Crushing tilt and slowdown customization (by Starkku)
 - Extra warhead detonations on weapon (by Starkku)
-- Customizable ElectricBolt Arcs (by Fryone, Kerbiter)
 - Chrono sparkle animation display customization and improvements (by Starkku)
 - Script action to Chronoshift teams to enemy base (by Starkku)
+- Customizable ElectricBolt Arcs (by Fryone, Kerbiter)
 - Digital display of HP and SP (by ststl, FlyStar, Saigyouji, JunJacobYoung)
 - PipScale pip customizations (size, ammo / spawn / tiberium frames or offsets) (by Starkku)
+- Auto-deploy/Deploy block on ammo change (by Fryone)
 - `AltPalette` lighting toggle (by Starkku)
 - Unhardcoded timer blinking color scheme (by Starkku)
 - Customizing shield self-healing timer restart when shield is damaged (by Starkku)

src/Ext/Techno/Body.Update.cpp

@@ -65,6 +65,26 @@ void TechnoExt::ExtData::ApplyInterceptor()
 	}
 }
 
+void TechnoExt::ExtData::DepletedAmmoActions()
+{
+	auto const pThis = this->OwnerObject();
+	auto const pType = pThis->GetTechnoType();
+	if ((pThis->WhatAmI() != AbstractType::Unit) || (pType->Ammo <= 0))
+		return;
+
+	auto const pTypeExt = this->TypeExtData;
+	if (!(pTypeExt->Ammo_AutoDeployAmount < 0))
+		return;
+
+	auto const pUnit = abstract_cast<UnitClass*>(pThis);
+
+	if (!pUnit->Type->IsSimpleDeployer)
+		return;
+	if (pThis->Ammo == pTypeExt->Ammo_AutoDeployAmount)
+		pThis->QueueMission(Mission::Unload, true);
+	return;
+}
+
 // TODO : Merge into new AttachEffects
 bool TechnoExt::ExtData::CheckDeathConditions(bool isInLimbo)
 {

src/Ext/Techno/Body.h

@@ -61,6 +61,7 @@ class TechnoExt
 
 		void ApplyInterceptor();
 		bool CheckDeathConditions(bool isInLimbo = false);
+		void DepletedAmmoActions();
 		void EatPassengers();
 		void UpdateShield();
 		void UpdateOnTunnelEnter();

src/Ext/Techno/Hooks.cpp

@@ -30,6 +30,7 @@ DEFINE_HOOK(0x6F9E50, TechnoClass_AI, 0x5)
 	pExt->UpdateShield();
 	pExt->ApplySpawnLimitRange();
 	pExt->UpdateLaserTrails();
+	pExt->DepletedAmmoActions();
 
 	TechnoExt::ApplyMindControlRangeLimit(pThis);
 

src/Ext/TechnoType/Body.cpp

@@ -152,6 +152,12 @@ void TechnoTypeExt::ExtData::LoadFromINIFile(CCINIClass* const pINI)
 
 	this->ShieldType.Read(exINI, pSection, "ShieldType", true);
 
+	this->Ammo_AddOnDeploy.Read(exINI, pSection, "Ammo.AddOnDeploy");
+	this->Ammo_AutoDeployAmount.Read(exINI, pSection, "Ammo.AutoDeployAmount");
+	this->Ammo_DeployUnlockAmount.Read(exINI, pSection, "Ammo.DeployUnlockAmount");
+
+	this->VoiceCantDeploy.Read(exINI, pSection, "VoiceCantDeploy");
+
 	this->AutoDeath_Behavior.Read(exINI, pSection, "AutoDeath.Behavior");
 	this->AutoDeath_VanishAnimation.Read(exINI, pSection, "AutoDeath.VanishAnimation");
 	this->AutoDeath_OnAmmoDepletion.Read(exINI, pSection, "AutoDeath.OnAmmoDepletion");
@@ -424,6 +430,11 @@ void TechnoTypeExt::ExtData::Serialize(T& Stm)
 		.Process(this->ShieldType)
 		.Process(this->PassengerDeletionType)
 
+		.Process(this->Ammo_AddOnDeploy)
+		.Process(this->Ammo_AutoDeployAmount)
+		.Process(this->Ammo_DeployUnlockAmount)
+		.Process(this->VoiceCantDeploy)
+
 		.Process(this->AutoDeath_Behavior)
 		.Process(this->AutoDeath_VanishAnimation)
 		.Process(this->AutoDeath_OnAmmoDepletion)

src/Ext/TechnoType/Body.h

@@ -52,6 +52,11 @@ class TechnoTypeExt
 		Valueable<ShieldTypeClass*> ShieldType;
 		std::unique_ptr<PassengerDeletionTypeClass> PassengerDeletionType;
 
+		Nullable<int> Ammo_AddOnDeploy;
+		Valueable<int> Ammo_AutoDeployAmount;
+		Valueable<int> Ammo_DeployUnlockAmount;
+		NullableIdx<VocClass> VoiceCantDeploy;
+
 		Nullable<AutoDeathBehavior> AutoDeath_Behavior;
 		Nullable<AnimTypeClass*> AutoDeath_VanishAnimation;
 		Valueable<bool> AutoDeath_OnAmmoDepletion;
@@ -265,6 +270,10 @@ class TechnoTypeExt
 			, DeployingAnim_ReverseForUndeploy { true }
 			, DeployingAnim_UseUnitDrawer { true }
 
+			, Ammo_AddOnDeploy { }
+			, Ammo_AutoDeployAmount { -1 }
+			, Ammo_DeployUnlockAmount { -1 }
+
 			, AutoDeath_Behavior { }
 			, AutoDeath_VanishAnimation {}
 			, AutoDeath_OnAmmoDepletion { false }

src/Ext/Unit/Hooks.Unload.cpp

@@ -0,0 +1,93 @@
+#include <UnitClass.h>
+#include <TechnoClass.h>
+
+#include <Ext/TechnoType/Body.h>
+#include <Utilities/EnumFunctions.h>
+#include <Utilities/GeneralUtils.h>
+#include <Utilities/Macro.h>
+
+DEFINE_HOOK(0x73FFE6, UnitClass_WhatAction_RemoveDeploying, 0xA)
+{
+	enum { Continue = 0x73FFF0 };
+
+	GET(UnitClass*, pThis, ESI);
+	auto const pThisType = TechnoTypeExt::ExtMap.Find(pThis->GetTechnoType());
+
+	R->AL(pThis->CanDeploySlashUnload());
+	if(pThis->CanDeploySlashUnload())
+	{
+		if(pThisType->Ammo_DeployUnlockAmount != 0 && pThis->Ammo < pThisType->Ammo_DeployUnlockAmount)
+			R->AL(false);
+	}
+
+	return Continue;
+}
+
+DEFINE_HOOK(0x730C70, DeployClass_Execute_RemoveDeploying, 0xA)
+{
+	enum { Continue = 0x730C7A };
+
+	GET(TechnoClass*, pThis, ESI);
+	auto const pThisType = TechnoTypeExt::ExtMap.Find(pThis->GetTechnoType());
+
+	R->AL(pThis->CanDeploySlashUnload());
+	if(pThis->CanDeploySlashUnload())
+	{
+		if(pThisType->Ammo_DeployUnlockAmount != 0 && pThis->Ammo < pThisType->Ammo_DeployUnlockAmount)
+			R->AL(false);
+	}
+
+	return Continue;
+}
+
+DEFINE_HOOK(0x739C74, UnitClass_ToggleDeployState_ChangeAmmo, 0x6) //deploying
+{
+	enum { Continue = 0x739C7A };
+
+	GET(UnitClass*, pThis, ECX);
+	auto const pThisExt = TechnoTypeExt::ExtMap.Find(pThis->GetTechnoType());
+
+	if (pThis->Deployed && !pThis->Deploying && pThisExt->Ammo_AddOnDeploy)
+	{
+		int ammoCalc = (pThis->Ammo + pThisExt->Ammo_AddOnDeploy) < 0 ? 0 : (pThis->Ammo + pThisExt->Ammo_AddOnDeploy);
+		pThis->Ammo = ammoCalc > pThis->Type->Ammo ? pThis->Type->Ammo : ammoCalc;
+	}
+
+	R->EAX(pThis->GetTechnoType());
+	return Continue;
+}
+
+DEFINE_HOOK(0x739E5A, UnitClass_ToggleSimpleDeploy_ChangeAmmo, 0x6) //undeploying
+{
+	enum { Continue = 0x739E60 };
+
+	GET(UnitClass*, pThis, ECX);
+	auto const pThisExt = TechnoTypeExt::ExtMap.Find(pThis->GetTechnoType());
+
+	if (!pThis->Deployed && !pThis->Undeploying && pThisExt->Ammo_AddOnDeploy)
+	{
+		int ammoCalc = (pThis->Ammo + pThisExt->Ammo_AddOnDeploy) < 0 ? 0 : (pThis->Ammo + pThisExt->Ammo_AddOnDeploy);
+		pThis->Ammo = ammoCalc > pThis->Type->Ammo ? pThis->Type->Ammo : ammoCalc;
+	}
+
+	R->AL(pThis->IsDisguised());
+	return Continue;
+}
+
+DEFINE_HOOK(0x73DE78, UnitClass_Unload_ChangeAmmo, 0x6) //converters
+{
+	enum { Continue = 0x73DE7E };
+
+	GET(TechnoClass*, pThis, ESI);
+	auto const pThisExt = TechnoTypeExt::ExtMap.Find(pThis->GetTechnoType());
+	auto pUnit = abstract_cast<UnitClass*>(pThis);
+
+	if (pUnit->Type->IsSimpleDeployer && pThisExt->Ammo_AddOnDeploy && (pUnit->Type->UnloadingClass == nullptr))
+	{
+		int ammoCalc = (pUnit->Ammo + pThisExt->Ammo_AddOnDeploy) < 0 ? 0 : (pUnit->Ammo + pThisExt->Ammo_AddOnDeploy);
+		pUnit->Ammo = ammoCalc > pUnit->Type->Ammo ? pUnit->Type->Ammo : ammoCalc;
+	}
+
+	R->AL(pUnit->Deployed);
+	return Continue;
+}