2. MXG Weapon Mod - Explosion and SFX Depending on Material

Tested on: 1.1b2
Note: I will only keep my resources up to date until next stable release (1.1 final)

This resource will give you the ability to define custom particle effects, explosions and sound effects for your materials. Like the previous, the system is not perfect but it works.

Like the previous, this is how to install it:
Where it says // Added, it means that the line is added.
Where it says // Removed, it means that the line is removed.
Where it says // Changed, it means that the line is changed.
Where it says ..., it means that there is code between what ever that was last written.
Whenever it says ..., there will be an comment below describing what function it is.

I recommend you using CTRL + F to find where to put the code blocks. Remember to backup before installing.

Unfortunately you'll have to install all my previous resources to install this one (Scroll down to see a list of my Weapon Mod resources). Of course this resource is easily modifiable if you for example only want this resource but no other.

We'll start by editing materials/materialDefinition.cpp

...
//In the includes
#include "sfx/sfxTrack.h"
#include "sfx/sfxTypes.h"
#include "T3D/decal/decalManager.h"
#include "T3D/decal/decalData.h"
#include "T3D/fx/explosion.h" // Added
...
//In Material::Material()
   mFootstepSoundCustom = 0;  mImpactSoundCustom = 0;
   mCustomDecal = NULL; 
   mCustomExplosion = NULL; // Added
...
//In Material::initPersistFields()
      addField( "customImpactSound", TypeSFXTrackName,    Offset( mImpactSoundCustom, Material ),
         "The sound to play when the player impacts on the surface with a velocity equal or greater than PlayerData::groundImpactMinSpeed.  "
         "If this is set, it overrides #impactSoundId.  This field is useful for directly assigning custom impact sounds to materials "
         "without having to rely on the PlayerData sound assignment.nn"
         "@warn Be aware that materials are client-side objects.  This means that the SFXTracks assigned to materials must be client-side, too." );
		 
	  addField( "customDecal",		   TYPEID< DecalData >(),    Offset( mCustomDecal, Material ) );
	  addField( "customExplosion",	   TYPEID< ExplosionData >(),Offset( mCustomExplosion, Material ) ); // Added
...
//Custom code, put it where you want
void Material::setCustomExplosion(ExplosionData *explosion)
{
	this->mCustomExplosion = explosion;
}

ConsoleMethod( Material, setCustomExplosion, void, 3, 3, 
              "setExplosionDecal: Set a spesific explosion for assigned material." )
{
   ExplosionData* explosion;
   if (Sim::findObject(argv[2],explosion)) 
	   object->setCustomExplosion(explosion); 
}

Now for materials/materialDefinition.h

...
//In friend class definition
class MaterialPhysicsProfile;
class DecalData;
class ExplosionData; // Added
...
//In public of class Material
SFXTrack* mImpactSoundCustom;
DecalData* mCustomDecal;
ExplosionData* mCustomExplosion; // Added
...
//Same
   virtual void setAutoGenerated(bool isAutoGenerated) { mAutoGenerated = isAutoGenerated; }
   virtual void setCustomDecal(DecalData *decal);
   virtual void setCustomExplosion(ExplosionData *explosion); // Added

Then you'll have to edit T3D/projectile.cpp

...
//In ProjectileData::ProjectileData()
   decalId = 0;
   customDecal = false;
   customExplosion = false; // Added
...
//In void ProjectileData::initPersistFields()
   addField("waterExplosion", TYPEID< ExplosionData >(), Offset(waterExplosion, ProjectileData));

   addField("customDecal", TypeBool, Offset(customDecal, ProjectileData));
   addField("customExplosion", TypeBool, Offset(customExplosion, ProjectileData)); // Added
