[Vanilla Enhancement] Task subtitles display in the middle of the screen (#1737)

- Now you can set `MessageApplyHoverState` to true，to make the upper
left messages not disappear while mouse hovering over the top of display
area.
- You can also let task subtitles (created by trigger 11) to display
directly in the middle area of the screen instead of the upper left
corner, with a semi transparent background, by setting
`MessageDisplayInCenter` to true.
- When the mouse hovers over the subtitle area (simply judged as a
rectangle), its opacity will increase and it will not disappear during
this period.

In `RA2MD.INI`:
```ini
[Phobos]
MessageApplyHoverState=false  ; boolean
MessageDisplayInCenter=false  ; boolean
```

---

I'm not sure if there is a better implementation, but it's the simplest
implementation that comes to my mind.

Author: CrimRecya

CREDITS.md

@@ -500,6 +500,7 @@ This page lists all the individual contributions to the project by their author.
   - Several new Infotypes, no display in specific status and a new single frame display method
   - Customizable spawn delay of `VoxelAnim`'s `TrailerAnim` and fix its incorrect position
   - Add `DebrisMinimums` to keep the count of debris within a certain range
+  - Task subtitles display in the middle of the screen
 - **Ollerus**:
   - Build limit group enhancement
   - Customizable rocker amplitude

Phobos.vcxproj

@@ -189,6 +189,7 @@
     <ClCompile Include="src\Misc\Hooks.INIInheritance.cpp" />
     <ClCompile Include="src\Misc\Hooks.SkirmishColors.cpp" />
     <ClCompile Include="src\Misc\Hooks.Overlay.cpp" />
+    <ClCompile Include="src\Misc\Hooks.Message.cpp" />
     <ClCompile Include="src\New\Type\Affiliated\TypeConvertGroup.cpp" />
     <ClCompile Include="src\Ext\BuildingType\Hooks.Upgrade.cpp" />
     <ClCompile Include="src\Phobos.COM.cpp" />

docs/User-Interface.md

@@ -368,7 +368,23 @@ ShowTimer=yes
 ShowTimer.Priority=0  ; integer
 ```
 
+### Task subtitles display in the middle of the screen
+
+![Message Display In Center](_static/images/messagedisplayincenter.png)
+
+- Now you can set `MessageApplyHoverState` to true，to make the upper left messages not disappear while mouse hovering over the top of display area.
+- You can also let task subtitles (created by trigger 11) to display directly in the middle area of the screen instead of the upper left corner, with a semi transparent background, by setting `MessageDisplayInCenter` to true.
+  - When the mouse hovers over the subtitle area (simply judged as a rectangle), its opacity will increase and it will not disappear during this period.
+
+In `RA2MD.INI`:
+```ini
+[Phobos]
+MessageApplyHoverState=false  ; boolean
+MessageDisplayInCenter=false  ; boolean
+```
+
 ### Type select for buildings
+
 - In vanilla game, type select can almost only be used on 1x1 buildings with `UndeploysInto`. Now it's possible to use it on all buildings if `BuildingTypeSelectable` set to true.
 
 In `rulesmd.ini`:

docs/Whats-New.md

@@ -410,6 +410,7 @@ New:
 - Several attackmove related enhancement (by TaranDahl)
 - Ground line for select box (by NetsuNegi)
 - Support for more optional weapons (by FlyStar)
+- Task subtitles display in the middle of the screen (by CrimRecya)
 
 Vanilla fixes:
 - Fixed sidebar not updating queued unit numbers when adding or removing units when the production is on hold (by CrimRecya)

docs/_static/images/messagedisplayincenter.png

@@ -163,6 +163,7 @@ void ScenarioExt::ExtData::Serialize(T& Stm)
 		.Process(this->TransportReloaders)
 		.Process(this->SWSidebar_Enable)
 		.Process(this->SWSidebar_Indices)
+//		.Process(this->NewMessageList); // Should not S/L
 		;
 }
 

src/Ext/Scenario/Body.cpp

@@ -1,6 +1,7 @@
 #pragma once
 
 #include <ScenarioClass.h>
+#include <MessageListClass.h>
 
 #include <Helpers/Macro.h>
 #include <Utilities/Container.h>
@@ -39,6 +40,8 @@ class ScenarioExt
 		bool SWSidebar_Enable;
 		std::vector<int> SWSidebar_Indices;
 
+		std::unique_ptr<MessageListClass> NewMessageList;
+
 		ExtData(ScenarioClass* OwnerObject) : Extension<ScenarioClass>(OwnerObject)
 			, ShowBriefing { false }
 			, BriefingTheme { -1 }
@@ -48,6 +51,7 @@ class ScenarioExt
 			, TransportReloaders {}
 			, SWSidebar_Enable { true }
 			, SWSidebar_Indices {}
+			, NewMessageList {}
 		{ }
 
 		void SetVariableToByID(bool bIsGlobal, int nIndex, char bState);

src/Ext/Scenario/Body.h

@@ -0,0 +1,171 @@
+#include <MessageListClass.h>
+#include <WWMouseClass.h>
+
+#include <Ext/Scenario/Body.h>
+
+namespace MessageTemp
+{
+	bool OnOldMessages = false;
+	bool OnNewMessages = false;
+	bool NewMessageList = false;
+}
+
+static inline bool MouseIsOverOldMessageLists()
+{
+	const auto pMousePosition = &WWMouseClass::Instance->XY1;
+	const auto pMessages = &MessageListClass::Instance;
+
+	if (TextLabelClass* pText = pMessages->MessageList)
+	{
+		const int textHeight = pMessages->Height;
+		int height = pMessages->MessagePos.Y;
+
+		for ( ; pText; pText = static_cast<TextLabelClass*>(pText->GetNext()))
+			height += textHeight;
+
+		if (pMousePosition->Y < (height + 2))
+			return true;
+	}
+
+	return false;
+}
+
+static inline bool MouseIsOverNewMessageLists()
+{
+	const auto pMousePosition = &WWMouseClass::Instance->XY1;
+
+	if (const auto pMessages = ScenarioExt::Global()->NewMessageList.get())
+	{
+		if (TextLabelClass* pText = pMessages->MessageList)
+		{
+			if (pMousePosition->Y >= pMessages->MessagePos.Y
+				&& pMousePosition->X >= pMessages->MessagePos.X
+				&& pMousePosition->X <= pMessages->MessagePos.X + pMessages->Width)
+			{
+				const int textHeight = pMessages->Height;
+				int height = pMessages->MessagePos.Y;
+
+				for ( ; pText; pText = static_cast<TextLabelClass*>(pText->GetNext()))
+					height += textHeight;
+
+				if (pMousePosition->Y < (height + 2))
+					return true;
+			}
+		}
+	}
+
+	return false;
+}
+
+DEFINE_HOOK(0x69300B, ScrollClass_MouseUpdate_NewMessageListCheck, 0x6)
+{
+	if (Phobos::Config::MessageApplyHoverState)
+		MessageTemp::OnOldMessages = MouseIsOverOldMessageLists();
+
+	if (Phobos::Config::MessageDisplayInCenter)
+		MessageTemp::OnNewMessages = MouseIsOverNewMessageLists();
+
+	return 0;
+}
+
+DEFINE_HOOK(0x4F4583, GScreenClass_NewMessageListDraw, 0x6)
+{
+	MessageTemp::NewMessageList = true;
+
+	if (const auto pList = ScenarioExt::Global()->NewMessageList.get())
+		pList->Draw();
+
+	MessageTemp::NewMessageList = false;
+
+	return 0;
+}
+
+DEFINE_HOOK(0x55DDA0, MainLoop_FrameStep_NewMessageListManage, 0x5)
+{
+	enum { SkipGameCode = 0x55DDAA };
+
+	if (!Phobos::Config::MessageApplyHoverState || !MessageTemp::OnOldMessages)
+		MessageListClass::Instance.Manage();
+
+	if (!MessageTemp::OnNewMessages)
+	{
+		if (const auto pList = ScenarioExt::Global()->NewMessageList.get())
+			pList->Manage();
+	}
+
+	return SkipGameCode;
+}
+
+DEFINE_HOOK(0x6DE11D, TActionClass_Execute_AddMessageInCenter, 0x5)
+{
+	enum { SkipGameCode = 0x6DE122 };
+
+	if (const auto pList = ScenarioExt::Global()->NewMessageList.get())
+		R->ECX(pList);
+	else // !Phobos::Config::MessageDisplayInCenter
+		R->ECX(&MessageListClass::Instance);
+
+	return SkipGameCode;
+}
+
+DEFINE_HOOK(0x4A8BCE, DisplayClass_Set_View_Dimensions, 0x5)
+{
+	if (Phobos::Config::MessageDisplayInCenter)
+	{
+		const auto& pScenarioExt = ScenarioExt::Global();
+
+		if (!pScenarioExt->NewMessageList) // Load game
+			pScenarioExt->NewMessageList = std::make_unique<MessageListClass>();
+
+		const auto& rect = DSurface::ViewBounds;
+		const auto sideWidth = rect.Width / 6;
+		const auto width = rect.Width - (sideWidth * 2);
+		const auto pList = pScenarioExt->NewMessageList.get();
+
+		// Except for X and Y, they are all original values
+		pList->Init((rect.X + sideWidth), (rect.Height - rect.Height / 8 - 120), 6, 98, 18, -1, -1, 0, 20, 98, width);
+		pList->SetWidth(width);
+	}
+
+	return 0;
+}
+
+DEFINE_HOOK(0x684AD3, UnknownClass_sub_684620_InitMessageList, 0x5)
+{
+	if (Phobos::Config::MessageDisplayInCenter)
+	{
+		const auto& pScenarioExt = ScenarioExt::Global();
+
+		if (!pScenarioExt->NewMessageList) // Start game
+			pScenarioExt->NewMessageList = std::make_unique<MessageListClass>();
+
+		const auto& rect = DSurface::ViewBounds;
+		const auto sideWidth = rect.Width / 6;
+		const auto width = rect.Width - (sideWidth * 2);
+		const auto pList = pScenarioExt->NewMessageList.get();
+
+		// Except for X and Y, they are all original values
+		pList->Init((rect.X + sideWidth), (rect.Height - rect.Height / 8 - 120), 6, 98, 18, -1, -1, 0, 20, 98, width);
+	}
+
+	return 0;
+}
+
+DEFINE_HOOK(0x623A9F, DSurface_sub_623880_DrawBitFontStrings, 0x5)
+{
+	if (!MessageTemp::NewMessageList)
+		return 0;
+
+	enum { SkipGameCode = 0x623AAB };
+
+	GET(RectangleStruct* const, pRect, EAX);
+	GET(DSurface* const, pSurface, ECX);
+	GET(const int, height, EBP);
+
+	pRect->Height = height;
+	auto black = ColorStruct { 0, 0, 0 };
+	auto trans = (MessageTemp::OnNewMessages || ScenarioClass::Instance->UserInputLocked) ? 80 : 40;
+	pSurface->FillRectTrans(pRect, &black, trans);
+
+	return SkipGameCode;
+}

src/Misc/Hooks.Message.cpp

@@ -53,6 +53,8 @@ bool Phobos::Config::ArtImageSwap = false;
 bool Phobos::Config::ShowPlacementPreview = false;
 bool Phobos::Config::EnableSelectBox = false;
 bool Phobos::Config::DigitalDisplay_Enable = false;
+bool Phobos::Config::MessageApplyHoverState = false;
+bool Phobos::Config::MessageDisplayInCenter = false;
 bool Phobos::Config::RealTimeTimers = false;
 bool Phobos::Config::RealTimeTimers_Adaptive = false;
 int Phobos::Config::CampaignDefaultGameSpeed = 2;
@@ -82,6 +84,8 @@ DEFINE_HOOK(0x5FACDF, OptionsClass_LoadSettings_LoadPhobosSettings, 0x5)
 	Phobos::Config::ToolTipBlur = CCINIClass::INI_RA2MD.ReadBool(phobosSection, "ToolTipBlur", false);
 	Phobos::Config::PrioritySelectionFiltering = CCINIClass::INI_RA2MD.ReadBool(phobosSection, "PrioritySelectionFiltering", true);
 	Phobos::Config::ShowPlacementPreview = CCINIClass::INI_RA2MD.ReadBool(phobosSection, "ShowPlacementPreview", true);
+	Phobos::Config::MessageApplyHoverState = CCINIClass::INI_RA2MD.ReadBool(phobosSection, "MessageApplyHoverState", false);
+	Phobos::Config::MessageDisplayInCenter = CCINIClass::INI_RA2MD.ReadBool(phobosSection, "MessageDisplayInCenter", false);
 	Phobos::Config::RealTimeTimers = CCINIClass::INI_RA2MD.ReadBool(phobosSection, "RealTimeTimers", false);
 	Phobos::Config::RealTimeTimers_Adaptive = CCINIClass::INI_RA2MD.ReadBool(phobosSection, "RealTimeTimers.Adaptive", false);
 	Phobos::Config::EnableSelectBox = CCINIClass::INI_RA2MD.ReadBool(phobosSection, "EnableSelectBox", false);

src/Phobos.INI.cpp

@@ -87,6 +87,8 @@ class Phobos
 		static bool EnableBuildingPlacementPreview;
 		static bool EnableSelectBox;
 		static bool DigitalDisplay_Enable;
+		static bool MessageApplyHoverState;
+		static bool MessageDisplayInCenter;
 		static bool RealTimeTimers;
 		static bool RealTimeTimers_Adaptive;
 		static int CampaignDefaultGameSpeed;