Particle effect hooks for subsystem destruction (scp-fs2open#6937)

Kestrellius · web-flow · commit 9e618f6632ec · 2025-08-22T07:19:15.000-04:00
* add particle hook

* partial bugfixing

* bugfixing

* appeasement

* syntax fix
diff --git a/code/model/model.h b/code/model/model.h
@@ -294,6 +294,7 @@ class model_subsystem {					/* contains rotation rate info */
 
 	float density;
 
+	particle::ParticleEffectHandle death_effect;
 	particle::ParticleEffectHandle debris_flame_particles;
 	particle::ParticleEffectHandle shrapnel_flame_particles;
 
diff --git a/code/particle/ParticleSource.cpp b/code/particle/ParticleSource.cpp
@@ -85,6 +85,7 @@ bool ParticleSource::process() {
 }
 
 void ParticleSource::setNormal(const vec3d& normal) {
+	Assertion(vm_vec_is_normalized(&normal), "Particle source normal must be normalized!");
 	m_normal = normal;
 }
 
diff --git a/code/ship/ship.cpp b/code/ship/ship.cpp
@@ -1352,6 +1352,8 @@ void ship_info::clone(const ship_info& other)
 	ship_passive_arcs = other.ship_passive_arcs;
 
 	glowpoint_bank_override_map = other.glowpoint_bank_override_map;
+
+	default_subsys_death_effect = other.default_subsys_death_effect; 
 }
 
 void ship_info::move(ship_info&& other)
@@ -1698,6 +1700,8 @@ void ship_info::move(ship_info&& other)
 
 	animations = std::move(other.animations);
 	cockpit_animations = std::move(other.cockpit_animations);
+
+	default_subsys_death_effect = other.default_subsys_death_effect;
 }
 
 ship_info &ship_info::operator= (ship_info&& other) noexcept
@@ -2091,6 +2095,8 @@ ship_info::ship_info()
 	glowpoint_bank_override_map.clear();
 
 	ship_passive_arcs.clear();
+
+	default_subsys_death_effect = particle::ParticleEffectHandle::invalid();
 }
 
 ship_info::~ship_info()
@@ -5488,6 +5494,10 @@ static void parse_ship_values(ship_info* sip, const bool is_template, const bool
 		required_string("$end_custom_strings");
 	}
 
+	if (optional_string("$Default Subsystem Death Effect:")) {
+		sip->default_subsys_death_effect = particle::util::parseEffect(sip->name);
+	}
+
 	if(optional_string("$Default Subsystem Debris Flame Effect:"))
 	{
 		sip->default_subsys_debris_flame_particles = particle::util::parseEffect(sip->name);
@@ -5595,8 +5605,11 @@ static void parse_ship_values(ship_info* sip, const bool is_template, const bool
 				sp->turret_max_bomb_ownage = -1;
 				sp->turret_max_target_ownage = -1;
 				sp->density = 1.0f;
+        
+				sp->death_effect = particle::ParticleEffectHandle::invalid();
 				sp->debris_flame_particles = particle::ParticleEffectHandle::invalid();
 				sp->shrapnel_flame_particles = particle::ParticleEffectHandle::invalid();
+
 			}
 			sfo_return = stuff_float_optional(&percentage_of_hits);
 			if(sfo_return==2)
@@ -5783,6 +5796,10 @@ static void parse_ship_values(ship_info* sip, const bool is_template, const bool
 				}
 			}
 
+			if (optional_string("$Subsystem Death Effect:")) {
+				sp->death_effect = particle::util::parseEffect(sip->name);
+			}
+
 			if (optional_string("$Debris Density:")) {
 				stuff_float(&sp->density);
 			}
diff --git a/code/ship/ship.h b/code/ship/ship.h
@@ -1262,6 +1262,7 @@ class ship_info
 	// subsystem information
 	int		n_subsystems;						// this number comes from ships.tbl
     model_subsystem *subsystems;				// see model.h for structure definition
+	particle::ParticleEffectHandle default_subsys_death_effect;
 
 	// Energy Transfer System fields
 	float		power_output;					// power output of ships reactor (EU/s)
