[GEN][ZH] Fix black terrain in World Builder without RTS_DEBUG (#1190)

Author: xezon

Core/GameEngine/Include/Common/GameDefines.h

@@ -40,3 +40,10 @@
 #ifndef ENABLE_GAMETEXT_SUBSTITUTES
 #define ENABLE_GAMETEXT_SUBSTITUTES (1) // The code can provide substitute texts when labels and strings are missing in the STR or CSF translation file
 #endif
+
+// Previously the configurable shroud sat behind #if defined(RTS_DEBUG)
+// Enable the configurable shroud to properly draw the terrain in World Builder without RTS_DEBUG compiled in.
+// Disable the configurable shroud to make shroud hacking a bit less accessible in Release game builds.
+#ifndef ENABLE_CONFIGURABLE_SHROUD
+#define ENABLE_CONFIGURABLE_SHROUD (1) // When enabled, the GlobalData contains a field to turn on/off the shroud, otherwise shroud is always enabled
+#endif

Generals/Code/GameEngine/Include/Common/GameCommon.h

@@ -52,6 +52,7 @@
 
 // ----------------------------------------------------------------------------------------------
 #include "Lib/BaseType.h"
+#include "Common/GameDefines.h"
 
 // ----------------------------------------------------------------------------------------------
 #if defined(RTS_DEBUG)

Generals/Code/GameEngine/Include/Common/GlobalData.h

@@ -465,15 +465,16 @@ class GlobalData : public SubsystemInterface
   Int					m_playStats;									///< Int whether we want to log play stats or not, if <= 0 then we don't log
 
   Bool m_TiVOFastMode;            ///< When true, the client speeds up the framerate... set by HOTKEY!
-  
 
+#if defined(RTS_DEBUG) || ENABLE_CONFIGURABLE_SHROUD
+	Bool m_shroudOn;
+#endif
 
 #if defined(RTS_DEBUG)
 	Bool m_wireframe;
 	Bool m_stateMachineDebug;
 	Bool m_useCameraConstraints;
 	Bool m_specialPowerUsesDelay;
-	Bool m_shroudOn;
 	Bool m_fogOfWarOn;
 	Bool m_jabberOn;
 	Bool m_munkeeOn;

Generals/Code/GameEngine/Include/Precompiled/PreRTS.h

@@ -111,7 +111,6 @@ class STLSpecialAlloc;
 #include "Common/SubsystemInterface.h"
 
 #include "Common/GameCommon.h"
-#include "Common/GameDefines.h"
 #include "Common/GameMemory.h"
 #include "Common/GameType.h"
 #include "Common/GlobalData.h"

Generals/Code/GameEngine/Source/Common/CommandLine.cpp

@@ -718,7 +718,7 @@ Int parseNoFX(char *args[], int)
 	return 1;
 }
 
