Ticket #1515: directed_unit_movement.patch

binaries/data/config/default.cfg

@@ -217 +217 @@
 hotkey.click.left = "Z"
 hotkey.click.right = "C"
 
+hotkey.selection.group.left = "Ctrl+LeftArrow"
+hotkey.selection.group.right = "Ctrl+RightArrow"
+hotkey.selection.group.up = "Ctrl+UpArrow"
+hotkey.selection.group.down = "Ctrl+DownArrow"
 ; > SESSION CONTROLS
 hotkey.session.kill = Delete                ; Destroy selected units
 hotkey.session.garrison = Ctrl              ; Modifier to garrison when clicking on building

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

@@ -1591 +1591 @@
     }
 }
 
+function walkDirection(direction)
+{
+    var selection = g_Selection.toList();
+    if (selection.length) {
+        Engine.PostNetworkCommand({
+            "type": "walk-direction",
+            "entities": selection,
+            "direction": direction
+        });
+    }
+}
+
 function handleHotkey(ev)
 {
     if (ev.hotkey && ev.hotkey.indexOf("selection.group.") == 0)
@@ -1663 +1675 @@
         preSelectedAction = ACTION_FORMATION;
         inputState = INPUT_ACTION_STATE;
         return;
+    case "up":
+        walkDirection(2 * Math.PI + Engine.GetCameraOrientation());
+        inputState = INPUT_NORMAL;
+        preSelectedAction = ACTION_NONE;
+        return;
+    case "right":
+        walkDirection(0.5 * Math.PI + Engine.GetCameraOrientation());
+        inputState = INPUT_NORMAL;
+        preSelectedAction = ACTION_NONE;
+        return;
+    case "down":
+        walkDirection(Math.PI + Engine.GetCameraOrientation());
+        inputState = INPUT_NORMAL;
+        preSelectedAction = ACTION_NONE;
+        return;
+    case "left":
+        walkDirection(1.5 * Math.PI + Engine.GetCameraOrientation());
+        inputState = INPUT_NORMAL;
+        preSelectedAction = ACTION_NONE;
+        return;
     }
     if (inputState == INPUT_ACTION_STATE)
         inputState = INPUT_NORMAL;

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

@@ -204 +204 @@
             this.SetNextState("INDIVIDUAL.WALKING");
     },
 
-    "Order.WalkToTarget": function(msg) {
+    "Order.WalkTo": function(msg) {
         // Let players move captured domestic animals around
         if (this.IsAnimal() && !this.IsDomestic())
         {
             this.FinishOrder();
             return;
         }
+        var ok;
+        if (this.order.data.target)
+            ok = this.MoveToTarget(this.order.data.target);
+        else if (this.order.data.direction)
+            ok = this.MoveDirection(this.order.data.direction);
 
-        var ok = this.MoveToTarget(this.order.data.target);
         if (ok)
         {
             // We've started walking to the given point
@@ -1656 +1660 @@
             // Ignore all orders that animals might otherwise respond to
             "Order.FormationWalk": function() { },
             "Order.Walk": function() { },
-            "Order.WalkToTarget": function() { },
+            "Order.WalkTo": function() { },
             "Order.Attack": function() { },
 
             "Attacked": function(msg) {
@@ -2410 +2414 @@
     return cmpUnitMotion.MoveToTargetRange(target, min, max);
 };
 
+UnitAI.prototype.MoveDirection = function(angle)
+{
+    // where are we?
+    var cmpPosition = Engine.QueryInterface(this.entity, IID_Position);
+    if (!cmpPosition || !cmpPosition.IsInWorld())
+        return false;
+
+    var targetPos = cmpPosition.GetPosition();
+    var cmpMotion = Engine.QueryInterface(this.entity, IID_UnitMotion);
+
+    // TODO: How far can we go until we meet an obstacle?
+    var distance = 50.0;
+
+    targetPos.x += Math.sin(angle) * distance;
+    targetPos.z += Math.cos(angle) * distance;
+
+    this.MoveToPoint(targetPos.x, targetPos.z)
+    return true;
+};
+
 UnitAI.prototype.CheckTargetRange = function(target, iid, type)
 {
     var cmpRanged = Engine.QueryInterface(this.entity, iid);
@@ -2722 +2746 @@
 
             break; // and continue the loop
 
-        case "WalkToTarget":
+        case "WalkTo":
         case "WalkToTargetRange": // This doesn't move to the target (just into range), but a later order will.
         case "Flee":
         case "LeaveFoundation":
@@ -2779 +2803 @@
  */
 UnitAI.prototype.WalkToTarget = function(target, queued)
 {
-    this.AddOrder("WalkToTarget", { "target": target, "force": true }, queued);
+    this.AddOrder("WalkTo", { "target": target, "force": true }, queued);
+};
+
+/**
+ * Adds walk-direction order to queue, but respond to events e.g. attack response
+ */
+UnitAI.prototype.WalkDirection = function(direction)
+{
+    this.AddOrder("WalkTo", { "direction": direction, "force": false });
 };
 
 /**

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

@@ -60 +60 @@
             cmpUnitAI.Walk(cmd.x, cmd.z, cmd.queued);
         });
         break;
+    case "walk-direction":
+        var entities = FilterEntityList(cmd.entities, player, controlAllUnits);
+        GetFormationUnitAIs(entities, player).forEach(function(cmpUnitAI) {
+            cmpUnitAI.WalkDirection(cmd.direction);
+        });
+        break;
 
     case "attack":
         if (g_DebugCommands && !IsOwnedByEnemyOfPlayer(player, cmd.target))

source/graphics/GameView.cpp

@@ -1049 +1049 @@
     return m->ViewFOV + DEGTORAD(6.0f); //add 6 degrees to the default FOV for use with the culling frustum;
 }
 
+float CGameView::getOrientation() const
+{
+    CVector3D cameraIn = m->ViewCamera.m_Orientation.GetIn();
+    return atan2(cameraIn.X, cameraIn.Z);
+}
+
+
 void CGameView::SetCameraProjection()
 {
     m->ViewCamera.SetProjection(m->ViewNear, m->ViewFar, m->ViewFOV);

source/graphics/GameView.h

@@ -94 +94 @@
     float GetFar() const;
     float GetFOV() const;
     float GetCullFOV() const;
+    float getOrientation() const;
 
     // Set projection of current camera using near, far, and FOV values
     void SetCameraProjection();

source/gui/scripting/ScriptFunctions.cpp

@@ -445 +445 @@
     return INVALID_ENTITY;
 }
 
+float GetCameraOrientation(void* UNUSED(cbdata))
+{
+    return g_Game->GetView()->getOrientation();
+}
+
 bool HotkeyIsPressed_(void* UNUSED(cbdata), std::string hotkeyName)
 {
     return HotkeyIsPressed(hotkeyName);
@@ -631 +636 @@
     scriptInterface.RegisterFunction<void, entity_id_t, &CameraFollowFPS>("CameraFollowFPS");
     scriptInterface.RegisterFunction<void, entity_pos_t, entity_pos_t, &CameraMoveTo>("CameraMoveTo");
     scriptInterface.RegisterFunction<entity_id_t, &GetFollowedEntity>("GetFollowedEntity");
+    scriptInterface.RegisterFunction<float, &GetCameraOrientation>("GetCameraOrientation");
     scriptInterface.RegisterFunction<bool, std::string, &HotkeyIsPressed_>("HotkeyIsPressed");
     scriptInterface.RegisterFunction<void, std::wstring, &DisplayErrorDialog>("DisplayErrorDialog");
     scriptInterface.RegisterFunction<CScriptVal, &GetProfilerState>("GetProfilerState");