Add variables to give more granular control of the geoscape time display & event queue

Author: BlackDog86

X2WOTCCommunityHighlander/Config/XComGame.ini

@@ -291,6 +291,13 @@ iMixedCharacterPoolChance = 50
 ;bForce24hClock = true
 ;bForce24hClockLeadingZero = true
 
+; Issue #1578 - Uncomment to force UTC Time with TimeZone Display, or only update the localized timezone when the skyranger takes off or lands 
+; Use bShowEventQueueWhileFlying to display the event queue on the geoscape at all times
+;bUseSourceTimeZoneWhenFlying = true
+;bUseDestinationTimeZoneWhenFlying = true
+;bForceUTCAtAllTimes = true
+;bShowEventQueueWhileFlying = true
+
 ;;; HL-Docs: ref:PositiveTraitUI
 ; Uncomment the following line to show UIAlerts at the end of a mission and on campaign start for all Traits instead of just the first one.
 ; bShowAllTraitAcquiredPopups = true

X2WOTCCommunityHighlander/Src/XComGame/Classes/CHHelpers.uc

@@ -276,6 +276,12 @@ var config bool InterruptionsTriggerGroupTurnBegunEvent;
 var config bool bForce24hClock;
 var config bool bForce24hclockLeadingZero;
 
+// Start Issue #1578 - Variables to adjust Geoscape behaviour when flying
+var config bool bUseSourceTimeZoneWhenFlying;
+var config bool bUseDestinationTimeZoneWhenFlying;
+var config bool bForceUTCAtAllTimes;
+var config bool bShowEventQueueWhileFlying;
+
 // Variable for Issue #1398 - Number of seconds to wait after a unit is killed before playing the 'OnSquadMemberDead' voiceline
 var config float fSquadMemberDeadVoicelineDelay;
 
@@ -1168,4 +1174,5 @@ static function bool GeoscapeReadyForUpdate()
 		StrategyMap != none &&
 		StrategyMap.m_eUIState != eSMS_Flight &&
 		StrategyMap.Movie.Pres.ScreenStack.GetCurrentScreen() == StrategyMap;
-}
+}
+

X2WOTCCommunityHighlander/Src/XComGame/Classes/UIEventQueue.uc

@@ -88,8 +88,8 @@ simulated function UpdateEventQueue(array<HQEvent> Events, bool bExpand, bool En
 	}
 
 	bIsInStrategyMap = `ScreenStack.IsInStack(class'UIStrategyMap');
-
-	if (Events.Length > 0 && !bIsInStrategyMap || (`HQPRES.StrategyMap2D != none && `HQPRES.StrategyMap2D.m_eUIState != eSMS_Flight))
+	// Single Line for Issue #1578 - Allow mods to display the event queue while flying
+	if (Events.Length > 0 && !bIsInStrategyMap || (`HQPRES.StrategyMap2D != none && (class'CHHelpers'.default.bShowEventQueueWhileFlying || `HQPRES.StrategyMap2D.m_eUIState != eSMS_Flight)))
 	{
 		if( bIsExpanded )
 		{
@@ -156,10 +156,15 @@ simulated function UpdateEventQueue(array<HQEvent> Events, bool bExpand, bool En
 }
 
 function RefreshDateTime()
-{
+{	
 	local TDateTime dateTimeData;
-	local string Hours, Minutes, Suffix;	
-	local XComGameState_HeadquartersXCom XComHQ;
+	local string Hours, Minutes, Suffix;
+	local XComGameState_HeadquartersXCom XComHQ;	
+	// Variables for Issue #1578 
+	local TDateTime UTCTimeData;
+	local string UTCHours, UTCMinutes, UTCSuffix;
+	local int timeZoneDifference;	
+	local XComGameState_GeoscapeEntity DestinationEntity;
 
 	if( `GAME.GetGeoscape() == none ) return; // stop log spam when in the shell testing. 
 
@@ -170,23 +175,67 @@ function RefreshDateTime()
 
 	//When showing time, either through time of day or the clock - always show local time
 	dateTimeData = `GAME.GetGeoscape().m_kDateTime;	
-	
-	//Don't adjust to local time while the base is in flight as it looks nicer for the clock to update smoothly
+	UTCTimeData = dateTimeData;
 	XComHQ = XComGameState_HeadquartersXCom(`XCOMHISTORY.GetSingleGameStateObjectForClass(class'XComGameState_HeadquartersXCom'));
