feat(input): Implement alternative key mappings for Game Pause and Step Frame that are usable as a Solo player (#1530)

The new default key mappings are SHIFT+P to Pause and SHIFT+O to Step Frame when playing

Author: xezon

Core/GameEngine/CMakeLists.txt

@@ -53,6 +53,7 @@ set(GAMEENGINE_SRC
 #    Include/Common/GameState.h
 #    Include/Common/GameStateMap.h
 #    Include/Common/GameType.h
+    Include/Common/GameUtility.h
 #    Include/Common/Geometry.h
 #    Include/Common/GlobalData.h
 #    Include/Common/Handicap.h
@@ -574,6 +575,7 @@ set(GAMEENGINE_SRC
 #    Source/Common/GameEngine.cpp
 #    Source/Common/GameLOD.cpp
 #    Source/Common/GameMain.cpp
+    Source/Common/GameUtility.cpp
 #    Source/Common/GlobalData.cpp
 #    Source/Common/INI/INI.cpp
 #    Source/Common/INI/INIAiData.cpp

Core/GameEngine/Include/Common/GameUtility.h

@@ -0,0 +1,28 @@
+/*
+**	Command & Conquer Generals Zero Hour(tm)
+**	Copyright 2025 TheSuperHackers
+**
+**	This program is free software: you can redistribute it and/or modify
+**	it under the terms of the GNU General Public License as published by
+**	the Free Software Foundation, either version 3 of the License, or
+**	(at your option) any later version.
+**
+**	This program is distributed in the hope that it will be useful,
+**	but WITHOUT ANY WARRANTY; without even the implied warranty of
+**	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+**	GNU General Public License for more details.
+**
+**	You should have received a copy of the GNU General Public License
+**	along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#pragma once
+
+// For miscellaneous game utility functions.
+
+namespace rts
+{
+
+Bool localPlayerIsObserving();
+
+} // namespace rts

Core/GameEngine/Source/Common/GameUtility.cpp

@@ -0,0 +1,42 @@
+/*
+**	Command & Conquer Generals Zero Hour(tm)
+**	Copyright 2025 TheSuperHackers
+**
+**	This program is free software: you can redistribute it and/or modify
+**	it under the terms of the GNU General Public License as published by
+**	the Free Software Foundation, either version 3 of the License, or
+**	(at your option) any later version.
+**
+**	This program is distributed in the hope that it will be useful,
+**	but WITHOUT ANY WARRANTY; without even the implied warranty of
+**	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+**	GNU General Public License for more details.
+**
+**	You should have received a copy of the GNU General Public License
+**	along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#include "PreRTS.h"
+
+#include "Common/GameUtility.h"
+#include "Common/PlayerList.h"
+#include "Common/Player.h"
+
+#include "GameLogic/GameLogic.h"
+
+
+namespace rts
+{
+
+Bool localPlayerIsObserving()
+{
+	if (TheGameLogic->isInReplayGame() || TheGameLogic->isInShellGame())
+		return true;
+
+	if (ThePlayerList->getLocalPlayer()->isPlayerObserver())
+		return true;
+
+	return false;
+}
+
+} // namespace rts

Generals/Code/GameEngine/Include/Common/MessageStream.h

@@ -273,8 +273,10 @@ class GameMessage : public MemoryPoolObject
 		MSG_META_END_CAMERA_ZOOM_OUT,
 		MSG_META_CAMERA_RESET,
 		MSG_META_TOGGLE_FAST_FORWARD_REPLAY,				///< Toggle the fast forward feature
-		MSG_META_TOGGLE_PAUSE,											///< TheSuperHackers @feature Toggle game pause (in replay playbacks)
-		MSG_META_STEP_FRAME,												///< TheSuperHackers @feature Step one frame (in replay playbacks)
+		MSG_META_TOGGLE_PAUSE,											///< TheSuperHackers @feature Toggle game pause
+		MSG_META_TOGGLE_PAUSE_ALT,									///< TheSuperHackers @feature Toggle game pause (alternative mapping)
+		MSG_META_STEP_FRAME,												///< TheSuperHackers @feature Step one frame
+		MSG_META_STEP_FRAME_ALT,										///< TheSuperHackers @feature Step one frame (alternative mapping)
 
 
 		// META items that are really for debug/demo/development use only...

Generals/Code/GameEngine/Include/GameClient/MetaEvent.h

@@ -314,16 +314,18 @@ enum CommandUsableInType CPP_11(: Int)
 {
 	COMMANDUSABLE_NONE				= 0,
 
-	COMMANDUSABLE_SHELL				= (1 << 0),
-	COMMANDUSABLE_GAME				= (1 << 1),
+	COMMANDUSABLE_SHELL				= (1 << 0), // Command is usable when in Shell (Menus)
+	COMMANDUSABLE_GAME				= (1 << 1), // Command is usable when not in Shell
+	COMMANDUSABLE_OBSERVER		= (1 << 2), // TheSuperHackers @feature Command is usable when observing
 
-	COMMANDUSABLE_EVERYWHERE = COMMANDUSABLE_SHELL | COMMANDUSABLE_GAME,
+	COMMANDUSABLE_EVERYWHERE = ~0,
 };
 
 static const char* TheCommandUsableInNames[] =
 {
 	"SHELL",
 	"GAME",
+	"OBSERVER",
 
 	NULL
 };

Generals/Code/GameEngine/Source/Common/MessageStream.cpp

@@ -376,7 +376,9 @@ const char *GameMessage::getCommandTypeAsString(GameMessage::Type t)
 	CASE_LABEL(MSG_META_CAMERA_RESET)
 	CASE_LABEL(MSG_META_TOGGLE_FAST_FORWARD_REPLAY)
 	CASE_LABEL(MSG_META_TOGGLE_PAUSE)
+	CASE_LABEL(MSG_META_TOGGLE_PAUSE_ALT)
 	CASE_LABEL(MSG_META_STEP_FRAME)
+	CASE_LABEL(MSG_META_STEP_FRAME_ALT)
 
 #if defined(RTS_DEBUG)
 	CASE_LABEL(MSG_META_DEMO_TOGGLE_BEHIND_BUILDINGS)

Generals/Code/GameEngine/Source/GameClient/MessageStream/CommandXlat.cpp

@@ -3302,10 +3302,9 @@ GameMessageDisposition CommandTranslator::translateGameMessage(const GameMessage
 
 		}
 		case GameMessage::MSG_META_TOGGLE_PAUSE:
+		case GameMessage::MSG_META_TOGGLE_PAUSE_ALT:
 		{
-#if !defined(_ALLOW_DEBUG_CHEATS_IN_RELEASE)//may be defined in GameCommon.h
-			if (TheGameLogic->isInReplayGame())
-#endif
+			if (!TheGameLogic->isInMultiplayerGame())
 			{
 				if (TheGameLogic->isGamePaused())
 				{
@@ -3318,17 +3317,18 @@ GameMessageDisposition CommandTranslator::translateGameMessage(const GameMessage
 					Bool pauseInput = FALSE;
 					TheGameLogic->setGamePaused(pause, pauseMusic, pauseInput);
 				}
+				disp = DESTROY_MESSAGE;
 			}
 			break;
 		}
 		case GameMessage::MSG_META_STEP_FRAME:
+		case GameMessage::MSG_META_STEP_FRAME_ALT:
 		{
-#if !defined(_ALLOW_DEBUG_CHEATS_IN_RELEASE)//may be defined in GameCommon.h
-			if (TheGameLogic->isInReplayGame())
-#endif
+			if (!TheGameLogic->isInMultiplayerGame())
 			{
 				TheGameLogic->setGamePaused(FALSE);
 				TheGameLogic->setGamePausedInFrame(TheGameLogic->getFrame() + 1, TRUE);
+				disp = DESTROY_MESSAGE;
 			}
 			break;
 		}

Generals/Code/GameEngine/Source/GameClient/MessageStream/MetaEvent.cpp

@@ -30,6 +30,7 @@
 // INCLUDES ///////////////////////////////////////////////////////////////////////////////////////
 #include "PreRTS.h"	// This must go first in EVERY cpp file int the GameEngine
 
+#include "Common/GameUtility.h"
 #include "Common/INI.h"
 #include "Common/MessageStream.h"
 #include "Common/Player.h"
@@ -174,7 +175,9 @@ static const LookupListRec GameMessageMetaTypeNames[] =
 	{ "CAMERA_RESET",															GameMessage::MSG_META_CAMERA_RESET },
 	{ "TOGGLE_FAST_FORWARD_REPLAY",								GameMessage::MSG_META_TOGGLE_FAST_FORWARD_REPLAY },
 	{ "TOGGLE_PAUSE",															GameMessage::MSG_META_TOGGLE_PAUSE },
+	{ "TOGGLE_PAUSE_ALT",													GameMessage::MSG_META_TOGGLE_PAUSE_ALT },
 	{ "STEP_FRAME",																GameMessage::MSG_META_STEP_FRAME },
+	{ "STEP_FRAME_ALT",														GameMessage::MSG_META_STEP_FRAME_ALT },
 
 #if defined(RTS_DEBUG)
 	{ "HELP",																			GameMessage::MSG_META_HELP },
@@ -362,6 +365,33 @@ static const char * findGameMessageNameByType(GameMessage::Type type)
 	return "???";
 }
 
+//-------------------------------------------------------------------------------------------------
+static Bool isMessageUsable(CommandUsableInType usableIn)
+{
+	// We will ignore all commands if the game client has not yet incremented to frame 1.
+	// It prevents the user from doing commands during a map load, which throws the input
+	// system into whack because there isn't a client frame for the input event, and in
+	// the case of a command that pauses the game, like the quit menu, the client frame
+	// will never get beyond 0 and we lose the ability to process any input.
+	if (TheGameClient->getFrame() == 0)
+		return false;
+
+	const Bool usableInShell = (usableIn & COMMANDUSABLE_SHELL);
+	const Bool usableInGame = (usableIn & COMMANDUSABLE_GAME);
+	const Bool usableAsObserver = (usableIn & COMMANDUSABLE_OBSERVER);
+
+	if (usableInShell && TheShell && TheShell->isShellActive())
+		return true;
+
+	if (usableInGame && (!TheShell || !TheShell->isShellActive()))
+		return true;
+
+	if (usableAsObserver && rts::localPlayerIsObserving())
+		return true;
+
+	return false;
+}
+
 //-------------------------------------------------------------------------------------------------
 GameMessageDisposition MetaEventTranslator::translateGameMessage(const GameMessage *msg)
 {
@@ -397,23 +427,7 @@ GameMessageDisposition MetaEventTranslator::translateGameMessage(const GameMessa
 			DEBUG_ASSERTCRASH(map->m_meta > GameMessage::MSG_BEGIN_META_MESSAGES &&
 				map->m_meta < GameMessage::MSG_END_META_MESSAGES, ("hmm, expected only meta-msgs here"));
 
-			//
-			// if this command is *only* usable in the game, we will ignore it if the game client
-			// has not yet incremented to frame 1 (keeps us from doing in-game commands during
-			// a map load, which throws the input system into wack because there isn't a
-			// client frame for the input event, and in the case of a command that pauses the
-			// game, like the quit menu, the client frame will never get beyond 0 and we
-			// lose the ability to process any input
-			//
-			if( map->m_usableIn == COMMANDUSABLE_GAME && TheGameClient->getFrame() < 1 )
-				continue;
-
-			// if the shell is active, and this command is not usable in shell, continue
-			if (TheShell && TheShell->isShellActive() && !(map->m_usableIn & COMMANDUSABLE_SHELL) )
-				continue;
-
-			// if the shell is not active and this command is not usable in the game, continue
-			if (TheShell && !TheShell->isShellActive() && !(map->m_usableIn & COMMANDUSABLE_GAME) )
+			if (!isMessageUsable(map->m_usableIn))
 				continue;
 
 			// check for the special case of mods-only-changed.
@@ -719,7 +733,7 @@ MetaMapRec *MetaMap::getMetaMapRec(GameMessage::Type t)
 			map->m_key = MK_F;
 			map->m_transition = DOWN;
 			map->m_modState = NONE;
-			map->m_usableIn = COMMANDUSABLE_GAME;
+			map->m_usableIn = COMMANDUSABLE_GAME; // @todo COMMANDUSABLE_OBSERVER
 		}
 	}
 	{
@@ -730,7 +744,18 @@ MetaMapRec *MetaMap::getMetaMapRec(GameMessage::Type t)
 			map->m_key = MK_P;
 			map->m_transition = DOWN;
 			map->m_modState = NONE;
-			map->m_usableIn = COMMANDUSABLE_GAME;
+			map->m_usableIn = COMMANDUSABLE_OBSERVER;
+		}
+	}
+	{
+		// Is useful for Generals and Zero Hour.
+		MetaMapRec *map = TheMetaMap->getMetaMapRec(GameMessage::MSG_META_TOGGLE_PAUSE_ALT);
+		if (map->m_key == MK_NONE)
+		{
+			map->m_key = MK_P;
+			map->m_transition = DOWN;
+			map->m_modState = SHIFT; // Requires modifier to avoid key conflicts as a player.
+			map->m_usableIn = COMMANDUSABLE_EVERYWHERE;
 		}
 	}
 	{
@@ -741,7 +766,18 @@ MetaMapRec *MetaMap::getMetaMapRec(GameMessage::Type t)
 			map->m_key = MK_O;
 			map->m_transition = DOWN;
 			map->m_modState = NONE;
-			map->m_usableIn = COMMANDUSABLE_GAME;
+			map->m_usableIn = COMMANDUSABLE_OBSERVER;
+		}
+	}
+	{
+		// Is useful for Generals and Zero Hour.
+		MetaMapRec *map = TheMetaMap->getMetaMapRec(GameMessage::MSG_META_STEP_FRAME_ALT);
+		if (map->m_key == MK_NONE)
+		{
+			map->m_key = MK_O;
+			map->m_transition = DOWN;
+			map->m_modState = SHIFT; // Requires modifier to avoid key conflicts as a player.
+			map->m_usableIn = COMMANDUSABLE_EVERYWHERE;
 		}
 	}
 	{

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

@@ -274,8 +274,10 @@ class GameMessage : public MemoryPoolObject
 		MSG_META_CAMERA_RESET,
     MSG_META_TOGGLE_CAMERA_TRACKING_DRAWABLE,
 		MSG_META_TOGGLE_FAST_FORWARD_REPLAY,				///< Toggle the fast forward feature
-		MSG_META_TOGGLE_PAUSE,											///< TheSuperHackers @feature Toggle game pause (in replay playbacks)
-		MSG_META_STEP_FRAME,												///< TheSuperHackers @feature Step one frame (in replay playbacks)
+		MSG_META_TOGGLE_PAUSE,											///< TheSuperHackers @feature Toggle game pause
+		MSG_META_TOGGLE_PAUSE_ALT,									///< TheSuperHackers @feature Toggle game pause (alternative mapping)
+		MSG_META_STEP_FRAME,												///< TheSuperHackers @feature Step one frame
+		MSG_META_STEP_FRAME_ALT,										///< TheSuperHackers @feature Step one frame (alternative mapping)
 		MSG_META_DEMO_INSTANT_QUIT,									///< bail out of game immediately
 
 

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

@@ -314,16 +314,18 @@ enum CommandUsableInType CPP_11(: Int)
 {
 	COMMANDUSABLE_NONE				= 0,
 
-	COMMANDUSABLE_SHELL				= (1 << 0),
-	COMMANDUSABLE_GAME				= (1 << 1),
+	COMMANDUSABLE_SHELL				= (1 << 0), // Command is usable when in Shell (Menus)
+	COMMANDUSABLE_GAME				= (1 << 1), // Command is usable when not in Shell
+	COMMANDUSABLE_OBSERVER		= (1 << 2), // TheSuperHackers @feature Command is usable when observing
 
-	COMMANDUSABLE_EVERYWHERE = COMMANDUSABLE_SHELL | COMMANDUSABLE_GAME,
+	COMMANDUSABLE_EVERYWHERE = ~0,
 };
 
 static const char* TheCommandUsableInNames[] =
 {
 	"SHELL",
 	"GAME",
+	"OBSERVER",
 
 	NULL
 };