Ticket #3168: t3168_let_observer_change_perspective_wip1.1.patch

binaries/data/mods/public/gui/session/menu.js

@@ -34 +34 @@
 const STEP = 5;
 
 var isMenuOpen = false;
 var menu;
 
-var isDiplomacyOpen = false;
-var isTradeOpen = false;
+var g_IsDiplomacyOpen = false;
+var g_IsTradeOpen = false;
 
 // Redefined every time someone makes a tribute (so we can save some data in a closure). Called in input.js handleInputBeforeGui.
 var flushTributing = function() {};
 
 // Ignore size defined in XML and set the actual menu size here
@@ -261 +261 @@
     Engine.PostNetworkCommand({"type": "tribute", "player": data.player, "amounts":  data.amounts});
 }
 
 function openDiplomacy()
 {
-    if (isTradeOpen)
+    if (g_IsTradeOpen)
         closeTrade();
-    isDiplomacyOpen = true;
 
-    let we = Engine.GetPlayerID();
+    let playerID = Engine.GetPlayerID();
+    let viewedPlayer = g_IsObserver ? g_ViewedPlayer : playerID;
+    let we = g_IsObserver ? g_ViewedPlayer : playerID;
+
+    if (we <= 0)
+        return;
+
+    g_IsDiplomacyOpen = true;
 
     // Get offset for one line
     let onesize = Engine.GetGUIObjectByName("diplomacyPlayer[0]").size;
     let rowsize = onesize.bottom - onesize.top;
 
@@ -336 +342 @@
                     };
                     if (!isBatchTrainPressed)
                         flushTributing();
                 };
             })(i, resource, button);
-            button.hidden = false;
+            button.hidden = g_IsObserver;
             button.tooltip = formatTributeTooltip(g_Players[i], resource, 100);
         }
 
         // Attack Request
         var simState = GetSimState();
         let button = Engine.GetGUIObjectByName("diplomacyAttackRequest["+(i-1)+"]");
         button.hidden = simState.ceasefireActive || !(g_Players[i].isEnemy[we]);
         button.tooltip = translate("Request your allies to attack this enemy");
+        button.hidden = g_IsObserver;
         button.onpress = (function(i, we){ return function() {
             Engine.PostNetworkCommand({"type": "attack-request", "source": we, "target": i});
         } })(i, we);
 
         // Skip our own teams on teams locked
