[GEN] Backport fast-forward of replays (TheSuperHackers#825)

Author: Bart Roossien

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

@@ -437,6 +437,8 @@ class GlobalData : public SubsystemInterface
 	Real				m_keyboardCameraRotateSpeed;    ///< How fast the camera rotates when rotated via keyboard controls.
   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) || defined(RTS_INTERNAL)
 	Bool m_wireframe;
 	Bool m_stateMachineDebug;

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

@@ -266,6 +266,8 @@ class GameMessage : public MemoryPoolObject
 		MSG_META_BEGIN_CAMERA_ZOOM_OUT,
 		MSG_META_END_CAMERA_ZOOM_OUT,
 		MSG_META_CAMERA_RESET,
+		MSG_META_TOGGLE_FAST_FORWARD_REPLAY,	      ///< Toggle the fast forward feature
+
 
 		// META items that are really for debug/demo/development use only...
 		// They do not get built into RELEASE builds.

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

@@ -667,19 +667,29 @@ void GameEngine::execute( void )
 					::Sleep(1); // give everyone else a tiny time slice.
 		#endif
 
-					// limit the framerate
-					DWORD now = timeGetTime();
-					DWORD limit = (1000.0f/m_maxFPS)-1;
-					while (TheGlobalData->m_useFpsLimit && (now - prevTime) < limit) 
-					{
-						::Sleep(0);
-						now = timeGetTime();
-					}
-					//Int slept = now - prevTime;
-					//DEBUG_LOG(("delayed %d\n",slept));
 
-					prevTime = now;
-				}
+		#if defined(_ALLOW_DEBUG_CHEATS_IN_RELEASE)
+          if ( ! TheGlobalData->m_TiVOFastMode )
+		#else	//always allow this cheatkey if we're in a replaygame.
+		  if ( ! (TheGlobalData->m_TiVOFastMode && TheGameLogic->isInReplayGame()))
+		#endif
+          {
+            // limit the framerate
+					  DWORD now = timeGetTime();
+					  DWORD limit = (1000.0f/m_maxFPS)-1;
+					  while (TheGlobalData->m_useFpsLimit && (now - prevTime) < limit) 
+					  {
+						  ::Sleep(0);
+						  now = timeGetTime();
+					  }
+					  //Int slept = now - prevTime;
+					  //DEBUG_LOG(("delayed %d\n",slept));
+
+					  prevTime = now;
+
+          }        
+        
+        }
 			}
 
 		}	// perfgather for execute_loop

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

@@ -543,6 +543,8 @@ GlobalData::GlobalData()
 		m_theOriginal = this;
 	m_next = NULL;
 
+	m_TiVOFastMode = FALSE;
+
 #if defined(RTS_DEBUG) || defined(RTS_INTERNAL)
 	m_wireframe = 0;
 	m_stateMachineDebug = FALSE;

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

@@ -364,6 +364,9 @@ AsciiString GameMessage::getCommandTypeAsAsciiString(GameMessage::Type t)
 	CHECK_IF(MSG_META_BEGIN_CAMERA_ZOOM_OUT)
 	CHECK_IF(MSG_META_END_CAMERA_ZOOM_OUT)
 	CHECK_IF(MSG_META_CAMERA_RESET)
+
+	CHECK_IF(MSG_META_TOGGLE_FAST_FORWARD_REPLAY)
+
 #if defined(RTS_DEBUG) || defined(RTS_INTERNAL)
 	CHECK_IF(MSG_META_DEMO_TOGGLE_BEHIND_BUILDINGS)
 	CHECK_IF(MSG_META_DEMO_TOGGLE_LETTERBOX)

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

