Add UI Help Screen overlay

past-due · pull[bot] · commit 10293687647b · 2024-06-28T00:00:19.000Z
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -68,8 +68,8 @@ if(ENABLE_NLS)
 	find_package (Intl REQUIRED)
 endif()
 
-file(GLOB HEADERS "*.h" "3rdparty/*.h" "titleui/*.h" "hci/*.h" "input/*.h")
-file(GLOB SRC "*.cpp" "3rdparty/*.cpp" "titleui/*.cpp" "hci/*.cpp" "input/*.cpp")
+file(GLOB HEADERS "*.h" "3rdparty/*.h" "titleui/*.h" "hci/*.h" "input/*.h" "screens/*.h")
+file(GLOB SRC "*.cpp" "3rdparty/*.cpp" "titleui/*.cpp" "hci/*.cpp" "input/*.cpp" "screens/*.cpp")
 
 set(_additionalSourceFiles)
 if(CMAKE_SYSTEM_NAME MATCHES "Windows")
diff --git a/src/cheat.cpp b/src/cheat.cpp
@@ -116,6 +116,12 @@ bool _attemptCheatCode(const char *cheat_name)
 		return true;
 	}
 
+	if (!strcasecmp("help", cheat_name))
+	{
+		intShowWidgetHelp();
+		return true;
+	}
+
 	const DebugInputManager& dbgInputManager = gInputManager.debugManager();
 	if (strcmp(cheat_name, "cheat on") == 0 || strcmp(cheat_name, "debug") == 0)
 	{
diff --git a/src/hci.cpp b/src/hci.cpp
@@ -47,6 +47,7 @@
 #include "lib/widget/bar.h"
 #include "lib/widget/button.h"
 #include "lib/widget/editbox.h"
+#include "screens/helpscreen.h"
 #include "cheat.h"
 #include "console.h"
 #include "design.h"
@@ -164,6 +165,7 @@ static bool Refreshing = false;
 
 /* The widget screen */
 std::shared_ptr<W_SCREEN> psWScreen = nullptr;
+std::shared_ptr<W_HELP_OVERLAY_SCREEN> psUIHelpOverlayScreen = nullptr;
 
 INTMODE intMode;
 
@@ -1979,6 +1981,64 @@ void intDisplayWidgets()
 	}
 }
 
+void intShowWidgetHelp()
+{
+	ASSERT_OR_RETURN(, psWScreen != nullptr, "psWScreen is null?");
+
+	if (!psUIHelpOverlayScreen)
+	{
+		// Initialize the help overlay screen
+		psUIHelpOverlayScreen = W_HELP_OVERLAY_SCREEN::make(
+			// close handler
+			[](std::shared_ptr<W_HELP_OVERLAY_SCREEN>){
+				psUIHelpOverlayScreen.reset();
+
+				if (!bMultiPlayer || !NetPlay.bComms)
+				{
+					if (gamePaused())
+					{
+						// unpause game
+
+						/* Get it going again */
+						setGamePauseStatus(false);
+						setConsolePause(false);
+						setScriptPause(false);
+						setAudioPause(false);
+						setScrollPause(false);
+
+						/* And start the clock again */
+						gameTimeStart();
+					}
+				}
+			}
+		);
+	}
+
+	if (!bMultiPlayer || !NetPlay.bComms)
+	{
+		if (!gamePaused())
+		{
+			// pause game
+			setGamePauseStatus(true);
+			setConsolePause(true);
+			setScriptPause(true);
+			setAudioPause(true);
+			setScrollPause(true);
+
+			/* And stop the clock */
+			gameTimeStop();
+		}
+	}
+
+	psUIHelpOverlayScreen->setHelpFromWidgets(psWScreen->psForm);
+	widgRegisterOverlayScreenOnTopOfScreen(psUIHelpOverlayScreen, psWScreen);
+}
+
+bool intHelpOverlayIsUp()
+{
+	return psUIHelpOverlayScreen != nullptr;
+}
+
 /* Tell the interface when the screen has been resized */
 void intScreenSizeDidChange(int oldWidth, int oldHeight, int newWidth, int newHeight)
 {
diff --git a/src/hci.h b/src/hci.h
@@ -289,6 +289,9 @@ INT_RETVAL intRunWidgets();
 /* Display the widgets for the in game interface */
 void intDisplayWidgets();
 
+void intShowWidgetHelp();
+bool intHelpOverlayIsUp();
+
 /* Add the reticule widgets to the widget screen */
 bool intAddReticule();
 bool intShowGroupSelectionMenu();
diff --git a/src/loop.cpp b/src/loop.cpp
@@ -222,7 +222,7 @@ static GAMECODE renderLoop()
 			displayRenderLoop();
 		}
 
-		if (InGameOpUp || isInGamePopupUp)		// ingame options menu up, run it!
+		if (InGameOpUp || isInGamePopupUp || intHelpOverlayIsUp())		// ingame options menu up, run it!
 		{
 			WidgetTriggers const &triggers = widgRunScreen(psWScreen);
 			unsigned widgval = triggers.empty() ? 0 : triggers.front().widget->id; // Just use first click here, since the next click could be on another menu.
diff --git a/src/screens/helpscreen.cpp b/src/screens/helpscreen.cpp
diff --git a/src/screens/helpscreen.h b/src/screens/helpscreen.h

Original file line number	Diff line number	Diff line change
`@@ -116,6 +116,12 @@ bool _attemptCheatCode(const char *cheat_name)`
`116`	`116`	`return true;`
`117`	`117`	`}`
`118`	`118`
	`119`	`+ if (!strcasecmp("help", cheat_name))`
	`120`	`+ {`
	`121`	`+ intShowWidgetHelp();`
	`122`	`+ return true;`
	`123`	`+ }`
	`124`	`+`
`119`	`125`	`const DebugInputManager& dbgInputManager = gInputManager.debugManager();`
`120`	`126`	`if (strcmp(cheat_name, "cheat on") == 0 \|\| strcmp(cheat_name, "debug") == 0)`
`121`	`127`	`{`
Original file line number	Diff line number	Diff line change
`@@ -222,7 +222,7 @@ static GAMECODE renderLoop()`
`222`	`222`	`displayRenderLoop();`
`223`	`223`	`}`
`224`	`224`
`225`		`- if (InGameOpUp \|\| isInGamePopupUp) // ingame options menu up, run it!`
	`225`	`+ if (InGameOpUp \|\| isInGamePopupUp \|\| intHelpOverlayIsUp()) // ingame options menu up, run it!`
`226`	`226`	`{`
`227`	`227`	`WidgetTriggers const &triggers = widgRunScreen(psWScreen);`
`228`	`228`	`unsigned widgval = triggers.empty() ? 0 : triggers.front().widget->id; // Just use first click here, since the next click could be on another menu.`