AuxWeapon

Author: Coronia

docs/New-or-Enhanced-Logics.md

@@ -41,7 +41,15 @@ This page describes all the engine features that are either new and introduced b
     - `ExtraWarheads.DetonationChances` can be used to customize the chance of each extra Warhead detonation occuring. Value from position matching the position from `ExtraWarheads` is used if found, or last listed value if not found. If list is empty, every extra Warhead detonation is guaranteed to occur.
     - `ExtraWarheads.FullDetonation` can be used to customize whether or not each individual Warhead is detonated fully (as part of a dummy weapon) or simply deals area damage and applies Phobos' Warhead effects. Value from position matching the position from `ExtraWarheads` is used if found, or last listed value if not found. If list is empty, defaults to true.
     - Note that the listed Warheads must be listed in `[Warheads]` for them to work.
-  - `FeedbackWeapon` can specify an auxiliary weapon to be fired on the firer itself when a weapon is fired.
+  - You can now specify an auxiliary weapon to be fired when a weapon is fired.
+    - `FireInTransport` setting of the auxiliary weapons are respected to determine if it can be fired when the original weapon is fired from inside `OpenTopped=true` transport. If auxiliary weapons are fired, it is fired on the transport. `OpenToppedDamageMultiplier` is not applied on auxiliary weapons.
+  - `AuxWeapon` is fired at the original target, or another nearby target if `AuxWeapon.Retarget` set to true.
+    - `AuxWeapon.Offset` defines the relative position to the firer that the auxiliary weapon will be fired from. `AuxWeapon.FireOnTurret` defines if the FLH is relative to the turret rather than the body.
+    - If `AuxWeapon.AllowZeroDamage` set to true, the auxiliary weapon will be fired even if its damage on the set target is 0.
+    - `AuxWeapon.ApplyFirepowerMult` determines whether or not the auxiliary weapon's damage should multiply the firer's firepower multipliers.
+    - `AuxWeapon.Retarget.AroundFirer` determines whether the original target or the firer will be the center of the retargeting. `AuxWeapon.Retarget.Range` determines the radius of the retargeting, default to the auxiliary weapon's `Range` if the center is the firer, and 0 if the center is the original target.
+    - `AuxWeapon.Retarget.Accuracy` defines the probability that the auxiliary weapon is fired to the original target.
+  - `FeedbackWeapon` is fired at the firer.
     - `FireInTransport` setting of the feedback weapon is respected to determine if it can be fired when the original weapon is fired from inside `OpenTopped=true` transport. If feedback weapon is fired, it is fired on the transport. `OpenToppedDamageMultiplier` is not applied on feedback weapons.
   - `Tint.Color` & `Tint.Intensity` can be used to set a color tint effect and additive lighting increase/decrease on the object the effect is attached to, respectively.
     - `Tint.VisibleToHouses` can be used to control which houses can see the tint effect.
@@ -124,6 +132,15 @@ ExtraWarheads=                                     ; List of WarheadTypes
 ExtraWarheads.DamageOverrides=                     ; List of integers
 ExtraWarheads.DetonationChances=                   ; List of floating-point values (percentage or absolute)
 ExtraWarheads.FullDetonation=                      ; List of booleans
+AuxWeapon=                                         ; WeaponType
+AuxWeapon.Offset=0,0,0                             ; integer - Forward,Lateral,Height
+AuxWeapon.FireOnTurret=false                       ; boolean
+AuxWeapon.AllowZeroDamage=true                     ; boolean
+AuxWeapon.ApplyFirepowerMult=false                 ; boolean
+AuxWeapon.Retarget=false                           ; boolean
+AuxWeapon.Retarget.Range=                          ; floating point value
+AuxWeapon.Retarget.Accuracy=                       ; floating point value, percents or absolute (0.0-1.0)
+AuxWeapon.Retarget.AroundFirer=false               ; boolean
 FeedbackWeapon=                                    ; WeaponType
 Tint.Color=                                        ; integer - R,G,B
 Tint.Intensity=                                    ; floating point value
