Ticket #1173: rallypoint-trade.patch

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

@@ -210 +210 @@
         var gaiaOwned = (targetState.player == 0);
 
         var cursor = "";
+        var tooltip;
 
         // default to walking there
         var data = {command: "walk"};
@@ -254 +255 @@
             data.target = target;
             cursor = "action-repair";
         }
+        else if (hasClass(entState, "Market") && hasClass(targetState, "Market") && entState.id != targetState.id &&
+                (!hasClass(entState, "NavalMarket") || hasClass(targetState, "NavalMarket")))
+        {
+            // Find a trader (if any) that this building can produce.
+            var trader;
+            if (entState.production && entState.production.entities.length)
+                for (var i = 0; i < entState.production.entities.length; ++i)
+                    if ((trader = GetTemplateData(entState.production.entities[i]).trader))
+                        break;
+
+            var traderData = { "firstMarket": entState.id, "secondMarket": targetState.id, "template": trader };
+            var gain = Engine.GuiInterfaceCall("GetTradingRouteGain", traderData);
+            if (gain !== null)
+            {
+                data.command = "trade";
+                data.target = traderData.secondMarket;
+                data.source = traderData.firstMarket;
+                cursor = "action-setup-trade-route";
+                tooltip = "Click to establish a default route for new traders. Gain: " + gain + " metal.";
+            }
+        }
         
-        return {"possible": true, "data": data, "position": targetState.position, "cursor": cursor};
+        return {"possible": true, "data": data, "position": targetState.position, "cursor": cursor, "tooltip": tooltip};
     }
 
     for each (var entityID in selection)
@@ -463 +485 @@
         else if (getActionInfo("repair", target).possible)
             return {"type": "build", "cursor": "action-repair", "target": target};
         else if ((actionInfo = getActionInfo("set-rallypoint", target)).possible)
-            return {"type": "set-rallypoint", "cursor": actionInfo.cursor, "data": actionInfo.data, "position": actionInfo.position};
+            return {"type": "set-rallypoint", "cursor": actionInfo.cursor, "data": actionInfo.data, "tooltip": actionInfo.tooltip, "position": actionInfo.position};
         else if (getActionInfo("heal", target).possible)
             return {"type": "heal", "cursor": "action-heal", "target": target};
         else if (getActionInfo("attack", target).possible)

binaries/data/mods/public/simulation/helpers/RallyPointCommands.js

@@ -60 +60 @@
                 "queued": true
             });
             break;
