Ticket #4277: reveal-shore-notfix_v2.patch

source/simulation2/components/CCmpPathfinder.cpp

@@ -139 +139 @@
 {
     SerializeVector<SerializeLongRequest>()(serialize, "long requests", m_AsyncLongPathRequests);
     SerializeVector<SerializeShortRequest>()(serialize, "short requests", m_AsyncShortPathRequests);
     serialize.NumberU32_Unbounded("next ticket", m_NextAsyncTicket);
     serialize.NumberU16_Unbounded("same turn moves count", m_SameTurnMovesCount);
+    serialize.NumberU16_Unbounded("map size", m_MapSize);
 }
 
 void CCmpPathfinder::Deserialize(const CParamNode& paramNode, IDeserializer& deserialize)
 {
     Init(paramNode);
 
     SerializeVector<SerializeLongRequest>()(deserialize, "long requests", m_AsyncLongPathRequests);
     SerializeVector<SerializeShortRequest>()(deserialize, "short requests", m_AsyncShortPathRequests);
     deserialize.NumberU32_Unbounded("next ticket", m_NextAsyncTicket);
     deserialize.NumberU16_Unbounded("same turn moves count", m_SameTurnMovesCount);
+    deserialize.NumberU16_Unbounded("map size", m_MapSize);
 }
 
 void CCmpPathfinder::HandleMessage(const CMessage& msg, bool UNUSED(global))
 {
     switch (msg.GetType())

source/simulation2/components/CCmpRangeManager.cpp

@@ -168 +168 @@
 /**
  * Representation of an entity, with the data needed for queries.
  */
 struct EntityData
 {
-    EntityData() : visibilities(0), size(0), retainInFog(0), owner(-1), inWorld(0), flags(1), scriptedVisibility(0) { }
+    EntityData() :
+        visibilities(0), size(0),
+        owner(-1), retainInFog(0), inWorld(0), revealShore(0),
+        flags(1), scriptedVisibility(0)
+        { }
     entity_pos_t x, z;
     entity_pos_t visionRange;
     u32 visibilities; // 2-bit visibility, per player
     u32 size;
-    u8 retainInFog; // boolean
     i8 owner;
+    u8 retainInFog; // boolean
     u8 inWorld; // boolean
+    u8 revealShore; // boolean
     u8 flags; // See GetEntityFlagMask
     u8 scriptedVisibility; // boolean, see ComputeLosVisibility
 };
 
 cassert(sizeof(EntityData) == 28);
@@ -234 +239 @@
         serialize.NumberFixed_Unbounded("x", value.x);
         serialize.NumberFixed_Unbounded("z", value.z);
         serialize.NumberFixed_Unbounded("vision", value.visionRange);
         serialize.NumberU32_Unbounded("visibilities", value.visibilities);
         serialize.NumberU32_Unbounded("size", value.size);
-        serialize.NumberU8("retain in fog", value.retainInFog, 0, 1);
         serialize.NumberI8_Unbounded("owner", value.owner);
+        serialize.NumberU8("retain in fog", value.retainInFog, 0, 1);
         serialize.NumberU8("in world", value.inWorld, 0, 1);
+        serialize.NumberU8("reveal shore", value.revealShore, 0, 1);
         serialize.NumberU8_Unbounded("flags", value.flags);
-        serialize.NumberU8_Unbounded("scripted visibility", value.scriptedVisibility);
+        serialize.NumberU8("scripted visibility", value.scriptedVisibility, 0, 1);
     }
 };
 
 
 /**
@@ -471 +477 @@
             EntityData entdata;
 
             // Store the LOS data, if any
             CmpPtr<ICmpVision> cmpVision(GetSimContext(), ent);
             if (cmpVision)
+            {
                 entdata.visionRange = cmpVision->GetRange();
+                entdata.revealShore = cmpVision->GetRevealShore() ? 1 : 0;
+            }
             CmpPtr<ICmpVisibility> cmpVisibility(GetSimContext(), ent);
             if (cmpVisibility)
                 entdata.retainInFog = (cmpVisibility->GetRetainInFog() ? 1 : 0);
 
             // Store the size
@@ -559 +568 @@
             if (it->second.inWorld)
             {
                 CFixedVector2D pos(it->second.x, it->second.z);
                 LosRemove(it->second.owner, it->second.visionRange, pos);
                 LosAdd(msgData.to, it->second.visionRange, pos);
+
+                if (it->second.revealShore)
+                {
+                    RevealShore(it->second.owner, false);
+                    RevealShore(msgData.to, true);
+                }
             }
 
             ENSURE(-128 <= msgData.to && msgData.to <= 127);
             it->second.owner = (i8)msgData.to;
 
@@ -749 +764 @@
         {
             if (it->second.inWorld)
             {
                 LosAdd(it->second.owner, it->second.visionRange, CFixedVector2D(it->second.x, it->second.z));
                 AddToTile(PosToLosTilesHelper(it->second.x, it->second.z), it->first);
+
+                if (it->second.revealShore)
+                    RevealShore(it->second.owner, true);
             }
         }
 
         m_TotalInworldVertices = 0;
         for (ssize_t j = 0; j < m_TerrainVerticesPerSide; ++j)

source/simulation2/components/CCmpVision.cpp

@@ -38 +38 @@
     DEFAULT_COMPONENT_ALLOCATOR(Vision)
 
     // Template state:
 
     entity_pos_t m_Range, m_BaseRange;
+
+    // TODO: The reveal shore system should be replaced by a general
+    // system of "special" vision methods that are not ranges.
     bool m_RevealShore;
 
     static std::string GetSchema()
     {
         return
@@ -88 +91 @@
             const CMessageOwnershipChanged& msgData = static_cast<const CMessageOwnershipChanged&> (msg);
             if (msgData.entity != GetEntityId())
                 break;
 
             ReloadRange();
-
-            if (!m_RevealShore)
-                break;
-            CmpPtr<ICmpRangeManager> cmpRangeManager(GetSystemEntity());
-            cmpRangeManager->RevealShore(msgData.from, false);
-            cmpRangeManager->RevealShore(msgData.to, true);
             break;
         }
         case MT_ValueModification:
         {
             const CMessageValueModification& msgData = static_cast<const CMessageValueModification&> (msg);
@@ -135 +132 @@
 
     virtual entity_pos_t GetRange()
     {
         return m_Range;
     }
+
+    virtual bool GetRevealShore()
+    {
+        return m_RevealShore;
+    }
 };
 
 REGISTER_COMPONENT_TYPE(Vision)

source/simulation2/components/ICmpVision.h

@@ -1 @@
-/* Copyright (C) 2014 Wildfire Games.
+/* Copyright (C) 2016 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 2 of the License, or
@@ -27 +27 @@
  */
 class ICmpVision : public IComponent
 {
 public:
     virtual entity_pos_t GetRange() = 0;
+    virtual bool GetRevealShore() = 0;
 
     DECLARE_INTERFACE_TYPE(Vision)
 };
 
 #endif // INCLUDED_ICMPVISION

source/simulation2/components/tests/test_RangeManager.h

@@ -1 @@
-/* Copyright (C) 2015 Wildfire Games.
+/* Copyright (C) 2016 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 2 of the License, or
@@ -29 +29 @@
 {
 public:
     DEFAULT_MOCK_COMPONENT()
 
     virtual entity_pos_t GetRange() { return entity_pos_t::FromInt(66); }
-    virtual bool GetRetainInFog() { return false; }
-    virtual bool GetAlwaysVisible() { return false; }
+    virtual bool GetRevealShore() { return false; }
 };
 
 class MockPosition : public ICmpPosition
 {
 public:
@@ -83 +82 @@
     void tearDown()
     {
         CXeromyces::Terminate();
     }
 
+    // TODO It would be nice to call Verify() with the shore revealing system
+    // but that means testing on an actual map, with water and land.
+
     void test_basic()
     {
         ComponentTestHelper test(g_ScriptRuntime);
 
         ICmpRangeManager* cmp = test.Add<ICmpRangeManager>(CID_RangeManager, "", SYSTEM_ENTITY);