feat: snapshot. MTT-685 MTT-822

com.unity.multiplayer.mlapi/Runtime/Configuration/NetworkConfig.cs

@@ -158,6 +158,14 @@ public class NetworkConfig
         /// </summary>
         public bool EnableNetworkLogs = true;
 
+        // todo: transitional. For the next release, only Snapshot should remain
+        // The booleans allow iterative development and testing in the meantime
+        public bool UseSnapshotDelta = false;
+        public bool UseSnapshotSpawn = false;
+
+        public const int RttAverageSamples = 5; // number of RTT to keep an average of (plus one)
+        public const int RttWindowSize = 64; // number of slots to use for RTT computations (max number of in-flight packets)
+
         private void Sort()
         {
             RegisteredScenes.Sort(StringComparer.Ordinal);

com.unity.multiplayer.mlapi/Runtime/Core/NetworkBehaviour.cs

@@ -475,15 +475,15 @@ private void NetworkVariableUpdate(ulong clientId, int behaviourIndex)
                 return;
             }
 
-            if (NetworkManager.UseSnapshot)
+            if (NetworkManager.NetworkConfig.UseSnapshotDelta)
             {
                 for (int k = 0; k < NetworkVariableFields.Count; k++)
                 {
                     NetworkManager.SnapshotSystem.Store(NetworkObjectId, behaviourIndex, k, NetworkVariableFields[k]);
                 }
             }
 
