feat: Added the ability to add runtime scenes

Author: TwoTenPvP

MLAPI/Configuration/NetworkConfig.cs

@@ -33,6 +33,13 @@ public class NetworkConfig
         [Tooltip("The Scenes that can be switched to by the server")]
         public List<string> RegisteredScenes = new List<string>();
         /// <summary>
+        /// Whether or not runtime scene changes should be allowed and expected.
+        /// If this is true, clients with different initial configurations will not worth together.
+        /// </summary>
+        [Tooltip("Whether or not runtime scene changes should be allowed and expected.\n " +
+        	     "If this is true, clients with different initial configurations will not worth together.")]
+        public bool AllowRuntimeSceneChanges = false;
+        /// <summary>
         /// A list of spawnable prefabs
         /// </summary>
         [Tooltip("The prefabs that can be spawned across the network")]
@@ -233,6 +240,7 @@ public string ToBase64()
                     writer.WriteBool(RecycleNetworkIds);
                     writer.WriteSinglePacked(NetworkIdRecycleDelay);
                     writer.WriteBool(EnableNetworkedVar);
+                    writer.WriteBool(AllowRuntimeSceneChanges);
                     stream.PadStream();
 
                     return Convert.ToBase64String(stream.ToArray());
@@ -280,6 +288,7 @@ public void FromBase64(string base64)
                     config.RecycleNetworkIds = reader.ReadBool();
                     config.NetworkIdRecycleDelay = reader.ReadSinglePacked();
                     config.EnableNetworkedVar = reader.ReadBool();
+                    config.AllowRuntimeSceneChanges = reader.ReadBool();
                 }
             }
         }
@@ -305,9 +314,12 @@ public ulong GetConfig(bool cache = true)
                     writer.WriteUInt16Packed(ProtocolVersion);
                     writer.WriteString(MLAPIConstants.MLAPI_PROTOCOL_VERSION);
 
-                    for (int i = 0; i < RegisteredScenes.Count; i++)
+                    if (!AllowRuntimeSceneChanges)
                     {
-                        writer.WriteString(RegisteredScenes[i]);
+                        for (int i = 0; i < RegisteredScenes.Count; i++)
+                        {
+                            writer.WriteString(RegisteredScenes[i]);
+                        }
                     }
 
                     if (ForceSamePrefabs)

MLAPI/Exceptions/NetworkConfigurationException.cs

@@ -0,0 +1,37 @@
+using System;
+
+namespace MLAPI.Exceptions
+{
+    /// <summary>
+    /// Exception thrown when the operation can only be done on the server
+    /// </summary>
+    public class NetworkConfigurationException : Exception
+    {
+        /// <summary>
+        /// Constructs a NetworkConfigurationException
+        /// </summary>
+        public NetworkConfigurationException()
+        {
+
+        }
+
+        /// <summary>
+        /// Constructs a NetworkConfigurationException with a message
+        /// </summary>
+        /// <param name="message">The exception message</param>
+        public NetworkConfigurationException(string message) : base(message)
+        {
+            
+        }
+
+        /// <summary>
+        /// Constructs a NetworkConfigurationException with a message and a inner exception
+        /// </summary>
+        /// <param name="message">The exception message</param>
+        /// <param name="inner">The inner exception</param>
+        public NetworkConfigurationException(string message, Exception inner) : base(message, inner)
+        {
+            
+        }
+    }
+}

MLAPI/Exceptions/NotServerException.cs

@@ -8,7 +8,7 @@ namespace MLAPI.Exceptions
     public class NotServerException : Exception
     {
         /// <summary>
-        /// Constructs a ObjectNotSpawnedException
+        /// Constructs a NotServerException
         /// </summary>
         public NotServerException()
         {

MLAPI/SceneManagement/NetworkSceneManager.cs

@@ -52,6 +52,24 @@ internal static void SetCurrentSceneIndex()
 
         internal static uint CurrentActiveSceneIndex { get; private set; } = 0;
 
+        /// <summary>
+        /// Adds a scene during runtime. 
+        /// The index is REQUIRED to be unique AND the same across all instances.
+        /// </summary>
+        /// <param name="sceneName">Scene name.</param>
+        /// <param name="index">Index.</param>
+        public static void AddRuntimeSceneName(string sceneName, uint index)
+        {
+            if (!NetworkingManager.Singleton.NetworkConfig.AllowRuntimeSceneChanges)
+            {
+                throw new NetworkConfigurationException("Cannot change the scene configuration when AllowRuntimeSceneChanges is false");
+            }
+
+            registeredSceneNames.Add(sceneName);
+            sceneIndexToString.Add(index, sceneName);
+            sceneNameToIndex.Add(sceneName, index);
+        }
+
         /// <summary>
         /// Switches to a scene with a given name. Can only be called from Server
         /// </summary>