Ticket #1551: gate-close.patch

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

@@ -14 +14 @@
  */
 Gate.prototype.Init = function()
 {
-    this.units = [];
+    this.allies = [];
     this.opened = false;
     this.locked = false;
 };
@@ -48 +48 @@
 {
     var cmpRangeManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_RangeManager);
     var cmpPlayerManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
+    var cmpPlayer = Engine.QueryInterface(cmpPlayerManager.GetPlayerByID(owner), IID_Player);
     if (this.unitsQuery)
         cmpRangeManager.DestroyActiveQuery(this.unitsQuery);
-    var players = []
 
-    var numPlayers = cmpPlayerManager.GetNumPlayers();
+    // Only allied units can make the gate open.
+    var players = [];
+    for (var i = 0; i < cmpPlayer.GetDiplomacy().length; ++i)
+        if (cmpPlayer.IsAlly(i))
+            players.push(i);
 
-    // Ignore gaia units
-    for (var i = 1; i < numPlayers; ++i)
-        players.push(i);
-
     var range = this.GetPassRange();
     if (range > 0)
     {
@@ -77 +77 @@
 
     if (msg.added.length > 0)
         for each (var entity in msg.added)
-            this.units.push(entity);
+            this.allies.push(entity);
 
     if (msg.removed.length > 0)
         for each (var entity in msg.removed)
-            this.units.splice(this.units.indexOf(entity), 1);
+            this.allies.splice(this.allies.indexOf(entity), 1);
 
     this.OperateGate();
 };
@@ -96 +96 @@
 
 /**
  * Attempt to open or close the gate.
- * An ally unit must be in range to open the gate, but there must be
- *  no units (including enemies) in range to close it again.
+ * An ally must be in range to open the gate, but an unlocked gate will only close
+ * if there are no allies in range and no units are inside the gate's obstruction.
  */
 Gate.prototype.OperateGate = function()
 {
-    if (this.opened == true )
+    // Cancel the closing-blocked timer if it's running.
+    if (this.timer)
     {
-        // If no units are in range, close the gate
-        if (this.units.length == 0)
-            this.CloseGate();
+        var cmpTimer = Engine.QueryInterface(SYSTEM_ENTITY, IID_Timer);
+        cmpTimer.CancelTimer(this.timer);
+        this.timer = undefined;
     }
-    else
-    {
-        // If one units in range is owned by an ally, open the gate
-        for each (var ent in this.units)
-        {
-            if (IsOwnedByAllyOfEntity(this.entity, ent))
-            {
-                this.OpenGate();
-                break;
-            }
-        }
-    }
+
+    if (this.opened && (this.allies.length == 0 || this.locked))
+        this.CloseGate();
+    else if (!this.opened && this.allies.length)
+        this.OpenGate();
 };
 
 Gate.prototype.IsLocked = function()
@@ -141 +135 @@
             return;
         cmpObstruction.SetDisableBlockMovementPathfinding(false, false, 0);
     }
+    else
+        this.OperateGate();
 
     // TODO: Possibly move the lock/unlock sounds to UI? Needs testing
     PlaySound("gate_locked", this.entity);
@@ -157 +153 @@
         return;
 
     // Disable 'block pathfinding'
-    cmpObstruction.SetDisableBlockMovementPathfinding(false, true, 0);
+    cmpObstruction.SetDisableBlockMovementPathfinding(this.opened, true, 0);
     this.locked = false;
 
     // TODO: Possibly move the lock/unlock sounds to UI? Needs testing
@@ -201 +197 @@
     if (!cmpObstruction)
         return;
 
+    // The gate can't be closed if there are entities colliding with it.
+    var collisions = cmpObstruction.GetStructureUnitCollisions();
+    if (collisions.length)
+    {       
+        if (!this.timer)
+        {
+            var cmpTimer = Engine.QueryInterface(SYSTEM_ENTITY, IID_Timer);
+            this.timer = cmpTimer.SetTimeout(this.entity, IID_Gate, "OperateGate", 500, {});
+        }
+        return;
+    }
+
     // If we ordered the gate to be locked, enable 'block movement' and 'block pathfinding'
     if (this.locked)
         cmpObstruction.SetDisableBlockMovementPathfinding(false, false, 0);

source/simulation2/components/CCmpObstruction.cpp

@@ -492 +492 @@
         // Ignore collisions within the same control group, or with other non-foundation-blocking shapes.
         // Note that, since the control group for each entity defaults to the entity's ID, this is typically 
         // equivalent to only ignoring the entity's own shape and other non-foundation-blocking shapes.
