Implement graceful exit during loading and movie screens

Author: githubawn

Core/GameEngine/Source/GameClient/GUI/LoadScreen.cpp

@@ -68,13 +68,15 @@
 #include "GameClient/Display.h"
 #include "GameClient/GadgetProgressBar.h"
 #include "GameClient/GadgetStaticText.h"
+#include "GameClient/GameClient.h"
 #include "GameClient/GameText.h"
 #include "GameClient/GameWindowManager.h"
 #include "GameClient/GameWindowTransitions.h"
 #include "GameClient/Keyboard.h"
 #include "GameClient/LoadScreen.h"
 #include "GameClient/MapUtil.h"
 #include "GameClient/Mouse.h"
+#include "Common/MessageStream.h"
 #include "GameClient/Shell.h"
 #include "GameClient/VideoPlayer.h"
 #include "GameClient/WindowLayout.h"
@@ -157,7 +159,8 @@ LoadScreen::~LoadScreen( void )
 void LoadScreen::update( Int percent )
 {
 	TheGameEngine->serviceWindowsOS();
-	if (TheGameEngine->getQuitting())
+	TheMessageStream->propagateMessages();
+	if (TheGameEngine->getQuitting() || TheGameLogic->m_quitToDesktopAfterMatch)
 		return;	//don't bother with any of this if the player is exiting game.
 
 	TheWindowManager->update();
@@ -539,20 +542,11 @@ void SinglePlayerLoadScreen::init( GameInfo *game )
 		Int shiftedPercent = -FRAME_FUDGE_ADD + 1;
 		while (m_videoStream->frameIndex() < m_videoStream->frameCount() - 1 )
 		{
-			// TheSuperHackers @feature User can now skip video by pressing ESC
-			if (TheKeyboard)
+			if (TheGameClient->isMovieAbortRequested())
 			{
-				TheKeyboard->UPDATE();
-				KeyboardIO *io = TheKeyboard->findKey(KEY_ESC, KeyboardIO::STATUS_UNUSED);
-				if (io && BitIsSet(io->state, KEY_STATE_DOWN))
-				{
-					io->setUsed();
-					break;
-				}
+				break;
 			}
 
-			TheGameEngine->serviceWindowsOS();
-
 			if(!m_videoStream->isFrameReady())
 			{
 				Sleep(1);
@@ -634,6 +628,11 @@ void SinglePlayerLoadScreen::init( GameInfo *game )
 			fudgeFactor = 30 * ((currTime - begin)/ INT_TO_REAL(delay ));
 			GadgetProgressBarSetProgress(m_progressBar, fudgeFactor);
 
+			if (TheGameClient->isMovieAbortRequested())
+			{
+				break;
+			}
+
 			TheWindowManager->update();
 			TheDisplay->draw();
 			Sleep(100);
@@ -1054,20 +1053,11 @@ void ChallengeLoadScreen::init( GameInfo *game )
 		Int shiftedPercent = -FRAME_FUDGE_ADD + 1;
 		while (m_videoStream->frameIndex() < m_videoStream->frameCount() - 1 )
 		{
-			// TheSuperHackers @feature User can now skip video by pressing ESC
-			if (TheKeyboard)
+			if (TheGameClient->isMovieAbortRequested())
 			{
-				TheKeyboard->UPDATE();
-				KeyboardIO *io = TheKeyboard->findKey(KEY_ESC, KeyboardIO::STATUS_UNUSED);
-				if (io && BitIsSet(io->state, KEY_STATE_DOWN))
-				{
-					io->setUsed();
-					break;
-				}
+				break;
 			}
 
-			TheGameEngine->serviceWindowsOS();
-
 			if(!m_videoStream->isFrameReady())
 			{
 				Sleep(1);
@@ -1109,7 +1099,13 @@ void ChallengeLoadScreen::init( GameInfo *game )
 		// if we're min speced
 		m_videoStream->frameGoto(m_videoStream->frameCount()); // zero based
 		while(!m_videoStream->isFrameReady())
+		{
+			if (TheGameClient->isMovieAbortRequested())
+			{
+				break;
+			}
 			Sleep(1);
+		}
 		m_videoStream->frameDecompress();
 		m_videoStream->frameRender(m_videoBuffer);
 		if(m_videoBuffer)
@@ -1126,6 +1122,11 @@ void ChallengeLoadScreen::init( GameInfo *game )
 			fudgeFactor = 30 * ((currTime - begin)/ INT_TO_REAL(delay ));
 			GadgetProgressBarSetProgress(m_progressBar, fudgeFactor);
 
+			if (TheGameClient->isMovieAbortRequested())
+			{
+				break;
+			}
+
 			TheWindowManager->update();
 			TheDisplay->draw();
 			Sleep(100);

GeneralsMD/Code/GameEngine/Include/GameClient/GameClient.h

@@ -155,6 +155,8 @@ class GameClient : public SubsystemInterface,
 	void incrementRenderedObjectCount() { m_renderedObjectCount++; }
 	virtual void notifyTerrainObjectMoved(Object *obj) = 0;
 
+	virtual Bool isMovieAbortRequested( void );
+
 
 protected:
 

GeneralsMD/Code/GameEngine/Include/GameLogic/GameLogic.h

@@ -262,6 +262,8 @@ class GameLogic : public SubsystemInterface, public Snapshot
 	// this should be called only by UpdateModule, thanks.
 	void friend_awakenUpdateModule(Object* obj, UpdateModulePtr update, UnsignedInt whenToWakeUp);
 
+	Bool m_quitToDesktopAfterMatch;
+
 protected:
 
 	// snapshot methods
@@ -406,7 +408,6 @@ class GameLogic : public SubsystemInterface, public Snapshot
 	void xferObjectTOC( Xfer *xfer );												///< save/load object TOC for current state of map
 	void prepareLogicForObjectLoad( void );									///< prepare engine for object data from game file
 
-	Bool m_quitToDesktopAfterMatch;
 };
 
 // INLINE /////////////////////////////////////////////////////////////////////////////////////////

GeneralsMD/Code/GameEngine/Source/GameClient/GameClient.cpp

@@ -556,6 +556,11 @@ void GameClient::update( void )
 					Int beginTime = timeGetTime();
 					while(beginTime + 4000 > timeGetTime() )
 					{
+						if (TheGameClient->isMovieAbortRequested())
+						{
+							break;
+						}
+
 						TheWindowManager->update();
 						// redraw all views, update the GUI
 						TheDisplay->draw();
@@ -793,6 +798,33 @@ void GameClient::updateHeadless()
 	TheParticleSystemManager->reset();
 }
 
+	// TheSuperHackers Check if the user has requested to abort movie
+Bool GameClient::isMovieAbortRequested( void )
+{
+	// User can skip video by pressing ESC
+	if (TheKeyboard)
+	{
+		TheKeyboard->UPDATE();
+		KeyboardIO *io = TheKeyboard->findKey(KEY_ESC, KeyboardIO::STATUS_UNUSED);
+		if (io && BitIsSet(io->state, KEY_STATE_DOWN))
+		{
+			io->setUsed();
+			return TRUE;
+		}
+	}
+
+	// Service OS for Window Close / Alt-F4 events
+	TheGameEngine->serviceWindowsOS();
+	TheMessageStream->propagateMessages();
+	
+	if (TheGameEngine->getQuitting() || (TheGameLogic && TheGameLogic->m_quitToDesktopAfterMatch))
+	{
+		return TRUE;
+	}
+
+	return FALSE;
+}
+
 /** -----------------------------------------------------------------------------------------------
  * Call the given callback function for each object contained within the given region.
  */

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

@@ -5568,6 +5568,7 @@ static Bool isSystemMessage( const GameMessage *msg )
 		case GameMessage::MSG_LOGIC_CRC:
 		case GameMessage::MSG_SET_REPLAY_CAMERA:
 		case GameMessage::MSG_FRAME_TICK:
+		case GameMessage::MSG_META_DEMO_INSTANT_QUIT:
 			return TRUE;
 	}
 	return FALSE;

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

@@ -1055,6 +1055,8 @@ static void populateRandomStartPosition( GameInfo *game )
 	}
 }
 
+struct QuitGameException {};
+
 // ------------------------------------------------------------------------------------------------
 /** Update the load screen progress */
 // ------------------------------------------------------------------------------------------------
@@ -1064,6 +1066,10 @@ void GameLogic::updateLoadProgress( Int progress )
 	if( m_loadScreen )
 		m_loadScreen->update( progress );
 
+	if (TheGameEngine->getQuitting() || m_quitToDesktopAfterMatch)
+	{
+		throw QuitGameException();
+	}
 }
 
 // ------------------------------------------------------------------------------------------------
@@ -1105,6 +1111,8 @@ void GameLogic::setGameMode( GameMode mode )
 // ------------------------------------------------------------------------------------------------
 void GameLogic::startNewGame( Bool loadingSaveGame )
 {
+	try
+	{
 
 	#ifdef DUMP_PERF_STATS
 	__int64 startTime64;
@@ -2372,7 +2380,11 @@ void GameLogic::startNewGame( Bool loadingSaveGame )
 		TheInGameUI->messageNoFormat( TheGameText->FETCH_OR_SUBSTITUTE( "GUI:FastForwardInstructions", L"Press F to toggle Fast Forward" ) );
   }
 
-
+	}
+	catch (QuitGameException&)
+	{
+		// TheSuperHackers: The application is cleanly aborting the loading process.
+	}
 }
 
 //-----------------------------------------------------------------------------------------