Updated documentation to explain soft sync

Author: TwoTenPvP

docs/_docs/advanced-topics/object-pooling.md

@@ -10,13 +10,15 @@ This can be achieved by registering custom spawn and destroy handlers.
 
 ### SpawnHandler
 ```csharp
-SpawnManager.RegisterCustomSpawnHandler(SpawnManager.GetPrefabHash("myPrefabName"), (position, rotation, disabled) {
+SpawnManager.RegisterCustomSpawnHandler(SpawnManager.GetPrefabHash("myPrefabName"), (position, rotation, disabled) =>
+{
     // Called when the MLAPI want's to spawn a prefab with the name "myPrefabName"
 });
 ```
 ### DestroyHandler
 ```csharp
-SpawnManager.RegisterCustomDestroyHandler(SpawnManager.GetPrefabHash("myPrefabName"), (networkedObject) {
+SpawnManager.RegisterCustomDestroyHandler(SpawnManager.GetPrefabHash("myPrefabName"), (networkedObject) =>
+{
     // Called when the MLAPI want's to destroy the given NetworkedObject
 });
 ```

docs/_docs/core-components/networked-behaviour.md

@@ -3,23 +3,4 @@ title: Networked Behaviour
 permalink: /wiki/networked-behaviour/
 ---
 
-NetworkedBehaviour is a abstract class that derives from MonoBehaviour, it's the base class all your networked scripts should derive from. It's what provides messaging functionality and much more. Each NetworkedBehaviour will belong to a NetworkedObject, it will be the first parent or first component on the current object that is found.
-
-
-## Properties
-##### isLocalPlayer
-This returns true if this is the player object of our own client.
-##### isOwner
-This returns true if we own this object.
-##### isOwnedByServer
-Returns true if this object is owned by the server.
-##### isServer
-Returns true if we are a server.
-##### isClient
-Returns true if we are a client.
-#### isHost
-Returns true if we are a host.
-#### NetworkId
-Returns the NetworkId of the NetworkedObject that owns this Behaviour.
-#### OwnerClientId
-Returns the clientId of the Owner of this object
+NetworkedBehaviour is a abstract class that derives from MonoBehaviour, it's the base class all your networked scripts should derive from. It's what provides messaging functionality and much more. Each NetworkedBehaviour will belong to a NetworkedObject, it will be the first parent or first component on the current object that is found.

docs/_docs/getting-started/connection-approval.md

@@ -9,26 +9,26 @@ However, when ConnectionApproval is true you are also required to provide a call
 ```csharp
 private void Setup() 
 {
-    NetworkingManager.singleton.ConnectionApprovalCallback = ApprovalCheck;
-    NetworkingManager.singleton.StartHost();
+    NetworkingManager.Singleton.ConnectionApprovalCallback = ApprovalCheck;
+    NetworkingManager.Singleton.StartHost();
 }
 
 private void ApprovalCheck(byte[] connectionData, uint clientId, MLAPI.NetworkingManager.ConnectionApprovedDelegate callback)
 {
     //Your logic here
     bool approve = true;
 
-    int prefabId = SpawnManager.GetNetworkedPrefabIndexOfName("myPrefabName"); // The prefab index. Use -1 to use the default player prefab.
+    ulong? prefabHash = SpawnManager.GetPrefabHashFromGenerator("MyPrefabHashGenerator"); // The prefab hash. Use null to use the default player prefab
     
     //If approve is true, the connection gets added. If it's false. The client gets disconnected
-    callback(clientId, prefabId, approve, positionToSpawnAt, rotationToSpawnWith);
+    callback(clientId, prefabHash, approve, positionToSpawnAt, rotationToSpawnWith);
 }
 ```
 ### Connection data
 The connectionData parameter is any custom data of your choice that the client should send to the server. Usually, this should be some sort of ticket, room password or similar that will decide if a connection should be approved or not. The connectionData is specified on the Client side in the NetworkingConfig supplied when connecting. Example:
 ```csharp
-NetworkingManager.singleton.NetworkConfig.ConnectionData = System.Text.Encoding.ASCII.GetBytes("room password");
-NetworkingManager.singleton.StartClient();
+NetworkingManager.Singleton.NetworkConfig.ConnectionData = System.Text.Encoding.ASCII.GetBytes("room password");
+NetworkingManager.Singleton.StartClient();
 ```
 The ConnectionData will then be passed to the server and it will decide if the client will be approved or not.
 

docs/_docs/getting-started/library-initialization.md

@@ -12,7 +12,7 @@ This mode runs a Server and a virtual Client connected to its own server.
 
 Usage:
 ```csharp
-NetworkingManager.singleton.StartHost();
+NetworkingManager.Singleton.StartHost();
 ```
 
 
@@ -22,7 +22,7 @@ This mode runs a Client that connects to a Server or Host.
 
 Usage:
 ```csharp
-NetworkingManager.singleton.StartClient();
+NetworkingManager.Singleton.StartClient();
 ```
 
 ### Server mode
@@ -31,5 +31,5 @@ This mode runs a Server which other Clients can connect to.
 
 Usage:
 ```csharp
-NetworkingManager.singleton.StartServer();
+NetworkingManager.Singleton.StartServer();
 ```

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

