ZScript Code Review Request

[solarsnowfall]

To teach myself ZScript I decided to create a particle effect which was infeasible back in the Decorate/ACS days: streaky looking sparks. This does everything I need it to do, what I'm asking for is optimization help. Am I doing anything obviously stupid due to my very incomplete understanding of how this stuff works?

The first argument on the placeable actors sets the color of the particles spawned whose sprite consists of a 1x1 square. The particles simply spawn a series of +NoInteraction particles behind them in a line which inherit the color.

Also, I can't seem to get the editor key stuff working in UDB.

---

Code: Select all

class FloorSpark : SwitchableDecoration
{
	//$Arg0 "Color"
	//$Arg0ToolTip "Color values (0 - 9)"
	//$Arg0Enum { 0 = "White"; 1 = "Yellow"; 2 = "Orange"; 3 = "Gold"; 4 = "Green"; 5 = "Light Red"; 6 = "Red"; 7 = "Pink"; 8 = "Purple"; 9 = "Blue"; }
	
	int translationIdx;
	
	static const string spriteList[] = {
		"PTCW",
		"PTCY",
		"PTCO",
		"PTCG",
		"PTGN",
		"PTR1",
		"PTR2",
		"PTP1",
		"PTP2",
		"PTCB"
	};
	
	override void BeginPlay()
	{
		super.BeginPlay();
		
		translationIdx = Args[0];
		
		if (translationIdx < 0)
			translationIdx = 0;
		else if (translationIdx > spriteList.Size() - 1)
			translationIdx = spriteList.Size() - 1;
	}

	virtual float GenerateAngle()
	{
		return frandom(0, 360);
	}
	
	virtual float GeneratePitch()
	{
		return pitch + 90 + frandom(-15, 15);
	}
	
	virtual Vector3 GenerateVelocity(float a, float p)
	{
		Vector3 velocity;
		float speed = frandom(4.0, 8.0);
		
		velocity.x = cos(a) * cos(p) * speed;
		velocity.y = sin(a) * cos(p) * speed;
		velocity.z = sin(p) * speed;
		
		return velocity;
	}
	
	virtual void SpawnSparkParticles()
	{
		float a, p;
		
		for (int i=0; i<16; i++)
		{
			a = GenerateAngle();
			p = GeneratePitch();
				
			let velocity = GenerateVelocity(a, p);
			
			Actor particle = Spawn("SparkParticle", pos);
			
			particle.vel.x = velocity.x;
			particle.vel.y = velocity.y;
			particle.vel.z = velocity.z;
			particle.A_SetAngle(a);
			particle.sprite = GetSpriteIndex(spriteList[translationIdx]);
		}
	}
	
	Default
	{
		Height 1;
		Radius 1;
		+NoBlockmap;
		+NoSector;
		+NoGravity;
		+DontSplash;
	}
	
	States
	{
	Spawn:
	Active:
		TNT1 A 1 NoDelay
		{
			A_StartSound("World/Spark");
			SpawnSparkParticles();
		}
		Goto Inactive;
	Inactive:
		TNT1 A -1;
		stop;
	}
}

class WallSpark : FloorSpark
{
	override float GenerateAngle()
	{
		return angle + frandom(-15, 15);
	}
	
	override float GeneratePitch()
	{
		return frandom(-15, 15);
	}
}

class CeilingSpark : FloorSpark
{
	override float GeneratePitch()
	{
		return pitch - 90 + frandom(-15, 15);
	}

	override Vector3 GenerateVelocity(float a, float p)
	{
		Vector3 velocity;
		float speed = frandom(4.0, 8.0);
		float vspeed = frandom(0, 4.0);
		
		velocity.x = cos(a) * cos(p) * speed;
		velocity.y = sin(a) * cos(p) * speed;
		velocity.z = sin(p) * vspeed;
		
		return velocity;
	}

	Default
	{
		+SpawnCeiling;
	}
}

