feat(NetworkVisibility): adding new visibility scripts for checking s…

…cenes (#958)

Assets/Mirage/Components/NetworkSceneChecker.cs → Assets/Mirage/Components/Visibility/SceneChecking/NetworkSceneChecker.cs

@@ -14,6 +14,7 @@ namespace Mirage
     [AddComponentMenu("Network/NetworkSceneChecker")]
     [RequireComponent(typeof(NetworkIdentity))]
     [HelpURL("https://miragenet.github.io/Mirage/Articles/Components/NetworkSceneChecker.html")]
+    [System.Obsolete("This checker is inefficient, use SimpleSceneChecker instead")]
     public class NetworkSceneChecker : NetworkVisibility
     {
         static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkSceneChecker));

Assets/Mirage/Components/Visibility/SceneChecking/SceneVisibilityChecker.cs

@@ -0,0 +1,77 @@
+using System.Collections.Generic;
+using Mirage.Logging;
+using UnityEngine;
+using UnityEngine.SceneManagement;
+
+namespace Mirage
+{
+    public class SceneVisibilityChecker : NetworkVisibility
+    {
+        static readonly ILogger logger = LogFactory.GetLogger<SceneVisibilityChecker>();
+
+        public override bool OnCheckObserver(INetworkPlayer player)
+        {
+            NetworkIdentity character = player.Identity;
+            if (character == null)
+            {
+                if (logger.LogEnabled()) logger.Log($"SceneChecker: {player} had no character");
+                return false;
+            }
+
+            Scene playerScene = character.gameObject.scene;
+            if (!playerScene.IsValid())
+            {
+                if (logger.WarnEnabled()) logger.LogWarning($"SceneChecker: Could not find scene for {player}");
+                return false;
+            }
+
+            Scene thisScene = gameObject.scene;
+            bool visible = playerScene == thisScene;
+            if (logger.LogEnabled()) logger.Log($"SceneChecker: {player} can see '{this}': {visible}");
+            return visible;
+        }
+
+        public override void OnRebuildObservers(HashSet<INetworkPlayer> observers, bool initialize)
+        {
+            foreach (INetworkPlayer player in Server.Players)
+            {
+                if (OnCheckObserver(player))
+                {
+                    observers.Add(player);
+                }
+            }
+        }
+
+        /// <summary>
+        /// Call this function on an object to move it to a new scene and rebuild its observers
+        /// </summary>
+        /// <param name="scene"></param>
+        public void MoveToScene(Scene scene)
+        {
+            INetworkPlayer owner = Identity.Owner;
+
+            // remove player from other clients
+            removeObservers(Identity);
+
+            // remove other objects from player
+            if (owner != null)
+                owner.RemoveAllVisibleObjects();
+
+            // move player to new scene
+            SceneManager.MoveGameObjectToScene(Identity.gameObject, scene);
+
+            // spawn new objects for player
+            if (owner != null)
+                ServerObjectManager.SpawnVisibleObjects(Identity.Owner);
+        }
+
+        private void removeObservers(NetworkIdentity identity)
+        {
+            HashSet<INetworkPlayer> observers = identity.observers;
+            foreach (INetworkPlayer observer in observers)
+            {
+                observer.RemoveFromVisList(identity);
+            }
+        }
+    }
+}