Ticket #2413: ResourceTrickle.patch

components/interfaces/ResourceTrickle.js

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

components/ResourceTrickle.js

@@ +1 @@
+function ResourceTrickle() {}
+
+ResourceTrickle.prototype.Schema = 
+    "<a:help>Controls the resource trickle ability of the unit.</a:help>" +
+    "<element name='FoodRate' a:help='Food given to the player every interval'>" +
+        "<ref name='nonNegativeDecimal'/>" +
+    "</element>" +
+    "<element name='WoodRate' a:help='Wood given to the player every interval'>" +
+        "<ref name='nonNegativeDecimal'/>" +
+    "</element>" +
+    "<element name='StoneRate' a:help='Stone given to the player every interval'>" +
+        "<ref name='nonNegativeDecimal'/>" +
+    "</element>" +
+    "<element name='MetalRate' a:help='Metal given to the player every interval'>" +
+        "<ref name='nonNegativeDecimal'/>" +
+    "</element>" +
+    "<element name='Interval' a:help='Number of miliseconds must pass for the player to gain the next trickle.'>" +
+        "<ref name='nonNegativeDecimal'/>" +
+    "</element>";
+
+ResourceTrickle.prototype.Init = function()
+{
+    // We can't add float values to player's resources. So we put the reminder of the float value here.
+    // For example, if our food rate is 1.5, in the first interval it gives 1 point of food to the player
+    // and puts the rest (0.5) here. In the next interval, the value here is added to the rate, which means
+    // 0.5 + 1.5 = 2.0 . So 2 points of food is added to the player and the rest (0.0) is put here and so on.
+    this.store = { "food": 0.0, "wood": 0.0, "stone": 0.0, "metal": 0.0 };
+    
+    // Call the timer
+    var cmpTimer = Engine.QueryInterface(SYSTEM_ENTITY, IID_Timer);
+    cmpTimer.SetInterval(this.entity, IID_ResourceTrickle, "Trickle", this.GetTimer(), this.GetTimer(), undefined)
+};
+
+ResourceTrickle.prototype.GetTimer = function()
+{
+    var interval = +this.template.Interval;
+
+    interval = ApplyValueModificationsToEntity("ResourceTrickle/Interval", interval, this.entity);
+    
+    return interval;
+};
+
+ResourceTrickle.prototype.GetRates = function()
+{
+    var foodrate = +this.template.FoodRate;
+    var woodrate = +this.template.WoodRate;
+    var stonerate = +this.template.StoneRate;
+    var metalrate = +this.template.MetalRate;
+
+    foodrate = ApplyValueModificationsToEntity("ResourceTrickle/FoodRate", foodrate, this.entity);
+    woodrate = ApplyValueModificationsToEntity("ResourceTrickle/WoodRate", woodrate, this.entity);
+    stonerate = ApplyValueModificationsToEntity("ResourceTrickle/StoneRate", stonerate, this.entity);
+    metalrate = ApplyValueModificationsToEntity("ResourceTrickle/MetalRate", metalrate, this.entity);
+    
+    return [ { "type": "food", "rate": foodrate }, 
+            { "type": "wood", "rate": woodrate },
+            { "type": "stone", "rate": stonerate }, 
+            { "type": "metal", "rate": metalrate } ];
+};
+
+// Do the actual work here
+ResourceTrickle.prototype.Trickle = function(data, lateness)
+{
+    // Get the rates
+    var rates = this.GetRates();
+    
+    // Get the player
+    var cmpPlayer = QueryOwnerInterface(this.entity, IID_Player);
+    
+    for each (var resource in rates)
+    {
+        // Always add an integer to the player's treasury. Explained fully in the init() function
+        this.store[resource.type] += resource.rate;
+        if (this.store[resource.type] >= 1.0)
+        {
+            var commit = Math.floor(this.store[resource.type]); // The ammount that is going to be committed to the player
+            cmpPlayer.AddResource(resource.type, commit);
+            this.store[resource.type] -= commit; // Store the reminder
+        }
+    }
+    
+};
+
+Engine.RegisterComponentType(IID_ResourceTrickle, "ResourceTrickle", ResourceTrickle);

templates/structures/pers_apadana.xml

@@ -31 +31 @@
     </Classes>
     <History>The term Apadana designates a large hypostyle palace found in Persia. The best known example, and by far the largest, was the great Apadana at Persepolis. Functioning as the empire's central audience hall, the palace is famous for the reliefs of the tribute-bearers and of the army, including the Immortals. The annual tribute that the Persians received from their satrapies and vassal states, as regularised by Darius the Great, accounted for incredible annual revenue.</History>
     <Icon>structures/palace.png</Icon>
-    <Tooltip>"Satrapy Tribute": Gain a trickle of food, wood, stone, and metal resources (not implemented yet). Train Persian heroes and their "Immortals" bodyguards. Build Limit: 1.</Tooltip>
+    <Tooltip>"Satrapy Tribute": Gain a trickle of food, wood, stone, and metal resources. Train Persian heroes and their "Immortals" bodyguards. Build Limit: 1.</Tooltip>
   </Identity>
   <Obstruction>
     <Static width="30.0" depth="30.0"/>
@@ -52 +52 @@
       persians/immortals
     </Technologies>
   </ProductionQueue>
+  <ResourceTrickle>
+    <FoodRate>1.0</FoodRate>
+    <WoodRate>1.0</WoodRate>
+    <StoneRate>0.75</StoneRate>
+    <MetalRate>0.75</MetalRate>
+    <Interval>1000</Interval>
+  </ResourceTrickle>
   <VisualActor>
     <Actor>structures/persians/sb1_new.xml</Actor>
     <FoundationActor>structures/fndn_6x6.xml</FoundationActor>