-#if defined(RTS_DEBUG)
+#if defined(RTS_DEBUG) && ENABLE_CONFIGURABLE_SHROUD
 Int parseNoShroud(char *args[], int)
 {
 	TheWritableGlobalData->m_shroudOn = FALSE;
@@ -1277,7 +1277,9 @@ static CommandLineParam paramsForEngineInit[] =
 	{ "-vTune", parseVTune },
 	{ "-selectTheUnselectable", parseSelectAll },
 	{ "-RunAhead", parseRunAhead },
+#if ENABLE_CONFIGURABLE_SHROUD
 	{ "-noshroud", parseNoShroud },
+#endif
 	{ "-forceBenchmark", parseForceBenchmark },
 	{ "-buildmapcache", parseBuildMapCache },
 	{ "-noshadowvolumes", parseNoShadows },

Generals/Code/GameEngine/Source/Common/GlobalData.cpp

@@ -545,11 +545,14 @@ GlobalData::GlobalData()
 
   m_TiVOFastMode = FALSE;
 
+#if defined(RTS_DEBUG) || ENABLE_CONFIGURABLE_SHROUD
+	m_shroudOn = TRUE;
+#endif
+
 #if defined(RTS_DEBUG)
 	m_wireframe = 0;
 	m_stateMachineDebug = FALSE;
 	m_useCameraConstraints = TRUE;
-	m_shroudOn = TRUE;
 	m_fogOfWarOn = FALSE;
 	m_jabberOn = FALSE;
 	m_munkeeOn = FALSE;

Generals/Code/GameEngine/Source/GameClient/GameClient.cpp

@@ -614,7 +614,7 @@ void GameClient::update( void )
 
 	if (!freezeTime)
 	{
-#if defined(RTS_DEBUG)
+#if ENABLE_CONFIGURABLE_SHROUD
 		if (TheGlobalData->m_shroudOn)
 #else
 		if (true)
@@ -645,7 +645,7 @@ void GameClient::update( void )
 		while (draw)
 		{	// update() could free the Drawable, so go ahead and grab 'next'
 			Drawable* next = draw->getNextDrawable();
-#if defined(RTS_DEBUG)
+#if ENABLE_CONFIGURABLE_SHROUD
 			if (TheGlobalData->m_shroudOn)
 #else
 			if (true)

Generals/Code/GameEngine/Source/GameClient/InGameUI.cpp

@@ -2483,7 +2483,7 @@ void InGameUI::createCommandHint( const GameMessage *msg )
 	{
 		const Object* obj = draw->getObject();
 		Int localPlayerIndex = ThePlayerList ? ThePlayerList->getLocalPlayer()->getPlayerIndex() : 0;
-#if defined(RTS_DEBUG)
+#if ENABLE_CONFIGURABLE_SHROUD
 		ObjectShroudStatus ss = (!obj || !TheGlobalData->m_shroudOn) ? OBJECTSHROUD_CLEAR : obj->getShroudedStatus(localPlayerIndex);
 #else
 		ObjectShroudStatus ss = (!obj) ? OBJECTSHROUD_CLEAR : obj->getShroudedStatus(localPlayerIndex);

Generals/Code/GameEngineDevice/Source/W3DDevice/Common/System/W3DRadar.cpp

@@ -1263,7 +1263,7 @@ void W3DRadar::buildTerrainTexture( TerrainLogic *terrain )
 //-------------------------------------------------------------------------------------------------
 void W3DRadar::clearShroud()
 {
-#if defined(RTS_DEBUG)
+#if ENABLE_CONFIGURABLE_SHROUD
 	if (!TheGlobalData->m_shroudOn)
 		return;
 #endif
@@ -1283,7 +1283,7 @@ void W3DRadar::clearShroud()
 //-------------------------------------------------------------------------------------------------
 void W3DRadar::setShroudLevel(Int shroudX, Int shroudY, CellShroudStatus setting)
 {
-#if defined(RTS_DEBUG)
+#if ENABLE_CONFIGURABLE_SHROUD
 	if (!TheGlobalData->m_shroudOn)
 		return;
 #endif
@@ -1420,7 +1420,7 @@ void W3DRadar::draw( Int pixelX, Int pixelY, Int width, Int height )
  	TheDisplay->drawImage( m_overlayImage, ul.x, ul.y, lr.x, lr.y );
 
 	// draw the shroud image
-#if defined(RTS_DEBUG)
+#if ENABLE_CONFIGURABLE_SHROUD
 	if( TheGlobalData->m_shroudOn )
 #else
 	if (true)

Generals/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DScene.cpp

@@ -99,7 +99,7 @@ RTS3DScene::RTS3DScene()
 	m_scratchLight = NEW_REF( LightClass, (LightClass::DIRECTIONAL) );
 //	REF_PTR_SET(m_globalLight[lightIndex], pLight);
 
-#if defined(RTS_DEBUG)
+#if ENABLE_CONFIGURABLE_SHROUD
 	if (TheGlobalData->m_shroudOn)
 		m_shroudMaterialPass = NEW_REF(W3DShroudMaterialPassClass,());
 	else
@@ -753,7 +753,7 @@ void RTS3DScene::renderOneObject(RenderInfoClass &rinfo, RenderObjClass *robj, I
 
 		if (drawInfo)
 		{
-#if defined(RTS_DEBUG)
+#if ENABLE_CONFIGURABLE_SHROUD
 			if (!TheGlobalData->m_shroudOn)
 				ss = OBJECTSHROUD_CLEAR;
 #endif