[ZH] Implement system time and simulation timer within InGameUI

Author: Mauller

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

@@ -284,6 +284,7 @@ class GlobalData : public SubsystemInterface
 	Bool m_constantDebugUpdate;		///< should we update the debug stats constantly, vs every 2 seconds?
 	Bool m_showTeamDot;						///< Shows the little colored team dot representing which team you are controlling.
 
+
 #ifdef DUMP_PERF_STATS
 	Bool m_dumpPerformanceStatistics;
   Bool  m_dumpStatsAtInterval;///< should I automatically dum stats every in N frames
@@ -409,6 +410,10 @@ class GlobalData : public SubsystemInterface
 	Bool m_saveCameraInReplay;
 	Bool m_useCameraInReplay;
 
+	// TheSuperHackers @feature Mauller 21/06/2025 allow the system time and game timer to be toggleable
+	Bool m_showSystemTime;
+	Bool m_showGameTime;
+
 	Real m_shakeSubtleIntensity;			///< Intensity for shaking a camera with SHAKE_SUBTLE
 	Real m_shakeNormalIntensity;			///< Intensity for shaking a camera with SHAKE_NORMAL
 	Real m_shakeStrongIntensity;			///< Intensity for shaking a camera with SHAKE_STRONG

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

@@ -129,6 +129,9 @@ class OptionPreferences : public UserPreferences
 
 	Int	 getCampaignDifficulty(void);
 	void setCampaignDifficulty( Int diff );
+
+	Bool getSystemTimeEnabled(void);
+	Bool getGameTimeEnabled(void);
 };
 
 //-----------------------------------------------------------------------------

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

@@ -382,6 +382,7 @@ friend class Drawable;	// for selection/deselection transactions
 	virtual void toggleMessages( void ) { m_messagesOn = 1 - m_messagesOn; }	///< toggle messages on/off
 	virtual Bool isMessagesOn( void ) { return m_messagesOn; }	///< are the display messages on
 	void freeMessageResources( void );				///< free resources for the ui messages
+	void freeCustomUiResources( void );				///< free resources for custom ui elements
 	Color getMessageColor(Bool altColor) { return (altColor)?m_messageColor2:m_messageColor1; }
 
 	// interface for military style messages
@@ -741,6 +742,25 @@ friend class Drawable;	// for selection/deselection transactions
 	VideoBuffer*								m_cameoVideoBuffer;///< video playback buffer
 	VideoStreamInterface*				m_cameoVideoStream;///< Video stream;
 
