feat: InterestManagementBase

Assets/Mirror/Core/InterestManagement.cs

@@ -8,40 +8,12 @@ namespace Mirror
 {
     [DisallowMultipleComponent]
     [HelpURL("https://mirror-networking.gitbook.io/docs/guides/interest-management")]
-    public abstract class InterestManagement : MonoBehaviour
+    public abstract class InterestManagement : InterestManagementBase
     {
         // allocate newObservers helper HashSet
         readonly HashSet<NetworkConnectionToClient> newObservers =
             new HashSet<NetworkConnectionToClient>();
 
-        // Awake configures InterestManagement in NetworkServer/Client
-        // Do NOT check for active server or client here.
-        // Awake must always set the static aoi references.
-        // make sure to call base.Awake when overwriting!
-        protected virtual void Awake()
-        {
-            if (NetworkServer.aoi == null)
-            {
-                NetworkServer.aoi = this;
-            }
-            else Debug.LogError($"Only one InterestManagement component allowed. {NetworkServer.aoi.GetType()} has been set up already.");
-
-            if (NetworkClient.aoi == null)
-            {
-                NetworkClient.aoi = this;
-            }
-            else Debug.LogError($"Only one InterestManagement component allowed. {NetworkClient.aoi.GetType()} has been set up already.");
-        }
-
-        [ServerCallback]
-        public virtual void Reset() {}
-
-        // Callback used by the visibility system to determine if an observer
-        // (player) can see the NetworkIdentity. If this function returns true,
-        // the network connection will be added as an observer.
-        //   conn: Network connection of a player.
-        //   returns True if the player can see this object.
-        public abstract bool OnCheckObserver(NetworkIdentity identity, NetworkConnectionToClient newObserver);
 
         // rebuild observers for the given NetworkIdentity.
         // Server will automatically spawn/despawn added/removed ones.
@@ -77,32 +49,7 @@ protected void RebuildAll()
             }
         }
 
-        // Callback used by the visibility system for objects on a host.
-        // Objects on a host (with a local client) cannot be disabled or
-        // destroyed when they are not visible to the local client. So this
-        // function is called to allow custom code to hide these objects. A
-        // typical implementation will disable renderer components on the
-        // object. This is only called on local clients on a host.
-        // => need the function in here and virtual so people can overwrite!
-        // => not everyone wants to hide renderers!
-        [ServerCallback]
-        public virtual void SetHostVisibility(NetworkIdentity identity, bool visible)
-        {
-            foreach (Renderer rend in identity.GetComponentsInChildren<Renderer>())
-                rend.enabled = visible;
-        }
-
-        /// <summary>Called on the server when a new networked object is spawned.</summary>
-        // (useful for 'only rebuild if changed' interest management algorithms)
-        [ServerCallback]
-        public virtual void OnSpawned(NetworkIdentity identity) {}
-
-        /// <summary>Called on the server when a networked object is destroyed.</summary>
-        // (useful for 'only rebuild if changed' interest management algorithms)
-        [ServerCallback]
-        public virtual void OnDestroyed(NetworkIdentity identity) {}
-
-        public void Rebuild(NetworkIdentity identity, bool initialize)
+        public override void Rebuild(NetworkIdentity identity, bool initialize)
         {
             // clear newObservers hashset before using it
             newObservers.Clear();

Assets/Mirror/Core/InterestManagementBase.cs

@@ -0,0 +1,84 @@
+// interest management component for custom solutions like
+// distance based, spatial hashing, raycast based, etc.
+// low level base class allows for low level spatial hashing etc., which is 3-5x faster.
+using System.Collections.Generic;
+using UnityEngine;
+
+namespace Mirror
+{
+    [DisallowMultipleComponent]
+    [HelpURL("https://mirror-networking.gitbook.io/docs/guides/interest-management")]
+    public abstract class InterestManagementBase : MonoBehaviour
+    {
+        // Awake configures InterestManagementBase in NetworkServer/Client
+        // Do NOT check for active server or client here.
+        // Awake must always set the static aoi references.
+        // make sure to call base.Awake when overwriting!
+        protected virtual void Awake()
+        {
+            if (NetworkServer.aoi == null)
+            {
+                NetworkServer.aoi = this;
+            }
+            else Debug.LogError($"Only one InterestManagement component allowed. {NetworkServer.aoi.GetType()} has been set up already.");
+
+            if (NetworkClient.aoi == null)
+            {
+                NetworkClient.aoi = this;
+            }
+            else Debug.LogError($"Only one InterestManagement component allowed. {NetworkClient.aoi.GetType()} has been set up already.");
+        }
+
+        [ServerCallback]
+        public virtual void Reset() {}
+
+        // Callback used by the visibility system to determine if an observer
+        // (player) can see the NetworkIdentity. If this function returns true,
+        // the network connection will be added as an observer.
+        //   conn: Network connection of a player.
+        //   returns True if the player can see this object.
+        public abstract bool OnCheckObserver(NetworkIdentity identity, NetworkConnectionToClient newObserver);
+
+
+        // Callback used by the visibility system for objects on a host.
+        // Objects on a host (with a local client) cannot be disabled or
+        // destroyed when they are not visible to the local client. So this
+        // function is called to allow custom code to hide these objects. A
+        // typical implementation will disable renderer components on the
+        // object. This is only called on local clients on a host.
+        // => need the function in here and virtual so people can overwrite!
+        // => not everyone wants to hide renderers!
+        [ServerCallback]
+        public virtual void SetHostVisibility(NetworkIdentity identity, bool visible)
+        {
+            foreach (Renderer rend in identity.GetComponentsInChildren<Renderer>())
+                rend.enabled = visible;
+        }
+
+        /// <summary>Called on the server when a new networked object is spawned.</summary>
+        // (useful for 'only rebuild if changed' interest management algorithms)
+        [ServerCallback]
+        public virtual void OnSpawned(NetworkIdentity identity) {}
+
+        /// <summary>Called on the server when a networked object is destroyed.</summary>
+        // (useful for 'only rebuild if changed' interest management algorithms)
+        [ServerCallback]
+        public virtual void OnDestroyed(NetworkIdentity identity) {}
+
+        public abstract void Rebuild(NetworkIdentity identity, bool initialize);
+
+        /// <summary>Adds the specified connection to the observers of identity</summary>
+        protected void AddObserver(NetworkConnectionToClient connection, NetworkIdentity identity)
+        {
+            connection.AddToObserving(identity);
+            identity.observers.Add(connection.connectionId, connection);
+        }
+
+        /// <summary>Removes the specified connection from the observers of identity</summary>
+        protected void RemoveObserver(NetworkConnectionToClient connection, NetworkIdentity identity)
+        {
+            connection.RemoveFromObserving(identity, false);
+            identity.observers.Remove(connection.connectionId);
+        }
+    }
+}

Assets/Mirror/Core/NetworkClient.cs

@@ -115,7 +115,7 @@ public static partial class NetworkClient
 
         // interest management component (optional)
         // only needed for SetHostVisibility
-        public static InterestManagement aoi;
+        public static InterestManagementBase aoi;
 
         // scene loading
         public static bool isLoadingScene;

Assets/Mirror/Core/NetworkServer.cs

@@ -68,7 +68,7 @@ public static partial class NetworkServer
 
         // interest management component (optional)
         // by default, everyone observes everyone
-        public static InterestManagement aoi;
+        public static InterestManagementBase aoi;
 
         // OnConnected / OnDisconnected used to be NetworkMessages that were
         // invoked. this introduced a bug where external clients could send