First pass at using replciation status for concealment

Author: rexxar-tc

Concealment/Commands.cs

@@ -9,32 +9,13 @@ public class Commands : CommandModule
     {
         public ConcealmentPlugin Plugin => (ConcealmentPlugin)Context.Plugin;
 
-        [Command("conceal", "Conceal grids x distance from players."), Permission(MyPromoteLevel.SpaceMaster)]
-        public void Conceal(double distance = 0)
+        [Command("update", "Forces a concealment update immediately."), Permission(MyPromoteLevel.SpaceMaster)]
+        public void Conceal()
         {
-            if (distance == 0)
-            {
-                distance = Plugin.Settings.Data.ConcealDistance;
-            }
-            var num = Plugin.ConcealGrids(distance);
-            Context.Respond($"{num} grids concealed.");
+            var num = Plugin.ConcealGrids();
+            Context.Respond($"{num.Item1} grids concealed, {num.Item2} grids revealed");
         }
-
-        [Command("reveal", "Reveal all grids within the given distance"), Permission(MyPromoteLevel.SpaceMaster)]
-        public void Reveal(double distance = 1000)
-        {
-            var pos = Context.Player?.Controller.ControlledEntity?.Entity.GetPosition();
-            if (!pos.HasValue)
-            {
-                Context.Respond("You must be controlling an entity.");
-                return;
-            }
-
-            var sphere = new BoundingSphereD(pos.Value, distance);
-            var num = Plugin.RevealGridsInSphere(sphere);
-            Context.Respond($"{num} grids revealed.");
-        }
-
+        
         [Command("reveal all", "Reveal all grids"), Permission(MyPromoteLevel.SpaceMaster)]
         public void RevealAll()
         {
@@ -46,7 +27,7 @@ public void RevealAll()
         public void Enable()
         {
             Plugin.Settings.Data.Enabled = true;
-            Plugin.ConcealGrids(Plugin.Settings.Data.ConcealDistance);
+            Plugin.ConcealGrids();
         }
 
         [Command("conceal off", "Disable concealment.")]

Concealment/Concealment.csproj

@@ -33,9 +33,8 @@
       <HintPath>$(SolutionDir)\GameBinaries\HavokWrapper.dll</HintPath>
       <Private>False</Private>
     </Reference>
-    <Reference Include="NLog, Version=4.0.0.0, Culture=neutral, PublicKeyToken=5120e14c03d0593c, processorArchitecture=MSIL">
-      <HintPath>..\packages\NLog.4.4.12\lib\net45\NLog.dll</HintPath>
-      <Private>False</Private>
+    <Reference Include="NLog">
+      <HintPath>..\TorchBinaries\NLog.dll</HintPath>
     </Reference>
     <Reference Include="PresentationCore" />
     <Reference Include="PresentationFramework" />
@@ -154,8 +153,10 @@
       <DependentUpon>DynamicConcealmentEditor.xaml</DependentUpon>
     </Compile>
     <Compile Include="DynamicConcealmentManager.cs" />
+    <Compile Include="Patches\PatchReplicableRequest.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="Settings.cs" />
+    <Compile Include="Utilities.cs" />
   </ItemGroup>
   <ItemGroup>
     <Page Include="ConcealmentControl.xaml">
@@ -170,8 +171,6 @@
   <ItemGroup>
     <Service Include="{508349B6-6B84-4DF5-91F0-309BEEBAD82D}" />
   </ItemGroup>
-  <ItemGroup>
-    <None Include="packages.config" />
-  </ItemGroup>
+  <ItemGroup />
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
 </Project>

Concealment/ConcealmentControl.xaml

@@ -19,26 +19,14 @@
                 <CheckBox Content="Enable Concealment" Margin="3" IsChecked="{Binding Enabled}" />
                 <CheckBox Content="Conceal Production" ToolTip="Conceal grids with active production blocks." Margin="3" IsChecked="{Binding ConcealProduction}" />
                 <CheckBox Content="Conceal Pirates" ToolTip="Conceal grids owned by Space Pirates." Margin="3" IsChecked="{Binding ConcealPirates}" />
-                <StackPanel Orientation="Horizontal">
-                    <TextBox Margin="3" Width="150" Text="{Binding ConcealDistance}" />
-                    <Label Content="Conceal Distance (meters)" Margin="3" />
-                </StackPanel>
-                <StackPanel Orientation="Horizontal">
-                    <TextBox Margin="3" Width="150" Text="{Binding RevealDistance}" />
-                    <Label Content="Reveal Distance (meters)" Margin="3" />
-                </StackPanel>
+                
                 <StackPanel Orientation="Horizontal">
                     <TextBox Margin="3" Width="150" Text="{Binding ConcealInterval}" />
                     <Label Content="Conceal Interval (ticks, 1/60 s)" Margin="3" />
                 </StackPanel>
-                <StackPanel Orientation="Horizontal">
-                    <TextBox Margin="3" Width="150" Text="{Binding RevealInterval}" />
-                    <Label Content="Reveal Interval (ticks, 1/60 s)" Margin="3" />
-                </StackPanel>
             </StackPanel>
             <StackPanel Orientation="Horizontal">
-                <Button Content="Manual Conceal" Margin="3" Click="Conceal_OnClick" />
-                <Button Content="Manual Reveal" Margin="3" Click="Reveal_OnClick" />
+                <Button Content="Force Update" Margin="3" Click="Conceal_OnClick" />
             </StackPanel>
             <Button Content="Edit Excluded Subtypes" Margin="3" Click="EditExclusion_OnClick"/>
             <Button Content="Edit Dynamic Concealment" Margin="3" Click="EditDynamicConcealment_OnClick"/>

Concealment/ConcealmentControl.xaml.cs

@@ -36,16 +36,10 @@ private void RevealSelected_OnClick(object sender, RoutedEventArgs e)
             });
         }
 
