[ZH] Implement system time and simulation timer within InGameUI

Author: Mauller

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

@@ -124,6 +124,11 @@ class GlobalData : public SubsystemInterface
 	// Run game without graphics, input or audio.
 	Bool m_headless;
 
+	// TheSuperHAckers @feature Mauller 21/06/2025
+	// Allow the system time and sim timer to be toggleable
+	Bool m_showSystemTime;
+	Bool m_showSimulationTimer;
+
 	Bool m_windowed;
 	Int m_xResolution;
 	Int m_yResolution;

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

@@ -129,6 +129,10 @@ class OptionPreferences : public UserPreferences
 
 	Int	 getCampaignDifficulty(void);
 	void setCampaignDifficulty( Int diff );
+
+	// TheSuperHackers @feature Mauller 21/06/2025
+	Bool getSystemTimeEnabled(void);
+	Bool getSimulationTimerEnabled(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,24 @@ 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_simulationTimerString;
+	AsciiString											m_simulationTimerFont;
+	Int													m_simulationTimerPointSize;
+	Bool												m_simulationTimerBold;
+	Coord2D												m_simulationTimerPosition;
+	Color												m_simulationTimerColor;
+	Color												m_simulationTimerDropColor;
+
 	// 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

@@ -614,6 +614,8 @@ GlobalData::GlobalData()
 	m_framesPerSecondLimit = 0;
 	m_chipSetType = 0;
 	m_headless = FALSE;
+	m_showSystemTime = TRUE;
+	m_showSimulationTimer = TRUE;
 	m_windowed = 0;
 	m_xResolution = 800;
 	m_yResolution = 600;
@@ -1282,5 +1284,9 @@ void GlobalData::parseGameDataDefinition( INI* ini )
 
 	TheWritableGlobalData->m_xResolution = xres;
 	TheWritableGlobalData->m_yResolution = yres;
+
+	// TheSuperHacker @info parse new settings
+	TheWritableGlobalData->m_showSystemTime = optionPref.getSystemTimeEnabled();
+	TheWritableGlobalData->m_showSimulationTimer = optionPref.getSimulationTimerEnabled();
 }
 

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 TheGlobalData->m_showSystemTime;
+
+	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::getSimulationTimerEnabled(void)
+{
+	OptionPreferences::const_iterator it = find("SimulationTimerEnabled");
+	if (it == end())
+		return TheGlobalData->m_showSimulationTimer;
+
+	if (stricmp(it->second.str(), "yes") == 0) {
+		return TRUE;
+	}
+	return FALSE;
+}
+
 static OptionPreferences *pref = NULL;
 
 static void setDefaults( void )

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 ) },
+
+	{ "SimulationTimerFont",			INI::parseAsciiString,	NULL, offsetof( InGameUI, m_simulationTimerFont ) },
+	{ "SimulationTimerPointSize",		INI::parseInt,			NULL, offsetof( InGameUI, m_simulationTimerPointSize ) },
+	{ "SimulationTimerBold",			INI::parseBool,			NULL, offsetof( InGameUI, m_simulationTimerBold ) },
+	{ "SimulationTimerPosition",		INI::parseCoord2D,		NULL, offsetof( InGameUI, m_simulationTimerPosition ) },
+	{ "SimulationTimerColor",			INI::parseColorInt,		NULL, offsetof( InGameUI, m_simulationTimerColor ) },
+	{ "SimulationTimerDropColor",		INI::parseColorInt,		NULL, offsetof( InGameUI, m_simulationTimerDropColor ) },
+
 	{ NULL,													NULL,										NULL,		0 }  // keep this last
 };
 
@@ -1001,6 +1016,24 @@ InGameUI::InGameUI()
 	m_replayWindow = NULL;
 	m_messagesOn = TRUE;
 
