Ticket #4161: 0005-Add-GetPlayersByDiplomacy-to-cmpPlayer.patch

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

@@ -121 +121 @@
     if (!cmpPlayer)
         return;
 
-    var enemies = [];
-    var numPlayers = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager).GetNumPlayers();
-    for (let i = 1; i < numPlayers; ++i)
-        if (cmpPlayer.IsEnemy(i))
-            enemies.push(i);
+    var enemies = cmpPlayer.GetEnemies();
+    if (enemies.length && enemies[0] == 0)
+        enemies.shift(); // remove gaia
 
     if (!enemies.length)
         return;

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

@@ -65 +65 @@
 Gate.prototype.SetupRangeQuery = function(owner)
 {
     var cmpRangeManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_RangeManager);
-    var cmpPlayer = QueryPlayerIDInterface(owner);
 
     if (this.unitsQuery)
         cmpRangeManager.DestroyActiveQuery(this.unitsQuery);
 
     // 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);
+    var players = QueryPlayerIDInterface(owner).GetAllies();
 
     var range = this.GetPassRange();
     if (range > 0)

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

@@ -497 +497 @@
 Player.prototype.UpdateSharedLos = function()
 {
     let cmpRangeManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_RangeManager);
-    let cmpPlayerManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
     let cmpTechnologyManager = Engine.QueryInterface(this.entity, IID_TechnologyManager);
-    if (!cmpRangeManager || !cmpPlayerManager || !cmpTechnologyManager)
+    if (!cmpRangeManager || !cmpTechnologyManager)
         return;
 
-    let sharedLos = [];
     if (!cmpTechnologyManager.IsTechnologyResearched(this.template.SharedLosTech))
     {
         cmpRangeManager.SetSharedLos(this.playerID, [this.playerID]);
         return;
     }
-    for (var i = 0; i < cmpPlayerManager.GetNumPlayers(); ++i)
-        if (this.IsMutualAlly(i))
-            sharedLos.push(i);
 
-    cmpRangeManager.SetSharedLos(this.playerID, sharedLos);
+    cmpRangeManager.SetSharedLos(this.playerID, this.GetMutualAllies());
 };
 
 Player.prototype.GetFormations = function()
@@ -575 +570 @@
     return this.isAI;
 };
 
+Player.prototype.GetPlayersByDiplomacy = function(func)
+{
+    var players = [];
+    for (var i = 0; i < this.diplomacy.length; ++i)
+        if (this[func](i))
+            players.push(i);
+    return players;
+};
+
 Player.prototype.SetAlly = function(id)
 {
     this.SetDiplomacyIndex(id, 1);
@@ -588 +592 @@
     return this.diplomacy[id] > 0;
 };
 
+Player.prototype.GetAllies = function()
+{
+    return this.GetPlayersByDiplomacy("IsAlly");
+};
+
 /**
  * Check if given player is our ally excluding ourself
  */
@@ -605 +614 @@
     return this.IsAlly(id) && cmpPlayer && cmpPlayer.IsAlly(this.playerID);
 };
 
+Player.prototype.GetMutualAllies = function()
+{
+    return this.GetPlayersByDiplomacy("IsMutualAlly");
+};
+
 /**
  * Check if given player is our ally, and we are its ally, excluding ourself
  */
@@ -619 +633 @@
 };
 
 /**
- * Get all enemies of a given player.
- */
-Player.prototype.GetEnemies = function()
-{
-    var enemies = [];
-    for (var i = 0; i < this.diplomacy.length; ++i)
-        if (this.diplomacy[i] < 0)
-            enemies.push(i);
-    return enemies;
-};
-
-/**
  * Check if given player is our enemy
  */
 Player.prototype.IsEnemy = function(id)
@@ -638 +640 @@
     return this.diplomacy[id] < 0;
 };
 
+Player.prototype.GetEnemies = function()
+{
+    return this.GetPlayersByDiplomacy("IsEnemy");
+};
+
 Player.prototype.SetNeutral = function(id)
 {
     this.SetDiplomacyIndex(id, 0);

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

@@ -3473 +3473 @@
     if (!cmpPlayer)
         return;
 
-    var players = [];
-
-    var numPlayers = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager).GetNumPlayers();
-    for (var i = 0; i < numPlayers; ++i)
-    {
-        // Exclude allies, and self
-        // TODO: How to handle neutral players - Special query to attack military only?
-        if (cmpPlayer.IsEnemy(i))
-            players.push(i);
-    }
-
+    // Exclude allies, and self
+    // TODO: How to handle neutral players - Special query to attack military only?
+    var players = cmpPlayer.GetEnemies();
     var range = this.GetQueryRange(IID_Attack);
 
     this.losRangeQuery = cmpRangeManager.CreateActiveQuery(this.entity, range.min, range.max, players, IID_DamageReceiver, cmpRangeManager.GetEntityFlagMask("normal"));
@@ -3510 +3502 @@
     if (!cmpPlayer)
         return;
 
-    var players = [];
-
-    var numPlayers = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager).GetNumPlayers();
-    for (var i = 0; i < numPlayers; ++i)
-    {
-        // Exclude gaia and enemies
-        if (cmpPlayer.IsAlly(i))
-            players.push(i);
-    }
-
+    var players = cmpPlayer.GetAllies();
     var range = this.GetQueryRange(IID_Heal);
 
     this.losHealRangeQuery = cmpRangeManager.CreateActiveQuery(this.entity, range.min, range.max, players, IID_Health, cmpRangeManager.GetEntityFlagMask("injured"));
@@ -4080 +4063 @@
     var players = [owner];
     var cmpPlayer = QueryOwnerInterface(this.entity);
     if (cmpPlayer && cmpPlayer.HasSharedDropsites())
-    {
-        let cmpPlayerManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
-        for (let i = 1; i < cmpPlayerManager.GetNumPlayers(); ++i)
-            if (i != owner && cmpPlayer.IsMutualAlly(i))
-                players.push(i);
-    }
+        players = cmpPlayer.GetMutualAllies();
 
     var cmpRangeManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_RangeManager);
     var nearby = cmpRangeManager.ExecuteQuery(this.entity, 0, -1, players, IID_ResourceDropsite);

binaries/data/mods/public/simulation/components/tests/test_Player.js

@@ -9 +9 @@
 TS_ASSERT_EQUALS(cmpPlayer.GetPopulationLimit(), 0);
 
 cmpPlayer.SetDiplomacy([-1, 1, 0, 1, -1]);
+TS_ASSERT_UNEVAL_EQUALS(cmpPlayer.GetAllies(), [1, 3]);
+TS_ASSERT_UNEVAL_EQUALS(cmpPlayer.GetEnemies(), [0, 4]);
 
 var diplo = cmpPlayer.GetDiplomacy();
 diplo[0] = 1;

binaries/data/mods/public/simulation/components/tests/test_UnitAI.js

@@ -58 +58 @@
     });
 
     AddMock(playerEntity, IID_Player, {
-        IsAlly: function() { return []; },
-        IsEnemy: function() { return []; },
+        IsAlly: function() { return false; },
+        IsEnemy: function() { return true; },
+        GetEnemies: function() { return []; },
     });
 
 
@@ -204 +205 @@
     });
 
     AddMock(playerEntity, IID_Player, {
-        IsAlly: function() { return []; },
-        IsEnemy: function() { return []; },
+        IsAlly: function() { return false; },
+        IsEnemy: function() { return true; },
+        GetEnemies: function() { return []; },
     });
 
     // create units