+	// System Time
+	DisplayString *										m_systemTimeString;
+	AsciiString											m_systemTimeFont;
+	Int													m_systemTimePointSize;
+	Bool												m_systemTimeBold;
+	Coord2D												m_systemTimePosition;
+	Color												m_systemTimeColor;
+	Color												m_systemTimeDropColor;
+
+	// Simulation Timer
+	DisplayString *										m_gameTimeString;
+	DisplayString *										m_gameTimeFrameString;
+	AsciiString											m_gameTimeFont;
+	Int													m_gameTimePointSize;
+	Bool												m_gameTimeBold;
+	Coord2D												m_gameTimePosition;
+	Color												m_gameTimeColor;
+	Color												m_gameTimeDropColor;
+
 	// message data
 	UIMessage										m_uiMessages[ MAX_UI_MESSAGES ];/**< messages to display to the user, the
 																						array is organized with newer messages at

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

@@ -928,6 +928,8 @@ GlobalData::GlobalData()
 	m_saveCameraInReplay = FALSE;
 	m_useCameraInReplay = FALSE;
 
+	m_showSystemTime = TRUE;
+	m_showGameTime = TRUE;
 
 	m_debugShowGraphicalFramerate = FALSE;
 
@@ -1263,6 +1265,9 @@ void GlobalData::parseGameDataDefinition( INI* ini )
 
 	TheWritableGlobalData->m_saveCameraInReplay = optionPref.saveCameraInReplays();
 	TheWritableGlobalData->m_useCameraInReplay = optionPref.useCameraInReplays();
+
+	TheWritableGlobalData->m_showSystemTime = optionPref.getSystemTimeEnabled();
+	TheWritableGlobalData->m_showGameTime = optionPref.getGameTimeEnabled();
 
 	Int val=optionPref.getGammaValue();
 	//generate a value between 0.6 and 2.0.

GeneralsMD/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/OptionsMenu.cpp

@@ -772,6 +772,32 @@ Real OptionPreferences::getMusicVolume(void)
 	return volume;
 }
 
+// TheSuperHackers @info Here for ini parsing and future use when the options menu is reworked to add new options
+Bool OptionPreferences::getSystemTimeEnabled(void)
+{
+	OptionPreferences::const_iterator it = find("SystemTimeEnabled");
+	if (it == end())
+		return TRUE;
+
+	if (stricmp(it->second.str(), "yes") == 0) {
+		return TRUE;
+	}
+	return FALSE;
+}
+
+// TheSuperHackers @info Here for ini parsing and future use when the options menu is reworked to add new options
+Bool OptionPreferences::getGameTimeEnabled(void)
+{
+	OptionPreferences::const_iterator it = find("GameTimerEnabled");
+	if (it == end())
+		return TRUE;
+
+	if (stricmp(it->second.str(), "yes") == 0) {
+		return TRUE;
+	}
+	return FALSE;
+}
+
 static OptionPreferences *pref = NULL;
 
 static void setDefaults( void )
@@ -1262,6 +1288,16 @@ static void saveOptions( void )
 		}
  	}
 
+	//-------------------------------------------------------------------------------------------------
+	// Show System Time
+
+	(*pref)["ShowSystemTime"] = TheWritableGlobalData->m_showSystemTime ? "yes" : "no";
+
+	//-------------------------------------------------------------------------------------------------
+	// Show Game Time
+
+	(*pref)["ShowGameTime"] = TheWritableGlobalData->m_showGameTime ? "yes" : "no";
+
 	//-------------------------------------------------------------------------------------------------
 	// Resolution
 	//

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

@@ -876,6 +876,21 @@ const FieldParse InGameUI::s_fieldParseTable[] =
 	{ "ClearMinesRadiusCursor",			RadiusDecalTemplate::parseRadiusDecalTemplate, NULL, offsetof( InGameUI, m_radiusCursors[ RADIUSCURSOR_CLEARMINES] ) },
 	{ "AmbulanceRadiusCursor",			RadiusDecalTemplate::parseRadiusDecalTemplate, NULL, offsetof( InGameUI, m_radiusCursors[ RADIUSCURSOR_AMBULANCE] ) },
 
+	// TheSuperHackers @info ui enhancement configuration
+	{ "SystemTimeFont",         INI::parseAsciiString,  NULL, offsetof( InGameUI, m_systemTimeFont ) },
+	{ "SystemTimePointSize",    INI::parseInt,          NULL, offsetof( InGameUI, m_systemTimePointSize ) },
+	{ "SystemTimeBold",         INI::parseBool,         NULL, offsetof( InGameUI, m_systemTimeBold ) },
+	{ "SystemTimePosition",     INI::parseCoord2D,      NULL, offsetof( InGameUI, m_systemTimePosition ) },
+	{ "SystemTimeColor",        INI::parseColorInt,     NULL, offsetof( InGameUI, m_systemTimeColor ) },
+	{ "SystemTimeDropColor",    INI::parseColorInt,     NULL, offsetof( InGameUI, m_systemTimeDropColor ) },
+
+	{ "GameTimeFont",           INI::parseAsciiString,  NULL, offsetof( InGameUI, m_gameTimeFont ) },
+	{ "GameTimePointSize",      INI::parseInt,          NULL, offsetof( InGameUI, m_gameTimePointSize ) },
+	{ "GameTimeBold",           INI::parseBool,         NULL, offsetof( InGameUI, m_gameTimeBold ) },
+	{ "GameTimePosition",       INI::parseCoord2D,      NULL, offsetof( InGameUI, m_gameTimePosition ) },
+	{ "GameTimeColor",          INI::parseColorInt,     NULL, offsetof( InGameUI, m_gameTimeColor ) },
+	{ "GameTimeDropColor",      INI::parseColorInt,     NULL, offsetof( InGameUI, m_gameTimeDropColor ) },
+
 	{ NULL,													NULL,										NULL,		0 }  // keep this last
 };
 
@@ -1001,6 +1016,25 @@ InGameUI::InGameUI()
 	m_replayWindow = NULL;
 	m_messagesOn = TRUE;
 
+	m_systemTimeString = NULL;
+	m_systemTimeFont = "Tahoma";
+	m_systemTimePointSize = 8;
+	m_systemTimeBold = TRUE;
+	m_systemTimePosition.x = 3; // TheSuperHackers @info relative to the left of the screen
+	m_systemTimePosition.y = -1;
+	m_systemTimeColor = GameMakeColor( 255, 255, 255, 255 );
+	m_systemTimeDropColor = GameMakeColor( 0, 0, 0, 255 );
+
+	m_gameTimeString = NULL;
+	m_gameTimeFrameString = NULL;
+	m_gameTimeFont = "Tahoma";
+	m_gameTimePointSize = 8;
+	m_gameTimeBold = TRUE;
+	m_gameTimePosition.x = 3; // TheSuperHackers @info relative to the right of the screen
+	m_gameTimePosition.y = -1;
+	m_gameTimeColor = GameMakeColor( 255, 255, 255, 255 );
+	m_gameTimeDropColor = GameMakeColor( 0, 0, 0, 255 );
+
 	m_superweaponPosition.x = 0.7f;
 	m_superweaponPosition.y = 0.7f;
 	m_superweaponFlashDuration = 1.0f;
@@ -1082,6 +1116,9 @@ InGameUI::~InGameUI()
 	// delete the message resources
 	freeMessageResources();
 
+	// free custom ui strings
+	freeCustomUiResources();
+
 	// delete the array for the drawbles
 	delete [] m_placeIcon;
 	m_placeIcon = NULL;
@@ -1924,6 +1961,9 @@ void InGameUI::reset( void )
 	// free any message resources allocated
 	freeMessageResources();
 
+	// free custom ui strings
+	freeCustomUiResources();
+
 	Int i;
 	for (i=0; i<MAX_PLAYER_COUNT; ++i)
 	{
@@ -2009,6 +2049,19 @@ void InGameUI::freeMessageResources( void )
 
 }  // end freeMessageResources
 
+void InGameUI::freeCustomUiResources( void )
+{
+
+	// release system time and game timer strings then set them to empty
+	TheDisplayStringManager->freeDisplayString(m_systemTimeString);
+	m_systemTimeString = NULL;
+	TheDisplayStringManager->freeDisplayString(m_gameTimeString);
+	m_gameTimeString = NULL;
+	TheDisplayStringManager->freeDisplayString(m_gameTimeFrameString);
+	m_gameTimeFrameString = NULL;
+
+}  // end freeCustomUiResources
+
 //-------------------------------------------------------------------------------------------------
 /** Same as the unicode message method, but this takes an ascii string which is assumed
 	* to me a string manager label */
