Merge branch 'master' of https://github.com/MidLevel/MLAPI

Author: TwoTenPvP

MLAPI/Configuration/NetworkConfig.cs

@@ -223,7 +223,7 @@ public byte[] ServerX509CertificateBytes
 
         private void Sort()
         {
-            RegisteredScenes.Sort();
+            RegisteredScenes.Sort(StringComparer.Ordinal);
         }
 
         /// <summary>

MLAPI/Core/NetworkedBehaviour.cs

@@ -258,7 +258,7 @@ private static FieldInfo[] GetFieldInfoForTypeRecursive(Type type, List<FieldInf
             }
             else
             {
-                return list.OrderBy(x => x.Name).ToArray();
+                return list.OrderBy(x => x.Name, StringComparer.Ordinal).ToArray();
             }
         }
 

MLAPI/Core/NetworkingManager.cs

@@ -347,8 +347,6 @@ private void Init(bool server)
             SpawnManager.SpawnedObjectsList.Clear();
             SpawnManager.releasedNetworkObjectIds.Clear();
             SpawnManager.pendingSoftSyncObjects.Clear();
-            SpawnManager.customSpawnHandlers.Clear();
-            SpawnManager.customDestroyHandlers.Clear();
             NetworkSceneManager.registeredSceneNames.Clear();
             NetworkSceneManager.sceneIndexToString.Clear();
             NetworkSceneManager.sceneNameToIndex.Clear();
