Ticket #1044: autogarrison-3.diff

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

@@ -295 +295 @@
             }
         }
 
-        // Don't allow the rally point to be set on any of the currently selected entities
+        // Don't allow the rally point to be set on any of the currently selected entities (used for unset)
+        // except if the target is a productionQueue and the autorallypoint hotkey is pressed
         for (var i = 0; i < selection.length; i++)
+        {
             if (target === selection[i])
+            {
+                if (Engine.HotkeyIsPressed("session.autorallypoint") && targetState.production && targetState.production.entities.length)
+                    break;
                 return {"possible": false};
+            }
+        }
 
         return {"possible": true, "data": data, "position": targetState.position, "cursor": cursor, "tooltip": tooltip};
     }
@@ -1788 +1795 @@
     if (entity)
     {
         var entState = GetEntityState(entity);
-        var template = GetTemplateData(entState.template);
-        var unitName = getEntityName(template);
 
         var playerID = Engine.GetPlayerID();
         var simState = GetSimState();

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

@@ -442 +442 @@
 };
 
 /*
- * This function creates the entities and places them in world if possible.
- * returns the number of successfully spawned entities.
+ * This function creates the entities and places them in world if possible
+ * and returns the number of successfully created entities.
+ * (some of these entities may be garrisoned directly if autogarrison, the others are spawned).
  */
 ProductionQueue.prototype.SpawnUnits = function(templateName, count, metadata)
 {
@@ -452 +453 @@
     var cmpOwnership = Engine.QueryInterface(this.entity, IID_Ownership);
     var cmpRallyPoint = Engine.QueryInterface(this.entity, IID_RallyPoint);
     
+    var createdEnts = [];
     var spawnedEnts = [];
     
     if (this.entityCache.length == 0)
@@ -476 +478 @@
         }
     }
 
+    var cmpAutoGarrison = undefined;
+    if (cmpRallyPoint)
+    {
+        var data = cmpRallyPoint.GetData()[0];
+        if (data && data.target == this.entity && data.command == "garrison")
+            cmpAutoGarrison = Engine.QueryInterface(this.entity, IID_GarrisonHolder);
+    }
+
     for (var i = 0; i < count; ++i)
     {
         var ent = this.entityCache[0];
-        var pos = cmpFootprint.PickSpawnPoint(ent);
-        if (pos.y < 0)
+        var cmpNewOwnership = Engine.QueryInterface(ent, IID_Ownership);
+        cmpNewOwnership.SetOwner(cmpOwnership.GetOwner());
+
+        if (cmpAutoGarrison && cmpAutoGarrison.PerformGarrison(ent))
         {
-            // Fail: there wasn't any space to spawn the unit
-            break;
+            var cmpUnitAI = Engine.QueryInterface(ent, IID_UnitAI);
+            cmpUnitAI.Autogarrison();
         }
         else
         {
-            // Successfully spawned
-            var cmpNewPosition = Engine.QueryInterface(ent, IID_Position);
-            cmpNewPosition.JumpTo(pos.x, pos.z);
-            // TODO: what direction should they face in?
+            var pos = cmpFootprint.PickSpawnPoint(ent);
+            if (pos.y < 0)
+            {
+                // Fail: there wasn't any space to spawn the unit
+                break;
+            }
+            else
+            {
+                // Successfully spawned
+                var cmpNewPosition = Engine.QueryInterface(ent, IID_Position);
+                cmpNewPosition.JumpTo(pos.x, pos.z);
+                // TODO: what direction should they face in?
+                spawnedEnts.push(ent);
+            }
+        }
 
-            var cmpNewOwnership = Engine.QueryInterface(ent, IID_Ownership);
-            cmpNewOwnership.SetOwner(cmpOwnership.GetOwner());
-            
-            var cmpPlayerStatisticsTracker = QueryOwnerInterface(this.entity, IID_StatisticsTracker);
-            cmpPlayerStatisticsTracker.IncreaseTrainedUnitsCounter();
+        var cmpPlayerStatisticsTracker = QueryOwnerInterface(this.entity, IID_StatisticsTracker);
+        cmpPlayerStatisticsTracker.IncreaseTrainedUnitsCounter();
 
-            // Play a sound, but only for the first in the batch (to avoid nasty phasing effects)
-            if (spawnedEnts.length == 0)
-                PlaySound("trained", ent);
+        // Play a sound, but only for the first in the batch (to avoid nasty phasing effects)
+        if (createdEnts.length == 0)
+            PlaySound("trained", ent);
             
-            this.entityCache.shift();
-            spawnedEnts.push(ent);
-        }
+        this.entityCache.shift();
+        createdEnts.push(ent);
     }
 
     if (spawnedEnts.length > 0)