diff --git a/code/ship/shipfx.cpp b/code/ship/shipfx.cpp
@@ -90,7 +90,7 @@ void model_get_rotating_submodel_axis(vec3d *model_axis, vec3d *world_axis, cons
  *
  * DKA: 5/26/99 make velocity of debris scale according to size of debris subobject (at least for large subobjects)
  */
-static void shipfx_subsystem_maybe_create_live_debris(object *ship_objp, const ship *ship_p, const ship_subsys *subsys, const vec3d *exp_center, float exp_mag)
+static void shipfx_subsystem_maybe_create_live_debris(object *ship_objp, const ship *ship_p, const ship_subsys *subsys, const vec3d *exp_center, float exp_mag, bool no_fireballs = false)
 {
 	// initializations
 	ship *shipp = &Ships[ship_objp->instance];
@@ -146,8 +146,11 @@ static void shipfx_subsystem_maybe_create_live_debris(object *ship_objp, const s
 		if(fireball_type < 0) {
 			fireball_type = FIREBALL_EXPLOSION_MEDIUM;
 		}
-		// create fireball here.
-		fireball_create(&end_world_pos, fireball_type, FIREBALL_MEDIUM_EXPLOSION, OBJ_INDEX(ship_objp), pm->submodel[live_debris_submodel].rad);
+
+		if (!no_fireballs) {
+			// create fireball here.
+			fireball_create(&end_world_pos, fireball_type, FIREBALL_MEDIUM_EXPLOSION, OBJ_INDEX(ship_objp), pm->submodel[live_debris_submodel].rad);
+		}
 
 		// create debris
 		live_debris_obj = debris_create(ship_objp, pm->id, live_debris_submodel, &end_world_pos, exp_center, 1, exp_mag, subsys);
@@ -269,7 +272,7 @@ static void shipfx_maybe_create_live_debris_at_ship_death( object *ship_objp )
 	}
 }
 
-void shipfx_blow_off_subsystem(object *ship_objp, ship *ship_p, const ship_subsys *subsys, const vec3d *exp_center, bool no_explosion)
+void shipfx_blow_off_subsystem(object *ship_objp, ship *ship_p, const ship_subsys *subsys, const vec3d *exp_center, bool no_explosion, bool no_fireballs)
 {
 	vec3d subobj_pos;
 
@@ -286,14 +289,16 @@ void shipfx_blow_off_subsystem(object *ship_objp, ship *ship_p, const ship_subsy
 
 		// create live debris objects, if any
 		// TODO:  some MULTIPLAYER implcations here!!
-		shipfx_subsystem_maybe_create_live_debris(ship_objp, ship_p, subsys, exp_center, 1.0f);
+		shipfx_subsystem_maybe_create_live_debris(ship_objp, ship_p, subsys, exp_center, 1.0f, no_fireballs);
 		
-		int fireball_type = fireball_ship_explosion_type(&Ship_info[ship_p->ship_info_index]);
-		if(fireball_type < 0) {
-			fireball_type = FIREBALL_EXPLOSION_MEDIUM;
+		if (!no_fireballs) {
+			int fireball_type = fireball_ship_explosion_type(&Ship_info[ship_p->ship_info_index]);
+			if(fireball_type < 0) {
+				fireball_type = FIREBALL_EXPLOSION_MEDIUM;
+			}
+			// create first fireball
+			fireball_create( &subobj_pos, fireball_type, FIREBALL_MEDIUM_EXPLOSION, OBJ_INDEX(ship_objp), psub->radius );
 		}
-		// create first fireball
-		fireball_create( &subobj_pos, fireball_type, FIREBALL_MEDIUM_EXPLOSION, OBJ_INDEX(ship_objp), psub->radius );
 	}
 }
 
diff --git a/code/ship/shipfx.h b/code/ship/shipfx.h
@@ -32,7 +32,7 @@ struct matrix;
 void shipfx_emit_spark( int n, int sn );
 
 // Does the special effects to blow a subsystem off a ship
-extern void shipfx_blow_off_subsystem(object *ship_obj, ship *ship_p, const ship_subsys *subsys, const vec3d *exp_center, bool no_explosion = false);
+extern void shipfx_blow_off_subsystem(object *ship_obj, ship *ship_p, const ship_subsys *subsys, const vec3d *exp_center, bool no_explosion = false, bool no_fireballs = false);
 
 // Creates "ndebris" pieces of debris on random verts of the "submodel" in the 
 // ship's model.
diff --git a/code/ship/shiphit.cpp b/code/ship/shiphit.cpp
@@ -157,7 +157,34 @@ void do_subobj_destroyed_stuff( ship *ship_p, ship_subsys *subsys, const vec3d*
 
 	// create fireballs when subsys destroy for large ships.
 	if (!(subsys->flags[Ship::Subsystem_Flags::Vanished, Ship::Subsystem_Flags::No_disappear]) && !no_explosion) {
-		if (ship_objp->radius > 100.0f) {
+		vec3d center_to_subsys;
+		vm_vec_sub(&center_to_subsys, &g_subobj_pos, &ship_objp->pos);
+
+		particle::ParticleEffectHandle death_effect;
+
+		if (psub->death_effect.isValid()) {
+			death_effect = psub->death_effect;
+		} else {
+			death_effect = sip->default_subsys_death_effect;
+		}
+
+		if (death_effect.isValid()) {
+			vec3d subsys_local_pos;
+			if (psub->subobj_num >= 0) {
+				// the vmd_zero_vector here should probably be psub->pnt instead, but this matches the behavior of get_subsystem_world_pos
+				model_instance_local_to_global_point(&subsys_local_pos, &vmd_zero_vector, ship_p->model_instance_num, psub->subobj_num);
+			} else {
+				subsys_local_pos = psub->pnt;
+			}
+			vec3d normalized_center_to_subsys = center_to_subsys;
+			vm_vec_normalize(&normalized_center_to_subsys);
+			// spawn particle effect
+			auto source = particle::ParticleManager::get()->createSource(death_effect);
+			source->setHost(make_unique<EffectHostObject>(ship_objp, subsys_local_pos, vmd_identity_matrix));
+			source->setTriggerRadius(psub->radius);
+			source->setNormal(normalized_center_to_subsys);
+			source->finishCreation();
+		} else if (ship_objp->radius > 100.0f) {
 			// number of fireballs determined by radius of subsys
 			int num_fireballs;
 			if ( psub->radius < 3 ) {
@@ -166,8 +193,7 @@ void do_subobj_destroyed_stuff( ship *ship_p, ship_subsys *subsys, const vec3d*
 				 num_fireballs = 5;
 			}
 
-			vec3d temp_vec, center_to_subsys, rand_vec;
-			vm_vec_sub(&center_to_subsys, &g_subobj_pos, &ship_objp->pos);
+			vec3d temp_vec, rand_vec;
 			for (i=0; i<num_fireballs; i++) {
 				if (i==0) {
 					// make first fireball at hitpos
@@ -308,9 +334,11 @@ void do_subobj_destroyed_stuff( ship *ship_p, ship_subsys *subsys, const vec3d*
 			));
 	}
 
+	bool no_fireballs = psub->death_effect.isValid() || sip->default_subsys_death_effect.isValid();
+
 	if (!(subsys->flags[Ship::Subsystem_Flags::No_disappear])) {
 		if (psub->subobj_num > -1) {
-			shipfx_blow_off_subsystem(ship_objp, ship_p, subsys, &g_subobj_pos, no_explosion);
+			shipfx_blow_off_subsystem(ship_objp, ship_p, subsys, &g_subobj_pos, no_explosion, no_fireballs);
 			subsys->submodel_instance_1->blown_off = true;
 		}
 

Original file line number	Diff line number	Diff line change
`@@ -85,6 +85,7 @@ bool ParticleSource::process() {`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`void ParticleSource::setNormal(const vec3d& normal) {`
	`88`	`+ Assertion(vm_vec_is_normalized(&normal), "Particle source normal must be normalized!");`
`88`	`89`	`m_normal = normal;`
`89`	`90`	`}`
`90`	`91`
Original file line number	Diff line number	Diff line change
`@@ -1352,6 +1352,8 @@ void ship_info::clone(const ship_info& other)`
`1352`	`1352`	`ship_passive_arcs = other.ship_passive_arcs;`
`1353`	`1353`
`1354`	`1354`	`glowpoint_bank_override_map = other.glowpoint_bank_override_map;`
	`1355`	`+`
	`1356`	`+ default_subsys_death_effect = other.default_subsys_death_effect;`
`1355`	`1357`	`}`
`1356`	`1358`
`1357`	`1359`	`void ship_info::move(ship_info&& other)`
`@@ -1698,6 +1700,8 @@ void ship_info::move(ship_info&& other)`
`1698`	`1700`
`1699`	`1701`	`animations = std::move(other.animations);`
`1700`	`1702`	`cockpit_animations = std::move(other.cockpit_animations);`
	`1703`	`+`
	`1704`	`+ default_subsys_death_effect = other.default_subsys_death_effect;`
`1701`	`1705`	`}`
`1702`	`1706`
`1703`	`1707`	`ship_info &ship_info::operator= (ship_info&& other) noexcept`
`@@ -2091,6 +2095,8 @@ ship_info::ship_info()`
`2091`	`2095`	`glowpoint_bank_override_map.clear();`
`2092`	`2096`
`2093`	`2097`	`ship_passive_arcs.clear();`
	`2098`	`+`
	`2099`	`+ default_subsys_death_effect = particle::ParticleEffectHandle::invalid();`
`2094`	`2100`	`}`
`2095`	`2101`
`2096`	`2102`	`ship_info::~ship_info()`
`@@ -5488,6 +5494,10 @@ static void parse_ship_values(ship_info* sip, const bool is_template, const bool`
`5488`	`5494`	`required_string("$end_custom_strings");`
`5489`	`5495`	`}`
`5490`	`5496`
	`5497`	`+ if (optional_string("$Default Subsystem Death Effect:")) {`
	`5498`	`+ sip->default_subsys_death_effect = particle::util::parseEffect(sip->name);`
	`5499`	`+ }`
	`5500`	`+`
`5491`	`5501`	`if(optional_string("$Default Subsystem Debris Flame Effect:"))`
`5492`	`5502`	`{`
`5493`	`5503`	`sip->default_subsys_debris_flame_particles = particle::util::parseEffect(sip->name);`
`@@ -5595,8 +5605,11 @@ static void parse_ship_values(ship_info* sip, const bool is_template, const bool`
`5595`	`5605`	`sp->turret_max_bomb_ownage = -1;`
`5596`	`5606`	`sp->turret_max_target_ownage = -1;`
`5597`	`5607`	`sp->density = 1.0f;`
	`5608`	`+`
	`5609`	`+ sp->death_effect = particle::ParticleEffectHandle::invalid();`
`5598`	`5610`	`sp->debris_flame_particles = particle::ParticleEffectHandle::invalid();`
`5599`	`5611`	`sp->shrapnel_flame_particles = particle::ParticleEffectHandle::invalid();`
	`5612`	`+`
`5600`	`5613`	`}`
`5601`	`5614`	`sfo_return = stuff_float_optional(&percentage_of_hits);`
`5602`	`5615`	`if(sfo_return==2)`
`@@ -5783,6 +5796,10 @@ static void parse_ship_values(ship_info* sip, const bool is_template, const bool`
`5783`	`5796`	`}`
`5784`	`5797`	`}`
`5785`	`5798`
	`5799`	`+ if (optional_string("$Subsystem Death Effect:")) {`
	`5800`	`+ sp->death_effect = particle::util::parseEffect(sip->name);`
	`5801`	`+ }`
	`5802`	`+`
`5786`	`5803`	`if (optional_string("$Debris Density:")) {`
`5787`	`5804`	`stuff_float(&sp->density);`
`5788`	`5805`	`}`
Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,7 @@ void model_get_rotating_submodel_axis(vec3d model_axis, vec3d world_axis, cons`
`90`	`90`	`*`
`91`	`91`	`* DKA: 5/26/99 make velocity of debris scale according to size of debris subobject (at least for large subobjects)`
`92`	`92`	`*/`
`93`		`-static void shipfx_subsystem_maybe_create_live_debris(object ship_objp, const ship ship_p, const ship_subsys subsys, const vec3d exp_center, float exp_mag)`
	`93`	`+static void shipfx_subsystem_maybe_create_live_debris(object ship_objp, const ship ship_p, const ship_subsys subsys, const vec3d exp_center, float exp_mag, bool no_fireballs = false)`
`94`	`94`	`{`
`95`	`95`	`// initializations`
`96`	`96`	`ship *shipp = &Ships[ship_objp->instance];`
`@@ -146,8 +146,11 @@ static void shipfx_subsystem_maybe_create_live_debris(object *ship_objp, const s`
`146`	`146`	`if(fireball_type < 0) {`
`147`	`147`	`fireball_type = FIREBALL_EXPLOSION_MEDIUM;`
`148`	`148`	`}`
`149`		`- // create fireball here.`
`150`		`- fireball_create(&end_world_pos, fireball_type, FIREBALL_MEDIUM_EXPLOSION, OBJ_INDEX(ship_objp), pm->submodel[live_debris_submodel].rad);`
	`149`	`+`
	`150`	`+ if (!no_fireballs) {`
	`151`	`+ // create fireball here.`
	`152`	`+ fireball_create(&end_world_pos, fireball_type, FIREBALL_MEDIUM_EXPLOSION, OBJ_INDEX(ship_objp), pm->submodel[live_debris_submodel].rad);`
	`153`	`+ }`
`151`	`154`
`152`	`155`	`// create debris`
`153`	`156`	`live_debris_obj = debris_create(ship_objp, pm->id, live_debris_submodel, &end_world_pos, exp_center, 1, exp_mag, subsys);`
`@@ -269,7 +272,7 @@ static void shipfx_maybe_create_live_debris_at_ship_death( object *ship_objp )`
`269`	`272`	`}`
`270`	`273`	`}`
`271`	`274`
`272`		`-void shipfx_blow_off_subsystem(object ship_objp, ship ship_p, const ship_subsys subsys, const vec3d exp_center, bool no_explosion)`
	`275`	`+void shipfx_blow_off_subsystem(object ship_objp, ship ship_p, const ship_subsys subsys, const vec3d exp_center, bool no_explosion, bool no_fireballs)`
`273`	`276`	`{`
`274`	`277`	`vec3d subobj_pos;`
`275`	`278`
`@@ -286,14 +289,16 @@ void shipfx_blow_off_subsystem(object ship_objp, ship ship_p, const ship_subsy`
`286`	`289`
`287`	`290`	`// create live debris objects, if any`
`288`	`291`	`// TODO: some MULTIPLAYER implcations here!!`
`289`		`- shipfx_subsystem_maybe_create_live_debris(ship_objp, ship_p, subsys, exp_center, 1.0f);`
	`292`	`+ shipfx_subsystem_maybe_create_live_debris(ship_objp, ship_p, subsys, exp_center, 1.0f, no_fireballs);`
`290`	`293`
`291`		`- int fireball_type = fireball_ship_explosion_type(&Ship_info[ship_p->ship_info_index]);`
`292`		`- if(fireball_type < 0) {`
`293`		`- fireball_type = FIREBALL_EXPLOSION_MEDIUM;`
	`294`	`+ if (!no_fireballs) {`
	`295`	`+ int fireball_type = fireball_ship_explosion_type(&Ship_info[ship_p->ship_info_index]);`
	`296`	`+ if(fireball_type < 0) {`
	`297`	`+ fireball_type = FIREBALL_EXPLOSION_MEDIUM;`
	`298`	`+ }`
	`299`	`+ // create first fireball`
	`300`	`+ fireball_create( &subobj_pos, fireball_type, FIREBALL_MEDIUM_EXPLOSION, OBJ_INDEX(ship_objp), psub->radius );`
`294`	`301`	`}`
`295`		`- // create first fireball`
`296`		`- fireball_create( &subobj_pos, fireball_type, FIREBALL_MEDIUM_EXPLOSION, OBJ_INDEX(ship_objp), psub->radius );`
`297`	`302`	`}`
`298`	`303`	`}`
`299`	`304`