Electric/RadBeam trail for laser tails (#1706)

- LaserTrail can now drawn as other behaviour like EBolt or RadBeam.
- 激光轨迹现在可以绘制成电弧或辐射波的样式。
- You can also specific laser trail on attacheffect, the trail will
disappear if attacheffect is expired.
- 你也可以在AE上指定激光轨迹，这种激光轨迹将会在AE过期后消失。


[SOMETRAIL]                      ; LaserTrailType name
DrawType=laser                 ; enumeration (laser | ebolt | radbeam)
IsAlternateColor=false      ; boolean
Bolt.Color1=                      ; r, g, b
Bolt.Disable1=false           ; boolean
Bolt.Color2=                      ; r, g, b
Bolt.Disable2=false           ; boolean
Bolt.Color3=                      ; r, g, b
Bolt.Disable3=false           ; boolean
Beam.Color=                     ; r, g, b
Beam.Amplitude=40.0      ; double
FadeDuration= ; integer, default 64 for laser, 17 for electric, 15 for
radbeam

[SOMEATTACHEFFECT]
LaserTrail.Type=                                ; lasertrail type

---------

Co-authored-by: CrimRecya <[email protected]>
Co-authored-by: Coronia <[email protected]>

Author: 3 people

CREDITS.md

@@ -416,6 +416,7 @@ This page lists all the individual contributions to the project by their author.
   - Customize limit when engineer repair a building
   - Fix the bug that damaged particle dont disappear after building has repaired by engineer
   - Display banner improvement
+  - Electric/RadBeam trail for laser tails
 - **Apollo** - Translucent SHP drawing patches
 - **ststl**:
   - Customizable `ShowTimer` priority of superweapons

Phobos.vcxproj

@@ -20,6 +20,8 @@
   <ItemGroup>
     <ClCompile Include="src\Ext\Infantry\Hooks.Firing.cpp" />
     <ClCompile Include="src\Ext\Unit\Hooks.Firing.cpp" />
+    <ClCompile Include="src\Ext\EBolt\Body.cpp" />
+    <ClCompile Include="src\Ext\EBolt\Hooks.cpp" />
     <ClCompile Include="src\New\Type\Affiliated\CreateUnitTypeClass.cpp" />
     <ClCompile Include="src\Blowfish\blowfish.cpp" />
     <ClCompile Include="src\Blowfish\Hooks.Blowfish.cpp" />
@@ -167,7 +169,6 @@
     <ClCompile Include="src\Ext\VoxelAnim\Body.cpp" />
     <ClCompile Include="src\Ext\VoxelAnim\Hooks.cpp" />
     <ClCompile Include="src\Ext\WeaponType\Body.cpp" />
-    <ClCompile Include="src\Ext\WeaponType\Hook.EBolt.cpp" />
     <ClCompile Include="src\Ext\WeaponType\Hooks.cpp" />
     <ClCompile Include="src\Ext\WeaponType\Hooks.DiskLaserRadius.cpp" />
     <ClCompile Include="src\Misc\BlittersFix.cpp" />
@@ -206,6 +207,7 @@
     <ClCompile Include="YRpp\StaticInits.cpp" />
   </ItemGroup>
   <ItemGroup>
+    <ClInclude Include="src\Ext\EBolt\Body.h" />
     <ClInclude Include="src\New\Type\Affiliated\CreateUnitTypeClass.h" />
     <ClInclude Include="src\Blowfish\blowfish.h" />
     <ClInclude Include="src\Ext\Cell\Body.h" />

docs/New-or-Enhanced-Logics.md

@@ -142,6 +142,7 @@ ReflectDamage.Override=                            ; integer
 ReflectDamage.UseInvokerAsOwner=false              ; boolean
 DisableWeapons=false                               ; boolean
 Unkillable=false                                   ; boolean
+LaserTrail.Type=                                ; lasertrail type
 Groups=                                            ; comma-separated list of strings (group IDs)
 
 [SOMETECHNO]                                       ; TechnoType
@@ -234,22 +235,36 @@ Due to performance concerns, unless any radiation type has `RadApplicationDelay.
 
 - Technos, Projectiles, and VoxelAnims can now have colorful trails of different transparency, thickness and color, which are drawn via laser drawing code.
 - Technos, Projectiles, and VoxelAnims can have multiple laser trails. For technos each trail can have custom laser trail type and FLH offset relative to turret and body.
+- LaserTrail can also be drawn as EBolt or RadBeam.
 
 In `artmd.ini`:
 ```ini
 [LaserTrailTypes]
 0=SOMETRAIL
 
 [SOMETRAIL]                      ; LaserTrailType name
-IsHouseColor=false               ; boolean
-Color=255,0,0                    ; integer - R,G,B
-FadeDuration=64                  ; integer
-Thickness=4                      ; integer
+DrawType=laser                   ; laser trail type (laser | ebolt | radbeam)
+FadeDuration=                    ; integer, default to 64 for laser, 17 for ebolt, 15 for radbeam
 SegmentLength=128                ; integer, minimal length of each trail segment
 IgnoreVertical=false             ; boolean, whether the trail won't be drawn on vertical movement
-IsIntense=false                  ; boolean, whether the laser is "supported" (AKA prism forwarding)
 CloakVisible=false               ; boolean, whether the laser is visible when the attached unit is cloaked
 CloakVisible.DetectedOnly=false  ; boolean, whether CloakVisible=true laser is visible only to those who can detect the attached unit
+; laser
+Color=255,0,0                    ; integer - R,G,B
+IsHouseColor=false               ; boolean
+Thickness=4                      ; integer
+IsIntense=false                  ; boolean, whether the laser is "supported" (AKA prism forwarding)
+; ebolt
+IsAlternateColor=false           ; boolean
+Bolt.Color1=                     ; integer - R,G,B
+Bolt.Disable1=false              ; boolean
+Bolt.Color2=                     ; integer - R,G,B
+Bolt.Disable2=false              ; boolean
+Bolt.Color3=                     ; integer - R,G,B
+Bolt.Disable3=false              ; boolean
+; radbeam
+Beam.Color=                      ; integer - R,G,B
+Beam.Amplitude=40.0              ; floating point value
 
 [SOMEPROJECTILE]                 ; Projectile Image
 LaserTrail.Types=SOMETRAIL       ; List of LaserTrailTypes
@@ -263,8 +278,8 @@ LaserTrailN.IsOnTurret=false     ; boolean, whether the trail origin is turret
 
 In `rulesmd.ini`:
 ```ini
-[SOMEVOXELANIM]             ; VoxelAnim
-LaserTrail.Types=SOMETRAIL  ; List of LaserTrailTypes
+[SOMEVOXELANIM]                  ; VoxelAnim
+LaserTrail.Types=SOMETRAIL       ; List of LaserTrailTypes
 ```
 
 ```{warning}

docs/Whats-New.md

@@ -405,6 +405,7 @@ New:
 - [Customizable debris trailer anim spawn delay](Fixed-or-Improved-Logics.md#customizable-debris-trailer-anim-spawn-delay) (by CrimRecya)
 - [Display banner](AI-Scripting-and-Mapping.md#display-banner) (by Morton & ststl)
 - Allows refineries to use multiple ActiveAnim simultaneously (by TaranDahl)
+- Electric/RadBeam trail for laser tails (by NetsuNegi)
 
 Vanilla fixes:
 - Fixed sidebar not updating queued unit numbers when adding or removing units when the production is on hold (by CrimRecya)

src/Ext/Bullet/Body.cpp

@@ -6,6 +6,7 @@
 #include <Ext/WeaponType/Body.h>
 #include <Ext/WarheadType/Body.h>
 #include <Ext/Cell/Body.h>
+#include <Ext/EBolt/Body.h>
 #include <Utilities/EnumFunctions.h>
 #include <Utilities/AresFunctions.h>
 #include <Misc/FlyingStrings.h>
@@ -146,9 +147,7 @@ void BulletExt::ExtData::InitializeLaserTrails()
 	this->LaserTrails.reserve(pTypeExt->LaserTrail_Types.size());
 
 	for (auto const& idxTrail : pTypeExt->LaserTrail_Types)
-	{
-		this->LaserTrails.emplace_back(LaserTrailTypeClass::Array[idxTrail].get(), pOwner);
-	}
+		this->LaserTrails.emplace_back(std::make_unique<LaserTrailClass>(LaserTrailTypeClass::Array[idxTrail].get(), pOwner));
 }
 
 static inline int SetBuildingFireAnimZAdjust(BuildingClass* pBuilding, int animY)
@@ -258,12 +257,14 @@ inline void BulletExt::SimulatedFiringElectricBolt(BulletClass* pBullet)
 	if (!pWeapon->IsElectricBolt)
 		return;
 
-	const auto pEBolt = (AresFunctions::CreateAresEBolt ? AresFunctions::CreateAresEBolt(pWeapon) : GameCreate<EBolt>());
-	pEBolt->AlternateColor = pWeapon->IsAlternateColor;
-	auto& weaponStruct = WeaponTypeExt::BoltWeaponMap[pEBolt];
-	weaponStruct.Weapon = WeaponTypeExt::ExtMap.Find(pWeapon);
-	weaponStruct.BurstIndex = 0;
-	pEBolt->Fire(pBullet->SourceCoords, (pBullet->Type->Inviso ? pBullet->Location : pBullet->TargetCoords), 0);
+	const auto pBolt = EBoltExt::CreateEBolt(pWeapon);
+	pBolt->AlternateColor = pWeapon->IsAlternateColor;
+
+	const auto targetCoords = pBullet->Type->Inviso ? pBullet->Location : pBullet->TargetCoords;
+	pBolt->Fire(pBullet->SourceCoords, targetCoords, 0);
+
+	if (const auto particle = WeaponTypeExt::ExtMap.Find(pWeapon)->Bolt_ParticleSystem.Get(RulesClass::Instance->DefaultSparkSystem))
+		GameCreate<ParticleSystemClass>(particle, targetCoords, nullptr, nullptr, CoordStruct::Empty, nullptr);
 }
 
 // Make sure pBullet and pBullet->WeaponType is not empty before call

src/Ext/Bullet/Body.h

@@ -25,7 +25,7 @@ class BulletExt
 		bool IsInterceptor;
 		InterceptedStatus InterceptedStatus;
 		bool DetonateOnInterception;
-		std::vector<LaserTrailClass> LaserTrails;
+		std::vector<std::unique_ptr<LaserTrailClass>> LaserTrails;
 		bool SnappedToTarget; // Used for custom trajectory projectile target snap checks
 		int DamageNumberOffset;
 

src/Ext/Bullet/Hooks.cpp

@@ -37,7 +37,7 @@ DEFINE_HOOK(0x4666F7, BulletClass_AI, 0x6)
 {
 	GET(BulletClass*, pThis, EBP);
 
-	auto pBulletExt = BulletExt::ExtMap.Find(pThis);
+	const auto pBulletExt = BulletExt::ExtMap.Find(pThis);
 	BulletAITemp::ExtData = pBulletExt;
 	BulletAITemp::TypeExtData = pBulletExt->TypeExtData;
 
@@ -70,7 +70,7 @@ DEFINE_HOOK(0x4666F7, BulletClass_AI, 0x6)
 	//Let trajectories draw their own laser trails after the Trajectory's OnAI() to avoid predicting incorrect positions or pass through targets.
 	if (!pBulletExt->Trajectory && pBulletExt->LaserTrails.size())
 	{
-		CoordStruct location = pThis->GetCoords();
+		const CoordStruct location = pThis->GetCoords();
 		const BulletVelocity& velocity = pThis->Velocity;
 
 		// We adjust LaserTrails to account for vanilla bug of drawing stuff one frame ahead.
@@ -82,14 +82,14 @@ DEFINE_HOOK(0x4666F7, BulletClass_AI, 0x6)
 			(int)(location.Z + velocity.Z)
 		};
 
-		for (auto& trail : pBulletExt->LaserTrails)
+		for (const auto& pTrail : pBulletExt->LaserTrails)
 		{
 			// We insert initial position so the first frame of trail doesn't get skipped - Kerbiter
 			// TODO move hack to BulletClass creation
-			if (!trail.LastLocation.isset())
-				trail.LastLocation = location;
+			if (!pTrail->LastLocation.isset())
+				pTrail->LastLocation = location;
 
-			trail.Update(drawnCoords);
+			pTrail->Update(drawnCoords);
 		}
 
 	}

src/Ext/Bullet/Trajectories/BombardTrajectory.cpp

@@ -235,8 +235,8 @@ void BombardTrajectory::PrepareForOpenFire(BulletClass* pBullet)
 
 		if (pExt->LaserTrails.size())
 		{
-			for (auto& trail : pExt->LaserTrails)
-				trail.LastLocation = middleLocation;
+			for (const auto& pTrail : pExt->LaserTrails)
+				pTrail->LastLocation = middleLocation;
 		}
 		this->RefreshBulletLineTrail(pBullet);
 
@@ -560,9 +560,10 @@ void BombardTrajectory::BulletVelocityChange(BulletClass* pBullet)
 
 				if (pExt->LaserTrails.size())
 				{
-					for (auto& trail : pExt->LaserTrails)
-						trail.LastLocation = middleLocation;
+					for (const auto& pTrail : pExt->LaserTrails)
+						pTrail->LastLocation = middleLocation;
 				}
+
 				this->RefreshBulletLineTrail(pBullet);
 
 				pBullet->SetLocation(middleLocation);

src/Ext/Bullet/Trajectories/PhobosTrajectory.cpp

@@ -462,7 +462,7 @@ DEFINE_HOOK(0x467E53, BulletClass_AI_PreDetonation_Trajectories, 0x6)
 
 	auto const pExt = BulletExt::ExtMap.Find(pThis);
 
-	if (auto pTraj = pExt->Trajectory.get())
+	if (auto const pTraj = pExt->Trajectory.get())
 		pTraj->OnAIPreDetonate(pThis);
 
 	return 0;
@@ -476,7 +476,7 @@ DEFINE_HOOK(0x46745C, BulletClass_AI_Position_Trajectories, 0x7)
 
 	auto const pExt = BulletExt::ExtMap.Find(pThis);
 
-	if (auto pTraj = pExt->Trajectory.get())
+	if (auto const pTraj = pExt->Trajectory.get())
 		pTraj->OnAIVelocity(pThis, pSpeed, pPosition);
 
 	// Trajectory can use Velocity only for turning Image's direction
@@ -490,12 +490,12 @@ DEFINE_HOOK(0x46745C, BulletClass_AI_Position_Trajectories, 0x7)
 			static_cast<int>(pSpeed->Z + pPosition->Z)
 		};
 
-		for (auto& trail : pExt->LaserTrails)
+		for (const auto& pTrail : pExt->LaserTrails)
 		{
-			if (!trail.LastLocation.isset())
-				trail.LastLocation = pThis->Location;
+			if (!pTrail->LastLocation.isset())
+				pTrail->LastLocation = pThis->Location;
 
-			trail.Update(futureCoords);
+			pTrail->Update(futureCoords);
 		}
 	}
 
@@ -510,7 +510,7 @@ DEFINE_HOOK(0x4677D3, BulletClass_AI_TargetCoordCheck_Trajectories, 0x5)
 
 	auto const pExt = BulletExt::ExtMap.Find(pThis);
 
-	if (auto pTraj = pExt->Trajectory.get())
+	if (auto const pTraj = pExt->Trajectory.get())
 	{
 		switch (pTraj->OnAITargetCoordCheck(pThis))
 		{
@@ -540,7 +540,7 @@ DEFINE_HOOK(0x467927, BulletClass_AI_TechnoCheck_Trajectories, 0x5)
 
 	auto const pExt = BulletExt::ExtMap.Find(pThis);
 
-	if (auto pTraj = pExt->Trajectory.get())
+	if (auto const pTraj = pExt->Trajectory.get())
 	{
 		switch (pTraj->OnAITechnoCheck(pThis, pTechno))
 		{

src/Ext/EBolt/Body.cpp

@@ -0,0 +1,101 @@
+#include "Body.h"
+
+#include <Ext/WeaponType/Body.h>
+
+EBoltExt::ExtContainer EBoltExt::ExtMap;
+
+EBolt* EBoltExt::CreateEBolt(WeaponTypeClass* pWeapon)
+{
+	const auto pBolt = GameCreate<EBolt>();
+	const auto pBoltExt = EBoltExt::ExtMap.Find(pBolt);
+
+	const int alternateIdx = pWeapon->IsAlternateColor ? 5 : 10;
+	const int defaultAlternate = EBoltExt::GetDefaultColor_Int(FileSystem::PALETTE_PAL, alternateIdx);
+	const int defaultWhite = EBoltExt::GetDefaultColor_Int(FileSystem::PALETTE_PAL, 15);
+	const auto pWeaponExt = WeaponTypeExt::ExtMap.Find(pWeapon);
+
+	for (int idx = 0; idx < 3; ++idx)
+	{
+		if (pWeaponExt->Bolt_Disable[idx])
+			pBoltExt->Disable[idx] = true;
+		else if (pWeaponExt->Bolt_Color[idx].isset())
+			pBoltExt->Color[idx] = pWeaponExt->Bolt_Color[idx].Get();
+		else
+			pBoltExt->Color[idx] = Drawing::Int_To_RGB(idx < 2 ? defaultAlternate : defaultWhite);
+	}
+
+	pBoltExt->Arcs = pWeaponExt->Bolt_Arcs;
+	pBolt->Lifetime = 1 << (std::clamp(pWeaponExt->Bolt_Duration.Get(), 1, 31) - 1);
+	return pBolt;
+}
+
+// =============================
+// load / save
+
+template <typename T>
+void EBoltExt::ExtData::Serialize(T& Stm)
+{
+	Stm
+		.Process(this->Color)
+		.Process(this->Disable)
+		.Process(this->Arcs)
+		.Process(this->BurstIndex)
+		;
+}
+
+void EBoltExt::ExtData::LoadFromStream(PhobosStreamReader& Stm)
+{
+	Extension<EBolt>::LoadFromStream(Stm);
+	this->Serialize(Stm);
+}
+
+void EBoltExt::ExtData::SaveToStream(PhobosStreamWriter& Stm)
+{
+	Extension<EBolt>::SaveToStream(Stm);
+	this->Serialize(Stm);
+}
+
+bool EBoltExt::LoadGlobals(PhobosStreamReader& Stm)
+{
+	return Stm.Success();
+}
+
+bool EBoltExt::SaveGlobals(PhobosStreamWriter& Stm)
+{
+	return Stm.Success();
+}
+
+void EBoltExt::ExtData::InvalidatePointer(void* ptr, bool removed)
+{ }
+
+// =============================
+// container
+
+EBoltExt::ExtContainer::ExtContainer() : Container("EBolt") { }
+EBoltExt::ExtContainer::~ExtContainer() = default;
+
+bool EBoltExt::ExtContainer::InvalidateExtDataIgnorable(void* const ptr) const
+{
+	return true;
+}
+
+// =============================
+// container hooks
+
+DEFINE_HOOK(0x4C1E42, EBolt_CTOR, 0x5)
+{
+	GET(EBolt*, pItem, EAX);
+
+	EBoltExt::ExtMap.Allocate(pItem);
+
+	return 0;
+}
+
+DEFINE_HOOK(0x4C2951, EBolt_DTOR, 0x5)
+{
+	GET(EBolt*, pItem, ESI);
+
+	EBoltExt::ExtMap.Remove(pItem);
+
+	return 0;
+}