feat(system): Prevent the system from sleeping or display from turning off while the game is busy in Windows OS

Author: xezon

GeneralsMD/Code/GameEngine/Include/Common/OSDisplay.h

@@ -63,4 +63,8 @@ enum OSDisplayOtherFlags CPP_11(: UnsignedInt)
 // This function will return the button pressed to close the dialog.
 OSDisplayButtonType OSDisplayWarningBox(AsciiString p, AsciiString m, UnsignedInt buttonFlags, UnsignedInt otherFlags);
 
+// TheSuperHackers @feature Tell the Operating System that the game is considered busy
+// and we would not like the display screen to shut off.
+void OSDisplaySetBusyState(Bool busy);
+
 #endif /* __OSDISPLAY_H__ */

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

@@ -183,6 +183,7 @@ class GameLogic : public SubsystemInterface, public Snapshot
 	Bool isInInternetGame( void );
 	Bool isInShellGame( void );
 	Bool isInMultiplayerGame( void );
+	Bool isInInteractiveGame() const;
 
 	static Bool isInInteractiveGame(GameMode mode) { return mode != GAME_NONE && mode != GAME_SHELL; }
 
@@ -420,6 +421,7 @@ inline GameMode GameLogic::getGameMode( void ) { return m_gameMode; }
 inline Bool GameLogic::isInLanGame( void ) { return (m_gameMode == GAME_LAN); }
 inline Bool GameLogic::isInSkirmishGame( void ) { return (m_gameMode == GAME_SKIRMISH); }
 inline Bool GameLogic::isInMultiplayerGame( void ) { return (m_gameMode == GAME_LAN) || (m_gameMode == GAME_INTERNET) ; }
+inline Bool GameLogic::isInInteractiveGame() const { return isInInteractiveGame(m_gameMode); }
 inline Bool GameLogic::isInReplayGame( void ) { return (m_gameMode == GAME_REPLAY); }
 inline Bool GameLogic::isInInternetGame( void ) { return (m_gameMode == GAME_INTERNET); }
 inline Bool GameLogic::isInShellGame( void ) { return (m_gameMode == GAME_SHELL); }

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

@@ -41,6 +41,7 @@
 #include "Common/LatchRestore.h"
 #include "Common/MapObject.h"
 #include "Common/MultiplayerSettings.h"
+#include "Common/OSDisplay.h"
 #include "Common/PerfTimer.h"
 #include "Common/Player.h"
 #include "Common/PlayerList.h"
@@ -1126,6 +1127,8 @@ void GameLogic::setGameMode( GameMode mode )
 	m_gameMode = mode;
 
 	TheMouse->onGameModeChanged(prev, mode);
+
+	OSDisplaySetBusyState(isInInteractiveGame() && !isGamePaused());
 }
 
 // ------------------------------------------------------------------------------------------------
@@ -4288,6 +4291,8 @@ void GameLogic::setGamePaused( Bool paused, Bool pauseMusic, Bool pauseInput )
 	pauseGameSound(paused);
 	pauseGameMusic(paused && pauseMusic);
 	pauseGameInput(paused && pauseInput);
+
+	OSDisplaySetBusyState(isInInteractiveGame() && !paused);
 }
 
 // ------------------------------------------------------------------------------------------------

GeneralsMD/Code/GameEngineDevice/Source/Win32Device/Common/Win32OSDisplay.cpp

@@ -123,3 +123,16 @@ OSDisplayButtonType OSDisplayWarningBox(AsciiString p, AsciiString m, UnsignedIn
 
 	return OSDBT_CANCEL;
 }
+
+//-------------------------------------------------------------------------------------------------
+void OSDisplaySetBusyState(Bool busy)
+{
+	if (busy)
+	{
+		::SetThreadExecutionState(ES_CONTINUOUS | ES_SYSTEM_REQUIRED | ES_DISPLAY_REQUIRED);
+	}
+	else
+	{
+		::SetThreadExecutionState(ES_CONTINUOUS);
+	}
+}