@@ -390,7 +388,7 @@ private void Init(bool server)
 
             if (NetworkConfig.EnableSceneManagement)
             {
-                NetworkConfig.RegisteredScenes.Sort();
+                NetworkConfig.RegisteredScenes.Sort(StringComparer.Ordinal);
 
                 for (int i = 0; i < NetworkConfig.RegisteredScenes.Count; i++)
                 {

MLAPI/Serialization/BitReader.cs

@@ -374,7 +374,7 @@ public Quaternion ReadRotationPacked()
             float y = ReadSinglePacked();
             float z = ReadSinglePacked();
 
-            float w = Mathf.Sqrt(1 - ((Mathf.Pow(x, 2) - (Mathf.Pow(y, 2) - (Mathf.Pow(z, 2))))));
+            float w = Mathf.Sqrt(1f - Mathf.Pow(x, 2) - Mathf.Pow(y, 2) - Mathf.Pow(z, 2));
 
             return new Quaternion(x, y, z, w);
         }

MLAPI/Serialization/SerializationManager.cs

@@ -98,7 +98,7 @@ internal static FieldInfo[] GetFieldsForType(Type type)
                 FieldInfo[] fields = type
                     .GetFields(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance)
                     .Where(x => (x.IsPublic || x.GetCustomAttributes(typeof(SerializeField), true).Length > 0) && IsTypeSupported(x.FieldType))
-                    .OrderBy(x => x.Name).ToArray();
+                    .OrderBy(x => x.Name, StringComparer.Ordinal).ToArray();
 
                 fieldCache.Add(type, fields);
 

MLAPI/Spawning/SpawnManager.cs

@@ -517,7 +517,7 @@ internal static void ServerResetShudownStateForSceneObjects()
 
         internal static void ServerDestroySpawnedSceneObjects()
         {
-            for (int i = 0; i < SpawnedObjectsList.Count; i++)
+            for (int i = SpawnedObjectsList.Count - 1; i >= 0; i--)
             {
                 if ((SpawnedObjectsList[i].IsSceneObject != null && SpawnedObjectsList[i].IsSceneObject == true) || SpawnedObjectsList[i].DestroyWithScene)
                 {

docs/_docs/advanced-topics/custom-transports.md

@@ -5,11 +5,11 @@ permalink: /wiki/custom-transports/
 
 The MLAPI supports custom transports. It uses UNET by default. You can also write custom transports. A transport is the library that is responsible for sending the raw bytes and handle connections.
 
-Usually, transports doesn't support support all channel types and event types. Sometimes they have more, in that case you manually have to do translation between them. See the ENET transport for examples.
+Usually, transports doesn't support all channel types and event types. Sometimes they have more, in that case you manually have to do translation between them. See the ENET transport for examples.
 
 ### Official Transports
 The MLAPI has some official transport implementations you can use. They can be found [here](https://github.com/midlevel/MLAPI.Transports). All you have to do is download the ZIP file you want from the CI server and export it into your assets folder and it will show up in the NetworkingManager automatically.
 
 
 ### Writing Your Own
-To get started writing transport interfaces, the current implementations for Unet, ENET and Ruffles are great starting points for learning their flow. If you do write a transport for a well known transport, feel free to open a PR to add it to the official transports repo.
+To get started writing transport interfaces, the current implementations for Unet, ENET and Ruffles are great starting points for learning their flow. If you do write a transport for a well known transport, feel free to open a PR to add it to the official transports repo.

docs/_docs/the-basics/messaging-system.md

@@ -195,7 +195,7 @@ private void Start()
 private void Start()
 {
     //Receiving
-    CustomMessagingManager.RegisterNamedMessageHandler("myMessageName", (senderClientId, stream)
+    CustomMessagingManager.RegisterNamedMessageHandler("myMessageName", (senderClientId, stream) =>
     {
         using (PooledBitReader reader = PooledBitReader.Get(stream))
         {
@@ -207,4 +207,4 @@ private void Start()
     //Sending
     CustomMessagingManager.SendNamedMessage("myMessageName", clientId, myStream, "myCustomChannel"); //Channel is optional.
 }
-```
+```

docs/_docs/the-basics/networkedvar.md

@@ -21,6 +21,11 @@ Since the NetworkedVar container is a wrapper container around the value, the va
 
 To create your own NetworkedVar container, simply create a class with the INetworkedVar interface and declare it as a field of a NetworkedBehaviour. To learn how to write your own containers for more complex structures, see the NetworkedVar implementation. To learn how to do custom delta encoding on complex structures. See the SyncedDictionary and SyncedLIst implementations.
 
+### Permissions
+By default NetworkedVar and it's subclasses can only be wrote to by the server (NetworkedVarPermission.ServerOnly). To change that set the permission to the desired value during initialization:
+```csharp
+private NetworkedVar<float> myFloat = new NetworkedVar(new NetworkedVarSettings {WritePermission = NetworkedVarPermission.OwnerOnly}, 5);
+```
 
 ### Example
 ```csharp

docs/_docs/the-basics/object-behaviour-relation.md

@@ -9,7 +9,7 @@ The MLAPI's high level components (The RPC system and the Object Spawning System
 For an object to be replicated across the network it needs to have a NetworkedObject component. It also has to be registered as a NetworkedPrefab. When a NetworkedObject is considered "Spawned", it's replicated across the network so that everyone has their own version of the object. Each NetworkedObject gets assigned a NetworkId at runtime which is used to associate two NetworkedObjects across the network. Ex: One peer can say, Send this RPC to the object with the NetworkId 103 and everyone knows what object that is.
 
 ### NetworkedBehaviour
-NetworkedBehaviour is an abstract class that inherits MonoBehaviour and adds additional functionality. Each NetworkedBehaviour is owned by a NetworkedObject. NetworkedBehaviours can contain RPC methods and NetworkedVars. When you call InvokeRPC, a message is sent containing your parameters, the networkId of the NetworkedObject that owns the NetworkedBehaviour that the Invoke was called on, and the "index" of the NetworkedBehaviour on the NetworkedObject. This means that if you run multiple projects, it's important that the order and amount of NetworkedBehaviours on each NetworkedObject is the same. It also means that NetworkedBehaviour's can only exist as a child or on the same object as a NetworkedObject that is activley Spawned.
+NetworkedBehaviour is an abstract class that inherits MonoBehaviour and adds additional functionality. Each NetworkedBehaviour is owned by a NetworkedObject. NetworkedBehaviours can contain RPC methods and NetworkedVars. When you call InvokeRPC, a message is sent containing your parameters, the networkId of the NetworkedObject that owns the NetworkedBehaviour that the Invoke was called on, and the "index" of the NetworkedBehaviour on the NetworkedObject. This means that if you run multiple projects, it's important that the order and amount of NetworkedBehaviours on each NetworkedObject is the same. It also means that NetworkedBehaviour's can only exist as a child or on the same object as a NetworkedObject that is actively Spawned.
 
 
 #### RPC Flow
@@ -30,4 +30,4 @@ Receive:
     - Reads RPC Method Name Hash
     - Finds The Method With The Hash Provided
     - Invokes It's Delegate With Parameters Or Body
-```
+```

docs/_docs/the-basics/object-spawning.md

@@ -16,7 +16,7 @@ The .Spawn() method takes 2 parameters, both with default values, so they are op
 ```csharp
 public void Spawn(Stream spawnPayload = null, bool destroyWithScene = false);
 ```
-The first parameter is a System.IO.Stream and can be retrieved in the NetworkStart() to sync values once when spawning this object. Note however, that the payload data is only avalible for people that get the spawn call straight away. People that join later on won't get the payload data.
+The first parameter is a System.IO.Stream and can be retrieved in the NetworkStart() to sync values once when spawning this object. Note however, that the payload data is only available for people that get the spawn call straight away. People that join later on won't get the payload data.
 
 The second parameter speaks for itself. If set to true, the object will be destroyed on scene switching. This can only be set inside the spawn call.
 

docs/_docs/troubleshooting/common-mistakes.md

@@ -6,6 +6,7 @@ permalink: /wiki/common-mistakes/
 This is a collection of common mistakes:
 
 - [`NullReferenceException` when trying to start a server/host/client](#err-001)
+- [`NullReferenceException` when trying to send an RPC to the server](#err-002)
 
 ---
 
@@ -28,3 +29,19 @@ NullReferenceException: Object reference not set to an instance of an object
 
 #### Solution
 You most likely forgot to add the `NetworkingManager` component to a game object in your scene.
+
+---
+
+### <a name="err-002"></a>`NullReferenceException` when trying to send an RPC to the server
+
+#### Problem
+When the client tries to run `InvokeServerRpc`, the following exception is thrown:
+
+```csharp
+NullReferenceException: Object reference not set to an instance of an object
+```
+
+#### Solution
+You most likely forgot to `Spawn()` your object.
+
+Run `Spawn()` on your `NetworkedObject` component as the server to fix this issue.