Ticket #1878: 0002-Do-some-more-caching-in-the-gui.patch

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

@@ -159 +159 @@
     return undefined;
 }
 
-function getActionInfo(action, target, simState)
+function getActionInfo(action, target)
 {
+    var simState = GetSimState();
     var selection = g_Selection.toList();
 
     // If the selection doesn't exist, no action
@@ -457 +458 @@
         target = targets[0];
     }
 
-    var simState = Engine.GuiInterfaceCall("GetSimulationState");
-
     if (preSelectedAction != ACTION_NONE)
     {
         switch (preSelectedAction)
         {
         case ACTION_GARRISON:
-            if (getActionInfo("garrison", target, simState).possible)
+            if (getActionInfo("garrison", target).possible)
                 return {"type": "garrison", "cursor": "action-garrison", "target": target};
             else
                 return  {"type": "none", "cursor": "action-garrison-disabled", "target": undefined};
             break;
         case ACTION_REPAIR:
-            if (getActionInfo("repair", target, simState).possible)
+            if (getActionInfo("repair", target).possible)
                 return {"type": "repair", "cursor": "action-repair", "target": target};
             else
                 return {"type": "none", "cursor": "action-repair-disabled", "target": undefined};
             break;
         }
     }
-    else if (Engine.HotkeyIsPressed("session.attack") && getActionInfo("attack", target, simState).possible)
+    else if (Engine.HotkeyIsPressed("session.attack") && getActionInfo("attack", target).possible)
     {
         return {"type": "attack", "cursor": "action-attack", "target": target};
     }
-    else if (Engine.HotkeyIsPressed("session.garrison") && getActionInfo("garrison", target, simState).possible)
+    else if (Engine.HotkeyIsPressed("session.garrison") && getActionInfo("garrison", target).possible)
     {
         return {"type": "garrison", "cursor": "action-garrison", "target": target};
     }
-    else if (Engine.HotkeyIsPressed("session.attackmove") && getActionInfo("attack-move", target, simState).possible)
+    else if (Engine.HotkeyIsPressed("session.attackmove") && getActionInfo("attack-move", target).possible)
     {
             return {"type": "attack-move", "cursor": "action-attack-move"};
     }
     else
     {
         var actionInfo = undefined;
-        if ((actionInfo = getActionInfo("setup-trade-route", target, simState)).possible)
+        if ((actionInfo = getActionInfo("setup-trade-route", target)).possible)
             return {"type": "setup-trade-route", "cursor": "action-setup-trade-route", "tooltip": actionInfo.tooltip, "target": target};
-        else if ((actionInfo = getActionInfo("gather", target, simState)).possible)
+        else if ((actionInfo = getActionInfo("gather", target)).possible)
             return {"type": "gather", "cursor": actionInfo.cursor, "target": target};
-        else if ((actionInfo = getActionInfo("returnresource", target, simState)).possible)
+        else if ((actionInfo = getActionInfo("returnresource", target)).possible)
             return {"type": "returnresource", "cursor": actionInfo.cursor, "target": target};
-        else if (getActionInfo("build", target, simState).possible)
+        else if (getActionInfo("build", target).possible)
             return {"type": "build", "cursor": "action-build", "target": target};
-        else if (getActionInfo("repair", target, simState).possible)
+        else if (getActionInfo("repair", target).possible)
             return {"type": "build", "cursor": "action-repair", "target": target};
-        else if ((actionInfo = getActionInfo("set-rallypoint", target, simState)).possible)
+        else if ((actionInfo = getActionInfo("set-rallypoint", target)).possible)
             return {"type": "set-rallypoint", "cursor": actionInfo.cursor, "data": actionInfo.data, "tooltip": actionInfo.tooltip, "position": actionInfo.position};
-        else if (getActionInfo("heal", target, simState).possible)
+        else if (getActionInfo("heal", target).possible)
             return {"type": "heal", "cursor": "action-heal", "target": target};
-        else if (getActionInfo("attack", target, simState).possible)
+        else if (getActionInfo("attack", target).possible)
             return {"type": "attack", "cursor": "action-attack", "target": target};
-        else if (getActionInfo("unset-rallypoint", target, simState).possible)
+        else if (getActionInfo("unset-rallypoint", target).possible)
             return {"type": "unset-rallypoint"};
-        else if (getActionInfo("move", target, simState).possible)
+        else if (getActionInfo("move", target).possible)
             return {"type": "move"};
     }
     return {"type": type, "cursor": cursor, "target": target};