+	m_systemTimeString = NULL;
+	m_systemTimeFont = "Tahoma";
+	m_systemTimePointSize = 8;
+	m_systemTimeBold = FALSE;
+	m_systemTimePosition.x = 5; // TheSuperHackers @info relative to the left of the screen
+	m_systemTimePosition.y = 0;
+	m_systemTimeColor = GameMakeColor( 255, 255, 255, 255 );
+	m_systemTimeDropColor = GameMakeColor( 0, 0, 0, 255 );
+
+	m_simulationTimerString = NULL;
+	m_simulationTimerFont = "Tahoma";
+	m_simulationTimerPointSize = 8;
+	m_simulationTimerBold = FALSE;
+	m_simulationTimerPosition.x = 5; // TheSuperHackers @info relative to the right of the screen
+	m_simulationTimerPosition.y = 0;
+	m_simulationTimerColor = GameMakeColor( 255, 255, 255, 255 );
+	m_simulationTimerDropColor = GameMakeColor( 0, 0, 0, 255 );
+
 	m_superweaponPosition.x = 0.7f;
 	m_superweaponPosition.y = 0.7f;
 	m_superweaponFlashDuration = 1.0f;
@@ -1082,6 +1115,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 +1960,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)
 	{
@@ -2007,8 +2046,25 @@ void InGameUI::freeMessageResources( void )
 
 	}  // end for i
 
+	// release system time and simulation timer strings then set them to empty
+	TheDisplayStringManager->freeDisplayString(m_systemTimeString);
+	m_systemTimeString = NULL;
+	TheDisplayStringManager->freeDisplayString(m_simulationTimerString);
+	m_simulationTimerString = NULL;
+
 }  // end freeMessageResources
 
+void InGameUI::freeCustomUiResources( void )
+{
+
+	// release system time and simulation timer strings then set them to empty
+	TheDisplayStringManager->freeDisplayString(m_systemTimeString);
+	m_systemTimeString = NULL;
+	TheDisplayStringManager->freeDisplayString(m_simulationTimerString);
+	m_simulationTimerString = 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 +3521,53 @@ void InGameUI::disregardDrawable( Drawable *draw )
 void InGameUI::postDraw( void )
 {
 
+	// TheSuperHackers @info render the system time and simulation timer first, this way other text will render over them if they overlap
+	// draw the current system time
+	if (TheGlobalData->m_showSystemTime && !TheGameLogic->isInShellGame())
+	{
+		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);
+		m_systemTimeString->setFont(TheWindowManager->winFindFont( m_systemTimeFont,
+			TheGlobalLanguageData->adjustFontSize(m_systemTimePointSize), m_systemTimeBold ));
+        m_systemTimeString->setText(TimeString);
+
+		m_systemTimeString->draw(m_systemTimePosition.x, m_systemTimePosition.y, m_systemTimeColor, m_systemTimeDropColor);
+	}
+
+	// draw the simulation timer
+	if (TheGlobalData->m_showSimulationTimer && !TheGameLogic->isInShellGame())
+	{
+		if (!m_simulationTimerString) {
+			m_simulationTimerString = TheDisplayStringManager->newDisplayString();
+		}
+
+		Int currentFrame = TheGameLogic->getFrame();
+		Int currentSimulationTime = (Int) (SECONDS_PER_LOGICFRAME_REAL * currentFrame );
+		Int hours = currentSimulationTime / 3600;
+		Int minutes = (currentSimulationTime / 60) - (hours * 60);
+		Int seconds = currentSimulationTime - (minutes * 60) - (hours * 3600);
+		Int frame = currentFrame % 30;
+
+        UnicodeString simulationTimeString;
+        simulationTimeString.format(L"%2.2d:%2.2d:%2.2d.%2.2d", hours, minutes, seconds, frame);
+		m_simulationTimerString->setFont(TheWindowManager->winFindFont( m_simulationTimerFont,
+			TheGlobalLanguageData->adjustFontSize(m_simulationTimerPointSize), m_simulationTimerBold ));
+        m_simulationTimerString->setText(simulationTimeString);
+
+		// TheSuperHackers @info this implicitly offsets the simulation timer from the right instead of left of the screen
+		int horizontalOffset = TheDisplay->getWidth() - (Int)m_simulationTimerPosition.x - m_simulationTimerString->getWidth();
+
+		m_simulationTimerString->draw(horizontalOffset, m_simulationTimerPosition.y, m_simulationTimerColor, m_simulationTimerDropColor);
+	}
+
 	// render our display strings for the messages if on
 	if( m_messagesOn )
 	{