Cleanup of Level 0 Particles (#6808)

* Make scripting use the full-blown particle system

* Add reverse option

* Add animation reversal as an option to modern particles

* Start implementation of beam particles

* Add multi-emission particle source API for legacy particles

* Attach beam muzzle particles to the correct host

* Reorder code in order to facilitate apparent visual size as modular curve input for particles

* fix lua api

* Typo

* Fix scripting and beam muzzle particles

* Remove muzzleflash code, prepare to replace with particles

* Begin mflash effect conversion

* Pass final parameters to mflashes and fix curve

* Remove deprecated particle function

* Add debris flame particles

* remove weapon_explosion table

* Convert shield explosion particles

* Fix modular curve full inputs and convert particle curve inputs accordingly

* Allow particle volume offset and rotation with curve-based rot around fvec

* Add Ring and Point Volumes

* Convert PSPEW to new system

* Make particle curve timing aware of interp

* Update todos

* get rid of performance waste

* Add last parameter for converted pspews

* Fix pspew bugs

* Fix direction for default pspew

* Fix order for voluem rotation

* particle vel interp

* particle vel interp 2

* Make beam muzzle stay parented to the firing ship, as it's likely the more commonly intended variamnt

* fix scripting particle lifetime

* Allow beam muzzle particle override

* Skip invalid pspews

* remove pspew dcf code

* Fix sparkler stretch

* Correct sparkler bia

* General sparkler weirdness

* Tune distribution of sparklers

* Convert Asteroid particles

* Fix conversion warning

* Fix conversion warning again

* Fix conversion warning again again

* Really clang?

Author: BMagnu

code/ai/aiturret.cpp

@@ -2043,9 +2043,6 @@ bool turret_fire_weapon(int weapon_num,
 						particleSource->setTriggerVelocity(vm_vec_mag_quick(&objp->phys_info.vel));
 						particleSource->finishCreation();
 					}
-					else if (wip->muzzle_flash >= 0) {
-						mflash_create(firing_pos, firing_vec, &Objects[parent_ship->objnum].phys_info, wip->muzzle_flash);
-					}
 
 					// in multiplayer (and the master), then send a turret fired packet.
 					if ( MULTIPLAYER_MASTER && (weapon_objnum != -1) ) {
@@ -2166,9 +2163,6 @@ void turret_swarm_fire_from_turret(turret_swarm_info *tsi)
 			particleSource->setTriggerRadius(Objects[weapon_objnum].radius);
 			particleSource->finishCreation();
 		}
-		else if (Weapon_info[tsi->weapon_class].muzzle_flash >= 0) {
-			mflash_create(&turret_pos, &turret_fvec, &Objects[tsi->parent_objnum].phys_info, Weapon_info[tsi->weapon_class].muzzle_flash);
-		}
 
 		// maybe sound
 		if ( Weapon_info[tsi->weapon_class].launch_snd.isValid() ) {

code/asteroid/asteroid.cpp

@@ -33,7 +33,7 @@
 #include "object/object.h"
 #include "parse/parselo.h"
 #include "scripting/global_hooks.h"
-#include "particle/particle.h"
+#include "particle/hosts/EffectHostVector.h"
 #include "render/3d.h"
 #include "ship/ship.h"
 #include "ship/shipfx.h"
@@ -63,8 +63,7 @@ asteroid			Asteroids[MAX_ASTEROIDS];
 asteroid_field	Asteroid_field;
 
 
-static int		Asteroid_impact_explosion_ani;
-static float	Asteroid_impact_explosion_radius;
+static particle::ParticleEffectHandle 		Asteroid_impact_explosion_ani;
 char	Asteroid_icon_closeup_model[NAME_LENGTH];
 vec3d	Asteroid_icon_closeup_position;
 float	Asteroid_icon_closeup_zoom;	
@@ -1752,7 +1751,9 @@ void asteroid_hit( object * pasteroid_obj, object * other_obj, vec3d * hitpos, f
 			wip = &Weapon_info[Weapons[other_obj->instance].weapon_info_index];
 			// If the weapon didn't play any impact animation, play custom asteroid impact animation
 			if (!wip->impact_weapon_expl_effect.isValid()) {
-				particle::create( hitpos, &vmd_zero_vector, 0.0f, Asteroid_impact_explosion_radius, Asteroid_impact_explosion_ani );
+				auto source = particle::ParticleManager::get()->createSource(Asteroid_impact_explosion_ani);
+				source->setHost(std::make_unique<EffectHostVector>(*hitpos, vmd_identity_matrix, vmd_zero_vector));
+				source->finishCreation();
 			}
 		}
 	}
@@ -2461,18 +2462,52 @@ static void asteroid_parse_tbl(const char* filename)
 
 		required_string("#End");
 
-		if (optional_string("$Impact Explosion:")) {
+		if (optional_string("$Impact Explosion Effect:")) {
+			Asteroid_impact_explosion_ani = particle::util::parseEffect();
+		}
+		else {
 			char impact_ani_file[MAX_FILENAME_LEN];
-			stuff_string(impact_ani_file, F_NAME, MAX_FILENAME_LEN);
+			float Asteroid_impact_explosion_radius;
+			int num_frames;
 
-			if (VALID_FNAME(impact_ani_file)) {
-				int num_frames;
-				Asteroid_impact_explosion_ani = bm_load_animation(impact_ani_file, &num_frames, nullptr, nullptr, nullptr, true);
+			if (optional_string("$Impact Explosion:")) {
+				stuff_string(impact_ani_file, F_NAME, MAX_FILENAME_LEN);
+			}
+			if (optional_string("$Impact Explosion Radius:")) {
+				stuff_float(&Asteroid_impact_explosion_radius);
 			}
-		}
 
-		if (optional_string("$Impact Explosion Radius:")) {
-			stuff_float(&Asteroid_impact_explosion_radius);
+			if(VALID_FNAME(impact_ani_file)) {
+				Asteroid_impact_explosion_ani = particle::ParticleManager::get()->addEffect(particle::ParticleEffect(
+						"", //Name
+						::util::UniformFloatRange(1.f), //Particle num
+						particle::ParticleEffect::Duration::ONETIME, //Single Particle Emission
+						::util::UniformFloatRange(), //No duration
+						::util::UniformFloatRange(-1.f), //Single particle only
+						particle::ParticleEffect::ShapeDirection::ALIGNED, //Particle direction
+						::util::UniformFloatRange(), //Velocity Inherit
+						false, //Velocity Inherit absolute?
+						nullptr, //Velocity volume
+						::util::UniformFloatRange(), //Velocity volume multiplier
+						particle::ParticleEffect::VelocityScaling::NONE, //Velocity directional scaling
+						std::nullopt, //Orientation-based velocity
+						std::nullopt, //Position-based velocity
+						nullptr, //Position volume
+						particle::ParticleEffectHandle::invalid(), //Trail
+						1.f, //Chance
+						false, //Affected by detail
+						-1.f, //Culling range multiplier
+						false, //Disregard Animation Length. Must be true for everything using particle::Anim_bitmap_X
+						false, //Don't reverse animation
+						false, //parent local
+						false, //ignore velocity inherit if parented
+						false, //position velocity inherit absolute?
+						std::nullopt, //Local velocity offset
+						std::nullopt, //Local offset
+						::util::UniformFloatRange(-1.f), //Lifetime
+						::util::UniformFloatRange(Asteroid_impact_explosion_radius), //Radius
+						bm_load_animation(impact_ani_file, &num_frames, nullptr, nullptr, nullptr, true))); //Bitmap
+			}
 		}
 
 		if (optional_string("$Briefing Icon Closeup Model:")) {
@@ -2622,8 +2657,7 @@ static void verify_asteroid_list()
  */
 void asteroid_init()
 {
-	Asteroid_impact_explosion_ani = -1;
-	Asteroid_impact_explosion_radius = 20.0;							// retail value
+	Asteroid_impact_explosion_ani = particle::ParticleEffectHandle::invalid();
 	Asteroid_icon_closeup_model[0] = '\0';
 	vm_vec_make(&Asteroid_icon_closeup_position, 0.0f, 0.0f, -334.0f);	// magic numbers from retail
 	Asteroid_icon_closeup_zoom = 0.5f;									// magic number from retail
@@ -2644,7 +2678,7 @@ void asteroid_init()
 	// now that Asteroid_info is filled in we can verify the asteroid splits and set their indecies
 	verify_asteroid_splits();
 
-	if (Asteroid_impact_explosion_ani == -1) {
+	if (!Asteroid_impact_explosion_ani.isValid()) {
 		Error(LOCATION, "Missing valid asteroid impact explosion definition in asteroid.tbl!");
 	}
 

code/debris/debris.cpp

@@ -121,6 +121,9 @@ void debris_init()
 	Debris_hit_particle = particle::ParticleManager::get()->addEffect(particle::ParticleEffect(
 		"", //Name
 		::util::UniformFloatRange(10.f), //Particle num
+		particle::ParticleEffect::Duration::ONETIME, //Single Particle Emission
+		::util::UniformFloatRange(), //No duration
+		::util::UniformFloatRange (-1.f), //Single particle only
 		particle::ParticleEffect::ShapeDirection::ALIGNED, //Particle direction
 		::util::UniformFloatRange(1.f), //Velocity Inherit
 		false, //Velocity Inherit absolute?
@@ -135,6 +138,12 @@ void debris_init()
 		true, //Affected by detail
 		1.f, //Culling range multiplier
 		true, //Disregard Animation Length. Must be true for everything using particle::Anim_bitmap_X
+		false, //Don't reverse animation
+		false, //parent local
+		false, //ignore velocity inherit if parented
+		false, //position velocity inherit absolute?
+		std::nullopt, //Local velocity offset
+		std::nullopt, //Local offset
 		::util::UniformFloatRange(0.25f, 0.75f), //Lifetime
 		::util::UniformFloatRange(0.2f, 0.4f), //Radius
 		particle::Anim_bitmap_id_fire)); //Bitmap
@@ -418,6 +427,14 @@ object *debris_create(object *source_obj, int model_num, int submodel_num, const
 	{
 		debris_create_set_velocity(&Debris[obj->instance], shipp, exp_center, exp_force, source_subsys);
 		debris_create_fire_hook(obj, source_obj);
+		const auto& sip = Ship_info[Ships[source_obj->instance].ship_info_index];
+		if (sip.debris_flame_particles.isValid()) {
+			auto source = particle::ParticleManager::get()->createSource(sip.debris_flame_particles);
+			source->setHost(std::make_unique<EffectHostObject>(obj, vmd_zero_vector));
+			source->setTriggerRadius(source_obj->radius);
+			source->setTriggerVelocity(vm_vec_mag_quick(&source_obj->phys_info.vel));
+			source->finishCreation();
+		}
 	}
 
 	return obj;

code/globalincs/pstypes.h

@@ -397,15 +397,6 @@ const size_t INVALID_SIZE = static_cast<size_t>(-1);
 // the trailing underscores are to avoid conflicts with previously #define'd tokens
 enum class TriStateBool : int { FALSE_ = 0, TRUE_ = 1, UNKNOWN_ = -1 };
 
-
-// lod checker for (modular) table parsing
-typedef struct lod_checker {
-	char filename[MAX_FILENAME_LEN];
-	int num_lods;
-	int override;
-} lod_checker;
-
-
 // Callback Loading function.
 // If you pass a function to this, that function will get called
 // around 10x per second, so you can update the screen.

code/lab/manager/lab_manager.cpp

@@ -48,7 +48,6 @@ LabManager::LabManager() {
 	shockwave_level_init();
 	ship_level_init();
 	shipfx_flash_init();
-	mflash_page_in(true);
 	weapon_level_init();
 	beam_level_init();
 	particle::init();

code/network/multimsgs.cpp

@@ -8770,15 +8770,30 @@ void process_flak_fired_packet(ubyte *data, header *hinfo)
 	// create the weapon object	
 	weapon_objnum = weapon_create( &pos, &orient, wid, OBJ_INDEX(objp), -1, true, false, 0.0f, ssp, launch_curve_data);
 	if (weapon_objnum != -1) {
-		if ( Weapon_info[wid].launch_snd.isValid() ) {
+		const weapon_info& wip = Weapon_info[wid];
+		if ( wip.launch_snd.isValid() ) {
 			snd_play_3d( gamesnd_get_game_sound(Weapon_info[wid].launch_snd), &pos, &View_position );
 		}
 
-		// create a muzzle flash from a flak gun based upon firing position and weapon type
-		mflash_create(&pos, &dir, &objp->phys_info, Weapon_info[wid].muzzle_flash);
+		object& wp_obj = Objects[weapon_objnum];
+		const weapon& wp = Weapons[wp_obj.instance];
+
+		if (wip.muzzle_effect.isValid()) {
+			float radius_mult = 1.f;
+			if (wip.render_type == WRT_LASER) {
+				radius_mult = wip.weapon_curves.get_output(weapon_info::WeaponCurveOutputs::LASER_RADIUS_MULT, wp, &wp.modular_curves_instance);
+			}
+			//spawn particle effect
+			auto particleSource = particle::ParticleManager::get()->createSource(wip.muzzle_effect);
+			//This could potentially be attached to the ship, but might look weird if the spawn position of the weapon is ever interpolated away from the ship's barrel.
+			particleSource->setHost(make_unique<EffectHostVector>(pos, orient, objp->phys_info.vel));
+			particleSource->setTriggerRadius(wp_obj.radius * radius_mult);
+			particleSource->setTriggerVelocity(vm_vec_mag_quick(&wp_obj.phys_info.vel));
+			particleSource->finishCreation();
+		}
 
 		// set its range explicitly - make it long enough so that it's guaranteed to still exist when the server tells us it blew up
-		flak_set_range(&Objects[weapon_objnum], (float)flak_range);
+		flak_set_range(&wp_obj, (float)flak_range);
 	}
 }
 

code/object/collideshipweapon.cpp

@@ -527,8 +527,8 @@ static int ship_weapon_check_collision(object *ship_objp, object *weapon_objp, f
 
 		if(!ship_override && !weapon_override) {
 			if (shield_collision && quadrant_num >= 0) {
-				if ((sip->shield_impact_explosion_anim > -1) && (wip->shield_impact_explosion_radius > 0)) {
-					shield_impact_explosion(&mc->hit_point, ship_objp, wip->shield_impact_explosion_radius, sip->shield_impact_explosion_anim);
+				if ((sip->shield_impact_explosion_anim.isValid()) && (wip->shield_impact_explosion_radius > 0)) {
+					shield_impact_explosion(mc->hit_point, mc->hit_normal, ship_objp, weapon_objp, wip->shield_impact_explosion_radius, sip->shield_impact_explosion_anim);
 				}
 			}
 			ship_weapon_do_hit_stuff(ship_objp, weapon_objp, &mc->hit_point_world, &mc->hit_point, quadrant_num, mc->hit_submodel, &mc->hit_normal);