@@ -1170 +1169 @@
                     {
                         // If double click hasn't already occurred, this is a double click.
                         // Select similar units regardless of rank
-                        templateToMatch = Engine.GuiInterfaceCall("GetEntityState", selectedEntity).identity.selectionGroupName;
+                        templateToMatch = GetEntityState(selectedEntity).identity.selectionGroupName;
                         if (templateToMatch)
                         {
                             matchRank = false;
                         }
                         else
                         {   // No selection group name defined, so fall back to exact match
-                            templateToMatch = Engine.GuiInterfaceCall("GetEntityState", selectedEntity).template;
+                            templateToMatch = GetEntityState(selectedEntity).template;
                         }
 
                         doubleClicked = true;
@@ -1188 +1187 @@
                     {
                         // Double click has already occurred, so this is a triple click.
                         // Select units matching exact template name (same rank)
-                        templateToMatch = Engine.GuiInterfaceCall("GetEntityState", selectedEntity).template;
+                        templateToMatch = GetEntityState(selectedEntity).template;
                     }
 
                     // TODO: Should we handle "control all units" here as well?
@@ -1557 +1556 @@
 // Add the unit shown at position to the training queue for all entities in the selection
 function addTrainingByPosition(position)
 {
-    var simState = Engine.GuiInterfaceCall("GetSimulationState");
+    var simState = GetSimState();
     var playerState = simState.players[Engine.GetPlayerID()];
     var selection = g_Selection.toList();
 

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

@@ -8 +8 @@
 
 var g_GameSpeeds = {};
 var g_CurrentSpeed;
+var g_SimState;
 
 var g_PlayerAssignments = { "local": { "name": "You", "player": 1 } };
 
@@ -46 +47 @@
     return g_EntityStates[entId];
 }
 
+function GetSimState()
+{
+    if (!g_SimState)
+    {
+        g_SimState = Engine.GuiInterfaceCall("GetSimulationState");
+    }
+
+    return g_SimState;
+}
+
 // Cache TemplateData
 var g_TemplateData = {}; // {id:template}
 
@@ -159 +170 @@
 
 function resignGame()
 {
-    var simState = Engine.GuiInterfaceCall("GetSimulationState");
+    var simState = GetSimState();
 
     // Players can't resign if they've already won or lost. 
     if (simState.players[Engine.GetPlayerID()].state != "active" || g_Disconnected)
@@ -301 +312 @@
 
 function checkPlayerState()
 {
-    var simState = Engine.GuiInterfaceCall("GetSimulationState");
+    var simState = GetSimState();
     var playerState = simState.players[Engine.GetPlayerID()];
 
     if (!g_GameEnded)
@@ -386 +397 @@
     g_TemplateData = {};
     g_TechnologyData = {};
 
-    var simState = Engine.GuiInterfaceCall("GetSimulationState");
+    g_SimState = Engine.GuiInterfaceCall("GetSimulationState");
 
     // If we're called during init when the game is first loading, there will be no simulation yet, so do nothing
-    if (!simState)
+    if (!g_SimState)
         return;
 
     handleNotifications();
@@ -397 +408 @@
     if (g_ShowAllStatusBars)
         recalculateStatusBarDisplay();
 
-    updateHero(simState);
+    updateHero();
     updateGroups();
-    updateDebug(simState);
-    updatePlayerDisplay(simState);
+    updateDebug();
+    updatePlayerDisplay();
     updateSelectionDetails();
     updateResearchDisplay();
     updateBuildingPlacementPreview();
-    updateTimeElapsedCounter(simState);
+    updateTimeElapsedCounter();
 
     // Update music state on basis of battle state.
     var battleState = Engine.GuiInterfaceCall("GetBattleState", Engine.GetPlayerID());
@@ -412 +423 @@
         global.music.setState(global.music.states[battleState]);
 }
 
-function updateHero(simState)
+function updateHero()
 {
+    var simState = GetSimState();
     var playerState = simState.players[Engine.GetPlayerID()];
     var heroButton = getGUIObjectByName("unitHeroButton");
 
@@ -424 +436 @@
     }
 
     var heroImage = getGUIObjectByName("unitHeroImage");
-    var heroState = Engine.GuiInterfaceCall("GetEntityState", playerState.heroes[0]);
+    var heroState = GetEntityState(playerState.heroes[0]);
     var template = GetTemplateData(heroState.template);
     heroImage.sprite = "stretched:session/portraits/" + template.icon;
 
@@ -471 +483 @@
         layoutButtonRow(i, guiName, buttonSideLength, buttonSpacer, rowLength*i, rowLength*(i+1) );
 }
 
-function updateDebug(simState)
+function updateDebug()
 {
+    var simState = GetSimState();
     var debug = getGUIObjectByName("debug");
 
     if (getGUIObjectByName("devDisplayState").checked)
@@ -506 +519 @@
     debug.caption = text;
 }
 
-function updatePlayerDisplay(simState)
+function updatePlayerDisplay()
 {
+    var simState = GetSimState();
     var playerState = simState.players[Engine.GetPlayerID()];
     if (!playerState)
         return;
@@ -582 +596 @@
         getGUIObjectByName("researchStartedButton[" + i + "]").hidden = true;
 }
 
-function updateTimeElapsedCounter(simState)
+function updateTimeElapsedCounter()
 {
+    var simState = GetSimState();
     var speed = g_CurrentSpeed != 1.0 ? " (" + g_CurrentSpeed + "x)" : "";
     var timeElapsedCounter = getGUIObjectByName("timeElapsedCounter");
     timeElapsedCounter.caption = timeToString(simState.timeElapsed) + speed;

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

@@ -1007 +1007 @@
     {
         // Get player state to check some constraints
         // e.g. presence of a hero or build limits
-        var simState = Engine.GuiInterfaceCall("GetSimulationState");
+        var simState = GetSimState();
         var playerState = simState.players[player];
 
         if (selection.length > 1)

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

@@ -37 +37 @@
 {
     var players = [];
 
-    var simState = Engine.GuiInterfaceCall("GetSimulationState");
+    var simState = GetSimState();
     if (!simState)
         return players;