@@ -518 +537 @@
             {
                 var commands = GetRallyPointCommands(cmpRallyPoint, spawnedEnts);
                 for each(var com in commands)
-                {
                     ProcessCommand(cmpOwnership.GetOwner(), com);
-                }
             }
         }
+    }
 
+    if (createdEnts.length > 0)
+    {
         Engine.PostMessage(this.entity, MT_TrainingFinished, {
-            "entities": spawnedEnts,
+            "entities": createdEnts,
             "owner": cmpOwnership.GetOwner(),
             "metadata": metadata,
         });
     }
     
-    return spawnedEnts.length;
+    return createdEnts.length;
 };
 
 /*

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

@@ -620 +620 @@
         }
     },
 
+    "Order.Autogarrison": function(msg) {
+        this.SetNextState("INDIVIDUAL.AUTOGARRISON");
+    },
+
     "Order.Cheering": function(msg) {
         this.SetNextState("INDIVIDUAL.CHEERING");
     },
@@ -2331 +2335 @@
             },
         },
 
+        "AUTOGARRISON": {
+            "enter": function() {
+                this.isGarrisoned = true;
+                return false;
+            },
+                
+            "Order.Ungarrison": function() {
+                if (this.FinishOrder())
+                    return;
+            },
+
+            "leave": function() {
+                this.isGarrisoned = false;
+            }
+        },
+
         "CHEERING": {
             "enter": function() {
                 // Unit is invulnerable while cheering
@@ -3980 +4000 @@
 };
 
 /**
+ * Adds autogarrison order to the queue (only used by ProductionQueue for auto-garrisoning)
+ */
+UnitAI.prototype.Autogarrison = function()
+{
+    this.AddOrder("Autogarrison", null, false);
+};
+
+/**
  * Adds gather order to the queue, forced by the player 
  * until the target is reached 
  */

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

@@ -157 +157 @@
  */
 GarrisonHolder.prototype.Garrison = function(entity)
 {
+    var cmpPosition = Engine.QueryInterface(entity, IID_Position);
+    if (!cmpPosition)
+        return false;
+
+    if (!this.PerformGarrison(entity))
+        return false;
+
+    cmpPosition.MoveOutOfWorld();
+    return true;
+};
+
+GarrisonHolder.prototype.PerformGarrison = function(entity)
+{
     if (!this.HasEnoughHealth())
         return false;
 
@@ -167 +180 @@
     if (this.entities.length >= this.GetCapacity())
         return false;
 
-    var cmpPosition = Engine.QueryInterface(entity, IID_Position);
-    if (!cmpPosition)
-        return false;
-
     if (!this.timer && this.GetHealRate() > 0)
     {
         var cmpTimer = Engine.QueryInterface(SYSTEM_ENTITY, IID_Timer);
@@ -179 +188 @@
 
     // Actual garrisoning happens here
     this.entities.push(entity);
-    cmpPosition.MoveOutOfWorld();
     this.UpdateGarrisonFlag();
     var cmpProductionQueue = Engine.QueryInterface(entity, IID_ProductionQueue);
     if (cmpProductionQueue)
@@ -260 +268 @@
         if (rallyPos)
         {
             var commands = GetRallyPointCommands(cmpRallyPoint, entities);
+            // ignore the rally point if it is autogarrison
+            if (commands[0].type == "garrison" && commands[0].target == this.entity)
+                return;
             for each (var com in commands)
             {
                 ProcessCommand(cmpOwnership.GetOwner(), com);

binaries/data/config/default.cfg

@@ -276 +276 @@
 hotkey.session.massbarter = Shift           ; Modifier to barter bunch of resources
 hotkey.session.masstribute = Shift          ; Modifier to tribute bunch of resources
 hotkey.session.unloadtype = Shift           ; Modifier to unload all units of type
+hotkey.session.autorallypoint = Ctrl        ; Modifier to set the rally point of one building on itself
 hotkey.session.deselectgroup = Ctrl         ; Modifier to deselect units when clicking group icon, instead of selecting
 hotkey.session.rotate.cw = RightBracket     ; Rotate building placement preview clockwise
 hotkey.session.rotate.ccw = LeftBracket     ; Rotate building placement preview anticlockwise