feat: Implement game exit with ALT+F4 and game window close button (TheSuperHackers#2336)

On Windows the user can press ALT+F4 or click the game window close button (X) to exit the game

Author: githubawn

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

@@ -60,6 +60,7 @@
 #include "Common/GameEngine.h"
 #include "Common/GameLOD.h"
 #include "Common/GameState.h"
+#include "Common/MessageStream.h"
 #include "Common/MultiplayerSettings.h"
 #include "Common/Player.h"
 #include "Common/PlayerList.h"
@@ -68,6 +69,7 @@
 #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"
@@ -157,7 +159,7 @@ LoadScreen::~LoadScreen()
 void LoadScreen::update( Int percent )
 {
 	TheGameEngine->serviceWindowsOS();
-	if (TheGameEngine->getQuitting())
+	if (TheGameEngine->getQuitting() || (TheGameLogic && TheGameLogic->isQuitToDesktopRequested()))
 		return;	//don't bother with any of this if the player is exiting game.
 
 	TheWindowManager->update();
@@ -539,20 +541,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 (GameClient::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 +627,11 @@ void SinglePlayerLoadScreen::init( GameInfo *game )
 			fudgeFactor = 30 * ((currTime - begin)/ INT_TO_REAL(delay ));
 			GadgetProgressBarSetProgress(m_progressBar, fudgeFactor);
 
+			if (GameClient::isMovieAbortRequested())
+			{
+				break;
+			}
+
 			TheWindowManager->update();
 			TheDisplay->draw();
 			Sleep(100);
@@ -1054,20 +1052,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 (GameClient::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 +1098,13 @@ void ChallengeLoadScreen::init( GameInfo *game )
 		// if we're min speced
 		m_videoStream->frameGoto(m_videoStream->frameCount()); // zero based
 		while(!m_videoStream->isFrameReady())
+		{
+			if (GameClient::isMovieAbortRequested())
+			{
+				return;
+			}
 			Sleep(1);
+		}
 		m_videoStream->frameDecompress();
 		m_videoStream->frameRender(m_videoBuffer);
 		if(m_videoBuffer)
@@ -1126,6 +1121,11 @@ void ChallengeLoadScreen::init( GameInfo *game )
 			fudgeFactor = 30 * ((currTime - begin)/ INT_TO_REAL(delay ));
 			GadgetProgressBarSetProgress(m_progressBar, fudgeFactor);
 
+			if (GameClient::isMovieAbortRequested())
+			{
+				break;
+			}
+
 			TheWindowManager->update();
 			TheDisplay->draw();
 			Sleep(100);

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

@@ -277,6 +277,7 @@ class GameMessage : public MemoryPoolObject
 		MSG_META_TOGGLE_PAUSE_ALT,									///< TheSuperHackers @feature Toggle game pause (alternative mapping)
 		MSG_META_STEP_FRAME,												///< TheSuperHackers @feature Step one frame
 		MSG_META_STEP_FRAME_ALT,										///< TheSuperHackers @feature Step one frame (alternative mapping)
+		MSG_META_DEMO_INSTANT_QUIT,									///< bail out of game immediately
 
 
 		// META items that are really for debug/demo/development use only...
@@ -289,7 +290,6 @@ class GameMessage : public MemoryPoolObject
 		MSG_META_DEMO_LOD_INCREASE,                 ///< increase LOD by 1
 		MSG_META_DEMO_TOGGLE_ZOOM_LOCK,							///< Toggle the camera zoom lock on/off
 		MSG_META_DEMO_PLAY_CAMEO_MOVIE,							///< Play a movie in the cameo spot
-		MSG_META_DEMO_INSTANT_QUIT,									///< bail out of game immediately
 		MSG_META_DEMO_TOGGLE_SPECIAL_POWER_DELAYS,	///< Toggle special power delays on/off
 		MSG_META_DEMO_BATTLE_CRY,										///< battle cry
 		MSG_META_DEMO_SWITCH_TEAMS,									///< switch local control to another team
@@ -725,6 +725,7 @@ class MessageStream : public GameMessageList
 
 	virtual GameMessage *appendMessage( GameMessage::Type type );		///< Append a message to the end of the stream
 	virtual GameMessage *insertMessage( GameMessage::Type type, GameMessage *messageToInsertAfter );	// Insert message after messageToInsertAfter.
+	virtual Bool isReadyForMessages() const;											///< Return true if a local player is present and ready to accept messages
 
 	// Methods NOT Inherited ------------------------------------------------------------------------
 	void propagateMessages();													///< Propagate messages through attached translators

Generals/Code/GameEngine/Include/GameClient/GUICallbacks.h

@@ -365,6 +365,7 @@ extern WindowMsgHandledType EstablishConnectionsControlInput( GameWindow *window
 
 // The in game quit menu --------------------------------------------------------------------------
 extern void destroyQuitMenu();
+extern Bool canOpenQuitMenu();
 extern void ToggleQuitMenu();
 extern void HideQuitMenu();
 extern WindowMsgHandledType QuitMenuSystem( GameWindow *window, UnsignedInt msg, WindowMsgData mData1, WindowMsgData mData2 );

Generals/Code/GameEngine/Include/GameClient/GameClient.h

@@ -150,6 +150,8 @@ class GameClient : public SubsystemInterface,
 	UnsignedInt getRenderedObjectCount() const { return m_renderedObjectCount; }
 	void incrementRenderedObjectCount() { m_renderedObjectCount++; }
 
+	static Bool isMovieAbortRequested();
+
 protected:
 
 	// snapshot methods

Generals/Code/GameEngine/Include/GameLogic/GameLogic.h

@@ -208,6 +208,7 @@ class GameLogic : public SubsystemInterface, public Snapshot
 	UnsignedInt getFrameObjectsChangedTriggerAreas() {return m_frameObjectsChangedTriggerAreas;}
 
 	void exitGame();
+	void quit(Bool toDesktop);
 	void clearGameData(Bool showScoreScreen = TRUE);														///< Clear the game data
 	void closeWindows();
 
@@ -255,6 +256,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 isQuitToDesktopRequested() const { return m_quitToDesktopAfterMatch; }
+
 protected:
 
 	// snapshot methods
@@ -264,6 +267,8 @@ class GameLogic : public SubsystemInterface, public Snapshot
 
 private:
 
+	void tryStartNewGame( Bool loadSaveGame );
+
 	void updateDisplayBusyState();
 
 	void pauseGameLogic(Bool paused);
@@ -308,6 +313,7 @@ class GameLogic : public SubsystemInterface, public Snapshot
 	Bool m_loadingMap;
 	Bool m_loadingSave;
 	Bool m_clearingGameData;
+	Bool m_quitToDesktopAfterMatch;
 
 	Bool m_isInUpdate;
 	Bool m_hasUpdated;

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

@@ -382,6 +382,7 @@ const char *GameMessage::getCommandTypeAsString(GameMessage::Type t)
 	CASE_LABEL(MSG_META_TOGGLE_PAUSE_ALT)
 	CASE_LABEL(MSG_META_STEP_FRAME)
 	CASE_LABEL(MSG_META_STEP_FRAME_ALT)
+	CASE_LABEL(MSG_META_DEMO_INSTANT_QUIT)
 
 #if defined(RTS_DEBUG)
 	CASE_LABEL(MSG_META_DEMO_TOGGLE_BEHIND_BUILDINGS)
@@ -391,7 +392,6 @@ const char *GameMessage::getCommandTypeAsString(GameMessage::Type t)
 	CASE_LABEL(MSG_META_DEMO_LOD_INCREASE)
 	CASE_LABEL(MSG_META_DEMO_TOGGLE_ZOOM_LOCK)
 	CASE_LABEL(MSG_META_DEMO_PLAY_CAMEO_MOVIE)
-	CASE_LABEL(MSG_META_DEMO_INSTANT_QUIT)
 	CASE_LABEL(MSG_META_DEMO_TOGGLE_SPECIAL_POWER_DELAYS)
 	CASE_LABEL(MSG_META_DEMO_BATTLE_CRY)
 	CASE_LABEL(MSG_META_DEMO_SWITCH_TEAMS)
@@ -845,6 +845,11 @@ void MessageStream::update()
 
 }
 
+Bool MessageStream::isReadyForMessages() const
+{
+	return (ThePlayerList != nullptr);
+}
+
 /**
  * Create a new message of the given message type and append it
  * to this message stream.  Return the message such that any data

Generals/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/QuitMenu.cpp

@@ -137,23 +137,9 @@ void destroyQuitMenu()
  */
 static void exitQuitMenu()
 {
+	TheGameLogic->quit(FALSE);
   // destroy the quit menu
 	destroyQuitMenu();
-
-	// clear out all the game data
-	if ( TheGameLogic->isInMultiplayerGame() && !TheGameLogic->isInSkirmishGame() && !TheGameInfo->isSandbox() )
-	{
-		GameMessage *msg = TheMessageStream->appendMessage(GameMessage::MSG_SELF_DESTRUCT);
-		msg->appendBooleanArgument(TRUE);
-	}
-	TheGameLogic->exitGame();
-	// TheGameLogic->clearGameData();
-	// display the menu on top of the shell stack
-  // TheShell->showShell();
-
-	// this will trigger an exit
-  // TheGameEngine->setQuitting( TRUE );
-	TheInGameUI->setClientQuiet( TRUE );
 }
 static void noExitQuitMenu()
 {
@@ -162,20 +148,9 @@ static void noExitQuitMenu()
 
 static void quitToDesktopQuitMenu()
 {
+	TheGameLogic->quit(TRUE);
   // destroy the quit menu
 	destroyQuitMenu();
-
-	if (TheGameLogic->isInGame())
-	{
-		if (TheRecorder->getMode() == RECORDERMODETYPE_RECORD)
-		{
-			TheRecorder->stopRecording();
-		}
-		TheGameLogic->clearGameData();
-	}
-	TheGameEngine->setQuitting(TRUE);
-	TheInGameUI->setClientQuiet( TRUE );
-
 }
 
 static void surrenderQuitMenu()
@@ -276,12 +251,23 @@ void HideQuitMenu()
 
 }
 
+Bool canOpenQuitMenu()
+{
+	return (TheGameEngine != nullptr && TheGameEngine->isActive() 
+		&& TheGameLogic != nullptr
+		&& (!TheInGameUI || !TheInGameUI->isQuitMenuVisible()) 
+		&& !TheGameLogic->isLoadingMap() 
+		&& !TheGameLogic->isLoadingSave() 
+		&& !TheGameLogic->isIntroMoviePlaying() 
+		&& (TheScriptEngine == nullptr || !TheScriptEngine->isGameEnding()));
+}
+
 //-------------------------------------------------------------------------------------------------
 /** Toggle visibility of the quit menu */
 //-------------------------------------------------------------------------------------------------
 void ToggleQuitMenu()
 {
-	if (TheGameLogic->isIntroMoviePlaying() || TheGameLogic->isLoadingMap() ||TheScriptEngine->isGameEnding())
+	if (!isVisible && !canOpenQuitMenu())
 		return;
 
 	// BGC- If we are currently in the disconnect screen, don't let the quit menu come up.

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

@@ -537,6 +537,11 @@ void GameClient::update()
 					Int beginTime = timeGetTime();
 					while(beginTime + 4000 > timeGetTime() )
 					{
+						if (GameClient::isMovieAbortRequested())
+						{
+							break;
+						}
+
 						TheWindowManager->update();
 						// redraw all views, update the GUI
 						TheDisplay->draw();
@@ -754,6 +759,43 @@ void GameClient::updateHeadless()
 	TheParticleSystemManager->update();
 }
 
+Bool GameClient::isMovieAbortRequested()
+{
+	if (TheGameEngine)
+	{
+		TheGameEngine->serviceWindowsOS();
+	}
+
+	// TheSuperHackers @feature 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;
+		}
+	}
+
+	if (TheGameEngine && TheGameEngine->getQuitting())
+	{
+		return TRUE;
+	}
+
+	if (TheMessageStream && TheMessageStream->containsMessageOfType(GameMessage::MSG_META_DEMO_INSTANT_QUIT))
+	{
+		return TRUE;
+	}
+
+	if (TheGameLogic && TheGameLogic->isQuitToDesktopRequested())
+	{
+		return TRUE;
+	}
+
+	return FALSE;
+}
+
 /** -----------------------------------------------------------------------------------------------
  * Call the given callback function for each object contained within the given region.
  */

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

@@ -3699,27 +3699,15 @@ GameMessageDisposition CommandTranslator::translateGameMessage(const GameMessage
 			break;
 
 		}
-
-
-#if defined(RTS_DEBUG)
-		//------------------------------------------------------------------------- BEGIN DEMO MESSAGES
-		//------------------------------------------------------------------------- BEGIN DEMO MESSAGES
-		//------------------------------------------------------------------------- BEGIN DEMO MESSAGES
-		//------------------------------------------------------------------------------- DEMO MESSAGES
-		//-----------------------------------------------------------------------------------------
+		
 		case GameMessage::MSG_META_DEMO_INSTANT_QUIT:
-			if (TheGameLogic->isInGame())
-			{
-				if (TheRecorder->getMode() == RECORDERMODETYPE_RECORD)
-				{
-					TheRecorder->stopRecording();
-				}
-				TheGameLogic->clearGameData();
-			}
-			TheGameEngine->setQuitting(TRUE);
+		{
+			TheGameLogic->quit(TRUE);
 			disp = DESTROY_MESSAGE;
 			break;
+		}
 
+#if defined(RTS_DEBUG)
 		//------------------------------------------------------------------------------- DEMO MESSAGES
 		//-----------------------------------------------------------------------------------------
 		case GameMessage::MSG_META_DEMO_SWITCH_TEAMS:
@@ -5054,6 +5042,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;

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

@@ -179,11 +179,10 @@ static const LookupListRec GameMessageMetaTypeNames[] =
 	{ "TOGGLE_PAUSE_ALT",													GameMessage::MSG_META_TOGGLE_PAUSE_ALT },
 	{ "STEP_FRAME",																GameMessage::MSG_META_STEP_FRAME },
 	{ "STEP_FRAME_ALT",														GameMessage::MSG_META_STEP_FRAME_ALT },
+	{ "DEMO_INSTANT_QUIT",												GameMessage::MSG_META_DEMO_INSTANT_QUIT },
 
 #if defined(RTS_DEBUG)
 	{ "HELP",																			GameMessage::MSG_META_HELP },
-	{ "DEMO_INSTANT_QUIT",												GameMessage::MSG_META_DEMO_INSTANT_QUIT },
-
 	{ "DEMO_TOGGLE_BEHIND_BUILDINGS",							GameMessage::MSG_META_DEMO_TOGGLE_BEHIND_BUILDINGS },
 	{ "DEMO_LOD_DECREASE",												GameMessage::MSG_META_DEMO_LOD_DECREASE },
 	{ "DEMO_LOD_INCREASE",												GameMessage::MSG_META_DEMO_LOD_INCREASE },