@@ -358 +365 @@
         // Diplomacy settings
         // Set up the buttons
         for each (let setting in ["Ally", "Neutral", "Enemy"])
         {
             let button = Engine.GetGUIObjectByName("diplomacyPlayer"+setting+"["+(i-1)+"]");
-
             button.caption = g_Players[we]["is"+setting][i] ? translate("x") : "";
             button.onpress = (function(e){ return function() { setDiplomacy(e); } })({"player": i, "to": setting.toLowerCase()});
             button.hidden = simState.ceasefireActive;
+            button.enabled = (we == playerID && we > 0);
         }
     }
 
     Engine.GetGUIObjectByName("diplomacyDialogPanel").hidden = false;
 }
 
 function closeDiplomacy()
 {
-    isDiplomacyOpen = false;
+    g_IsDiplomacyOpen = false;
     Engine.GetGUIObjectByName("diplomacyDialogPanel").hidden = true;
 }
 
 function toggleDiplomacy()
 {
-    if (isDiplomacyOpen)
+    if (g_IsDiplomacyOpen)
         closeDiplomacy();
     else
         openDiplomacy();
 }
 
 function openTrade()
 {
-    if (isDiplomacyOpen)
+    if (g_IsDiplomacyOpen)
         closeDiplomacy();
-    isTradeOpen = true;
+
+    g_IsTradeOpen = true;
+    var viewedPlayer = g_IsObserver ? g_ViewedPlayer : Engine.GetPlayerID();
 
     var updateButtons = function()
     {
         for (var res in button)
         {
             button[res].label.caption = proba[res] + "%";
             if (res == selec)
             {
-                button[res].sel.hidden = false;
+                button[res].sel.hidden = g_IsObserver;
                 button[res].up.hidden = true;
                 button[res].dn.hidden = true;
             }
             else
             {
                 button[res].sel.hidden = true;
-                button[res].up.hidden = (proba[res] == 100 || proba[selec] == 0);
-                button[res].dn.hidden = (proba[res] == 0 || proba[selec] == 100);
+                button[res].up.hidden = g_IsObserver || (proba[res] == 100 || proba[selec] == 0);
+                button[res].dn.hidden = g_IsObserver || (proba[res] == 0 || proba[selec] == 100);
             }
         }
     };
 
-    var proba = Engine.GuiInterfaceCall("GetTradingGoods");
+    var proba = Engine.GuiInterfaceCall("GetTradingGoods", viewedPlayer);
     var button = {};
     var selec = RESOURCES[0];
     for (var i = 0; i < RESOURCES.length; ++i)
     {
         var buttonResource = Engine.GetGUIObjectByName("tradeResource["+i+"]");
@@ -433 +442 @@
         var buttonUp = Engine.GetGUIObjectByName("tradeArrowUp["+i+"]");
         var buttonDn = Engine.GetGUIObjectByName("tradeArrowDn["+i+"]");
         var iconSel = Engine.GetGUIObjectByName("tradeResourceSelection["+i+"]");
         button[resource] = { "up": buttonUp, "dn": buttonDn, "label": label, "sel": iconSel };
 
+        buttonResource.enabled = !g_IsObserver;
         buttonResource.onpress = (function(resource){
             return function() {
                 if (Engine.HotkeyIsPressed("session.fulltradeswap"))
                 {
                     for (var ress of RESOURCES)
@@ -467 +477 @@
             };
         })(resource);
     }
     updateButtons();
 
-    var traderNumber = Engine.GuiInterfaceCall("GetTraderNumber");
+    var traderNumber = Engine.GuiInterfaceCall("GetTraderNumber", viewedPlayer);
     var caption = "";
     if (traderNumber.landTrader.total == 0)
         caption = translate("There are no land traders.");
     else
     {
@@ -597 +607 @@
     Engine.GetGUIObjectByName("tradeDialogPanel").hidden = false;
 }
 
 function closeTrade()
 {
-    isTradeOpen = false;
+    g_IsTradeOpen = false;
     Engine.GetGUIObjectByName("tradeDialogPanel").hidden = true;
 }
 
 function toggleTrade()
 {
-    if (isTradeOpen)
+    if (g_IsTradeOpen)
         closeTrade();
     else
         openTrade();
 }
 
@@ -620 +630 @@
 function openStrucTree()
 {
     closeMenu();
     closeOpenDialogs();
     pauseGame();
+
+    var playerID = Engine.GetPlayerID();
+    var viewedPlayer = g_IsObserver ? g_ViewedPlayer : playerID;
+
+    if (playerID == 0 || (g_IsObserver && g_ViewedPlayer <= 0))
+        return;
+
     var data = { // TODO add info about researched techs and unlocked entities
-        "civ" : g_Players[Engine.GetPlayerID()].civ,
+        "civ" : g_Players[viewedPlayer].civ,
         "callback": "resumeGame",
     };
     Engine.PushGuiPage("page_structree.xml", data);
 }
 

binaries/data/mods/public/gui/session/selection_details.js

@@ -408 +408 @@
     detailsPanel.hidden = false;
 
     if (g_IsObserver)
     {
         // Observers don't need these displayed.
-        supplementalDetailsPanel.hidden = true;
-        commandsPanel.hidden = true;
+        //supplementalDetailsPanel.hidden = true;
+        //commandsPanel.hidden = true;
     }
     else
     {
         // Fill out commands panel for specific unit selected (or first unit of primary group)
         updateUnitCommands(entState, supplementalDetailsPanel, commandsPanel, selection);

binaries/data/mods/public/gui/session/session.js

@@ -8 +8 @@
 var g_IsController;
 // Match ID for tracking
 var g_MatchID;
 // Is this user an observer?
 var g_IsObserver = false;
-
+// Is the change-perspective developers option activated?
+var g_ChangePerspective = false;
+// The player which is selected by the observer / change-perspective tool list
+var g_ViewedPlayer = -1;
 // Cache the basic player data (name, civ, color)
 var g_Players = [];
 // Cache the useful civ data
 var g_CivData = {};
 
@@ -58 +61 @@
 
 // for saving the hitpoins of the hero (is there a better way to do that?) 
 // Should be possible with AttackDetection but might be an overkill because it would have to loop
 // always through the list of all ongoing attacks...
 var g_previousHeroHitPoints = undefined;
+var g_previouslyViewedHero = undefined;
 
 function GetSimState()
 {
     if (!g_SimState)
         g_SimState = Engine.GuiInterfaceCall("GetSimulationState");
@@ -192 +196 @@
         playerNames.push(g_Players[player].name);
         playerIDs.push(player);
     }
 
     var viewPlayerDropdown = Engine.GetGUIObjectByName("viewPlayer");
-    viewPlayerDropdown.list = playerNames;
-    viewPlayerDropdown.list_data = playerIDs;
-    viewPlayerDropdown.selected = Engine.GetPlayerID();
+    viewPlayerDropdown.list = ["Observer"].concat(playerNames);
+    viewPlayerDropdown.list_data = [-1].concat(playerIDs);
+    viewPlayerDropdown.selected = Engine.GetPlayerID() + 1;
+    viewPlayerDropdown.hidden = !g_IsObserver && !g_ChangePerspective;
 
     // If in Atlas editor, disable the exit button
     if (Engine.IsAtlasRunning())
         Engine.GetGUIObjectByName("menuExitButton").enabled = false;
 
@@ -227 +232 @@
     //setTimeout(function() { reportPerformance(60); }, 60000);
 }
 
 function selectViewPlayer(playerID)
 {
-    Engine.SetPlayerID(playerID);
+    playerID--;
+
+    if (g_ChangePerspective)
+        Engine.SetPlayerID(playerID);
+    else
+        g_ViewedPlayer = playerID;
+
     updateTopPanel();
+
+    if (playerID < 1)
+    {
+        closeTrade();
+        closeDiplomacy();
+    }
+    else
+    {
+        if (g_IsDiplomacyOpen)
+            openDiplomacy();
+        else if (g_IsTradeOpen)
+            openTrade();
+    }
 }
 
 function updateTopPanel()
 {
     var playerID = Engine.GetPlayerID();
     var isPlayer =  playerID > 0;
-    if (isPlayer)
+    var viewsPlayer = isPlayer || (g_IsObserver && g_ViewedPlayer > 0);
+    var viewedPlayer = g_IsObserver ? g_ViewedPlayer : playerID;
+
+    Engine.GetGUIObjectByName("buildTimeLabel").size="50%-78 0 50%+178 100%-2";
+
+    // Set civ icon
+    if (viewsPlayer)
     {
-        var civName = g_CivData[g_Players[playerID].civ].Name;
-        Engine.GetGUIObjectByName("civIcon").sprite = "stretched:" + g_CivData[g_Players[playerID].civ].Emblem;
+        let civName = g_CivData[g_Players[viewedPlayer].civ].Name
+        Engine.GetGUIObjectByName("civIcon").sprite = "stretched:" + g_CivData[g_Players[viewedPlayer].civ].Emblem;
         Engine.GetGUIObjectByName("civIconOverlay").tooltip = sprintf(translate("%(civ)s - Structure Tree"), {"civ": civName});
     }
-    
-    // Hide stuff gaia/observers don't use.
-    Engine.GetGUIObjectByName("food").hidden = !isPlayer;
-    Engine.GetGUIObjectByName("wood").hidden = !isPlayer;
-    Engine.GetGUIObjectByName("stone").hidden = !isPlayer;
-    Engine.GetGUIObjectByName("metal").hidden = !isPlayer;
-    Engine.GetGUIObjectByName("population").hidden = !isPlayer;
-    Engine.GetGUIObjectByName("civIcon").hidden = !isPlayer;
-    Engine.GetGUIObjectByName("diplomacyButton1").hidden = !isPlayer;
-    Engine.GetGUIObjectByName("tradeButton1").hidden = !isPlayer;
-    Engine.GetGUIObjectByName("observerText").hidden = playerID >= 0;
+
+    // Hide stuff gaia doesn't use.
+    Engine.GetGUIObjectByName("food").hidden = !viewsPlayer;
+    Engine.GetGUIObjectByName("wood").hidden = !viewsPlayer;
+    Engine.GetGUIObjectByName("stone").hidden = !viewsPlayer;
+    Engine.GetGUIObjectByName("metal").hidden = !viewsPlayer;
+    Engine.GetGUIObjectByName("population").hidden = !viewsPlayer;
+    Engine.GetGUIObjectByName("civIcon").hidden = !viewsPlayer;
+    Engine.GetGUIObjectByName("diplomacyButton1").hidden = !viewsPlayer;
+    Engine.GetGUIObjectByName("tradeButton1").hidden = !viewsPlayer;
+    Engine.GetGUIObjectByName("observerText").hidden = viewsPlayer;
 
     // Disable stuff observers shouldn't use
     var isActive = isPlayer && GetSimState().players[playerID].state == "active";
     Engine.GetGUIObjectByName("pauseButton").enabled = isActive || !g_IsNetworked;
     Engine.GetGUIObjectByName("menuResignButton").enabled = isActive;
@@ -408 +438 @@
 
     var now = new Date();
     var tickLength = new Date() - lastTickTime;
     lastTickTime = now;
 
-    checkPlayerState();
+    checkGameEnded();
+
     while (true)
     {
         var message = Engine.PollNetworkClient();
         if (!message)
             break;
@@ -448 +479 @@
 
     // Clear renamed entities list
     Engine.GuiInterfaceCall("ClearRenamedEntities");
 }
 
-function checkPlayerState()
+function checkGameEnded()
 {
     // Once the game ends, we're done here.
-    if (g_GameEnded || g_IsObserver)
+    if (g_GameEnded || g_IsObserver || g_ViewedPlayer <= 0)
         return;
 
     // Send a game report for each player in this game.
     var m_simState = GetSimState();
     var playerState = m_simState.players[Engine.GetPlayerID()];
@@ -547 +578 @@
     updateDebug();
     updatePlayerDisplay();
     updateSelectionDetails();
     updateBuildingPlacementPreview();
     updateTimeNotifications();
-    if (!g_IsObserver)
-        updateResearchDisplay();
+    updateResearchDisplay();
 
     if (!g_IsObserver && !g_GameEnded)
     {
         // Update music state on basis of battle state.
         var battleState = Engine.GuiInterfaceCall("GetBattleState", Engine.GetPlayerID());
@@ -610 +640 @@
 }
 
 
 function updateHero()
 {
-    var playerState = GetSimState().players[Engine.GetPlayerID()];
+    var viewedPlayer = g_IsObserver ? g_ViewedPlayer : Engine.GetPlayerID();
+    var playerState = GetSimState().players[viewedPlayer];
     var unitHeroPanel = Engine.GetGUIObjectByName("unitHeroPanel");
     var heroButton = Engine.GetGUIObjectByName("unitHeroButton");
 
     if (!playerState || playerState.heroes.length <= 0)
     {
         g_previousHeroHitPoints = undefined;
+        g_previouslyViewedHero = undefined;
         unitHeroPanel.hidden = true;
         return;
     }
 
     var heroImage = Engine.GetGUIObjectByName("unitHeroImage");
@@ -654 +686 @@
     // update heros health bar
     updateGUIStatusBar("heroHealthBar", heroState.hitpoints, heroState.maxHitpoints);
     
     // define the hit points if not defined
     if (!g_previousHeroHitPoints)
+    {
         g_previousHeroHitPoints = heroState.hitpoints;
+        g_previouslyViewedHero = viewedPlayer;
+    }
     
     // if the health of the hero changed since the last update, trigger the animation
-    if (heroState.hitpoints < g_previousHeroHitPoints)
+    if (g_previouslyViewedHero == viewedPlayer && heroState.hitpoints < g_previousHeroHitPoints)
         startColorFade("heroHitOverlay", 100, 0, colorFade_attackUnit, true, smoothColorFadeRestart_attackUnit);
 
     g_previousHeroHitPoints = heroState.hitpoints;
+    g_previouslyViewedHero = viewedPlayer;
 }
 
 
 function updateGroups()
 {
@@ -718 +754 @@
     debug.caption = text.replace(/\[/g, "\\[");
 }
 
 function updatePlayerDisplay()
 {
-    var playerState = GetSimState().players[Engine.GetPlayerID()];
+    var playerID = Engine.GetPlayerID();
+    var viewsPlayer = playerID > 0 || (g_IsObserver && g_ViewedPlayer > 0);
+    var viewedPlayer = g_IsObserver ? g_ViewedPlayer : playerID;
+
+    if (!viewsPlayer)
+        return;
+
+    var playerState = GetSimState().players[viewedPlayer];
     if (!playerState)
         return;
 
     Engine.GetGUIObjectByName("resourceFood").caption = Math.floor(playerState.resourceCounts.food);
     Engine.GetGUIObjectByName("resourceWood").caption = Math.floor(playerState.resourceCounts.wood);
@@ -748 +791 @@
     Engine.CameraMoveTo(position.x, position.z);
 }
 
 function updateResearchDisplay()
 {
-    var researchStarted = Engine.GuiInterfaceCall("GetStartedResearch", Engine.GetPlayerID());
-    if (!researchStarted)
+    var viewedPlayer = g_IsObserver ? g_ViewedPlayer : Engine.GetPlayerID();
+
+    var researchStarted = Engine.GuiInterfaceCall("GetStartedResearch", viewedPlayer);
+    if (!researchStarted && !g_IsObserver)
         return;
 
     // Set up initial positioning.
     var buttonSideLength = Engine.GetGUIObjectByName("researchStartedButton[0]").size.right;
     for (var i = 0; i < 10; ++i)

binaries/data/mods/public/gui/session/session.xml

@@ -68 +68 @@
 
         <object size="0 16 100%-18 32" type="text" style="devCommandsText">
             <translatableAttribute id="caption">Change perspective</translatableAttribute>
         </object>
         <object size="100%-16 16 100% 32" type="checkbox" style="ModernTickBox">
-            <action on="Press">Engine.GetGUIObjectByName("viewPlayer").hidden = !this.checked;</action>
+            <action on="Press">
+                g_ChangePerspective = !g_ChangePerspective;
+                Engine.GetGUIObjectByName("viewPlayer").hidden = !g_ChangePerspective;
+            </action>
         </object>
 
         <object size="0 32 100%-18 48" type="text" style="devCommandsText">
             <translatableAttribute id="caption">Display selection state</translatableAttribute>
         </object>

binaries/data/mods/public/gui/session/top_panel.xml

@@ -21 +21 @@
 
     <!-- ================================  ================================ -->
     <!-- Observer Mode Warning -->
     <!-- ================================  ================================ -->
     <object size="50 4 50% 100%-2" name="observerText" type="text" style="ModernLabelText" text_align="left" hidden="true">
-        <translatableAttribute id="caption">Observer Mode (experimental)</translatableAttribute>
+        <translatableAttribute id="caption">Observer Mode</translatableAttribute>
     </object>
 
 </object>

binaries/data/mods/public/simulation/components/GuiInterface.js

@@ -109 +109 @@
             "isEnemy": enemies,
             "entityLimits": cmpPlayerEntityLimits ? cmpPlayerEntityLimits.GetLimits() : null,
             "entityCounts": cmpPlayerEntityLimits ? cmpPlayerEntityLimits.GetCounts() : null,
             "entityLimitChangers": cmpPlayerEntityLimits ? cmpPlayerEntityLimits.GetLimitChangers() : null,
             "researchQueued": cmpTechnologyManager ? cmpTechnologyManager.GetQueuedResearch() : null,
-            "researchStarted": cmpTechnologyManager ? cmpTechnologyManager.GetStartedResearch() : null,
+            "researchStarted": cmpTechnologyManager ? cmpTechnologyManager.GetStartedResearch(i) : null,
             "researchedTechs": cmpTechnologyManager ? cmpTechnologyManager.GetResearchedTechs() : null,
             "classCounts": cmpTechnologyManager ? cmpTechnologyManager.GetClassCounts() : null,
             "typeCountsByClass": cmpTechnologyManager ? cmpTechnologyManager.GetTypeCountsByClass() : null
         };
         ret.players.push(playerData);
@@ -645 +645 @@
     return cmpTechnologyManager.CanResearch(tech);
 };
 
 // Returns technologies that are being actively researched, along with
 // which entity is researching them and how far along the research is.
-GuiInterface.prototype.GetStartedResearch = function(player)
+// TODO: player will be filled in automatically by ScriptCall, how to make it less ugly?
+GuiInterface.prototype.GetStartedResearch = function(player, differentPlayer)
 {
-    var cmpTechnologyManager = QueryPlayerIDInterface(player, IID_TechnologyManager);
+    var cmpTechnologyManager = QueryPlayerIDInterface(differentPlayer ? differentPlayer : player, IID_TechnologyManager);
     if (!cmpTechnologyManager)
         return false;
 
     var ret = {};
     for (var tech in cmpTechnologyManager.GetTechsStarted())
@@ -1803 +1804 @@
 {
     var cmpRangeManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_RangeManager);
     cmpRangeManager.SetDebugOverlay(enabled);
 };
 
-GuiInterface.prototype.GetTraderNumber = function(player)
+// TODO: player will be filled in automatically by ScriptCall, how to make it less ugly?
+GuiInterface.prototype.GetTraderNumber = function(player, differentPlayer)
 {
     var cmpRangeManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_RangeManager);
-    var traders = cmpRangeManager.GetEntitiesByPlayer(player).filter( function(e) {
+    var traders = cmpRangeManager.GetEntitiesByPlayer(differentPlayer ? differentPlayer : player).filter(e => {
         return Engine.QueryInterface(e, IID_Trader);
     });
 
     var landTrader = { "total": 0, "trading": 0, "garrisoned": 0 };
     var shipTrader = { "total": 0, "trading": 0 };
@@ -1842 +1844 @@
     }
 
     return { "landTrader": landTrader, "shipTrader": shipTrader };
 };
 
-GuiInterface.prototype.GetTradingGoods = function(player)
+// TODO: player will be filled in automatically by ScriptCall, how to make it less ugly?
+GuiInterface.prototype.GetTradingGoods = function(player, differentPlayer)
 {
-    return QueryPlayerIDInterface(player).GetTradingGoods();
+    return QueryPlayerIDInterface(differentPlayer ? differentPlayer : player).GetTradingGoods();
 };
 
 GuiInterface.prototype.OnGlobalEntityRenamed = function(msg)
 {
     this.renamedEntities.push(msg);

source/simulation2/system/SimContext.cpp

@@ -1 @@
-/* Copyright (C) 2011 Wildfire Games.
+/* Copyright (C) 2015 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. 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 2 of the License, or
@@ -65 +65 @@
     return GetComponentManager().GetScriptInterface();
 }
 
 int CSimContext::GetCurrentDisplayedPlayer() const
 {
+    // TODO: use currentDisplayedPlayer and use that for fog-of-war
     if (!g_Game)
         return -1;
     return g_Game->GetPlayerID();
 }
+
+void CSimContext::SetCurrentDisplayedPlayer(int player)
+{
+    currentDisplayedPlayer = player;
+}

source/simulation2/system/SimContext.h

@@ -51 +51 @@
     /**
      * Returns the player ID that the current display is being rendered for.
      * Currently relies on g_Game being initialised (evil globals...)
      */
     int GetCurrentDisplayedPlayer() const;
+    void SetCurrentDisplayedPlayer(int player);
 
 private:
     CComponentManager* m_ComponentManager;
     CUnitManager* m_UnitManager;
     CTerrain* m_Terrain;
 
     CEntityHandle m_SystemEntity;
 
+    int currentDisplayedPlayer = -1;
+
     friend class CSimulation2Impl;
 };
 
 #endif // INCLUDED_SIMCONTEXT