@@ -966,11 +983,13 @@ SubjectToGround=false         ; boolean
 ### Return weapon
 
 - It is now possible to make another weapon & projectile go off from a detonated projectile (in somewhat similar manner to `AirburstWeapon` or `ShrapnelWeapon`) straight back to the firer by setting `ReturnWeapon`. If the firer perishes before the initial projectile detonates, `ReturnWeapon` is not fired off.
+  - `ReturnWeapon.ApplyFirepowerMult` determines whether or not the auxiliary weapon's damage should multiply the firer's firepower multipliers.
 
 In `rulesmd.ini`:
 ```ini
-[SOMEPROJECTILE]  ; Projectile
-ReturnWeapon=     ; WeaponType
+[SOMEPROJECTILE]                        ; Projectile
+ReturnWeapon=                           ; WeaponType
+ReturnWeapon.ApplyFirepowerMult=false   ; boolean
 ```
 
 ```{note}
@@ -2241,18 +2260,34 @@ ExtraWarheads.DetonationChances=  ; List of floating-point values (percentage or
 ExtraWarheads.FullDetonation=     ; List of booleans
 ```
 
-### Feedback weapon
+### Auxiliary weapon
 
 ![image](_static/images/feedbackweapon.gif)
 *`FeedbackWeapon` used to apply healing aura upon firing a weapon in [Project Phantom](https://www.moddb.com/mods/project-phantom)*
 
-- You can now specify an auxiliary weapon to be fired on the firer itself when a weapon is fired.
-  - `FireInTransport` setting of the feedback weapon is respected to determine if it can be fired when the original weapon is fired from inside `OpenTopped=true` transport. If feedback weapon is fired, it is fired on the transport. `OpenToppedDamageMultiplier` is not applied on feedback weapons.
-
-In `rulesmd.ini`:
-```ini
-[SOMEWEAPON]     ; WeaponType
-FeedbackWeapon=  ; WeaponType
+- You can now specify an auxiliary weapon to be fired when a weapon is fired.
+  - `FireInTransport` setting of the auxiliary weapons are respected to determine if it can be fired when the original weapon is fired from inside `OpenTopped=true` transport. If auxiliary weapons are fired, it is fired on the transport. `OpenToppedDamageMultiplier` is not applied on auxiliary weapons.
+- `AuxWeapon` is fired at the original target, or another nearby target if `AuxWeapon.Retarget` set to true.
+  - `AuxWeapon.Offset` defines the relative position to the firer that the auxiliary weapon will be fired from. `AuxWeapon.FireOnTurret` defines if the FLH is relative to the turret rather than the body.
+  - If `AuxWeapon.AllowZeroDamage` set to true, the auxiliary weapon will be fired even if its damage on the set target is 0.
+  - `AuxWeapon.ApplyFirepowerMult` determines whether or not the auxiliary weapon's damage should multiply the firer's firepower multipliers.
+  - `AuxWeapon.Retarget.AroundFirer` determines whether the original target or the firer will be the center of the retargeting. `AuxWeapon.Retarget.Range` determines the radius of the retargeting, default to the auxiliary weapon's `Range` if the center is the firer, and 0 if the center is the original target.
+  - `AuxWeapon.Retarget.Accuracy` defines the probability that the auxiliary weapon is fired to the original target.
+- `FeedbackWeapon` is fired at the firer.
+
+In `rulesmd.ini`:
+```ini
+[SOMEWEAPON]                              ; WeaponType
+AuxWeapon=                                ; WeaponType
+AuxWeapon.Offset=0,0,0                    ; integer - Forward,Lateral,Height
+AuxWeapon.FireOnTurret=false              ; boolean
+AuxWeapon.AllowZeroDamage=true            ; boolean
+AuxWeapon.ApplyFirepowerMult=false        ; boolean
+AuxWeapon.Retarget=false                  ; boolean
+AuxWeapon.Retarget.Range=                 ; floating point value
+AuxWeapon.Retarget.Accuracy=              ; floating point value, percents or absolute (0.0-1.0)
+AuxWeapon.Retarget.AroundFirer=false      ; boolean
+FeedbackWeapon=                           ; WeaponType
 ```
 
 ### Keep Range After Firing

src/Ext/Bullet/Hooks.DetonateLogics.cpp

@@ -330,8 +330,13 @@ DEFINE_HOOK(0x469AA4, BulletClass_Logics_Extras, 0x5)
 
 		if (auto const pWeapon = pTypeExt->ReturnWeapon)
 		{
+			auto damage = pWeapon->Damage;
+
+			if (pTypeExt->ReturnWeapon_ApplyFirepowerMult)
+				damage = static_cast<int>(damage * pThis->Owner->FirepowerMultiplier * TechnoExt::ExtMap.Find(pThis->Owner)->AE.FirepowerMultiplier);
+
 			if (BulletClass* pBullet = pWeapon->Projectile->CreateBullet(pThis->Owner, pThis->Owner,
-				pWeapon->Damage, pWeapon->Warhead, pWeapon->Speed, pWeapon->Bright))
+				damage, pWeapon->Warhead, pWeapon->Speed, pWeapon->Bright))
 			{
 				pBullet->WeaponType = pWeapon;
 				pBullet->MoveTo(pThis->Location, BulletVelocity::Empty);
@@ -347,38 +352,6 @@ DEFINE_HOOK(0x469AA4, BulletClass_Logics_Extras, 0x5)
 
 #pragma region Airburst
 
-static bool IsAllowedSplitsTarget(TechnoClass* pSource, HouseClass* pOwner, WeaponTypeClass* pWeapon, TechnoClass* pTarget, bool useWeaponTargeting)
-{
-	auto const pWH = pWeapon->Warhead;
-
-	if (useWeaponTargeting)
-	{
-		auto const pType = pTarget->GetTechnoType();
-
-		if (!pType->LegalTarget || GeneralUtils::GetWarheadVersusArmor(pWH, pType->Armor) == 0.0)
-			return false;
-
-		auto const pWeaponExt = WeaponTypeExt::ExtMap.Find(pWeapon);
-
-		if (!EnumFunctions::CanTargetHouse(pWeaponExt->CanTargetHouses, pOwner, pTarget->Owner)
-			|| !EnumFunctions::IsCellEligible(pTarget->GetCell(), pWeaponExt->CanTarget, true, true)
-			|| !EnumFunctions::IsTechnoEligible(pTarget, pWeaponExt->CanTarget))
-		{
-			return false;
-		}
-
-		if (!pWeaponExt->HasRequiredAttachedEffects(pTarget, pSource))
-			return false;
-	}
-	else
-	{
-		if (!WarheadTypeExt::ExtMap.Find(pWH)->CanTargetHouse(pOwner, pTarget))
-			return false;
-	}
-
-	return true;
-}
-
 // Disable Ares' Airburst implementation.
 DEFINE_PATCH(0x469EBA, 0x90, 0x90, 0x90, 0x90, 0x90, 0x90);
 
@@ -494,7 +467,7 @@ DEFINE_HOOK(0x469EC0, BulletClass_Logics_AirburstWeapon, 0x6)
 
 					if (coordsTarget.DistanceFrom(coords) < pTypeExt->Splits_TargetingDistance.Get()
 						&& (pType->AA || !pTechno->IsInAir())
-						&& IsAllowedSplitsTarget(pSource, pOwner, pWeapon, pTechno, pTypeExt->Splits_UseWeaponTargeting))
+						&& TechnoExt::IsAllowedSplitsTarget(pSource, pOwner, pWeapon, pTechno, pTypeExt->Splits_UseWeaponTargeting))
 					{
 						targets.AddItem(pTechno);
 					}

src/Ext/BulletType/Body.cpp

@@ -52,6 +52,7 @@ void BulletTypeExt::ExtData::LoadFromINIFile(CCINIClass* const pINI)
 	this->AAOnly.Read(exINI, pSection, "AAOnly");
 	this->Arcing_AllowElevationInaccuracy.Read(exINI, pSection, "Arcing.AllowElevationInaccuracy");
 	this->ReturnWeapon.Read<true>(exINI, pSection, "ReturnWeapon");
+	this->ReturnWeapon_ApplyFirepowerMult.Read(exINI, pSection, "ReturnWeapon.ApplyFirepowerMult");
 	this->SubjectToGround.Read(exINI, pSection, "SubjectToGround");
 
 	this->Splits.Read(exINI, pSection, "Splits");
@@ -144,6 +145,7 @@ void BulletTypeExt::ExtData::Serialize(T& Stm)
 		.Process(this->AAOnly)
 		.Process(this->Arcing_AllowElevationInaccuracy)
 		.Process(this->ReturnWeapon)
+		.Process(this->ReturnWeapon_ApplyFirepowerMult)
 		.Process(this->SubjectToGround)
 		.Process(this->Splits)
 		.Process(this->AirburstSpread)

src/Ext/BulletType/Body.h

@@ -44,6 +44,7 @@ class BulletTypeExt
 		Valueable<bool> AAOnly;
 		Valueable<bool> Arcing_AllowElevationInaccuracy;
 		Valueable<WeaponTypeClass*> ReturnWeapon;
+		Valueable<bool> ReturnWeapon_ApplyFirepowerMult;
 
 		Valueable<bool> SubjectToGround;
 
@@ -92,6 +93,7 @@ class BulletTypeExt
 			, AAOnly { false }
 			, Arcing_AllowElevationInaccuracy { true }
 			, ReturnWeapon {}
+			, ReturnWeapon_ApplyFirepowerMult { false }
 			, SubjectToGround { false }
 			, Splits { false }
 			, AirburstSpread { 1.5 }

src/Ext/Techno/Body.Update.cpp

@@ -1171,7 +1171,7 @@ void TechnoExt::ExtData::RecalculateStatMultipliers()
 	bool hasRestrictedArmorMultipliers = false;
 	bool hasCritModifiers = false;
 	bool hasExtraWarheads = false;
-	bool hasFeedbackWeapon = false;
+	bool hasFeedbackOrAuxWeapon = false;
 
 	for (const auto& attachEffect : this->AttachedEffects)
 	{
@@ -1194,7 +1194,7 @@ void TechnoExt::ExtData::RecalculateStatMultipliers()
 		hasRestrictedArmorMultipliers |= (type->ArmorMultiplier != 1.0 && (type->ArmorMultiplier_AllowWarheads.size() > 0 || type->ArmorMultiplier_DisallowWarheads.size() > 0));
 		hasCritModifiers |= (type->Crit_Multiplier != 1.0 || type->Crit_ExtraChance != 0.0);
 		hasExtraWarheads |= type->ExtraWarheads.size() > 0;
-		hasFeedbackWeapon |= type->FeedbackWeapon != nullptr;
+		hasFeedbackOrAuxWeapon |= type->FeedbackWeapon != nullptr || type->AuxWeapon != nullptr;
 	}
 
 	this->AE.FirepowerMultiplier = firepower;
@@ -1212,7 +1212,7 @@ void TechnoExt::ExtData::RecalculateStatMultipliers()
 	this->AE.HasRestrictedArmorMultipliers = hasRestrictedArmorMultipliers;
 	this->AE.HasCritModifiers = hasCritModifiers;
 	this->AE.HasExtraWarheads = hasExtraWarheads;
-	this->AE.HasFeedbackWeapon = hasFeedbackWeapon;
+	this->AE.HasFeedbackOrAuxWeapon = hasFeedbackOrAuxWeapon;
 
 	if (forceDecloak && pThis->CloakState == CloakState::Cloaked)
 		pThis->Uncloak(true);

src/Ext/Techno/Body.h

@@ -146,6 +146,7 @@ class TechnoExt
 		int GetAttachedEffectCumulativeCount(AttachEffectTypeClass* pAttachEffectType, bool ignoreSameSource = false, TechnoClass* pInvoker = nullptr, AbstractClass* pSource = nullptr) const;
 		void ApplyMindControlRangeLimit();
 		int ApplyForceWeaponInRange(TechnoClass* pTarget);
+		void ApplyAuxWeapon(WeaponTypeClass* pAuxWeapon, AbstractClass* pTarget, CoordStruct offset, double accuracy, bool onTurret, bool retarget, bool aroundFirer, bool zeroDamage, bool firepowerMult);
 
 		UnitTypeClass* GetUnitTypeExtra() const;
 
@@ -222,4 +223,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 IsAllowedSplitsTarget(TechnoClass* pSource, HouseClass* pOwner, WeaponTypeClass* pWeapon, TechnoClass* pTarget, bool useWeaponTargeting = true, bool allowZeroDamage = false);
 };

src/Ext/Techno/Hooks.Firing.cpp

@@ -574,31 +574,40 @@ DEFINE_HOOK(0x6FF43F, TechnoClass_FireAt_FeedbackWeapon, 0x6)
 {
 	GET(TechnoClass*, pThis, ESI);
 	GET(WeaponTypeClass*, pWeapon, EBX);
+	GET_BASE(AbstractClass*, pTarget, 0x8);
+
+	auto const pExt = TechnoExt::ExtMap.Find(pThis);
 
 	if (auto const pWeaponExt = WeaponTypeExt::ExtMap.Find(pWeapon))
 	{
 		if (auto const pWeaponFeedback = pWeaponExt->FeedbackWeapon)
 		{
-			if (pThis->InOpenToppedTransport && !pWeaponFeedback->FireInTransport)
-				return 0;
-
-			WeaponTypeExt::DetonateAt(pWeaponFeedback, pThis, pThis);
+			if (!pThis->InOpenToppedTransport || pWeaponFeedback->FireInTransport)
+				WeaponTypeExt::DetonateAt(pWeaponFeedback, pThis, pThis);
 		}
-	}
 
-	auto const pExt = TechnoExt::ExtMap.Find(pThis);
+		if (auto const pAuxWeapon = pWeaponExt->AuxWeapon)
+			pExt->ApplyAuxWeapon(pThis, pAuxWeapon, pTarget, pWeaponExt->AuxWeapon_Offset, pWeaponExt->AuxWeapon_Retarget_Accuracy, pWeaponExt->AuxWeapon_FireOnTurret,
+				pWeaponExt->AuxWeapon_Retarget, pWeaponExt->AuxWeapon_Retarget_AroundFirer, pWeaponExt->AuxWeapon_AllowZeroDamage, pWeaponExt->AuxWeapon_ApplyFirepowerMult);
+	}
 
-	if (pExt->AE.HasFeedbackWeapon)
+	if (pExt->AE.HasFeedbackOrAuxWeapon)
 	{
 		for (auto const& pAE : pExt->AttachedEffects)
 		{
-			if (auto const pWeaponFeedback = pAE->GetType()->FeedbackWeapon)
+			auto const pAEType = pAE->GetType();
+
+			if (auto const pWeaponFeedback = pAEType->FeedbackWeapon)
 			{
 				if (pThis->InOpenToppedTransport && !pWeaponFeedback->FireInTransport)
-					return 0;
+					continue;
 
 				WeaponTypeExt::DetonateAt(pWeaponFeedback, pThis, pThis);
 			}
+
+			if (auto const pAuxWeapon = pAEType->AuxWeapon)
+				pExt->ApplyAuxWeapon(pAuxWeapon, pTarget, pAEType->AuxWeapon_Offset, pAEType->AuxWeapon_Retarget_Accuracy, pAEType->AuxWeapon_FireOnTurret,
+					pAEType->AuxWeapon_Retarget, pAEType->AuxWeapon_Retarget_AroundFirer, pAEType->AuxWeapon_AllowZeroDamage, pAEType->AuxWeapon_ApplyFirepowerMult);
 		}
 	}