@@ -3050,7 +3050,24 @@ GameMessageDisposition CommandTranslator::translateGameMessage(const GameMessage
 		case GameMessage::MSG_META_CAMERA_RESET:
 			TheInGameUI->resetCamera();
 			break;
-			
+		case GameMessage::MSG_META_TOGGLE_FAST_FORWARD_REPLAY:
+		{
+			if (TheGlobalData)
+			{
+#if !defined(_ALLOW_DEBUG_CHEATS_IN_RELEASE)//may be defined in GameCommon.h
+				if (TheGameLogic->isInReplayGame())
+#endif
+				{
+					TheWritableGlobalData->m_TiVOFastMode = 1 - TheGlobalData->m_TiVOFastMode;
+					TheInGameUI->message(UnicodeString(L"m_TiVOFastMode: %s"),
+						TheGlobalData->m_TiVOFastMode ? L"ON" : L"OFF");
+				}
+			}  // end if
+
+			disp = DESTROY_MESSAGE;
+			break;
+
+		}  // end toggle special power delays			
 		//-----------------------------------------------------------------------------------------
 		case GameMessage::MSG_META_BEGIN_FORCEMOVE:
 			DEBUG_ASSERTCRASH(!TheInGameUI->isInForceMoveToMode(), ("forceMoveToMode mismatch"));

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

@@ -171,6 +171,7 @@ static const LookupListRec GameMessageMetaTypeNames[] =
 	{ "BEGIN_CAMERA_ZOOM_OUT",										GameMessage::MSG_META_BEGIN_CAMERA_ZOOM_OUT },
 	{ "END_CAMERA_ZOOM_OUT",											GameMessage::MSG_META_END_CAMERA_ZOOM_OUT },
 	{ "CAMERA_RESET",															GameMessage::MSG_META_CAMERA_RESET },
+	{ "TOGGLE_FAST_FORWARD_REPLAY",              GameMessage::MSG_META_TOGGLE_FAST_FORWARD_REPLAY },
 
 #if defined(RTS_DEBUG) || defined(RTS_INTERNAL)
 	{ "HELP",																			GameMessage::MSG_META_HELP },
@@ -448,6 +449,27 @@ GameMessageDisposition MetaEventTranslator::translateGameMessage(const GameMessa
 				}
 				else
 				{
+
+					// THIS IS A GREASY HACK... MESSAGE SHOULD BE HANDLED IN A TRANSLATOR, BUT DURING CINEMATICS THE TRANSLATOR IS DISABLED
+					if (map->m_meta == GameMessage::MSG_META_TOGGLE_FAST_FORWARD_REPLAY)
+					{
+#if defined(_ALLOW_DEBUG_CHEATS_IN_RELEASE)//may be defined in GameCommon.h
+						if (TheGlobalData)
+#else
+						if (TheGlobalData && TheGameLogic->isInReplayGame())
+#endif
+						{
+							if (TheWritableGlobalData)
+								TheWritableGlobalData->m_TiVOFastMode = 1 - TheGlobalData->m_TiVOFastMode;
+
+							if (TheInGameUI)
+								TheInGameUI->message(TheGlobalData->m_TiVOFastMode ? "Fast Forward ON" : "Fast Forward OFF");
+						}
+						disp = KEEP_MESSAGE; // cause for goodness sake, this key gets used a lot by non-replay hotkeys
+						break;
+					}
+
+
 					/*GameMessage *metaMsg =*/ TheMessageStream->appendMessage(map->m_meta);
 					//DEBUG_LOG(("Frame %d: MetaEventTranslator::translateGameMessage() normal: %s\n", TheGameLogic->getFrame(), findGameMessageNameByType(map->m_meta)));
 				}

Generals/Code/GameEngine/Source/GameLogic/System/GameLogic.cpp

@@ -1036,6 +1036,7 @@ void GameLogic::startNewGame( Bool saveGame )
 	m_rankLevelLimit = 1000;	// this is reset every game.
 	setDefaults( saveGame );
 	TheWritableGlobalData->m_loadScreenRender = TRUE;	///< mark it so only a few select things are rendered during load	
+	TheWritableGlobalData->m_TiVOFastMode = FALSE;	//always disable the TIVO fast-forward mode at the start of a new game.
 
 	m_showBehindBuildingMarkers = TRUE;
 	m_drawIconUI = TRUE;

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

@@ -1761,6 +1761,11 @@ void W3DDisplay::draw( void )
 		Int numRenderTargetVertices=Debug_Statistics::Get_DX8_Vertices();
 
 		// start render block
+#if defined(_ALLOW_DEBUG_CHEATS_IN_RELEASE)
+		if ((TheGameLogic->getFrame() % 30 == 1) || (!(!TheGameLogic->isGamePaused() && TheGlobalData->m_TiVOFastMode)))
+#else
+		if ((TheGameLogic->getFrame() % 30 == 1) || (!(!TheGameLogic->isGamePaused() && TheGlobalData->m_TiVOFastMode && TheGameLogic->isInReplayGame())))
+#endif
 		{
 			//USE_PERF_TIMER(BigAssRenderLoop)
 			static Bool couldRender = true;