...
//In Projectile::simulate( F32 dt )
		 //if(mSourceObject)
            //mSourceObject->enableCollision();

		 // Get the rayCasts material info // Changed ->
		 Material* material = ( rInfo.material ? dynamic_cast< Material* >( rInfo.material->getMaterial() ) : 0 );
		 DecalData* decal = NULL;
		 ExplosionData* explosion = NULL;

		 if(material != NULL)
		 {
			 if(mDataBlock->customDecal && material->mCustomDecal != NULL)
				 // Uses custom decal, initalizing custom decal
				 decal = material->mCustomDecal;
			 else
				 // Initalizing default decal
				 decal = mDataBlock->decal;

			 if(mDataBlock->customExplosion && material->mCustomExplosion != NULL)
				 // Uses custom explosion, ititalizing custom explosion
				 explosion = material->mCustomExplosion;
			 else
				 // Initalizing default explosion
				 explosion = mDataBlock->explosion;
		 } // Changed <-

// Ok, here is how this works:
// onCollision is called to notify the server scripts that a collision has occurred, then
...
//Same
         onCollision(rInfo.point, rInfo.normal, rInfo.object);
		 explode(rInfo.point, rInfo.normal, decal, explosion, objectType ); // Changed
...
//In void Projectile::unpackUpdate(NetConnection* con, BitStream* stream)
	  stream->read(&mCollideHitType);
	  DecalData* decal = NULL;
	  ExplosionData* explosion = NULL; // Added

      // start the explosion visuals
      explode(explodePoint, explodeNormal, decal, explosion, mCollideHitType); // Changed
...
//In void Projectile::explode( const Point3F &p, const Point3F &n, DecalData* decal, const U32 collideType )
void Projectile::explode( const Point3F &p, const Point3F &n, DecalData* decal, ExplosionData* explosion, const U32 collideType ) // Changed
{
...
//Same void Projectile::explode( const Point3F &p, const Point3F &n, DecalData* decal, ExplosionData* explosion, const U32 collideType )
      // Client just plays the explosion at the right place...
      //       
      Explosion* pExplosion = NULL;

	  if (explosion != NULL) // Added ->
      {  
	      pExplosion = new Explosion;  
	      pExplosion->onNewDataBlock(explosion);  
      }  
      else // Added <-
...
//Same
         pExplosion = new Explosion;
         pExplosion->onNewDataBlock(mDataBlock->waterExplosion);
      }
      else
      if (mDataBlock->explosion && explosion == mDataBlock->explosion) // Changed

Last, edit T3D/projectile.h

...
//In public of class ProjectileData
   S32 decalId;                        // (impact) Decal ID
   bool customDecal;
   bool customExplosion; // Added
...
//In protected of class Projectile
   virtual void explode(const Point3F& p, const Point3F& n, DecalData* decal, ExplosionData* explosion, const U32 collideType ); // Changed

Start (re)building while you add the next part.

The next part is the part I would like to avoid, this will be fixed in a later resource
Edit scripts/server/customMatFX.cs that you created in the previous resouce, and add:

function loadCustomExplosion()
{
   // Where material is the name/id of the material
   // and explosion is the name/id of the explosion
   material.setCustomDecal(explosion); 
}

and last, adding this line to game/gameCore.cs:

$Game::Schedule = schedule($Game::Duration * 1000 * 60, 0, "onGameDurationEnd");
   $Game::Running = true;
   
   loadCustomDecals();
   loadCustomExplosion(); // Added

Now, add variable customExplosion = true; in the projectile of the weapons you want to be affected by the custom explosions , this is good for RocketLaunchers which usually have the same explosion unregardless of material.

To test:
Run game,
Load level,
Load up an random shape,
Find the material name of the shape and enter material.setCustomExplosion(explosion); in the console, where material is the name/id of the material, and explosion is the name/id of the explosion.
And try shooting it.

If you stumble upon some issues, let me know.
Also know that my methods might not be correct, nor the most professional. Therefore if you see some silly mistakes please leave a comment with the "fix".

Other resources in my Weapon Mod:
1. MXG Weapon Mod - Decals Depending on Material
2. MXG Weapon Mod - Explosion and SFX Depending on Material
3. MXG Weapon Mod - Structure and Armor Piercing Projectiles
4. MXG Weapon Mod - Advanced Crosshair

Thanks,
Marcus L.