+        case "trade":
+            ret.push( {
+                "type": "setup-trade-route",
+                "entities": spawnedEnts,
+                "source": data[i].source,
+                "target": data[i].target,
+                "queued": true
+            });
+            break;
         default:
             ret.push( {
                 "type": "walk",

binaries/data/mods/public/simulation/helpers/Commands.js

@@ -379 +379 @@
         {
             var cmpUnitAI = Engine.QueryInterface(ent, IID_UnitAI);
             if (cmpUnitAI)
-                cmpUnitAI.SetupTradeRoute(cmd.target);
+                cmpUnitAI.SetupTradeRoute(cmd.target, cmd.source);
         }
         break;
 

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

@@ -2919 +2919 @@
  * Adds trade order to the queue. Either walk to the first market, or
  * start a new route. Not forced, so it can be interrupted by attacks.
  */
-UnitAI.prototype.SetupTradeRoute = function(target, queued)
+UnitAI.prototype.SetupTradeRoute = function(target, source, queued)
 {
     if (!this.CanTrade(target))
     {
@@ -2928 +2928 @@
     }
 
     var cmpTrader = Engine.QueryInterface(this.entity, IID_Trader);
-    var marketsChanged = cmpTrader.SetTargetMarket(target);
+    var marketsChanged = cmpTrader.SetTargetMarket(target, source);
     if (marketsChanged)
     {
         if (cmpTrader.HasBothMarkets())

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

@@ -36 +36 @@
     this.goods = { "type": null, "amount": 0 };
 }
 
-Trader.prototype.CalculateGain = function(firstMarket, secondMarket)
+Trader.prototype.CalculateGain = function(firstMarket, secondMarket, template)
 {
     var cmpFirstMarketPosition = Engine.QueryInterface(firstMarket, IID_Position);
     var cmpSecondMarketPosition = Engine.QueryInterface(secondMarket, IID_Position);
@@ -59 +59 @@
 
     // For ship increase gain for each garrisoned trader
     var cmpIdentity = Engine.QueryInterface(this.entity, IID_Identity);
-    if (cmpIdentity.HasClass("Ship"))
+    if (cmpIdentity && cmpIdentity.HasClass("Ship"))
     {
         var cmpGarrisonHolder = Engine.QueryInterface(this.entity, IID_GarrisonHolder);
         if (cmpGarrisonHolder)
@@ -75 +75 @@
         }
     }
 
-    if (this.template.GainMultiplier)
-        gain *= this.template.GainMultiplier;
+    // A template may be passed as an argument, serving as an override.
+    if (!template)
+        template = this.template;
+
+    if (template.GainMultiplier)
+        gain *= template.GainMultiplier;
     gain = Math.round(gain);
     return gain;
 }
@@ -88 +92 @@
 
 // Set target as target market.
 // Return true if at least one of markets was changed.
-Trader.prototype.SetTargetMarket = function(target)
+Trader.prototype.SetTargetMarket = function(target, source)
 {
     // Check that target is a market
     var cmpTargetIdentity = Engine.QueryInterface(target, IID_Identity);
@@ -96 +100 @@
         return false;
     if (!cmpTargetIdentity.HasClass("Market") && !cmpTargetIdentity.HasClass("NavalMarket"))
         return false;
-    var marketsChanged = false;
+    var marketsChanged = true;
+    if (source)
+    {
+        // Establish a trade route with both markets in one go.
+        cmpTargetIdentity = Engine.QueryInterface(source, IID_Identity);
+        if (!cmpTargetIdentity)
+            return false;
+        if (!cmpTargetIdentity.HasClass("Market") && !cmpTargetIdentity.HasClass("NavalMarket"))
+            return false;
+
+        this.firstMarket = source;
+        this.secondMarket = INVALID_ENTITY;
+    }
+
     if (this.secondMarket)
     {
         // If we already have both markets - drop them
         // and use the target as first market
         this.firstMarket = target;
         this.secondMarket = INVALID_ENTITY;
-        marketsChanged = true;
     }
     else if (this.firstMarket)
     {
         // If we have only one market and target is different from it,
         // set the target as second one
-        if (target != this.firstMarket)
+        if (target == this.firstMarket)
+            marketsChanged = false;
+        else
         {
             this.secondMarket = target;
             this.gain = this.CalculateGain(this.firstMarket, this.secondMarket);
-            marketsChanged = true;
         }
     }
     else
@@ -121 +138 @@
         // Else we don't have target markets at all,
         // set the target as first market
         this.firstMarket = target;
-        marketsChanged = true;
     }
     if (marketsChanged)
     {

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

@@ -452 +452 @@
         if (template.UnitMotion.Run) ret.speed.run = +template.UnitMotion.Run.Speed;
     }
 
+    if (template.Trader)
+        ret.trader = template.Trader;
+
     if (template.WallSet)
     {
         ret.wallSet = {
@@ -1468 +1471 @@
     return 0;
 };
 
+GuiInterface.prototype.GetTradingRouteGain = function(player, data)
+{
+    if (!data.firstMarket || !data.secondMarket)
+        return null;
+
+    var cmpTrader = Engine.QueryInterface(SYSTEM_ENTITY, IID_Trader);
+    if (!cmpTrader)
+        return null;
+
+    return cmpTrader.CalculateGain(data.firstMarket, data.secondMarket, data.template);
+}
+
 GuiInterface.prototype.GetTradingDetails = function(player, data)
 {
     var cmpEntityTrader = Engine.QueryInterface(data.trader, IID_Trader);
@@ -1588 +1603 @@
     "GetFoundationSnapData": 1,
     "PlaySound": 1,
     "FindIdleUnit": 1,
+    "GetTradingRouteGain": 1,
     "GetTradingDetails": 1,
     "CanAttack": 1,
 

source/simulation2/Simulation2.cpp

@@ -121 +121 @@
 
             LOAD_SCRIPTED_COMPONENT("AIInterface");
             LOAD_SCRIPTED_COMPONENT("Barter");
+            LOAD_SCRIPTED_COMPONENT("Trader");
             LOAD_SCRIPTED_COMPONENT("EndGameManager");
             LOAD_SCRIPTED_COMPONENT("GuiInterface");
             LOAD_SCRIPTED_COMPONENT("PlayerManager");