feat(observer): Add button mapping for toggling Replay Observer

The CommandMap name is 'TOGGLE_PLAYER_OBSERVER' and the default button mapping is 'M'

Author: xezon

Core/GameEngine/Include/Common/GameUtility.h

@@ -28,7 +28,7 @@ namespace rts
 Bool localPlayerIsObserving();
 Player* getObservedOrLocalPlayer(); ///< Get the current observed or local player. Is never null.
 
-void changeLocalPlayer(Player* player); //< Change local player during game
-void changeObservedPlayer(Player* player); ///< Change observed player during game
+void changeLocalPlayer(Player* player); //< Change local player during game. Must not pass null.
+void changeObservedPlayer(Player* player); ///< Change observed player during game. Can pass null: is identical to passing the "ReplayObserver" player.
 
 } // namespace rts

Core/GameEngine/Source/Common/GameUtility.cpp

@@ -70,6 +70,8 @@ Player* getObservedOrLocalPlayer()
 
 void changeLocalPlayer(Player* player)
 {
+	DEBUG_ASSERTCRASH(player != NULL, ("Player is NULL"));
+
 	ThePlayerList->setLocalPlayer(player);
 	TheControlBar->setControlBarSchemeByPlayer(player);
 	TheControlBar->initSpecialPowershortcutBar(player);
@@ -87,7 +89,11 @@ void changeObservedPlayer(Player* player)
 	if (canBeginObservePlayer || canEndObservePlayer)
 	{
 		TheControlBar->setObservedPlayer(player);
-		detail::changePlayerCommon(player);
+
+		Player *becomePlayer = player;
+		if (becomePlayer == NULL)
+			becomePlayer = ThePlayerList->findPlayerWithNameKey(TheNameKeyGenerator->nameToKey("ReplayObserver"));
+		detail::changePlayerCommon(becomePlayer);
 	}
 }
 

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

@@ -247,6 +247,7 @@ class GameMessage : public MemoryPoolObject
 		MSG_META_DECREASE_LOGIC_TIME_SCALE,					///< TheSuperHackers @feature Decrease the logic time scale
 		MSG_META_TOGGLE_LOWER_DETAILS,							///< toggles graphics options to crappy mode instantly
 		MSG_META_TOGGLE_CONTROL_BAR,								///< show/hide controlbar
+		MSG_META_TOGGLE_PLAYER_OBSERVER,						///< TheSuperHackers @feature Toggle the player observer view in game
 
 		MSG_META_BEGIN_PATH_BUILD,									///< enter path-building mode
 		MSG_META_END_PATH_BUILD,										///< exit path-building mode

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

@@ -352,6 +352,7 @@ const char *GameMessage::getCommandTypeAsString(GameMessage::Type t)
 	CASE_LABEL(MSG_META_DECREASE_LOGIC_TIME_SCALE)
 	CASE_LABEL(MSG_META_TOGGLE_LOWER_DETAILS)
 	CASE_LABEL(MSG_META_TOGGLE_CONTROL_BAR)
+	CASE_LABEL(MSG_META_TOGGLE_PLAYER_OBSERVER)
 	CASE_LABEL(MSG_META_BEGIN_PATH_BUILD)
 	CASE_LABEL(MSG_META_END_PATH_BUILD)
 	CASE_LABEL(MSG_META_BEGIN_FORCEATTACK)

GeneralsMD/Code/GameEngine/Source/GameClient/GUI/ControlBar/ControlBarObserver.cpp