class SparkParticle : Actor
{
	virtual int SpawnTail()
	{
		int count;
		let a = VectorAngle(vel.x, vel.y);
		let p = VectorAngle(vel.xy.Length(), vel.z);
		Vector3 pPos;
		
		for (float i=1; i<vel.Length(); i+=0.5)
		{
			pPos.x = pos.x - cos(a) * cos(p) * i;
			pPos.y = pos.y - sin(a) * cos(p) * i;
			pPos.z = pos.z - sin(p) * i;
			let tail = Spawn("SparkParticleTail", pPos);
			tail.A_SetAngle(a);
			tail.sprite = sprite;
			count++;
		}
		
		return count;
	}
	
	override void BeginPlay()
	{
		super.BeginPlay();
		
		if (!random(0,7))
		{
			BounceFactor = 0.333;
			bBounceOnFloors = true;
			bBounceAutoOff = true;
		}
	}

	Default
	{
		Height 1;
		Radius 1;
		Projectile;
		Gravity 0.5;
		-NoGravity;
		+DontSplash;
		+ForceXYBillboard;
	}
	
	States
	{
	Spawn:
		#### A 1 Bright
		{
			SpawnTail();
		}
		loop;
	Death:
		#### A 0 Bright
		{
			SpawnTail();
			A_Stop();
		}
		#### BCD 2 Bright A_FadeOut(0.25);
		stop;
	SpriteList:
		PTCW ABCD 0;
		PTCY ABCD 0;
		PTCO ABCD 0;
		PTCG ABCD 0;
		PTGN ABCD 0;
		PTR1 ABCD 0;
		PTR2 ABCD 0;
		PTP1 ABCD 0;
		PTP2 ABCD 0;
		PTCB ABCD 0;
		stop;
	}
}

class SparkParticleTail : SparkParticle
{
	Default
	{
		+NoInteraction;
	}

	States
	{
	Spawn:
		#### A 2 Bright;
		stop;
	}
}

---

Code: Select all

sprite PTCWB0, 1, 1
{
	patch PTCWA0, 0, 0
}

sprite PTCWC0, 1, 1
{
	patch PTCWA0, 0, 0
}

sprite PTCWD0, 1, 1
{
	patch PTCWA0, 0, 0
}

sprite PTCYA0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=227:227";
	}
}

sprite PTCYB0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=227:227";
	}
}

sprite PTCYC0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=227:227";
	}
}

sprite PTCYD0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=227:227";
	}
}

sprite PTCOA0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=211:211";
	}
}

sprite PTCOB0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=211:211";
	}
}

sprite PTCOC0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=211:211";
	}
}

sprite PTCOD0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=211:211";
	}
}

sprite PTCGA0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=249:249";
	}
}

sprite PTCGB0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=249:249";
	}
}

sprite PTCGC0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=249:249";
	}
}

sprite PTCGD0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=249:249";
	}
}

sprite PTGNA0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=112:112";
	}
}

sprite PTGNB0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=112:112";
	}
}

sprite PTGNC0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=112:112";
	}
}

sprite PTGND0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=112:112";
	}
}

sprite PTR1A0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=171:171";
	}
}

sprite PTR1B0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=171:171";
	}
}

sprite PTR1C0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=171:171";
	}
}

sprite PTR1D0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=171:171";
	}
}

sprite PTR2A0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=176:176"
	}
}

sprite PTR2B0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=176:176"
	}
}

sprite PTR2C0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=176:176"
	}
}

sprite PTR2D0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=176:176"
	}
}

sprite PTP1A0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=250:250";
	}
}

sprite PTP1B0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=250:250";
	}
}

sprite PTP1C0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=250:250";
	}
}

sprite PTP1D0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=250:250";
	}
}

sprite PTP2A0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=253:253";
	}
}

sprite PTP2B0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=253:253";
	}
}

sprite PTP2C0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=253:253";
	}
}

sprite PTP2D0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=253:253";
	}
}

sprite PTCBA0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=195:195";
	}
}

sprite PTCBB0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=195:195";
	}
}

sprite PTCBC0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=195:195";
	}
}

sprite PTCBD0, 1, 1
{
	patch PTCWA0, 0, 0
	{
		Translation "4:4=195:195";
	}
}

---

Code: Select all

pointlight WhiteSpark1
{
	color 1.0 1.0 1.0
	size 8
	offset 0 0 0
}

pointlight WhiteSpark2
{
	color 1.0 1.0 1.0
	size 6
	offset 0 0 0
}