-        private void Reveal_OnClick(object sender, RoutedEventArgs e)
-        {
-            var p = Plugin;
-            Plugin.Torch.Invoke(delegate { p.RevealGrids(p.Settings.Data.RevealDistance); });
-        }
-
         private void Conceal_OnClick(object sender, RoutedEventArgs e)
         {
             var p = Plugin;
-            Plugin.Torch.Invoke(delegate { p.ConcealGrids(p.Settings.Data.ConcealDistance); });
+            Plugin.Torch.Invoke(delegate { p.ConcealGrids(); });
         }
 
         private void EditExclusion_OnClick(object sender, RoutedEventArgs e)

Concealment/ConcealmentPlugin.cs

@@ -29,6 +29,7 @@
 using VRage.Game.ModAPI;
 using VRage.Game.ObjectBuilders.ComponentSystem;
 using VRage.ModAPI;
+using VRage.Network;
 using VRageMath;
 
 namespace Concealment
@@ -50,6 +51,10 @@ public sealed class ConcealmentPlugin : TorchPluginBase, IWpfPlugin
         private bool _settingsChanged;
         private bool _ready;
 
+        private MyReplicationServer Replication => (MyReplicationServer)MyMultiplayer.Static.ReplicationLayer;
+
+        public static ConcealmentPlugin Instance { get; private set; }
+
         public ConcealmentPlugin()
         {
             _intersectGroups = new List<ConcealGroup>();
@@ -76,6 +81,8 @@ public override void Init(ITorchBase torch)
             Settings.Data.PropertyChanged += Data_PropertyChanged;
             _concealedAabbTree = new MyDynamicAABBTreeD(MyConstants.GAME_PRUNING_STRUCTURE_AABB_EXTENSION);
             torch.Managers.GetManager<ITorchSessionManager>()?.AddFactory(CreateManager);
+
+            Instance = this;
         }
 
         private IManager CreateManager(ITorchSession session)
