Ticket #3277: trading_v2.patch

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

@@ -1660 +1660 @@
     let firstMarket = cmpEntityTrader.GetFirstMarket();
     let secondMarket = cmpEntityTrader.GetSecondMarket();
     let result = null;
-    if (data.target === firstMarket)
+    if (!firstMarket)
     {
+        result = { "type": "set first" };
+    }
+    else if (!secondMarket)
+    {
         result = {
+            "type": "set second",
+            "gain": cmpEntityTrader.CalculateGain(firstMarket, data.target),
+        };
+    }
+    else if (data.target === firstMarket)
+    {
+        result = {
             "type": "is first",
             "hasBothMarkets": cmpEntityTrader.HasBothMarkets()
         };
@@ -1676 +1687 @@
             "gain": cmpEntityTrader.GetGain(),
         };
     }
-    else if (!firstMarket)
-    {
-        result = { "type": "set first" };
-    }
-    else if (!secondMarket)
-    {
-        result = {
-            "type": "set second",
-            "gain": cmpEntityTrader.CalculateGain(firstMarket, data.target),
-        };
-    }
     else
     {
         // Else both markets are not null and target is different from them

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

@@ +1 @@
+/**
+ @file Market.js
+ Component used for the management of market and trade units in the field
+*/
+function Market() {}
+
+Market.prototype.Schema = "<a:component type='system'/><empty/>";
+
+Market.prototype.Init = function()
+{
+    this.tradeEntities = []; // List of trade entities from which this market works as a target
+};
+
+/**
+ Subscribes a new trader to this market.
+ @param {Object} trader - The trader object expected being subscribed inside the market.
+*/
+
+Market.prototype.SubscribeTrader = function(trader)
+{
+    // First check that this trader has not been already registered inside the market.
+    // If that is the case then do nothing and return true
+    if (trader in this.tradeEntities)
+        return true;
+
+    // If the entity has not been registered for this market,
+    // add it to the list of traders
+    this.tradeEntities.push(trader);
+
+    // If everything was correct return true
+    return true;
+};
+
+Market.prototype.OnDestroy = function()
+{
+    this.NotifySubscribedTraders();
+};
+
+Market.prototype.OnOwnershipChanged = function(msg)
+{
+    if (msg.to != -1 && msg.from != -1)
+    {
+        let cmpPlayerManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
+        let cmpPlayer = Engine.QueryInterface(cmpPlayerManager.GetPlayerByID(msg.to), IID_Player);
+
+        // If the new owner is an not an ally the trader should display a behavior
+        // similar when the market is destroyed.
+        if(!cmpPlayer.IsAlly(msg.from))
+        {
+            this.NotifySubscribedTraders();
+        }
+    }
+};
+
+Market.prototype.OnDiplomacyChanged = function(msg)
+{
+    let cmpOwnership = Engine.QueryInterface(this.entity, IID_Ownership);
+    let cmpPlayerManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
+    let cmpPlayer = Engine.QueryInterface(cmpPlayerManager.GetPlayerByID(msg.player), IID_Player);
+
+    // If the new diplomatic position of the player is not an ally return to
+    // respective ally markets
+    if (!cmpPlayer.IsAlly(cmpOwnership.GetOwner()))
+    {
+        this.NotifySubscribedTraders();
+    }
+}
+
+/**
+ Notifies traders subscribed to this market to change their trading behavior
+*/
+Market.prototype.NotifySubscribedTraders = function() {
+
+    let cmpTraderUnitAI = undefined;
+    for(let i=0, l=this.tradeEntities.length; i<l; ++i)
+    {
+        if (this.tradeEntities[i])
+        {
+            cmpTraderUnitAI = Engine.QueryInterface(this.tradeEntities[i], IID_UnitAI);
+            if (cmpTraderUnitAI)
+                cmpTraderUnitAI.InvalidateTradingMarket(this.entity);
+        }
+    }
+}
+
+Engine.RegisterComponentType(IID_Market, "Market", Market);

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

@@ -1 @@
-// See helpers/TraderGain.js for the CalculateTaderGain() function which works out how many 
-// resources a trader gets 
+// See helpers/TraderGain.js for the CalculateTaderGain() function which works out how many
+// resources a trader gets
 
 // Additional gain for ships for each garrisoned trader, in percents
 const GARRISONED_TRADER_ADDITION = 20;
@@ -63 +63 @@
                 gain.market2Gain = Math.round(garrisonMultiplier * gain.market2Gain);
         }
     }
-    
+
     return gain;
 };
 
@@ -280 +280 @@
         this.gain = this.CalculateGain(this.firstMarket, this.secondMarket);
 };
 
+Trader.prototype.InvalidateFirstMarket = function()
+{
+    this.firstMarket = INVALID_ENTITY;
+}
+
+Trader.prototype.InvalidateSecondMarket = function()
+{
+    this.secondMarket = INVALID_ENTITY;
+}
+
 Engine.RegisterComponentType(IID_Trader, "Trader", Trader);

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

@@ -2746 +2746 @@
                     let dropsiteTypes = cmpResourceDropsite.GetTypes();
                     cmpResourceGatherer.CommitResources(dropsiteTypes);
                     this.SetGathererAnimationOverride();
