MultiWeapon (#1695)

![multiweapons](https://github.com/user-attachments/assets/192f8aa9-baa2-4f9d-89c5-25f480f9d83e)
You are free to decide whether to use Weapon x or not, instead of
passively using Primary/secondary.
您可以自由决定是否启动WeaponX，而不是只能使用主/副武器。

- TechnoType reads `WeaponX` as their weapon when `MultiWeapon=yes`, be
careful not to forget `WeaponCount`.
`MultiWeapon=yes`时会读取`WeaponX`作为他们的武器，注意不要忘记了`WeaponCount`。

- `MultiWeapon.IsSecondary` can only be used by infantry, who will play
the animation `SecondaryFire` when using these weapons.
`MultiWeapon.IsSecondary`只能用于步兵，使用这些武器时步兵会播放`SecondaryFire`。

- `MultiWeapon.SelectCount` determines the number of weapons that can be
selected. The lower the number the better the performance. The default
is 2.
`MultiWeapon.SelectCount`决定可选择的武器数量。数量越少性能越好。默认为 2。

In `rulesmd.ini`:
```ini
[SOMETECHNO]                    ; TechnoType
MultiWeapon=                    ; boolean
MultiWeapon.IsSecondary=        ; List of integers
MultiWeapon.SelectCount=       ; integer
```

Author: Fly-Star-him

CREDITS.md

@@ -373,6 +373,7 @@ This page lists all the individual contributions to the project by their author.
   - Fix the issue where some units crashed after the deployment transformation
   - Turretless vehicles with `Voxel=no` support use `FireUp` like infantry
   - Infantry support `IsGattling=yes`
+  - Support for more optional weapons
 - **NetsuNegi**:
   - Forbidding parallel AI queues by type
   - Jumpjet crash speed fix when crashing onto building

Phobos.vcxproj

@@ -19,6 +19,7 @@
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="src\Ext\Infantry\Hooks.Firing.cpp" />
+    <ClCompile Include="src\Ext\TechnoType\Hooks.MultiWeapon.cpp" />
     <ClCompile Include="src\Ext\Unit\Hooks.Firing.cpp" />
     <ClCompile Include="src\Ext\EBolt\Body.cpp" />
     <ClCompile Include="src\Ext\EBolt\Hooks.cpp" />

docs/New-or-Enhanced-Logics.md

@@ -1604,6 +1604,26 @@ MindControlLink.VisibleToHouse=all    ; Affected House Enumeration (none|owner/s
 MultiMindControl.ReleaseVictim=false  ; boolean
 ```
 
+### Multi Weapon
+
+![image](_static/images/multiweapons.gif)
+*Multi Weapon used to release different weapons against different targets in **Zero Boundary** by @[Stormsulfur](https://space.bilibili.com/11638715/lists/5358986)*
+
+- You can now use `WeaponX` to enable more than 2 weapons for a TechnoType without hardcoded `Gunner=yes`, `IsGattling=yes` or `IsChargeTurret=yes` restriction.
+ - Set `MultiWeapon=yes` to enable this feature, be careful not to forget `WeaponCount`.
+ - `MultiWeapon.IsSecondary` specifies which weapons will be considered as `Secondary` when selecting weapons or triggering infantry's `SecondaryFire` settings. If not set, `Weapon1` will be considered as `Secondary`.
+ - `MultiWeapon.SelectCount` determines the number of weapons that can be selected by default weapon selection logic. Notice that higher number is bad for performance.
+  - If the number is smaller than the total amount of weapons, the ones with smaller indices will be picked.
+  - Other weapons can still be used for logic that specify a weapon index, such as [ForceWeapon](#forcing-specific-weapon-against-certain-targets).
+
+In `rulesmd.ini`:
+```ini
+[SOMETECHNO]                    ; TechnoType
+MultiWeapon=false               ; boolean
+MultiWeapon.IsSecondary=        ; List of integers
+MultiWeapon.SelectCount=2       ; integer
+```
+
 ### No Manual Move
 
 - You can now specify whether a TechnoType is unable to receive move command.

docs/Whats-New.md

@@ -406,12 +406,10 @@ New:
 - [Display banner](AI-Scripting-and-Mapping.md#display-banner) (by Morton & ststl)
 - [Allows refineries to use multiple ActiveAnim simultaneously](Fixed-or-Improved-Logics.md#allows-refineries-to-use-multiple-activeanim-simultaneously) (by TaranDahl)
 - Electric/RadBeam trail for laser tails (by NetsuNegi)
-<<<<<<< HEAD
-- Ground line for select box (by NetsuNegi)
-=======
 - Add `DebrisMinimums` to keep the count of debris within a certain range (by CrimRecya)
 - Several attackmove related enhancement (by TaranDahl)
->>>>>>> upstream/develop
+- Ground line for select box (by NetsuNegi)
+- Support for more optional weapons (by FlyStar)
 
 Vanilla fixes:
 - Fixed sidebar not updating queued unit numbers when adding or removing units when the production is on hold (by CrimRecya)

docs/_static/images/multiweapons.gif

@@ -263,4 +263,5 @@ class TechnoExt
 	static int GetWeaponIndexAgainstWall(TechnoClass* pThis, OverlayTypeClass* pWallOverlayType);
 	static void ApplyKillWeapon(TechnoClass* pThis, TechnoClass* pSource, WarheadTypeClass* pWH);
 	static void ApplyRevengeWeapon(TechnoClass* pThis, TechnoClass* pSource, WarheadTypeClass* pWH);
+	static bool MultiWeaponCanFire(TechnoClass* const pThis, AbstractClass* const pTarget, WeaponTypeClass* const pWeaponType);
 };

src/Ext/Techno/Body.h

@@ -38,6 +38,20 @@ DEFINE_HOOK(0x6F3339, TechnoClass_WhatWeaponShouldIUse_Interceptor, 0x8)
 	return SkipGameCode;
 }
 
+DEFINE_HOOK(0x6F3360, TechnoClass_WhatWeaponShouldIUse_MultiWeapon, 0x6)
+{
+	GET(TechnoTypeClass*, pType, EAX);
+	enum { SkipGameCode = 0x6F3379 };
+
+	if (TechnoTypeExt::ExtMap.Find(pType)->MultiWeapon.Get()
+		&& (pType->WhatAmI() != AbstractType::UnitType || !pType->Gunner))
+	{
+		return SkipGameCode;
+	}
+
+	return 0;
+}
+
 DEFINE_HOOK(0x6F33CD, TechnoClass_WhatWeaponShouldIUse_ForceFire, 0x6)
 {
 	enum { ReturnWeaponIndex = 0x6F37AF };
@@ -94,6 +108,15 @@ DEFINE_HOOK(0x6F3428, TechnoClass_WhatWeaponShouldIUse_ForceWeapon, 0x6)
 		return UseWeaponIndex;
 	}
 
+	// Multi weapon
+	const int multiWeaponIndex = pTypeExt->SelectMultiWeapon(pThis, pTarget);
+
+	if (multiWeaponIndex >= 0)
+	{
+		R->EAX(multiWeaponIndex);
+		return UseWeaponIndex;
+	}
+
 	return 0;
 }
 
@@ -253,14 +276,10 @@ DEFINE_HOOK(0x6FC339, TechnoClass_CanFire, 0x6)
 	// Checking for nullptr is not required here, since the game has already executed them before calling the hook  -- Belonit
 	const auto pWH = pWeapon->Warhead;
 	const auto pWHExt = WarheadTypeExt::ExtMap.Find(pWH);
+	const int nMoney = pWHExt->TransactMoney;
 
-	if (pWHExt)
-	{
-		const int nMoney = pWHExt->TransactMoney;
-
-		if (nMoney < 0 && pThis->Owner->Available_Money() < -nMoney)
-			return CannotFire;
-	}
+	if (nMoney < 0 && pThis->Owner->Available_Money() < -nMoney)
+		return CannotFire;
 
 	// AAOnly doesn't need to be checked if LandTargeting=1.
 	if (pThis->GetTechnoType()->LandTargeting != LandTargetingType::Land_Not_OK && pWeapon->Projectile->AA
@@ -314,7 +333,7 @@ DEFINE_HOOK(0x6FC339, TechnoClass_CanFire, 0x6)
 
 		if (pWH->Airstrike)
 		{
-			if (!pWHExt || !EnumFunctions::IsTechnoEligible(pTargetTechno, pWHExt->AirstrikeTargets))
+			if (!EnumFunctions::IsTechnoEligible(pTargetTechno, pWHExt->AirstrikeTargets))
 				return CannotFire;
 
 			if (!TechnoExt::ExtMap.Find(pTargetTechno)->TypeExtData->AllowAirstrike.Get(pTargetTechno->AbstractFlags & AbstractFlags::Foot ? true : static_cast<BuildingClass*>(pTargetTechno)->Type->CanC4))

src/Ext/Techno/Hooks.Firing.cpp

@@ -350,3 +350,148 @@ int TechnoExt::ExtData::ApplyForceWeaponInRange(AbstractClass* pTarget)
 
 	return forceWeaponIndex;
 }
+
+bool TechnoExt::MultiWeaponCanFire(TechnoClass* const pThis, AbstractClass* const pTarget, WeaponTypeClass* const pWeaponType)
+{
+	if (!pWeaponType || pWeaponType->NeverUse
+		|| (pThis->InOpenToppedTransport && !pWeaponType->FireInTransport))
+	{
+		return false;
+	}
+
+	const auto rtti = pTarget->WhatAmI();
+	const bool isBuilding = rtti == AbstractType::Building;
+	const auto pWH = pWeaponType->Warhead;
+	const auto pBulletType = pWeaponType->Projectile;
+
+	const auto pTechno = abstract_cast<TechnoClass*, true>(pTarget);
+	const bool isInAir = pTechno ? pTechno->IsInAir() : false;
+
+	const auto pOwner = pThis->Owner;
+	const auto pTechnoOwner = pTechno ? pTechno->Owner : nullptr;
+	const bool isAllies = pTechnoOwner ? pOwner->IsAlliedWith(pTechnoOwner) : false;
+
+	if (isInAir)
+	{
+		if (!pBulletType->AA)
+			return false;
+	}
+	else
+	{
+		if (BulletTypeExt::ExtMap.Find(pBulletType)->AAOnly.Get())
+		{
+			return false;
+		}
+		else if (pWH->ElectricAssault)
+		{
+			if (!isBuilding || !isAllies
+				|| !static_cast<BuildingClass*>(pTarget)->Type->Overpowerable)
+			{
+				return false;
+			}
+		}
+		else if (pWH->IsLocomotor)
+		{
+			if (isBuilding)
+				return false;
+		}
+	}
+
+	CellClass* pTargetCell = nullptr;
+
+	// Ignore target cell for airborne target technos.
+	if (!pTechno || !isInAir)
+	{
+		if (auto const pObject = abstract_cast<ObjectClass*, true>(pTarget))
+			pTargetCell = pObject->GetCell();
+		else if (auto const pCell = abstract_cast<CellClass*, true>(pTarget))
+			pTargetCell = pCell;
+	}
+
+	const auto pWeaponExt = WeaponTypeExt::ExtMap.Find(pWeaponType);
+
+	if (!pWeaponExt->SkipWeaponPicking)
+	{
+		if (pTargetCell && !EnumFunctions::IsCellEligible(pTargetCell, pWeaponExt->CanTarget, true, true))
+			return false;
+
+		if (pTechno)
+		{
+			if (!EnumFunctions::IsTechnoEligible(pTechno, pWeaponExt->CanTarget)
+				|| !EnumFunctions::CanTargetHouse(pWeaponExt->CanTargetHouses, pOwner, pTechnoOwner)
+				|| !pWeaponExt->IsHealthRatioEligible(pTechno)
+				|| !pWeaponExt->HasRequiredAttachedEffects(pTechno, pThis))
+			{
+				return false;
+			}
+		}
+	}
+
+	if (pTechno)
+	{
+		if (pTechno->AttachedBomb ? pWH->IvanBomb : pWH->BombDisarm)
+			return false;
+
+		if (!pWH->Temporal && pTechno->BeingWarpedOut)
+			return false;
+
+		if (pWH->Parasite
+			&& (isBuilding || static_cast<FootClass*>(pTechno)->ParasiteEatingMe))
+		{
+			return false;
+		}
+
+		const auto pTechnoType = pTechno->GetTechnoType();
+
+		if (pWH->MindControl
+			&& (pTechnoType->ImmuneToPsionics || pTechno->IsMindControlled() || pOwner == pTechnoOwner))
+		{
+			return false;
+		}
+
+		if (pWeaponType->DrainWeapon
+			&& (!pTechnoType->Drainable || pTechno->DrainingMe || isAllies))
+		{
+			return false;
+		}
+
+		if (pWH->Airstrike)
+		{
+			if (!EnumFunctions::IsTechnoEligible(pTechno, WarheadTypeExt::ExtMap.Find(pWH)->AirstrikeTargets))
+				return false;
+
+			const auto pTechnoTypeExt = TechnoTypeExt::ExtMap.Find(pTechnoType);
+
+			if (pTechno->AbstractFlags & AbstractFlags::Foot)
+			{
+				if (!pTechnoTypeExt->AllowAirstrike.Get(true))
+					return false;
+			}
+			else if (pTechnoTypeExt->AllowAirstrike.Get(static_cast<BuildingTypeClass*>(pTechnoType)->CanC4)
+				&& (!pTechnoType->ResourceDestination || !pTechnoType->ResourceGatherer))
+			{
+				return false;
+			}
+		}
+
+		if (GeneralUtils::GetWarheadVersusArmor(pWH, pTechno, pTechnoType) == 0.0)
+			return false;
+	}
+	else if (rtti == AbstractType::Cell)
+	{
+		if (pTargetCell->OverlayTypeIndex >= 0)
+		{
+			const auto pOverlayType = OverlayTypeClass::Array.GetItem(pTargetCell->OverlayTypeIndex);
+
+			if (pOverlayType->Wall && !pWH->Wall && (!pWH->Wood || pOverlayType->Armor != Armor::Wood))
+				return false;
+		}
+	}
+	else if (rtti == AbstractType::Terrain)
+	{
+		if (!pWH->Wood)
+			return false;
+	}
+
+	return true;
+}