pointlight WhiteSpark3
{
	color 1.0 1.0 1.0
	size 4
	offset 0 0 0
}

pointlight WhiteSpark4
{
	color 1.0 1.0 1.0
	size 2
	offset 0 0 0
}

pointlight YellowSpark1
{
	color 1.0 1.0 0.56
	size 8
	offset 0 0 0
}

pointlight YellowSpark2
{
	color 1.0 1.0 0.56
	size 6
	offset 0 0 0
}

pointlight YellowSpark3
{
	color 1.0 1.0 0.56
	size 4
	offset 0 0 0
}

pointlight YellowSpark4
{
	color 1.0 1.0 0.56
	size 2
	offset 0 0 0
}

pointlight OrangeSpark1
{
	color 1.0 0.78 0.6
	size 8
	offset 0 0 0
}

pointlight OrangeSpark2
{
	color 1.0 0.78 0.6
	size 6
	offset 0 0 0
}

pointlight OrangeSpark3
{
	color 1.0 0.78 0.6
	size 4
	offset 0 0 0
}

pointlight OrangeSpark4
{
	color 1.0 0.78 0.6
	size 2
	offset 0 0 0
}

pointlight GoldSpark1
{
	color 1.0 0.9 0.29
	size 8
	offset 0 0 0
}

pointlight GoldSpark2
{
	color 1.0 0.9 0.29
	size 6
	offset 0 0 0
}

pointlight GoldSpark3
{
	color 1.0 0.9 0.29
	size 4
	offset 0 0 0
}

pointlight GoldSpark4
{
	color 1.0 0.9 0.29
	size 2
	offset 0 0 0
}

pointlight GreenSpark1
{
	color 0.46 1.0 0.43
	size 8
	offset 0 0 0
}

pointlight GreenSpark2
{
	color 0.46 1.0 0.43
	size 6
	offset 0 0 0
}

pointlight GreenSpark3
{
	color 0.46 1.0 0.43
	size 4
	offset 0 0 0
}

pointlight GreenSpark4
{
	color 0.46 1.0 0.43
	size 2
	offset 0 0 0
}

pointlight Red1Spark1
{
	color 1.0 0.6 0.6
	size 8
	offset 0 0 0
}

pointlight Red1Spark2
{
	color 1.0 0.6 0.6
	size 6
	offset 0 0 0
}

pointlight Red1Spark3
{
	color 1.0 0.6 0.6
	size 4
	offset 0 0 0
}

pointlight Red1Spark4
{
	color 1.0 0.6 0.6
	size 2
	offset 0 0 0
}

pointlight Red2Spark1
{
	color 1.0 0 0
	size 8
	offset 0 0 0
}

pointlight Red2Spark2
{
	color 1.0 0 0
	size 6
	offset 0 0 0
}

pointlight Red2Spark3
{
	color 1.0 0 0
	size 4
	offset 0 0 0
}

pointlight Red2Spark4
{
	color 1.0 0 0
	size 2
	offset 0 0 0
}

pointlight PinkSpark1
{
	color 1.0 0.48 1.0
	size 8
	offset 0 0 0
}

pointlight PinkSpark2
{
	color 1.0 0.48 1.0
	size 6
	offset 0 0 0
}

pointlight PinkSpark3
{
	color 1.0 0.48 1.0
	size 4
	offset 0 0 0
}

pointlight PinkSpark4
{
	color 1.0 0.48 1.0
	size 2
	offset 0 0 0
}

pointlight PurpleSpark1
{
	color 0.62 0 0.6
	size 8
	offset 0 0 0
}

pointlight PurpleSpark2
{
	color 0.62 0 0.6
	size 6
	offset 0 0 0
}

pointlight PurpleSpark3
{
	color 0.62 0 0.6
	size 4
	offset 0 0 0
}

pointlight PurpleSpark4
{
	color 0.62 0 0.6
	size 2
	offset 0 0 0
}

pointlight BlueSpark1
{
	color 0.56 0.56 1.0
	size 8
	offset 0 0 0
}

pointlight BlueSpark2
{
	color 0.56 0.56 1.0
	size 6
	offset 0 0 0
}

