TSE shapebase material swap

TSE milestone 3.5 now requires all materials to be defined in a materials.cs file. If a material is not defined the error texture will show on your shapes. I have rewritten the reskin functionality to work with the latest TSE milestone 3.5. I have expanded it's functionality to allow you to change a material to any material defined in any of your materials.cs files. You can switch back and fourth as many times as you want and use any defined material you want. Here's the code changes:

Open ts/tsShapeInstance.h and look for the following line:

void reSkin(StringHandle& newBaseHandle);

Change it to:

void reSkin(StringHandle& oldMaterial,StringHandle& newMaterial);

I added an arg and changed the names of the agrs to make more sense. Save this file.

Open ts/tsShapeInstance.cpp and look for the TSShapeInstance::reSkin function and change it to:

void TSShapeInstance::reSkin(StringHandle& oldMaterial,StringHandle& newMaterial)
{
//BCS - Swaps skin on shapebase and static objects
const char* MatName = null;
const char* newMatName = null;
      if (oldMaterial.isValidString() && newMaterial.isValidString()) {
      	MatName = oldMaterial.getString();
	newMatName = newMaterial.getString();
      	}
   if (MatName == NULL || newMatName == NULL){return;}
   if (ownMaterialList() == false) {cloneMaterialList();}
   // Cycle through the materials.
   TSMaterialList* pMatList = getMaterialList();
   for (S32 j = 0; j < pMatList->mMaterialNames.size(); j++)
  {
      const char* pName = pMatList->mMaterialNames[j];
      if (pName == NULL){continue;}
      if(!dStricmp(pName,MatName))
      {
         MatInstance * matInst = pMatList->getMaterialInst(j);
         if(!matInst->swapMaterial(newMatName)){
	Con::errorf("reSkin failed. Material %s not found.",newMatName);
         }
      }
   }
}

Save this file. This function calls swapMaterial() which we need to create in the materials/matInstance.h

Open materials/matInstance.h and add the following around line 110 in the public section of the class:

//BCS - added for material swap
	bool swapMaterial(const char*);

Save this file.

Open materials/matInstance.cpp and add the following function to the bottom of the file:

//BCS - added for material swap
bool MatInstance::swapMaterial(const char* newName)
{
	Material * myMat;
	//if we find the new material swap it out
	if(!Sim::findObject(newName, myMat))
	{
		return false;
	}
	else
	{
		mMaterial = myMat;
		reInit();
		return true;
	}
	myMat = NULL;
}

Save this file.

Open game/ShapeBase.h and add the following line around line 709 right after the mSkinNameHandle line:

//BCS - added for material swap
	StringHandle     mNewSkinNameHandle;

We need a second argument for updating the skin over the network. That's what this is used for.

Search for setSkinName(const char*); and change it to:

void setSkinName(const char*,const char*);

Again we need that second arg. Save this file.

Open game/ShapeBase.cpp and look for the setSkinName console method. It's towards the bottom of the file. Change it to this:

ConsoleMethod( ShapeBase, setSkinName, void, 4, 4, "(oldMaterialName,newMaterialName)")
{
   object->setSkinName(argv[2],argv[3]);
}

All we did was add a second arg. This allows us to pass the old and new material name.

Search for the ShapeBase::setSkinName function and change it to:

void ShapeBase::setSkinName(const char* name,const char* newSkinName)
{
   if (!isGhost()) {
      if (name[0] != '[[60c1e3d54fbbd]]') {
         // Use tags for better network performance
         // Should be a tag, but we'll convert to one if it isn't.
         if (name[0] == StringTagPrefixByte) {
            mSkinNameHandle = StringHandle(U32(dAtoi(name + 1)));
         }
         else {
            mSkinNameHandle = StringHandle(name);
         }
      }
      else {
         mSkinNameHandle = StringHandle();
      }
      if (newSkinName[0] != '[[60c1e3d54fbbd]]') {
         // Use tags for better network performance
         // Should be a tag, but we'll convert to one if it isn't.
         if (newSkinName[0] == StringTagPrefixByte) {
            mNewSkinNameHandle = StringHandle(U32(dAtoi(newSkinName + 1)));
         }
         else {
            mNewSkinNameHandle = StringHandle(newSkinName);
         }
      }
      else {
         mNewSkinNameHandle = StringHandle();
      }
      setMaskBits(SkinMask);
   }
}

All we did was add the second arg that is passed to us from the console function.

Now find the ShapeBase::packUpdate function and add the following around line 2864 right under con->packStringHandleU(stream, mSkinNameHandle);

con->packStringHandleU(stream, mNewSkinNameHandle);

This packs our second argument for network update.

Now find the ShapeBase::unpackUpdate function and replace the existing SkinMask unpack with this one(around line 3040):

//BCS - changed for material swap
      if (stream->readFlag()) {  // SkinMask
         StringHandle skinDesiredNameHandle = con->unpackStringHandleU(stream);
	   StringHandle newskinDesiredNameHandle = con->unpackStringHandleU(stream);
         if (mSkinNameHandle != newskinDesiredNameHandle) {
            mSkinNameHandle = newskinDesiredNameHandle;
            if (mShapeInstance) {
               mShapeInstance->reSkin(skinDesiredNameHandle,newskinDesiredNameHandle);
               if (mSkinNameHandle.isValidString()) {
                  mSkinHash = _StringTable::hashString(mSkinNameHandle.getString());
               }
            }
         }
      }

Again, this unpacks two arguments instead of one.

Now find the reSkin function around line 852 and change it to:

mShapeInstance->reSkin(mSkinNameHandle,mSkinNameHandle);

Save this file.

Open game/ShapeImage.cpp and look for the reSkin function around line 1291. Change it to:

image.shapeInstance->reSkin(image.skinNameHandle,skinNameHandle);

Search again for the reSkin function around line 1333 and change it to:

image.shapeInstance->reSkin(skinNameHandle,skinNameHandle);

Save this file and compile.

To use this simply specify the orginal material and the new material.

Obj.setSkinName(original_MaterialMpTo_Name, New_Material_Name);

The original material mapTo name will not change even after swapping materials. For example, to swap the Orc_Material with the OrcEye material and back we would do the following:
$Game::Player.setSkinName(Orc_Material,OrcEye);
$Game::Player.setSkinName(Orc_Material, SpaceOrc);

I designed it this way so that you wouldn't have to keep track of the names as you swap them out. The original name is the original mapTo name. The new name is the name of the new material
new Material(OrcEye)
{
baseTex[0] = "~/data/shapes/spaceOrc/orc_ID6_eye";
emissive[0] = true;
glow[0] = true;
};