@@ -97,9 +104,7 @@ public override void Update()
             if (_ready)
             {
                 if (_counter % (ulong)Settings.Data.ConcealInterval == 0)
-                    ConcealGrids(Settings.Data.ConcealDistance);
-                if (_counter % (ulong)Settings.Data.RevealInterval == 0)
-                    RevealGrids(Settings.Data.RevealDistance);
+                    ConcealGrids();
                 _counter += 1;
             }
 
@@ -239,8 +244,8 @@ public int RevealGroup(ConcealGroup group)
         {
             if (!group.IsConcealed)
             {
-                Log.Warn($"Attempted to reveal a group that wasn't concealed: {group.GridNames}");
-                Log.Warn(new StackTrace());
+                //Log.Warn($"Attempted to reveal a group that wasn't concealed: {group.GridNames}");
+                //Log.Warn(new StackTrace());
                 return 0;
             }
 
@@ -268,57 +273,57 @@ public int RevealGridsInSphere(BoundingSphereD sphere)
             return revealed;
         }
 
-        public int RevealGrids(double distanceFromPlayers)
-        {
-            var revealed = 0;
-            var playerSpheres = GetPlayerViewSpheres(distanceFromPlayers);
-            foreach (var sphere in playerSpheres)
-            {
-                Log.Trace($"{sphere.Center}: {sphere.Radius}");
-                revealed += RevealGridsInSphere(sphere);
-            }
-
-            if (_settingsChanged)
-            {
-                for (var i = ConcealedGroups.Count - 1; i >= 0; i--)
-                {
-                    if (IsExcluded(ConcealedGroups[i]))
-                        revealed += RevealGroup(ConcealedGroups[i]);
-                }
-
-                _settingsChanged = false;
-            }
-
-            if (revealed != 0)
-                Log.Info($"Revealed {revealed} grids near players.");
-            return revealed;
-        }
-
-        public int ConcealGrids(double distanceFromPlayers = 0)
+        //public int RevealGrids()
+        //{
+        //    var revealed = 0;
+
+        //    foreach (var sphere in playerSpheres)
+        //    {
+        //        Log.Trace($"{sphere.Center}: {sphere.Radius}");
+        //        revealed += RevealGridsInSphere(sphere);
+        //    }
+
+        //    if (_settingsChanged)
+        //    {
+        //        for (var i = ConcealedGroups.Count - 1; i >= 0; i--)
+        //        {
+        //            if (IsExcluded(ConcealedGroups[i]))
+        //                revealed += RevealGroup(ConcealedGroups[i]);
+        //        }
+
+        //        _settingsChanged = false;
+        //    }
+
+        //    if (revealed != 0)
+        //        Log.Info($"Revealed {revealed} grids near players.");
+        //    return revealed;
+        //}
+
+        public (int ,int) ConcealGrids()
         {
             Log.Debug("Concealing grids");
             int concealed = 0;
-            var playerSpheres = GetPlayerViewSpheres(distanceFromPlayers);
+            int revealed = 0;
 
             ConcurrentBag<ConcealGroup> groups = new ConcurrentBag<ConcealGroup>();
+            ConcurrentBag<ConcealGroup> reveal = new ConcurrentBag<ConcealGroup>();
             var sw = Stopwatch.StartNew();
             Parallel.ForEach(MyCubeGridGroups.Static.Physical.Groups, group =>
             {
                 var concealGroup = new ConcealGroup(group);
 
-                if (distanceFromPlayers != 0)
+                if (IsExcluded(concealGroup))
                 {
-                    var volume = group.GetWorldAABB();
-                    if (playerSpheres.Any(s => s.Contains(volume) != ContainmentType.Disjoint))
-                    {
-                        Log.Trace("group near player");
-                        return;
-                    }
+                    Log.Trace("group excluded");
+                    reveal.Add(concealGroup);
+                    return;
                 }
 
-                if (IsExcluded(concealGroup))
+                //Checks if any connected clients have requested any grid in this group for replication
+                if (concealGroup.Grids.Any(g => Replication.IsReplicated(Utilities.GetReplicable(g))))
                 {
-                    Log.Trace("group excluded");
+                    Log.Trace("group in replication");
+                    reveal.Add(concealGroup);
                     return;
                 }
 
@@ -332,6 +337,14 @@ public int ConcealGrids(double distanceFromPlayers = 0)
                 concealed += ConcealGroup(group);
             }
             Log.Debug($"Concealed grids in {sw.ElapsedMilliseconds}ms.");
+            sw.Restart();
+
+            foreach (var group in reveal)
+            {
+                revealed += RevealGroup(group);
+            }
+
+            Log.Debug($"Revealed grids in {sw.ElapsedMilliseconds}ms");
             sw.Stop();
 
             var concealedCount = ConcealedGroups.SelectMany(x => x.Grids).Count();
@@ -340,7 +353,10 @@ public int ConcealGrids(double distanceFromPlayers = 0)
             if (concealed > 0)
                 Log.Info($"{concealedCount+concealed}/{totalCount} grids are concealed ({concealedCount+concealed/(float)totalCount:P}), {concealed} new.");
 
-            return concealed;
+            if(revealed > 0)
+                Log.Info($"Revealed {revealed} grids replicated to players.");
+
+            return (concealed, revealed);
         }
 
         public bool IsExcluded(ConcealGroup group)

Concealment/DynamicConcealmentManager.cs

@@ -613,7 +613,7 @@ private static MyRelationsBetweenPlayerAndBlock GetRelationTolerant(long id1, lo
             if (playerFaction1 == playerFaction2)
                 return MyRelationsBetweenPlayerAndBlock.FactionShare;
             return MySession.Static.Factions.GetRelationBetweenFactions(playerFaction1.FactionId,
-                       playerFaction2.FactionId) == MyRelationsBetweenFactions.Neutral
+                       playerFaction2.FactionId).Item1 == MyRelationsBetweenFactions.Neutral
                 ? MyRelationsBetweenPlayerAndBlock.Neutral
                 : MyRelationsBetweenPlayerAndBlock.Enemies;
         }