-        SkipControlGroupsRequireFlagObstructionFilter filter(m_ControlGroup, m_ControlGroup2,
+        SkipControlGroupsRequireFlagObstructionFilter filter(false, m_ControlGroup, m_ControlGroup2,
             ICmpObstructionManager::FLAG_BLOCK_FOUNDATION);
 
         if (m_Type == STATIC)
@@ -530 +530 @@
         // Ignore collisions within the same control group, or with other non-construction-blocking shapes.
         // Note that, since the control group for each entity defaults to the entity's ID, this is typically 
         // equivalent to only ignoring the entity's own shape and other non-construction-blocking shapes. 
-        SkipControlGroupsRequireFlagObstructionFilter filter(m_ControlGroup, m_ControlGroup2,
+        SkipControlGroupsRequireFlagObstructionFilter filter(false, m_ControlGroup, m_ControlGroup2,
             ICmpObstructionManager::FLAG_BLOCK_CONSTRUCTION);
 
         if (m_Type == STATIC)
@@ -543 +543 @@
         return ret;
     }
 
+    virtual std::vector<entity_id_t> GetStructureUnitCollisions()
+    {
+        std::vector<entity_id_t> ret;
+
+        CmpPtr<ICmpPosition> cmpPosition(GetSimContext(), GetEntityId());
+        if (!cmpPosition)
+            return ret; // error
+
+        if (!cmpPosition->IsInWorld())
+            return ret; // no obstruction
+
+        CFixedVector2D pos = cmpPosition->GetPosition2D();
+
+        CmpPtr<ICmpObstructionManager> cmpObstructionManager(GetSimContext(), SYSTEM_ENTITY);
+        if (!cmpObstructionManager)
+            return ret; // error
+
+        // required precondition to use SkipControlGroupsRequireFlagObstructionFilter
+        if (m_ControlGroup == INVALID_ENTITY)
+        {
+            LOGERROR(L"[CmpObstruction] Cannot test for unit obstructions; primary control group must be valid");
+            return ret;
+        }
+
+        // Ignore collisions within the same control group, or with other non-construction-blocking shapes.
+        // Note that, since the control group for each entity defaults to the entity's ID, this is typically 
+        // equivalent to only ignoring the entity's own shape and other non-construction-blocking shapes. 
+        SkipControlGroupsRequireFlagObstructionFilter filter(true, m_ControlGroup, m_ControlGroup2,
+            ICmpObstructionManager::FLAG_BLOCK_FOUNDATION | ICmpObstructionManager::FLAG_BLOCK_PATHFINDING);
+
+        cmpObstructionManager->TestStaticShape(filter, pos.X, pos.Y, cmpPosition->GetRotation().Y, m_Size0, m_Size1, &ret);
+    
+        return ret;
+    }
+
     virtual void SetMovingFlag(bool enabled)
     {
         m_Moving = enabled;

source/simulation2/components/ICmpObstructionManager.h

@@ -365 +365 @@
  */
 class SkipControlGroupsRequireFlagObstructionFilter : public IObstructionTestFilter
 {
+    bool m_Exclude;
     entity_id_t m_Group;
     entity_id_t m_Group2;
     flags_t m_Mask;
 
 public:
-    SkipControlGroupsRequireFlagObstructionFilter(entity_id_t group1, entity_id_t group2, flags_t mask) : 
-        m_Group(group1), m_Group2(group2), m_Mask(mask)
+    SkipControlGroupsRequireFlagObstructionFilter(bool exclude, entity_id_t group1, entity_id_t group2, flags_t mask) : 
+        m_Exclude(exclude), m_Group(group1), m_Group2(group2), m_Mask(mask)
     {
         // the primary control group to filter out must be valid
         ENSURE(m_Group != INVALID_ENTITY);
@@ -386 +387 @@
     {
         // To be included in the testing, a shape must have at least one of the flags in m_Mask set, and its
         // primary control group must be valid and must equal neither our primary nor secondary control group.
-        bool includeInTesting = ((flags & m_Mask) != 0 && group != m_Group && group != m_Group2);
+        bool includeInTesting;
+        if (m_Exclude)
+            includeInTesting = (flags & m_Mask) == 0;
+        else
+            includeInTesting = (flags & m_Mask) != 0;
+        includeInTesting = (includeInTesting && group != m_Group && group != m_Group2);
 
         // If the shape being tested has a valid secondary control group, exclude it from testing if it
         // matches either our primary or secondary control group.

source/simulation2/components/tests/test_ObstructionManager.h

@@ -282 +282 @@
         // group, and shape 3 has the BLOCK_FOUNDATION flag (but not BLOCK_CONSTRUCTION), we should find only 
         // shape 3 in the result.
 
-        SkipControlGroupsRequireFlagObstructionFilter skipGroup1ReqFoundConstr(ent1g1, INVALID_ENTITY,
+        SkipControlGroupsRequireFlagObstructionFilter skipGroup1ReqFoundConstr(false, ent1g1, INVALID_ENTITY,
             ICmpObstructionManager::FLAG_BLOCK_FOUNDATION | ICmpObstructionManager::FLAG_BLOCK_CONSTRUCTION);
 
         cmp->TestUnitShape(skipGroup1ReqFoundConstr, ent1x, ent1z, fixed::FromInt(10), &out);
@@ -299 +299 @@
         // group). Despite shape 3 having at least one of the required flags set, it should now also be ignored,
         // yielding an empty result set.
         
-        SkipControlGroupsRequireFlagObstructionFilter skipGroup1And3ReqFoundConstr(ent1g1, ent3g,
+        SkipControlGroupsRequireFlagObstructionFilter skipGroup1And3ReqFoundConstr(false, ent1g1, ent3g,
             ICmpObstructionManager::FLAG_BLOCK_FOUNDATION | ICmpObstructionManager::FLAG_BLOCK_CONSTRUCTION);
 
         cmp->TestUnitShape(skipGroup1And3ReqFoundConstr, ent1x, ent1z, fixed::FromInt(10), &out);
@@ -314 +314 @@
         // to be set. Since both shape 1 and shape 2 have at least one flag set and are both in a different control 
         // group, we should find them in the result.
         
-        SkipControlGroupsRequireFlagObstructionFilter skipGroup3RequireAnyFlag(ent3g, INVALID_ENTITY,
+        SkipControlGroupsRequireFlagObstructionFilter skipGroup3RequireAnyFlag(false, ent3g, INVALID_ENTITY,
             (ICmpObstructionManager::flags_t) -1);
 
         cmp->TestUnitShape(skipGroup3RequireAnyFlag, ent1x, ent1z, fixed::FromInt(10), &out);
@@ -333 +333 @@
         // impossible for shape 1 and shape 2 to have at least one of the required flags set, and shape 3 is excluded by
         // virtue of the control group filtering, we should find an empty result.
 
-        SkipControlGroupsRequireFlagObstructionFilter skipGroup3RequireNoFlags(ent3g, INVALID_ENTITY, 0U);
+        SkipControlGroupsRequireFlagObstructionFilter skipGroup3RequireNoFlags(false, ent3g, INVALID_ENTITY, 0U);
 
         cmp->TestUnitShape(skipGroup3RequireNoFlags, ent1x, ent1z, fixed::FromInt(10), &out);
         TS_ASSERT_EQUALS(0U, out.size());
@@ -369 +369 @@
         // Since neither shape 2 nor shape 3 are part of those control groups and both have at least one available flag set,
         // the results should only those two shapes' entities.
 
-        SkipControlGroupsRequireFlagObstructionFilter skipGroup1SecAnd4SecRequireAny(ent1g2_new, ent4g2,
+        SkipControlGroupsRequireFlagObstructionFilter skipGroup1SecAnd4SecRequireAny(false, ent1g2_new, ent4g2,
             (ICmpObstructionManager::flags_t) -1);
 
         cmp->TestUnitShape(skipGroup1SecAnd4SecRequireAny, ent1x, ent1z, fixed::FromInt(10), &out);
@@ -388 +388 @@
         // any available flag to be set. (Note that the test above used shape 4's secondary control group). Results should 
         // remain the same.
         
-        SkipControlGroupsRequireFlagObstructionFilter skipGroup1SecAnd4PrimRequireAny(ent1g2_new, ent4g1,
+        SkipControlGroupsRequireFlagObstructionFilter skipGroup1SecAnd4PrimRequireAny(false, ent1g2_new, ent4g1,
             (ICmpObstructionManager::flags_t) -1);
 
         cmp->TestUnitShape(skipGroup1SecAnd4PrimRequireAny, ent1x, ent1z, fixed::FromInt(10), &out);

source/simulation2/components/ICmpObstruction.h

@@ -56 +56 @@
      */
     virtual std::vector<entity_id_t> GetConstructionCollisions() = 0;
 
+    /**
+     * Returns a list of entities that are colliding with this entity, and
+     * which are not set to block pathfinding or foundation placement.
+     * @return vector of blocking entities
+     */
+    virtual std::vector<entity_id_t> GetStructureUnitCollisions() = 0;
+
     virtual void SetActive(bool active) = 0;
 
     virtual void SetMovingFlag(bool enabled) = 0;

source/simulation2/components/ICmpObstruction.cpp

@@ -25 +25 @@
 DEFINE_INTERFACE_METHOD_0("GetUnitRadius", entity_pos_t, ICmpObstruction, GetUnitRadius)
 DEFINE_INTERFACE_METHOD_1("CheckFoundation", bool, ICmpObstruction, CheckFoundation, std::string)
 DEFINE_INTERFACE_METHOD_0("GetConstructionCollisions", std::vector<entity_id_t>, ICmpObstruction, GetConstructionCollisions)
+DEFINE_INTERFACE_METHOD_0("GetStructureUnitCollisions", std::vector<entity_id_t>, ICmpObstruction, GetStructureUnitCollisions)
 DEFINE_INTERFACE_METHOD_1("SetActive", void, ICmpObstruction, SetActive, bool)
 DEFINE_INTERFACE_METHOD_3("SetDisableBlockMovementPathfinding", void, ICmpObstruction, SetDisableBlockMovementPathfinding, bool, bool, int32_t)
 DEFINE_INTERFACE_METHOD_0("GetBlockMovementFlag", bool, ICmpObstruction, GetBlockMovementFlag)