feat: add more control over player spawning (#626)

* feat: add more control over player spawning

* add tests

* Update Assets/Mirage/Runtime/PlayerSpawner.cs

Co-authored-by: Paul Pacheco <paulpach@gmail.com>

Assets/Mirage/Runtime/PlayerSpawner.cs

@@ -7,7 +7,7 @@ namespace Mirage
 {
 
     /// <summary>
-    /// Spawns a player as soon  as the connection is authenticated
+    /// Spawns a player as soon as the connection is authenticated
     /// </summary>
     public class PlayerSpawner : MonoBehaviour
     {
@@ -26,6 +26,11 @@ public class PlayerSpawner : MonoBehaviour
         [FormerlySerializedAs("playerPrefab")]
         public NetworkIdentity PlayerPrefab;
 
+        /// <summary>
+        /// Whether to span the player upon connection automatically
+        /// </summary>
+        public bool AutoSpawn = true;
+
         // Start is called before the first frame update
         public virtual void Start()
         {
@@ -89,8 +94,13 @@ private void OnServerAuthenticated(INetworkConnection connection)
         /// <param name="conn">Connection to the server.</param>
         private void OnClientSceneChanged(string sceneName, SceneOperation sceneOperation)
         {
-            if(sceneOperation == SceneOperation.Normal)
-                Client.Send(new AddPlayerMessage());
+            if (AutoSpawn && sceneOperation == SceneOperation.Normal)
+                RequestServerSpawnPlayer();
+        }
+
+        public virtual void RequestServerSpawnPlayer()
+        {
+            Client.Send(new AddPlayerMessage());
         }
 
         void OnServerAddPlayerInternal(INetworkConnection conn, AddPlayerMessage msg)

Assets/Tests/Runtime/Host/PlayerSpawnerTest.cs

@@ -0,0 +1,61 @@
+using NUnit.Framework;
+using UnityEngine;
+
+namespace Mirage.Tests.Host
+{
+    public class PlayerSpawnerTest : HostSetup<MockComponent>
+    {
+        AssetBundle bundle;
+        GameObject player;
+        PlayerSpawner spawner;
+
+        public override void ExtraSetup()
+        {
+            bundle = AssetBundle.LoadFromFile("Assets/Tests/Runtime/TestScene/testscene");
+
+            spawner = networkManagerGo.AddComponent<PlayerSpawner>();
+
+            spawner.Client = client;
+            spawner.Server = server;
+            spawner.SceneManager = sceneManager;
+            spawner.ClientObjectManager = clientObjectManager;
+            spawner.ServerObjectManager = serverObjectManager;
+
+            player = new GameObject();
+            NetworkIdentity identity = player.AddComponent<NetworkIdentity>();
+            spawner.PlayerPrefab = identity;
+
+            spawner.AutoSpawn = false;
+
+            spawner.Start();
+        }
+
+        public override void ExtraTearDown()
+        {
+            bundle.Unload(true);
+            Object.Destroy(player);
+        }
+
+        [Test]
+        public void DontAutoSpawnTest()
+        {
+            bool invokeAddPlayerMessage = false;
+            server.LocalConnection.RegisterHandler<AddPlayerMessage>(msg => invokeAddPlayerMessage = true);
+
+            sceneManager.ChangeServerScene("Assets/Mirror/Tests/Runtime/testScene.unity");
+
+            Assert.That(invokeAddPlayerMessage, Is.False);
+        }
+
+        [Test]
+        public void ManualSpawnTest()
+        {
+            bool invokeAddPlayerMessage = false;
+            server.LocalConnection.RegisterHandler<AddPlayerMessage>(msg => invokeAddPlayerMessage = true);
+
+            spawner.RequestServerSpawnPlayer();
+
+            Assert.That(invokeAddPlayerMessage, Is.False);
+        }
+    }
+}