KillWeapon

Author: Coronia

docs/New-or-Enhanced-Logics.md

@@ -67,6 +67,10 @@ This page describes all the engine features that are either new and introduced b
     - On TechnoTypes with `OpenTopped=true`, `OpenTopped.UseTransportRangeModifiers` can be set to true to make passengers firing out use the transport's active range bonuses instead.
   - `Crit.Multiplier` and `Crit.ExtraChance` can be used to multiply the [critical hit](#chance-based-extra-damage-or-warhead-detonation--critical-hits) chance or grant a fixed bonus to it for the object the effect is attached to, respectively.
     - `Crit.AllowWarheads` can be used to list only Warheads that can benefit from this critical hit chance multiplier and `Crit.DisallowWarheads` weapons that are not allowed to, respectively.
+  - `KillWeapon` will be fired at the target TechnoType's location once it's killed by the attached object.
+    - `KillWeapon.OnFirer` will be fired at the attacker's location once the target TechnoType is killed the attached object. If `KillWeapon.OnFirer.RealLaunch` set to true, the weapon will be fired through a real projectile from the TechnoType to the attached object.
+    - `KillWeapon.AffectsHouses` / `KillWeapon.OnFirer.AffectsHouses` and `KillWeapon.Affects` / `KillWeapon.OnFirer.Affects` can be used to filter which houses targets can belong to and which types of targets are be considered valid for `KillWeapon` and `KillWeapon.OnFirer` respectively.
+    - If a TechnoType has `SuppressKillWeapons` set to true, it will not trigger `KillWeapon` or `KillWeapon.OnFirer` upon being killed. `SuppressKillWeapons.Types` can be used to list WeaponTypes affected by this, if none are listed all WeaponTypes are affected.
   - `RevengeWeapon` can be used to temporarily grant the specified weapon as a [revenge weapon](#revenge-weapon) for the attached object.
     - `RevengeWeapon.AffectsHouses` customizes which houses can trigger the revenge weapon.
     - If `RevengeWeapon.RealLaunch` set to true, the weapon will be fired through a real projectile from the TechnoType to the killer.

src/Ext/Bullet/Body.cpp

@@ -153,13 +153,13 @@ void BulletExt::ExtData::InitializeLaserTrails()
 void BulletExt::ExtData::ApplyExtraWarheads(const std::vector<WarheadTypeClass*>& exWH, const std::vector<int>& exWHOverrides, const std::vector<double>& exWHChances, const std::vector<bool>& exWHFull, const std::vector<bool>& exWHOwner, const CoordStruct& coords, HouseClass* pOwner, TechnoClass* pInvoker)
 {
 	auto const pThis = this->OwnerObject();
-	auto const pTarget = abstract_cast<TechnoClass*>(pThis->Target);
 	const int defaultDamage = pThis->WeaponType ? pThis->WeaponType->Damage : 0;
 
 	for (size_t i = 0; i < exWH.size(); i++)
 	{
 		auto const pWH = exWH[i];
 		auto const pWHExt = WarheadTypeExt::ExtMap.Find(pWH);
+		auto const pTarget = abstract_cast<TechnoClass*>(pThis->Target); // must be check in every loop
 
 		if (pTarget && !pWHExt->IsHealthInThreshold(pTarget))
 			continue;

src/Ext/Techno/WeaponHelpers.cpp

@@ -239,25 +239,60 @@ void TechnoExt::ApplyKillWeapon(TechnoClass* pThis, TechnoClass* pSource, Warhea
 	auto const pWHExt = WarheadTypeExt::ExtMap.Find(pWH);
 	const bool hasFilters = pTypeExt->SuppressKillWeapons_Types.size() > 0;
 
-	// KillWeapon can be triggered without the source
-	if (pWHExt->KillWeapon && (!pSource || (EnumFunctions::CanTargetHouse(pWHExt->KillWeapon_AffectsHouses, pSource->Owner, pThis->Owner)
-		&& EnumFunctions::IsTechnoEligible(pThis, pWHExt->KillWeapon_Affects))))
-	{
-		if (!pTypeExt->SuppressKillWeapons || (hasFilters && !pTypeExt->SuppressKillWeapons_Types.Contains(pWHExt->KillWeapon)))
-			WeaponTypeExt::DetonateAt(pWHExt->KillWeapon, pThis, pSource);
-	}
-
-	// KillWeapon.OnFirer must have a source
-	if (pWHExt->KillWeapon_OnFirer && pSource && EnumFunctions::CanTargetHouse(pWHExt->KillWeapon_OnFirer_AffectsHouses, pSource->Owner, pThis->Owner)
-		&& EnumFunctions::IsTechnoEligible(pThis, pWHExt->KillWeapon_OnFirer_Affects))
-	{
-		if (!pTypeExt->SuppressKillWeapons || (hasFilters && !pTypeExt->SuppressKillWeapons_Types.Contains(pWHExt->KillWeapon_OnFirer)))
+	auto tryKillWeapon = [&](auto pWeapon, AffectedHouse affectsHouses, AffectedTarget affects, bool realLaunch, bool onFirer)
 		{
-			if (pWHExt->KillWeapon_OnFirer_RealLaunch)
-				RealLaunch(pWHExt->KillWeapon_OnFirer, pSource, pSource, true, pThis);
+			if (!pWeapon)
+				return;
+
+			if (onFirer)
+			{
+				if (!pSource)
+					return;
+
+				if (!(EnumFunctions::CanTargetHouse(affectsHouses, pSource->Owner, pThis->Owner)
+					&& EnumFunctions::IsTechnoEligible(pThis, affects)))
+				{
+					return;
+				}
+			}
 			else
-				WeaponTypeExt::DetonateAt(pWHExt->KillWeapon_OnFirer, pSource, pSource);
-		}
+			{
+				if (pSource && !(EnumFunctions::CanTargetHouse(affectsHouses, pSource->Owner, pThis->Owner)
+					&& EnumFunctions::IsTechnoEligible(pThis, affects)))
+				{
+					return;
+				}
+			}
+
+			if (pTypeExt->SuppressKillWeapons && (!hasFilters || pTypeExt->SuppressKillWeapons_Types.Contains(pWeapon)))
+				return;
+
+			if (onFirer)
+			{
+				if (realLaunch)
+					RealLaunch(pWeapon, pSource, pSource, true, pThis);
+				else
+					WeaponTypeExt::DetonateAt(pWeapon, pSource, pSource);
+			}
+			else
+			{
+				WeaponTypeExt::DetonateAt(pWeapon, pThis, pSource);
+			}
+		};
+
+	tryKillWeapon(pWHExt->KillWeapon, pWHExt->KillWeapon_AffectsHouses, pWHExt->KillWeapon_Affects, false, false);
+	tryKillWeapon(pWHExt->KillWeapon_OnFirer, pWHExt->KillWeapon_OnFirer_AffectsHouses, pWHExt->KillWeapon_OnFirer_Affects, pWHExt->KillWeapon_OnFirer_RealLaunch, true);
+
+	auto const pExt = TechnoExt::ExtMap.Find(pSource);
+
+	for (auto const& attachEffect : pExt->AttachedEffects)
+	{
+		if (!attachEffect->IsActive())
+			continue;
+
+		auto const pType = attachEffect->GetType();
+		tryKillWeapon(pType->KillWeapon, pType->KillWeapon_AffectsHouses, pType->KillWeapon_Affects, false, false);
+		tryKillWeapon(pType->KillWeapon_OnFirer, pType->KillWeapon_OnFirer_AffectsHouses, pType->KillWeapon_OnFirer_Affects, pType->KillWeapon_OnFirer_RealLaunch, true);
 	}
 }
 

src/New/Type/AttachEffectTypeClass.cpp

@@ -171,6 +171,14 @@ void AttachEffectTypeClass::LoadFromINI(CCINIClass* pINI)
 	this->Crit_AllowWarheads.Read(exINI, pSection, "Crit.AllowWarheads");
 	this->Crit_DisallowWarheads.Read(exINI, pSection, "Crit.DisallowWarheads");
 
+	this->KillWeapon.Read(exINI, pSection, "KillWeapon");
+	this->KillWeapon_OnFirer.Read(exINI, pSection, "KillWeapon.OnFirer");
+	this->KillWeapon_AffectsHouses.Read(exINI, pSection, "KillWeapon.AffectsHouses");
+	this->KillWeapon_OnFirer_AffectsHouses.Read(exINI, pSection, "KillWeapon.OnFirer.AffectsHouses");
+	this->KillWeapon_Affects.Read(exINI, pSection, "KillWeapon.Affects");
+	this->KillWeapon_OnFirer_Affects.Read(exINI, pSection, "KillWeapon.OnFirer.Affects");
+	this->KillWeapon_OnFirer_RealLaunch.Read(exINI, pSection, "KillWeapon.OnFirer.RealLaunch");
+
 	this->RevengeWeapon.Read<true>(exINI, pSection, "RevengeWeapon");
 	this->RevengeWeapon_AffectsHouses.Read(exINI, pSection, "RevengeWeapon.AffectsHouses");
 	this->RevengeWeapon_RealLaunch.Read(exINI, pSection, "RevengeWeapon.RealLaunch");
@@ -264,6 +272,13 @@ void AttachEffectTypeClass::Serialize(T& Stm)
 		.Process(this->Crit_ExtraChance)
 		.Process(this->Crit_AllowWarheads)
 		.Process(this->Crit_DisallowWarheads)
+		.Process(this->KillWeapon)
+		.Process(this->KillWeapon_OnFirer)
+		.Process(this->KillWeapon_AffectsHouses)
+		.Process(this->KillWeapon_OnFirer_AffectsHouses)
+		.Process(this->KillWeapon_Affects)
+		.Process(this->KillWeapon_OnFirer_Affects)
+		.Process(this->KillWeapon_OnFirer_RealLaunch)
 		.Process(this->RevengeWeapon)
 		.Process(this->RevengeWeapon_AffectsHouses)
 		.Process(this->RevengeWeapon_RealLaunch)

src/New/Type/AttachEffectTypeClass.h

@@ -106,6 +106,13 @@ class AttachEffectTypeClass final : public Enumerable<AttachEffectTypeClass>
 	Valueable<double> Crit_ExtraChance;
 	ValueableVector<WarheadTypeClass*> Crit_AllowWarheads;
 	ValueableVector<WarheadTypeClass*> Crit_DisallowWarheads;
+	Valueable<WeaponTypeClass*> KillWeapon;
+	Valueable<WeaponTypeClass*> KillWeapon_OnFirer;
+	Valueable<AffectedHouse> KillWeapon_AffectsHouses;
+	Valueable<AffectedHouse> KillWeapon_OnFirer_AffectsHouses;
+	Valueable<AffectedTarget> KillWeapon_Affects;
+	Valueable<AffectedTarget> KillWeapon_OnFirer_Affects;
+	Valueable<bool> KillWeapon_OnFirer_RealLaunch;
 	Valueable<WeaponTypeClass*> RevengeWeapon;
 	Valueable<AffectedHouse> RevengeWeapon_AffectsHouses;
 	Valueable<bool> RevengeWeapon_RealLaunch;
@@ -191,6 +198,13 @@ class AttachEffectTypeClass final : public Enumerable<AttachEffectTypeClass>
 		, Crit_ExtraChance { 0.0 }
 		, Crit_AllowWarheads {}
 		, Crit_DisallowWarheads {}
+		, KillWeapon {}
+		, KillWeapon_OnFirer {}
+		, KillWeapon_AffectsHouses { AffectedHouse::All }
+		, KillWeapon_OnFirer_AffectsHouses { AffectedHouse::All }
+		, KillWeapon_Affects { AffectedTarget::All }
+		, KillWeapon_OnFirer_Affects { AffectedTarget::All }
+		, KillWeapon_OnFirer_RealLaunch { false }
 		, RevengeWeapon {}
 		, RevengeWeapon_AffectsHouses { AffectedHouse::All }
 		, RevengeWeapon_RealLaunch { false }