Concealment/Patches/PatchReplicableRequest.cs

@@ -0,0 +1,61 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Reflection;
+using System.Text;
+using System.Threading.Tasks;
+using NLog;
+using Torch.Managers.PatchManager;
+using Torch.Utils;
+using VRage;
+using VRage.Network;
+
+namespace Concealment.Patches
+{
+    /// <summary>
+    /// Clients call ReplicableRequest when they need a replicable immediately (remote terminal, remote control, etc).
+    /// We listen to this even and immediately reveal the grid if concealed.
+    ///
+    /// Event is also called when client no longer needs the replicable, but we can just let the grid re-conceal
+    /// when the timer elapses.
+    /// </summary>
+    [PatchShim]
+    static class PatchReplicableRequest
+    {
+        private static readonly Logger Log = LogManager.GetCurrentClassLogger();
+
+        [ReflectedMethodInfo(typeof(MyReplicationServer), nameof(MyReplicationServer.ReplicableRequest))]
+        private static MethodInfo _requestMethod;
+
+        public static void Patch(PatchContext ctx)
+        {
+            ctx.GetPattern(_requestMethod).Prefixes.Add(typeof(PatchReplicableRequest).GetMethod(nameof(PrefixRequest)));
+        }
+
+        public static void PrefixRequest(MyPacket packet)
+        {
+            try
+            {
+                var stream = packet.BitStream;
+                var id = stream.ReadInt64();
+                bool add = stream.ReadBool();
+
+                var g = ConcealmentPlugin.Instance.ConcealedGroups.First(gr => gr.Grids.Any(q => q.EntityId == id));
+                if (g != null && add)
+                    ConcealmentPlugin.Instance.RevealGroup(g);
+
+                stream.ResetRead();
+            }
+            catch (Exception ex)
+            {
+                Log.Error("Exception encountered in Request patch!");
+                Log.Error(ex);
+            }
+            finally
+            {
+                //this allows us to fail gracefully
+                packet.BitStream.ResetRead();
+            }
+        }
+    }
+}