pointlight BlueSpark3
{
	color 0.56 0.56 1.0
	size 4
	offset 0 0 0
}

pointlight BlueSpark4
{
	color 0.56 0.56 1.0
	size 2
	offset 0 0 0
}

object SparkParticle
{
	frame PTCWA { light WhiteSpark1		}
	frame PTCWB { light WhiteSpark2		}
	frame PTCWB { light WhiteSpark3		}
	frame PTCWC { light WhiteSpark4		}
	
	frame PTCYA { light YellowSpark1	}
	frame PTCYB { light YellowSpark2	}
	frame PTCYC { light YellowSpark3	}
	frame PTCYD { light YellowSpark4	}
	
	frame PTCOA { light OrangeSpark1 	}
	frame PTCOB { light OrangeSpark2 	}
	frame PTCOC { light OrangeSpark3 	}
	frame PTCOD { light OrangeSpark4 	}
	
	frame PTCGA { light GoldSpark1 		}
	frame PTCGB { light GoldSpark2 		}
	frame PTCGC { light GoldSpark3 		}
	frame PTCGD { light GoldSpark4 		}
	
	frame PTGNA { light GreenSpark1 	}
	frame PTGNB { light GreenSpark2 	}
	frame PTGNC { light GreenSpark3 	}
	frame PTGND { light GreenSpark4 	}
	
	frame PTR1A { light Red1Spark1 		}
	frame PTR1B { light Red1Spark2 		}
	frame PTR1C { light Red1Spark3 		}
	frame PTR1D { light Red1Spark4 		}
	
	frame PTR2A { light Red2Spark1 		}
	frame PTR2B { light Red2Spark2 		}
	frame PTR2C { light Red2Spark3 		}
	frame PTR2D { light Red2Spark4 		}
	
	frame PTP1A { light PinkSpark1 		}
	frame PTP1B { light PinkSpark2 		}
	frame PTP1C { light PinkSpark3 		}
	frame PTP1D { light PinkSpark4 		}
	
	frame PTP2A { light PurpleSpark1 	}
	frame PTP2B { light PurpleSpark2 	}
	frame PTP2C { light PurpleSpark3 	}
	frame PTP2D { light PurpleSpark4 	}
	
	frame PTCBA { light BlueSpark1 		}
	frame PTCBB { light BlueSpark2 		}
	frame PTCBC { light BlueSpark3 		}
	frame PTCBD { light BlueSpark4 		}	
}

[Fishytza]

Also, I can't seem to get the editor key stuff working in UDB.

It's missing //$Arg0Type 11
Like so:

Code: Select all

   //$Arg0 "Color"
   //$Arg0Type 11
   //$Arg0ToolTip "Color values (0 - 9)"
   //$Arg0Enum { 0 = "White"; 1 = "Yellow"; 2 = "Orange"; 3 = "Gold"; 4 = "Green"; 5 = "Light Red"; 6 = "Red"; 7 = "Pink"; 8 = "Purple"; 9 = "Blue"; }

[solarsnowfall]

Thanks! I also found that I needed to move the comments to the Default block to get it working. I also found Vec3Offset for calculating coordinates.

[AFADoomer]

Not necessarily optimizations, per-se, but cleaner code...

• You can move the code in the FloorSpark "Active" state to an override for the Activate function (override void Activate(Actor activator)) instead of in the sprite states
• Your SparkParticle "SpriteList" state doesn't need to have all four frames defined. Just (for example), PTCW A 0; will allow GetSpriteIndex to work.

One additional thing to maybe play with: Instead of dedicated sprites for each color, you could allow the map author to set any spark color by experimenting with different render styles and setting the actor's fillcolor (SetShade(color)) or another user variable.

I implemented this technique in Blade of Agony alongside the sprites, but I was never able to get nice bright spark centers unless using dedicated sprites, so the ability to set RGB colors went mostly unused (apologies, that code is tied in with the BoA particle culling system and had to be backward compatible with old actor setups, so is a bit of a mess).

[solarsnowfall]

You can move the code in the FloorSpark "Active" state to an override for the Activate function (override void Activate(Actor activator)) instead of in the sprite states