-	if(!XComHQ.Flying)
+	
+	// Start Issue #1578
+	/// HL-Docs: feature:GeoscapeClockOptions; issue:1578; tags:strategy
+	/// Provide easily adjustable options for display of the Geoscape time by modders, to make the time display more intuitive 
+	/// when the skyranger is flying (in this case, options are: 1. The timezone is only updated when the avenger lands, 
+	/// 2. The timezone is updated only when the skyranger takes off, 3. Display UTC at all times and display the timezone 
+	/// difference on the clock UI.
+	if(!class'CHHelpers'.default.bForceUTCAtAllTimes)
+	{
+		// Base Game
+		if(!XComHQ.Flying)
+		{
+			class'X2StrategyGameRulesetDataStructures'.static.GetLocalizedTime(XComHQ.Get2DLocation(), dateTimeData);
+		}
+		// Option 1
+		else if(class'CHHelpers'.default.bUseSourceTimeZoneWhenFlying)
+		{
+			class'X2StrategyGameRulesetDataStructures'.static.GetLocalizedTime(XComHQ.SourceLocation, dateTimeData);
+		}
+		// Option 2
+		else if(class'CHHelpers'.default.bUseDestinationTimeZoneWhenFlying)
+		{
+			DestinationEntity = XComGameState_GeoscapeEntity(`XCOMHISTORY.GetGameStateForObjectID(XComHQ.SelectedDestination.ObjectID));
+			class'X2StrategyGameRulesetDataStructures'.static.GetLocalizedTime(DestinationEntity.Get2DLocation(), dateTimeData);
+		}
+		class'X2StrategyGameRulesetDataStructures'.static.GetTimeStringSeparated(dateTimeData, Hours, Minutes, Suffix);
+
+		MC.BeginFunctionOp("RefreshDateTime");
+		MC.QueueString(class'X2StrategyGameRulesetDataStructures'.static.GetDateString(dateTimeData));
+		//RED: //MC.QueueString(class'UIUtilities_Text'.static.GetColoredText(class'X2StrategyGameRulesetDataStructures'.static.GetTimeString(dateTimeData), eUIState_IsGeoscapePaused));
+		MC.QueueString(Hours);
+		MC.QueueString(Minutes);
+		MC.QueueString(Suffix);
+		MC.EndOp();
+	}
+	else
 	{
+		// Option 3
 		class'X2StrategyGameRulesetDataStructures'.static.GetLocalizedTime(XComHQ.Get2DLocation(), dateTimeData);
+		class'X2StrategyGameRulesetDataStructures'.static.GetTimeStringSeparated(UTCTimeData, UTCHours, UTCMinutes, UTCSuffix);		
+		timeZoneDifference = class'X2StrategyGameRulesetDataStructures'.static.GetHour(dateTimeData) - class'X2StrategyGameRulesetDataStructures'.static.GetHour(UTCTimeData);
+		
+		if (timeZoneDifference < -12)
+		{
+			timeZoneDifference += 24;
+		}
+		else if (timeZoneDifference > 12)
+		{
+			timeZoneDifference -= 24;
+		}
+
+		MC.BeginFunctionOp("RefreshDateTime");
+		MC.QueueString(class'X2StrategyGameRulesetDataStructures'.static.GetDateString(UTCTimeData));
+		MC.QueueString(UTCHours);
+		MC.QueueString(UTCMinutes);
+		MC.QueueString(timeZoneDifference >=0 ? "+" @ string(timeZoneDifference) : string(timeZoneDifference));
+		MC.EndOp();
 	}
-	
-	class'X2StrategyGameRulesetDataStructures'.static.GetTimeStringSeparated(dateTimeData, Hours, Minutes, Suffix);
-
-	MC.BeginFunctionOp("RefreshDateTime");
-	MC.QueueString(class'X2StrategyGameRulesetDataStructures'.static.GetDateString(dateTimeData));
-	//RED: //MC.QueueString(class'UIUtilities_Text'.static.GetColoredText(class'X2StrategyGameRulesetDataStructures'.static.GetTimeString(dateTimeData), eUIState_IsGeoscapePaused));
-	MC.QueueString(Hours);
-	MC.QueueString(Minutes);
-	MC.QueueString(Suffix);
-	MC.EndOp();
+	// End Issue #1578	
 }
 
 simulated function HideDateTime()

X2WOTCCommunityHighlander/Src/XComGame/Classes/X2StrategyGameRulesetDataStructures.uc

@@ -1571,7 +1571,7 @@ static function GetTimeStringSeparated(TDateTime kDateTime, out string Hours, ou
 	/// Allow forcing the 24h clock independently of locale and add an option to display leading zeroes for military-style time - e.g. 03:41 instead of 3:41
 
 	// INT and ESN use the 12 hour clock for events, checked with Loc 12/15/2015. -bsteiner 
-	if( !class'CHHelpers'.default.bForce24hclock && (Lang == "INT" || Lang == "ESN"))
+	if( !class'CHHelpers'.default.bForce24hclock && !class'CHHelpers'.default.bForceUTCAtAllTimes && (Lang == "INT" || Lang == "ESN"))
 	{		
 		// AM
 		if( iHour < 12 )
@@ -1853,12 +1853,12 @@ static function GetLocalizedTime( vector2d v2Loc, out TDateTime kDate )
 		iHourDiff -= iXMT;
 	}
 
-	AddTime(kDate, iHourDiff*60*60);
+		AddTime(kDate, iHourDiff*60*60);
 
-	if( kDate.m_fTime < 0 )
-	{
-		kDate.m_fTime += 24*60*60;
-	}
+		if( kDate.m_fTime < 0 )
+		{
+			kDate.m_fTime += 24*60*60;
+		}
 }
 
 //  Time has always been treated as GMT, but we adjust your base (visually) so that the game start at midnight "GMT" (let's call it XMT)