@@ -27,7 +27,7 @@ private void Update()
 {
     if (GUI.Button("SendRandomInt"))
     {
-        if (isServer)
+        if (IsServer)
         {
             InvokeClientRpcOnEveryone(MyClientRPC, Random.Range(-50, 50));
         }
@@ -87,24 +87,28 @@ private void Update()
 {
     if (GUI.Button("SendRandomInt"))
     {
-        if (isServer)
+        if (IsServer)
         {
             using (PooledBitStream stream = PooledBitStream.Get())
             {
-                BitWriter writer = new BitWriter(stream);
-                writer.WriteInt32Packed(Random.Range(-50, 50));
+                using (PooledBitWriter writer = PooledBitWriter.Get(stream))
+                {
+                    writer.WriteInt32Packed(Random.Range(-50, 50));
 
-                InvokeClientRpcOnEveryone(MyClientRPC, stream);
+                    InvokeClientRpcOnEveryone(MyClientRPC, stream);
+                }
             }
         }
         else
         {
             using (PooledBitStream stream = PooledBitStream.Get())
             {
-                BitWriter writer = new BitWriter(stream);
-                writer.WriteInt32Packed(Random.Range(-50, 50));
+                using (PooledBitWriter writer = PooledBitWriter.Get(stream))
+                {
+                    writer.WriteInt32Packed(Random.Range(-50, 50));
 
-                InvokeServerRpc(MyServerRpc, stream);
+                    InvokeServerRpc(MyServerRpc, stream);
+                }
             }
         }
     }
@@ -113,19 +117,23 @@ private void Update()
 [ServerRPC]
 private void MyServerRPC(uint clientId, Stream stream) //This signature is REQUIRED for the performance mode
 {
-    BitReader reader = new BitReader(stream);
-    int number = reader.ReadInt32Packed();
-    Debug.Log("The number recieved was: " + number);
-    Debug.Log("This method ran on the server upon the request of a client");
+    using (PooledBitReader reader = PooledBitReader.Get(stream))
+    {
+        int number = reader.ReadInt32Packed();
+        Debug.Log("The number recieved was: " + number);
+        Debug.Log("This method ran on the server upon the request of a client");
+    }
 }
 
 [ClientRPC]
 private void MyClientRPC(uint clientId, Stream stream) //This signature is REQUIRED for the performance mode
 {
-    BitReader reader = new BitReader(stream);
-    int number = reader.ReadInt32Packed();
-    Debug.Log("The number recieved was: " + number);
-    Debug.Log("This method ran on the client upon the request of the server");
+    using (PooledBitReader reader = PooledBitReader.Get(stream))
+    {
+        int number = reader.ReadInt32Packed();
+        Debug.Log("The number recieved was: " + number);
+        Debug.Log("This method ran on the client upon the request of the server");
+    }
 }
 ```
 
@@ -162,12 +170,15 @@ If you don't want to use the MLAPI's messaging. You don't have to. You can use a
 void Start()
 {
     //Recieving
-    NetworkingManager.singleton.OnIncommingCustomMessage += ((clientId, stream) {
-        BitReader reader = new BitReader(stream);
-        string message = reader.ReadString(); //Example
+    NetworkingManager.Singleton.OnIncommingCustomMessage += ((clientId, stream) =>
+    {
+        using (PooledBitReader reader = PooledBitReader.Get(stream))
+        {
+            string message = reader.ReadString(); //Example
+        }
     });
 
     //Sending
-    NetworkingManager.singleton.SendCustomMessage(clientId, myStream, "myCustomChannel"); //Channel is optional.
+    NetworkingManager.Singleton.SendCustomMessage(clientId, myStream, "myCustomChannel"); //Channel is optional.
 }
 ```

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

@@ -15,7 +15,7 @@ The default behavior is that an object is owned by the server. To give ownership
 GetComponent<NetworkedObject>().RemoveOwnership();
 ```
 
-When you are owner of an object. You can check for ``isOwner`` in any NetworkedBehaviour, similar to how player objects can do ``isLocalPlayer``
+When you are owner of an object. You can check for ``IsOwner`` in any NetworkedBehaviour, similar to how player objects can do ``IsLocalPlayer``
 
 ## Object destruction
 When a client disconnects. All objects owned by that client will be destroyed. If you don't want that. (Ex. if you want the objects to be dropped), you can remove ownership just before they are destroyed.

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

@@ -6,11 +6,19 @@ permalink: /wiki/object-spawning/
 To spawn an object. Make sure the object is in the spawnable prefabs array. Then simply instantiate the object. And 
 invoke the spawn method on the NetworkedObject component that should be attached to the prefab. This should only be done on the server as the object will automatically replicate on the other clients.
 
-Any objects already on the server with NetworkedObject components (static scene objects) will get automatically replicated. When objects are spawned the position and rotation is synced. This means that serialized data gets lost on the clients. It's thus recommended to place serialized data in NetworkedVars.
-
-
 Here is an example on how to spawn a object
 ```csharp
 GameObject go = Instantiate(myPrefab, Vector3.zero, Quaternion.identity);
 go.GetComponent<NetworkedObject>().Spawn();
-```
+```
+
+## Scene Objects
+Any objects already on the server with NetworkedObject components (static scene objects) will get automatically replicated. 
+
+There are **two** modes that define how scene objects are spawned. The first mode is *PrefabSync*. It can enabled in the NetworkConfig.
+
+#### SoftSync
+If PrefabSync is disabled, the MLAPI will use SoftSync. This allows scene objects to be non prefabs and they will not be replaced, thus keeping their serialized data. **This mode is recommended for single project setups**. This is the default since MLAPI 6.
+
+#### PrefabSync
+If it's enabled, every scene object has to be a prefab and scene objects are recreated on the client side. This means that serialized data gets lost on the clients. It's thus recommended to place serialized data in NetworkedVars. **This mode is ONLY recommended for Multi project setups**. This was the default before MLAPI 6.