Ticket #4138: test_visibilities.patch

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

@@ -58 +58 @@
  * isVisible: true if the entity is in the vision range of a unit, false otherwise
  * isExplored: true if the entity is in explored territory, false otherwise
  */
 Visibility.prototype.GetVisibility = function(player, isVisible, isExplored)
 {
-    if (this.preview)
-    {
-        // For the owner only, mock the "RetainInFog" behavior
-        let cmpOwnership = Engine.QueryInterface(this.entity, IID_Ownership);
-        if (cmpOwnership && cmpOwnership.GetOwner() == player && isExplored)
-            return isVisible ? VIS_VISIBLE : VIS_FOGGED;
+    if (!this.preview && !this.corpse)
+        return VIS_VISIBLE;
 
-        // For others, hide the preview
-        return VIS_HIDDEN;
-    }
-    else if (this.corpse)
-    {
-        // For the owner only, mock the "RetainInFog" behavior
-        let cmpOwnership = Engine.QueryInterface(this.entity, IID_Ownership);
-        if (cmpOwnership && cmpOwnership.GetOwner() == player && isExplored)
-            return isVisible ? VIS_VISIBLE : VIS_FOGGED;
+    // For the owner, mock the "RetainInFog" behavior
+    let cmpOwnership = Engine.QueryInterface(this.entity, IID_Ownership);
+    if (cmpOwnership && cmpOwnership.GetOwner() == player && isExplored)
+        return isVisible ? VIS_VISIBLE : VIS_FOGGED;
 
-        // For others, regular displaying
-        return isVisible ? VIS_VISIBLE : VIS_HIDDEN;
-    }
-
-    return VIS_VISIBLE;
+    // Hide preview from other players
+    return isVisible && !this.preview ? VIS_VISIBLE : VIS_HIDDEN;
 };
 
 Visibility.prototype.GetRetainInFog = function()
 {
     return this.retainInFog;

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

@@ -32 +32 @@
         "IsInWorld": () => true,
         "GetHeightOffset": () => 5
     });
 
     AddMock(attacker, IID_Ownership, {
-        "GetOwner": owner => 1
+        "GetOwner": () => 1
     });
 
     let cmpAttack = ConstructComponent(attacker, "Attack", {
         "Melee" : {
             "Hack": 11,

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

@@ +1 @@
+Engine.LoadComponentScript("Visibility.js");
+
+const VIS_HIDDEN = 0;
+const VIS_FOGGED = 1;
+const VIS_VISIBLE = 2;
+
+let maxPlayers = 8;
+let owner = 3;
+
+function testVisbility(template, test)
+{
+    ResetState();
+
+    AddMock(SYSTEM_ENTITY, IID_RangeManager, {
+        "ActivateScriptedVisibility": (entity, status) => {}
+    });
+
+    let entityID = 804;
+
+    AddMock(entityID, IID_Ownership, {
+        "GetOwner": () => owner
+    });
+
+    let cmpVisibility = ConstructComponent(entityID, "Visibility", template);
+
+    TS_ASSERT_EQUALS(cmpVisibility.GetRetainInFog(), template.RetainInFog == "true");
+    TS_ASSERT_EQUALS(cmpVisibility.GetAlwaysVisible(), template.AlwaysVisible == "true");
+
+    TS_ASSERT_EQUALS(cmpVisibility.IsActivated(), template.Corpse == "true" || template.Preview == "true");
+    for (let value of [true, false, true])
+    {
+        cmpVisibility.SetActivated(value);
+        TS_ASSERT_EQUALS(cmpVisibility.IsActivated(), value);
+    }
+
+    test(cmpVisibility);
+}
+
+// Test corpse
+testVisbility({
+    "RetainInFog": "true",
+    "AlwaysVisible": "false",
+    "Corpse": "true",
+    "Preview": "false"
+}, cmpVisibility => {
+
+    for (let [isVisible, isExplored] of [[true, true], [false, false], [false, true]])
+        for (let playerID = 0; playerID <= maxPlayers; ++playerID)
+            TS_ASSERT_EQUALS(
+                cmpVisibility.GetVisibility(playerID, isVisible, isExplored),
+                isVisible ? VIS_VISIBLE :
+                    isExplored && playerID == owner ? VIS_FOGGED: VIS_HIDDEN
+            );
+});
+
+// Preview should be visible only to the owner
+testVisbility({
+    "RetainInFog": "true",
+    "AlwaysVisible": "false",
+    "Corpse": "false",
+    "Preview": "true"
+}, cmpVisibility => {
+
+    for (let [isVisible, isExplored] of [[true, true], [false, false], [false, true]])
+        for (let playerID = 0; playerID <= maxPlayers; ++playerID)
+            TS_ASSERT_EQUALS(
+                cmpVisibility.GetVisibility(playerID, isVisible, isExplored),
+                playerID == owner ?
+                        (isVisible ?
+                            VIS_VISIBLE :
+                            isExplored ?
+                                VIS_FOGGED :
+                                VIS_HIDDEN) :
+                        VIS_HIDDEN);
+});
+
+// Test regular entity
+// Notice GetVisibility returns VIS_VISIBLE even if isVisible and isExplored are false
+// TODO: can [false, false] occur even or should an argument be removed?
+testVisbility({
+    "RetainInFog": "true",
+    "AlwaysVisible": "false",
+    "Corpse": "false",
+    "Preview": "false"
+}, cmpVisibility => {
+
+    for (let [isVisible, isExplored] of [[true, true], [false, false], [false, true]])
+        for (let playerID = 0; playerID <= maxPlayers; ++playerID)
+            TS_ASSERT_EQUALS(cmpVisibility.GetVisibility(playerID, isVisible, isExplored), VIS_VISIBLE);
+});
+
+// Test GetAlwaysVisible
+testVisbility({
+    "RetainInFog": "true",
+    "AlwaysVisible": "true",
+    "Corpse": "false",
+    "Preview": "false"
+}, function() {});