TGEA 1.7 port of twSurfaceReference

Download Code File

This resource allows you to add all the functionality of the twSurfaceRefrence to TGEA 1.7's foliage replicator. To start with, download the attached zip file containing the code files. Open your compiler and add the files to your project. They should go in the /T3D/fx folder.

Now, for the code changes.

1. Add this to the top of fxFoliageReplicator.cpp:

#include "twSurfaceReference.h"

2. After

//------------------------------------------------------------------------------
//
// Trig Table Lookups.
//
//------------------------------------------------------------------------------
const F32 PeriodLen = (F32) 2.0f * (F32) M_PI;
const F32 PeriodLenMinus = (F32) (2.0f * M_PI) - 0.01f;

//------------------------------------------------------------------------------
//
// Class: fxFoliageRenderList
//
//------------------------------------------------------------------------------

add

bool fxFoliageReplicator::GetTerrainTextures(float distance, Point3F& pt, U8 *alphas)
{
RayInfo rInfo;

   if (gClientContainer.castRay(pt, Point3F(pt.x, pt.y, pt.z - distance ), TerrainObjectType, &rInfo))
   {
   U32 CollisionType = rInfo.object->getTypeMask();

      if (CollisionType & TerrainObjectType)
      {
		   TerrainBlock* ter = static_cast<TerrainBlock*>(rInfo.object);
		   Point2I gPos;
		   const MatrixF & mat = ter->getTransform();

		   Point3F origin;
		   mat.getColumn(3, &origin);
		   F32 squareSize = (F32) ter->getSquareSize();
		   F32 halfSquareSize = squareSize / 2;

		   float x = (pt.x - origin.x + halfSquareSize) / squareSize;
		   float y = (pt.y - origin.y + halfSquareSize) / squareSize;

		   ter->getMaterialAlpha(Point2I(x,y), alphas);
		   return true;
      }
   }
   return false;
}

3. Add the following lines to the initPersistFields() function:

addField( "SurfaceExclusionMode",		TypeBool,		Offset( mFieldData.mSurfaceExclusionMode,			fxFoliageReplicator ) );   
	addField( "SurfaceType",      TypeEnum,      Offset(mFieldData.mTheSurface,		fxFoliageReplicator ), 1, &gSurfaceTypeTable );

4. After

if ((CollisionType & WaterObjectType) && !mFieldData.mAllowWaterSurface &&
					!gClientContainer.castRay( FoliageStart, FoliageEnd, FXFOLIAGEREPLICATOR_NOWATER_COLLISION_MASK, &RayEvent)) continue;

add

if ((twSurfaceReference::ESurfaceType)mFieldData.mTheSurface)  // if we are checking for specific surfaces and not just 'any'
            {
               if ( BaseSurfaces[(twSurfaceReference::ESurfaceType)mFieldData.mTheSurface].isAvailable)
               {
				   CollisionResult = false;
               U8 alphas[TerrainBlock::MaterialGroups];
                  // Checks if the new position is over a blended terrain texture (a 'surface' ) that is *exactly* the same as the surface where
                  // the specified SurfaceReference marker was placed.

                  if (GetTerrainTextures(4000.0f, FoliageStart, alphas))
                  {
                  bool skip = mFieldData.mSurfaceExclusionMode;

                     for (int i=0; i < TerrainBlock::MaterialGroups; i++)
                     {
                        if (alphas[ i] != BaseSurfaces[(twSurfaceReference::ESurfaceType)mFieldData.mTheSurface].alphas[ i])
                        {
                           skip = !mFieldData.mSurfaceExclusionMode;                 // even one non-match means this is not the same surface
                           break;
                        }
                     }
                     if (skip) continue;              // don't place grass here
                  }
               }
             }

5. After

stream->write(mFieldData.mPlaceAreaColour);

add

stream->writeFlag(mFieldData.mSurfaceExclusionMode);					// allow/disallow toggle
		stream->write( mFieldData.mTheSurface );                          // the surface reference

6. After

stream->read(&mFieldData.mPlaceAreaColour);

add

mFieldData.mSurfaceExclusionMode = stream->readFlag();				// Allow/Disallow toggle
	    stream->read( &mFieldData.mTheSurface);                           // the surface reference

7. Alright, now open up fxFoliageReplicator.h. After

U32               mFoliageRetries;

add

bool              mSurfaceExclusionMode;              // if 1 then allow, if 0 then disallow         
	  U32				mTheSurface;

8. After

mFoliageRetries       = 100;

add

mSurfaceExclusionMode			= false;         
		 mTheSurface            = (U32)twSurfaceReference::eAny;

9. After

fxFoliageReplicator();
   ~fxFoliageReplicator();

add

bool GetTerrainTextures(float,Point3F&, U8 *);

10. Next, open up \console\sim.h. After

DeclareNamedSet(sgMissionLightingFilterSet);

add

DeclareNamedSet(twSurfaceSet)

11. Then, open \console\sim.cpp. After

ImplementNamedSet(sgMissionLightingFilterSet)

add [codeImplementNamedSet(twSurfaceSet)[/code]

12. Open \console\simManager.cpp. After

InstantiateNamedSet(sgMissionLightingFilterSet);

add

InstantiateNamedSet(twSurfaceSet);

.

13. Ok, thats all for source changes. Recompile to make sure that no errors occur, then move onto the scripts changes.





Script Changes

1. Open game\tools\missiodeditor\gui\objectBuilderGui.ed.gui. Right before

function ObjectBuilderGui::buildfxFoliageReplicator(%this)

add

function ObjectBuilderGui::buildtwSurfaceReference(%this)      
{      	
	%this.className = "twSurfaceReference";      	
	%this.process();      
}

2. Open game\tools\missiodeditor\scripts\editors\creator.ed.cs. After

%Environment_Item[17] = "MegaTerrain";

add

%Environment_Item[18] = "twSurfaceReference";

.

3. Open game\common\clientScripts\missiondownload.cs. After

onPhase2Complete();

add

StartSurfaceReferencer();

Alright, thats all the script changes. To use the twSurfaceRefrence:

1. Add to your mission like any other object. Examples of a twSurfaceRefence mission
object and a modified fxFoliageReplicator object are contained in the file 'samples.txt'
in the twSurfaceReference_tgea.zip file.

2. Set up your reference surface:

Place the SurfaceReference object over the precise surface that you want to
reference later for your grass. Select a type from the SurfaceType drop-down menu.

3. Place your foliage:

14a. Place a modified fxFoilageReplicator object in an appropriate location. Make sure that there
is some surface texture the same as you referenced in step 13 above. Select the same
SurfaceType from the drop down menu. Hit 'Apply'.

14b. To make sure your grass does NOT appear on a given referenced surface, then check the
'SurfaceExclusionMode' box. Hit 'Apply'.


If you have any issues, post them here.