-                } 
+                }
 
                 // We finished building it.
                 // Switch to the next order (if any)
@@ -3458 +3458 @@
     var cmpRangeManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_RangeManager);
     if (this.losRangeQuery)
         this.SetupRangeQuery(cmpRangeManager.IsActiveQueryEnabled(this.losRangeQuery));
- 
+
     if (this.IsHealer() && this.losHealRangeQuery)
         this.SetupHealRangeQuery(cmpRangeManager.IsActiveQueryEnabled(this.losHealRangeQuery));
 };
@@ -5163 +5163 @@
         return;
     }
 
-    var marketsChanged = this.SetTargetMarket(target, source);
+    let marketsChanged = this.SetTargetMarket(target, source);
     if (!marketsChanged)
         return;
 
-    var cmpTrader = Engine.QueryInterface(this.entity, IID_Trader);
-    if (cmpTrader.HasBothMarkets())
+    let cmpTrader = Engine.QueryInterface(this.entity, IID_Trader);
+    let cmpMarket = Engine.QueryInterface(target, IID_Market);
+
+    if (cmpMarket.SubscribeTrader(this.entity) && cmpTrader.HasBothMarkets())
     {
-        var data = { "firstMarket": cmpTrader.GetFirstMarket(), "secondMarket": cmpTrader.GetSecondMarket(), "route": route, "force": false };
+        let data = { "firstMarket": cmpTrader.GetFirstMarket(), "secondMarket": cmpTrader.GetSecondMarket(), "route": route, "force": false };
 
         if (this.expectedRoute)
         {
@@ -5182 +5184 @@
         if (this.IsFormationController())
         {
             this.CallMemberFunction("AddOrder", ["Trade", data, queued]);
-            var cmpFormation = Engine.QueryInterface(this.entity, IID_Formation);
+            let cmpFormation = Engine.QueryInterface(this.entity, IID_Formation);
             if (cmpFormation)
                 cmpFormation.Disband();
         }
@@ -5230 +5232 @@
     return ok;
 };
 
+/**
+ * Makes a routing trade invalid sending the trader unit to the next
+ * possible market.
+ */
+UnitAI.prototype.InvalidateTradingMarket = function(market)
+{
+    // Find the entity inside the one of the list used in the market
+    //
+    // If the trader is found in the SourceMarket list then
+    // send him to his target market.
+    //
+    // If the trader is found in the TargetMarket list then
+    // send him to his source market
+    //
+    // If the source and target have been captured then stop
+    // trading
+    let cmpTrader = Engine.QueryInterface(this.entity, IID_Trader);
+
+    if(!cmpTrader)
+        return false;
+
+    if (!cmpTrader.GetFirstMarket() || !cmpTrader.GetSecondMarket())
+    {
+        // At the moment of writing this this.StopTrading generate errors
+        // because it calls this.FinishOrder but the order queue is empty in
+        // certain conditions. If that error is fixed this two lines
+        // should be changed to this.StopTrading()
+        //
+        // The reason of why the queue is empty is because MoveCompleted is
+        // called when the two markets are destroyed, captured or change diplomacy stattus
+        //  and inside the method, this.FinishOrder is called cleaning the order queue.
+        // This generates the problem that the trader finish its order but it doesn't stop
+        // moving or trading.
+        //
+        // Here we stop moving and trading
+        this.StopMoving();
+        cmpTrader.StopTrading();
+    }
+    else if(cmpTrader.GetFirstMarket() === market)
+    {
+        cmpTrader.InvalidateFirstMarket();
+        this.MoveToMarket(cmpTrader.GetSecondMarket());
+    }
+    else if(cmpTrader.GetSecondMarket() === market)
+    {
+        cmpTrader.InvalidateSecondMarket();
+        this.MoveToMarket(cmpTrader.GetFirstMarket());
+    }
+
+    return true;
+};
+
 UnitAI.prototype.PerformTradeAndMoveToNextMarket = function(currentMarket, nextMarket, nextFsmStateName)
 {
     if (!this.CanTrade(currentMarket))
@@ -5272 +5326 @@
 {
     this.StopMoving();
     this.FinishOrder();
-    var cmpTrader = Engine.QueryInterface(this.entity, IID_Trader);
+    let cmpTrader = Engine.QueryInterface(this.entity, IID_Trader);
     cmpTrader.StopTrading();
 };
 

binaries/data/mods/public/simulation/components/interfaces/Market.js

@@ +1 @@
+Engine.RegisterInterface("Market");

binaries/data/mods/public/simulation/templates/template_structure_economic_market.xml

@@ -63 +63 @@
   <Vision>
     <Range>32</Range>
   </Vision>
+  <Market/>
   <VisualActor>
     <FoundationActor>structures/fndn_5x5.xml</FoundationActor>
   </VisualActor>

binaries/data/mods/public/simulation/templates/template_structure_military_dock.xml

@@ -74 +74 @@
   <Vision>
     <Range>40</Range>
   </Vision>
+  <Market/>
   <VisualActor>
     <FoundationActor>structures/fndn_4x4_dock.xml</FoundationActor>
   </VisualActor>