@@ -138,7 +138,7 @@ void ControlBar::initObserverControls( void )
 //-------------------------------------------------------------------------------------------------
 void ControlBar::setObserverLookAtPlayer(Player *player)
 {
-	if (player == ThePlayerList->findPlayerWithNameKey(s_replayObserverNameKey))
+	if (player != NULL && player == ThePlayerList->findPlayerWithNameKey(s_replayObserverNameKey))
 	{
 		// Looking at the observer. Treat as not looking at player.
 		m_observerLookAtPlayer = NULL;
@@ -152,7 +152,7 @@ void ControlBar::setObserverLookAtPlayer(Player *player)
 //-------------------------------------------------------------------------------------------------
 void ControlBar::setObservedPlayer(Player *player)
 {
-	if (player == ThePlayerList->findPlayerWithNameKey(s_replayObserverNameKey))
+	if (player != NULL && player == ThePlayerList->findPlayerWithNameKey(s_replayObserverNameKey))
 	{
 		// Looking at the observer. Treat as not observing player.
 		m_observedPlayer = NULL;
@@ -196,8 +196,7 @@ WindowMsgHandledType ControlBarObserverSystem( GameWindow *window, UnsignedInt m
 			Int controlID = control->winGetWindowId();
 			if( controlID == buttonCancelID)
 			{
-				Player* observerPlayer = ThePlayerList->findPlayerWithNameKey(s_replayObserverNameKey);
-				rts::changeObservedPlayer(observerPlayer);
+				rts::changeObservedPlayer(NULL);
 
 				ObserverPlayerInfoWindow->winHide(TRUE);
 				ObserverPlayerListWindow->winHide(FALSE);
@@ -209,7 +208,7 @@ WindowMsgHandledType ControlBarObserverSystem( GameWindow *window, UnsignedInt m
 			{
 				if( controlID == buttonPlayerID[i])
 				{
-					Player* player = reinterpret_cast<Player*>(GadgetButtonGetData(buttonPlayer[i]));
+					Player* player = static_cast<Player*>(GadgetButtonGetData(buttonPlayer[i]));
 					rts::changeObservedPlayer(player);
 
 					ObserverPlayerInfoWindow->winHide(FALSE);

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

@@ -3388,6 +3388,28 @@ GameMessageDisposition CommandTranslator::translateGameMessage(const GameMessage
 			break;
 		}
 
+		//-----------------------------------------------------------------------------------------
+		case GameMessage::MSG_META_TOGGLE_PLAYER_OBSERVER:
+		{
+			if (Player *lookAtPlayer = TheControlBar->getObserverLookAtPlayer())
+			{
+				if (Player *observedPlayer = TheControlBar->getObservedPlayer())
+				{
+					// Set no observed player.
+					rts::changeObservedPlayer(NULL);
+					// But keep the look-at player.
+					TheControlBar->setObserverLookAtPlayer(lookAtPlayer);
+				}
+				else
+				{
+					// Set observed player to look-at player.
+					rts::changeObservedPlayer(lookAtPlayer);
+				}
+				disp = DESTROY_MESSAGE;
+			}
+			break;
+		}
+
 		//-----------------------------------------------------------------------------------------
 		case GameMessage::MSG_META_TOGGLE_ATTACKMOVE:
 			TheInGameUI->toggleAttackMoveToMode( );

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

@@ -158,6 +158,7 @@ static const LookupListRec GameMessageMetaTypeNames[] =
 	{ "DECREASE_LOGIC_TIME_SCALE",								GameMessage::MSG_META_DECREASE_LOGIC_TIME_SCALE },
 	{ "TOGGLE_LOWER_DETAILS",											GameMessage::MSG_META_TOGGLE_LOWER_DETAILS },
 	{ "TOGGLE_CONTROL_BAR",												GameMessage::MSG_META_TOGGLE_CONTROL_BAR },
+	{ "TOGGLE_PLAYER_OBSERVER",										GameMessage::MSG_META_TOGGLE_PLAYER_OBSERVER },
 	{ "BEGIN_PATH_BUILD",													GameMessage::MSG_META_BEGIN_PATH_BUILD },
 	{ "END_PATH_BUILD",														GameMessage::MSG_META_END_PATH_BUILD },
 	{ "BEGIN_FORCEATTACK",												GameMessage::MSG_META_BEGIN_FORCEATTACK },
@@ -771,6 +772,17 @@ MetaMapRec *MetaMap::getMetaMapRec(GameMessage::Type t)
 			map->m_usableIn = COMMANDUSABLE_EVERYWHERE;
 		}
 	}
+	{
+		// Is useful for Generals and Zero Hour.
+		MetaMapRec *map = TheMetaMap->getMetaMapRec(GameMessage::MSG_META_TOGGLE_PLAYER_OBSERVER);
+		if (map->m_key == MK_NONE)
+		{
+			map->m_key = MK_M;
+			map->m_transition = DOWN;
+			map->m_modState = NONE;
+			map->m_usableIn = COMMANDUSABLE_OBSERVER;
+		}
+	}
 	{
 		// Is mostly useful for Generals.
 		MetaMapRec *map = TheMetaMap->getMetaMapRec(GameMessage::MSG_META_TOGGLE_FAST_FORWARD_REPLAY);