Okay, so here's a potential can of worms. That works great (and thank you), but I took things a step further and commented out the States block all together. What I found was that the floor and wall sparks worked as expected, but the ceiling spark never activates. Not sure why that would be the case. If handled via that method, I can't quite see why state definitions would be necessary at all.

Your SparkParticle "SpriteList" state doesn't need to have all four frames defined. Just (for example), PTCW A 0; will allow GetSpriteIndex to work.

I went from spawning invisible particles to spewing imps everywhere (which crashed the game) figuring out sprite registration. Thanks for the tip.

One additional thing to maybe play with: Instead of dedicated sprites for each color, you could allow the map author to set any spark color by experimenting with different render styles and setting the actor's fillcolor (SetShade(color)) or another user variable.

That's sharp. My first concern is with the GLDEFS. The whole reason I defined the sprites this way was to tag them with point lights. I'll have to do some more research, but I'm not immediately aware of how to carry over the color to the glow. At the very least, it seems like I should be able to break free of the confines of the pallette and have a better range of colors. I did really want to give greater color control, but settled on this for the perceived lack of better options.

I implemented this technique in Blade of Agony alongside the sprites, but I was never able to get nice bright spark centers unless using dedicated sprites, so the ability to set RGB colors went mostly unused (apologies, that code is tied in with the BoA particle culling system and had to be backward compatible with old actor setups, so is a bit of a mess).

Hey, that kinda sorta exactly looks derivative of my old decorate spark actors, for which I had to assail Tormentor into giving me credit. Cool! Seriously, though, good work. I can tell I'm going to be rifling through this repository for purposes of edification.

[AFADoomer]

You can move the code in the FloorSpark "Active" state to an override for the Activate function (override void Activate(Actor activator)) instead of in the sprite states

Okay, so here's a potential can of worms. That works great (and thank you), but I took things a step further and commented out the States block all together. What I found was that the floor and wall sparks worked as expected, but the ceiling spark never activates. Not sure why that would be the case. If handled via that method, I can't quite see why state definitions would be necessary at all.

I'm not sure why that would be the case... Commenting out the States block causes the actor to fall back to using the default Actor class "Spawn" state, which is the same TNT1 A -1; Stop; that you used before, so I can't see why there would be a change.

One additional thing to maybe play with: Instead of dedicated sprites for each color, you could allow the map author to set any spark color by experimenting with different render styles and setting the actor's fillcolor (SetShade(color)) or another user variable.

That's sharp. My first concern is with the GLDEFS. The whole reason I defined the sprites this way was to tag them with point lights. I'll have to do some more research, but I'm not immediately aware of how to carry over the color to the glow. At the very least, it seems like I should be able to break free of the confines of the pallette and have a better range of colors. I did really want to give greater color control, but settled on this for the perceived lack of better options.

Check out the [wiki]A_AttachLight[/wiki] function... You can attach lights on-the-fly without requiring GLDEFs entries - just give the light an arbitrary name, and you can also remove it later with [wiki]A_RemoveLight[/wiki]. For an example, see again the BoA spark code.

I implemented this technique in Blade of Agony alongside the sprites, but I was never able to get nice bright spark centers unless using dedicated sprites, so the ability to set RGB colors went mostly unused (apologies, that code is tied in with the BoA particle culling system and had to be backward compatible with old actor setups, so is a bit of a mess).

Hey, that kinda sorta exactly looks derivative of my old decorate spark actors, for which I had to assail Tormentor into giving me credit. Cool! Seriously, though, good work. I can tell I'm going to be rifling through this repository for purposes of edification.

Thanks! Yes, those were originally yours... Almost completely reworked in the transition to ZScript and our particle culling system, but the underpinning logic and appearance is still yours.

Sorry for the difficulties in getting credit - the team's approach toward crediting others improved significantly before I came aboard, and I think that we were much better about crediting others during chapter 2 and 3 development. One note on the BoA code: Most of what's in the 'decorate' folder was a direct conversion from Decorate with no ZScript optimization (so, ugly state jumps, no custom functions, etc.). Everything else is fresh ZScript, but I was learning ZScript while writing a lot of this code, so be aware that not everything is optimal. I rewrote some of the worst code before chapter 3 was released, but there are still things that can be improved on.