-            if (NetworkManager.UseClassicDelta)
+            if (!NetworkManager.NetworkConfig.UseSnapshotDelta)
             {
                 for (int j = 0; j < m_ChannelMappedNetworkVariableIndexes.Count; j++)
                 {

com.unity.multiplayer.mlapi/Runtime/Core/NetworkManager.cs

@@ -39,11 +39,6 @@ public class NetworkManager : MonoBehaviour, INetworkUpdateSystem, IProfilableTr
         private static ProfilerMarker s_InvokeRpc = new ProfilerMarker($"{nameof(NetworkManager)}.{nameof(InvokeRpc)}");
 #endif
 
-        // todo: transitional. For the next release, only Snapshot should remain
-        // The booleans allow iterative development and testing in the meantime
-        internal static bool UseClassicDelta = true;
-        internal static bool UseSnapshot = false;
-
         private const double k_TimeSyncFrequency = 1.0d; // sync every second, TODO will be removed once timesync is done via snapshots
 
         internal MessageQueueContainer MessageQueueContainer { get; private set; }

com.unity.multiplayer.mlapi/Runtime/Core/NetworkObject.cs

@@ -432,6 +432,37 @@ private void SpawnInternal(bool destroyWithScene, ulong? ownerClientId, bool pla
             }
 
             NetworkManager.SpawnManager.SpawnNetworkObjectLocally(this, NetworkManager.SpawnManager.GetNetworkObjectId(), false, playerObject, ownerClientId, null, false, destroyWithScene);
+
+            if (NetworkManager.NetworkConfig.UseSnapshotSpawn)
+            {
+                SnapshotSpawnCommand command;
+                command.NetworkObjectId = NetworkObjectId;
+                command.OwnerClientId = OwnerClientId;
+                command.IsPlayerObject = IsPlayerObject;
+                command.IsSceneObject = (IsSceneObject == null) || IsSceneObject.Value;
+
+                ulong? parent = NetworkManager.SpawnManager.GetSpawnParentId(this);
+                if (parent != null)
+                {
+                    command.ParentNetworkId = parent.Value;
+                }
+                else
+                {
+                    // write own network id, when no parents. todo: optimize this.
+                    command.ParentNetworkId = command.NetworkObjectId;
+                }
+
+                command.GlobalObjectIdHash = HostCheckForGlobalObjectIdHashOverride();
+                // todo: check if (IncludeTransformWhenSpawning == null || IncludeTransformWhenSpawning(clientId)) for any clientId
+                command.ObjectPosition = transform.position;
+                command.ObjectRotation = transform.rotation;
+                command.ObjectScale = transform.localScale;
+                command.TickWritten = 0; // will be reset in Spawn
+                command.TargetClientIds = default;
+
+                NetworkManager.SnapshotSystem.Spawn(command);
+            }
+
             ulong ownerId = ownerClientId != null ? ownerClientId.Value : NetworkManager.ServerClientId;
             for (int i = 0; i < NetworkManager.ConnectedClientsList.Count; i++)
             {

com.unity.multiplayer.mlapi/Runtime/Core/SnapshotRTT.cs

@@ -4,9 +4,6 @@ namespace Unity.Netcode
 {
     internal class ConnectionRtt
     {
-        internal const int RttSize = 5; // number of RTT to keep an average of (plus one)
-        internal const int RingSize = 64; // number of slots to use for RTT computations (max number of in-flight packets)
-
         private double[] m_RttSendTimes; // times at which packet were sent for RTT computations
         private int[] m_SendSequence; // tick, or other key, at which packets were sent (to allow matching)
         private double[] m_MeasuredLatencies; // measured latencies (ring buffer)
@@ -26,17 +23,17 @@ public struct Rtt
         }
         public ConnectionRtt()
         {
-            m_RttSendTimes = new double[RingSize];
-            m_SendSequence = new int[RingSize];
-            m_MeasuredLatencies = new double[RingSize];
+            m_RttSendTimes = new double[NetworkConfig.RttWindowSize];
+            m_SendSequence = new int[NetworkConfig.RttWindowSize];
+            m_MeasuredLatencies = new double[NetworkConfig.RttWindowSize];
         }
 
         /// <summary>
         /// Returns the Round-trip-time computation for this client
         /// </summary>
         public Rtt GetRtt()
         {
-            var ret = new Rtt(); // is this a memory alloc ? How do I get a stack alloc ?
+            var ret = new Rtt();
             var index = m_LatenciesBegin;
             double total = 0.0;
             ret.BestSec = m_MeasuredLatencies[m_LatenciesBegin];
@@ -48,14 +45,14 @@ public Rtt GetRtt()
                 ret.SampleCount++;
                 ret.BestSec = Math.Min(ret.BestSec, m_MeasuredLatencies[index]);
                 ret.WorstSec = Math.Max(ret.WorstSec, m_MeasuredLatencies[index]);
-                index = (index + 1) % RttSize;
+                index = (index + 1) % NetworkConfig.RttAverageSamples;
             }
 
             if (ret.SampleCount != 0)
             {
                 ret.AverageSec = total / ret.SampleCount;
                 // the latest RTT is one before m_LatenciesEnd
-                ret.LastSec = m_MeasuredLatencies[(m_LatenciesEnd + (RingSize - 1)) % RingSize];
+                ret.LastSec = m_MeasuredLatencies[(m_LatenciesEnd + (NetworkConfig.RttWindowSize - 1)) % NetworkConfig.RttWindowSize];
             }
             else
             {
@@ -71,23 +68,23 @@ public Rtt GetRtt()
 
         internal void NotifySend(int sequence, double timeSec)
         {
-            m_RttSendTimes[sequence % RingSize] = timeSec;
-            m_SendSequence[sequence % RingSize] = sequence;
+            m_RttSendTimes[sequence % NetworkConfig.RttWindowSize] = timeSec;
+            m_SendSequence[sequence % NetworkConfig.RttWindowSize] = sequence;
         }
 
         internal void NotifyAck(int sequence, double timeSec)
         {
             // if the same slot was not used by a later send
-            if (m_SendSequence[sequence % RingSize] == sequence)
+            if (m_SendSequence[sequence % NetworkConfig.RttWindowSize] == sequence)
             {
-                double latency = timeSec - m_RttSendTimes[sequence % RingSize];
+                double latency = timeSec - m_RttSendTimes[sequence % NetworkConfig.RttWindowSize];
 
                 m_MeasuredLatencies[m_LatenciesEnd] = latency;
-                m_LatenciesEnd = (m_LatenciesEnd + 1) % RttSize;
+                m_LatenciesEnd = (m_LatenciesEnd + 1) % NetworkConfig.RttAverageSamples;
 
                 if (m_LatenciesEnd == m_LatenciesBegin)
                 {
-                    m_LatenciesBegin = (m_LatenciesBegin + 1) % RttSize;
+                    m_LatenciesBegin = (m_LatenciesBegin + 1) % NetworkConfig.RttAverageSamples;
                 }
             }
         }