@@ -3465,6 +3518,64 @@ void InGameUI::disregardDrawable( Drawable *draw )
 void InGameUI::postDraw( void )
 {
 
+	// TheSuperHackers @info render the system time and game timer first, this way other text will render over them if they overlap
+	if (TheGlobalData->m_showSystemTime)
+	{
+		if (!m_systemTimeString) {
+			m_systemTimeString = TheDisplayStringManager->newDisplayString();
+		}
+
+		// current system time
+		SYSTEMTIME systemTime;
+		GetLocalTime( &systemTime );
+
+        UnicodeString TimeString;
+        TimeString.format(L"%2.2d:%2.2d:%2.2d", systemTime.wHour, systemTime.wMinute, systemTime.wSecond);
+		Int adjustedSystemTimeFontSize = TheGlobalLanguageData->adjustFontSize(m_systemTimePointSize);
+		GameFont* systemTimeFont = TheWindowManager->winFindFont(m_systemTimeFont, adjustedSystemTimeFontSize, m_systemTimeBold);
+		m_systemTimeString->setFont(systemTimeFont);
+        m_systemTimeString->setText(TimeString);
+
+		m_systemTimeString->draw(m_systemTimePosition.x, m_systemTimePosition.y, m_systemTimeColor, m_systemTimeDropColor);
+	}
+
+	if (TheGlobalData->m_showGameTime && !TheGameLogic->isInShellGame())
+	{
+		if (!m_gameTimeString) {
+			m_gameTimeString = TheDisplayStringManager->newDisplayString();
+		}
+
+		if (!m_gameTimeFrameString) {
+			m_gameTimeFrameString = TheDisplayStringManager->newDisplayString();
+		}
+
+		Int currentFrame = TheGameLogic->getFrame();
+		Int gameSeconds = (Int) (SECONDS_PER_LOGICFRAME_REAL * currentFrame );
+		Int hours = gameSeconds / 60 / 60;
+		Int minutes = (gameSeconds / 60) % 60;
+		Int seconds = gameSeconds % 60;
+		Int frame = currentFrame % 30;
+
+        UnicodeString gameTimeString;
+        gameTimeString.format(L"%2.2d:%2.2d:%2.2d", hours, minutes, seconds);
+		Int adjustedGameTimeFontSize = TheGlobalLanguageData->adjustFontSize(m_gameTimePointSize);
+		GameFont* gameTimeFont = TheWindowManager->winFindFont(m_gameTimeFont, adjustedGameTimeFontSize, m_gameTimeBold);
+		m_gameTimeString->setFont(gameTimeFont);
+        m_gameTimeString->setText(gameTimeString);
+
+		UnicodeString gameTimeFrameString;
+        gameTimeFrameString.format(L".%2.2d", frame);
+		m_gameTimeFrameString->setFont(gameTimeFont);
+        m_gameTimeFrameString->setText(gameTimeFrameString);
+
+		// TheSuperHackers @info this implicitly offsets the game timer from the right instead of left of the screen
+		int horizontalTimerOffset = TheDisplay->getWidth() - (Int)m_gameTimePosition.x - m_gameTimeString->getWidth() - m_gameTimeFrameString->getWidth();
+		int horizontalFrameOffset = TheDisplay->getWidth() - (Int)m_gameTimePosition.x - m_gameTimeFrameString->getWidth();
+
+		m_gameTimeString->draw(horizontalTimerOffset, m_gameTimePosition.y, m_gameTimeColor, m_gameTimeDropColor);
+		m_gameTimeFrameString->draw(horizontalFrameOffset, m_gameTimePosition.y, GameMakeColor(180,180,180,255), m_gameTimeDropColor);
+	}
+
 	// render our display strings for the messages if on
 	if( m_messagesOn )
 	{