fix: ownership change halfprecision, session owner onclientconnected, and minor optimizations (#2948)

* fix

Fixing issue when using half float precision and ownership changes, the current base position needs to be synchronized.

* fix

This fixes the issue of not invoking OnClientConnected when scene management is enabled for the session owner of a distributed authority session.

* update

Minor reduction in allocs while processing received messages (with the asteroids stress test this removes a regular 83kb allocation that occurs when processing received messages).

* update

Making a client's owned objects be returned as an array as opposed to a list for performance purposes.

* update

Adding change log entries.

* update

Adding the PR number to the changelog entries.

* fix

Cast the local variable so message hooks based on type still work.

* style

adding and removing whitespaces...

* style

removing using statement for generic collections.

* style

Fixing spelling of private dictionary.

* update

Moving around how distributed authority mode is checked.
First pass of getting UnityTransport to be able to dictate what network topology is currently available (during a session).

* update

minor updates to NetworkTransform

* update

Only display the Start Client option in the inspector view when distributed authority mode is selected.

* updte

Adding event for when a session owner is promoted.

* update

adding a few more change log entries.

* test fix

Adding the same changes made to UnityTransport to MockTransport.

* update

Additional control flow for topology usage check

* fix

Fixing issue with NetworkObject ownership properties not showing up in the inspector view.
Renaming the version define from MULTIPLAYER_SDK_INSTALLED to MULTIPLAYER_SERVICES_SDK_INSTALLED.

Removing the components folder that was used for the assembly that no longer exists.

* update

Modifying the EveryoneRpcTarget so that it uses the NotAuthorityRpcTarget and AuthorityRpcTarget when in distributed authority mode.

* update

handling minor merge conflict

* fix

Fixing issue with motion based on very small linear velocity values.

* update

Adding 2D rigibody threshold calculations.
Disabling the auto session owner promotion in distributed authority host mode.

* fix and style

Initializing NetworkManager dependent properties within the OnNetworkSpawn of the NetworkRigidbodyBase class.

Removing whitespaces from NetworkConnectionManager.

* update

adding change log entries

* fix

declaring var rotationThreshold when there is no physics package installed.

* update

reverting previous change. Did another deep profile with Unity 6 (5f1) and this area does not seem to be causing any allocations.

* update

Adding authority mode selection drop down and exposing the NetworkTransformEditor  OnEnable method (making it virtual) so the control can be derived from and extended.

* update

adding changelog entry for NetworkTransformEditor adjustment.

* update

make sure to update to Owner authority during initialization.

Author: NoelStephensUnity

com.unity.netcode.gameobjects/CHANGELOG.md

@@ -6,6 +6,27 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 Additional documentation and release notes are available at [Multiplayer Documentation](https://docs-multiplayer.unity3d.com).
 
+## [Unreleased]
+
+### Added
+
+- Added event `NetworkManager.OnSessionOwnerPromoted` that is invoked when a new session owner promotion occurs. (#2948)
+- Added `NetworkRigidBodyBase.GetLinearVelocity` and `NetworkRigidBodyBase.SetLinearVelocity` convenience/helper methods. (#2948)
+- Added `NetworkRigidBodyBase.GetAngularVelocity` and `NetworkRigidBodyBase.SetAngularVelocity` convenience/helper methods. (#2948)
+
+### Fixed
+
+- Fixed issue when `NetworkTransform` half float precision is enabled and ownership changes the current base position was not being synchronized. (#2948)
+- Fixed issue where `OnClientConnected` not being invoked on the session owner when connecting to a new distributed authority session. (#2948)
+- Fixed issue where Rigidbody micro-motion (i.e. relatively small velocities) would result in non-authority instances slightly stuttering as the body would come to a rest (i.e. no motion). Now, the threshold value can increase at higher velocities and can decrease slightly below the provided threshold to account for this. (#2948)
+
+### Changed
+
+- Changed the client's owned objects is now returned (`NetworkClient` and `NetworkSpawnManager`) as an array as opposed to a list for performance purposes. (#2948)
+- Changed `NetworkTransfrom.TryCommitTransformToServer` to be internal as it will be removed by the final 2.0.0 release. (#2948)
+- Changed `NetworkTransformEditor.OnEnable` to a virtual method to be able to customize a `NetworkTransform` derived class by creating a derived editor control from `NetworkTransformEditor`. (#2948)
+
+
 ## [2.0.0-exp.5] - 2024-06-03
 
 ### Added

com.unity.netcode.gameobjects/Components.meta

@@ -30,7 +30,7 @@ public class NetworkManagerEditor : UnityEditor.Editor
         private SerializedProperty m_ProtocolVersionProperty;
         private SerializedProperty m_NetworkTransportProperty;
         private SerializedProperty m_TickRateProperty;
-#if MULTIPLAYER_SDK_INSTALLED
+#if MULTIPLAYER_SERVICES_SDK_INSTALLED
         private SerializedProperty m_NetworkTopologyProperty;
 #endif
         private SerializedProperty m_ClientConnectionBufferTimeoutProperty;
@@ -102,7 +102,7 @@ private void Initialize()
             m_ProtocolVersionProperty = m_NetworkConfigProperty.FindPropertyRelative("ProtocolVersion");
             m_NetworkTransportProperty = m_NetworkConfigProperty.FindPropertyRelative("NetworkTransport");
             m_TickRateProperty = m_NetworkConfigProperty.FindPropertyRelative("TickRate");
-#if MULTIPLAYER_SDK_INSTALLED
+#if MULTIPLAYER_SERVICES_SDK_INSTALLED
             m_NetworkTopologyProperty = m_NetworkConfigProperty.FindPropertyRelative("NetworkTopology");
 #endif
             m_ClientConnectionBufferTimeoutProperty = m_NetworkConfigProperty.FindPropertyRelative("ClientConnectionBufferTimeout");
@@ -142,7 +142,7 @@ private void CheckNullProperties()
             m_ProtocolVersionProperty = m_NetworkConfigProperty.FindPropertyRelative("ProtocolVersion");
             m_NetworkTransportProperty = m_NetworkConfigProperty.FindPropertyRelative("NetworkTransport");
             m_TickRateProperty = m_NetworkConfigProperty.FindPropertyRelative("TickRate");
-#if MULTIPLAYER_SDK_INSTALLED
+#if MULTIPLAYER_SERVICES_SDK_INSTALLED
             m_NetworkTopologyProperty = m_NetworkConfigProperty.FindPropertyRelative("NetworkTopology");
 #endif
             m_ClientConnectionBufferTimeoutProperty = m_NetworkConfigProperty.FindPropertyRelative("ClientConnectionBufferTimeout");
@@ -186,7 +186,7 @@ public override void OnInspectorGUI()
 
                 EditorGUILayout.Space();
                 EditorGUILayout.LabelField("Network Settings", EditorStyles.boldLabel);
-#if MULTIPLAYER_SDK_INSTALLED
+#if MULTIPLAYER_SERVICES_SDK_INSTALLED
                 EditorGUILayout.PropertyField(m_NetworkTopologyProperty);
 #endif
                 EditorGUILayout.PropertyField(m_ProtocolVersionProperty);
@@ -310,21 +310,32 @@ public override void OnInspectorGUI()
                         GUI.enabled = false;
                     }
 
-                    if (GUILayout.Button(new GUIContent("Start Host", "Starts a host instance" + buttonDisabledReasonSuffix)))
+                    if (m_NetworkManager.NetworkConfig.NetworkTopology == NetworkTopologyTypes.ClientServer)
                     {
-                        m_NetworkManager.StartHost();
-                    }
+                        if (GUILayout.Button(new GUIContent("Start Host", "Starts a host instance" + buttonDisabledReasonSuffix)))
+                        {
+                            m_NetworkManager.StartHost();
+                        }
 
-                    if (GUILayout.Button(new GUIContent("Start Server", "Starts a server instance" + buttonDisabledReasonSuffix)))
-                    {
-                        m_NetworkManager.StartServer();
-                    }
+                        if (GUILayout.Button(new GUIContent("Start Server", "Starts a server instance" + buttonDisabledReasonSuffix)))
+                        {
+                            m_NetworkManager.StartServer();
+                        }
 
-                    if (GUILayout.Button(new GUIContent("Start Client", "Starts a client instance" + buttonDisabledReasonSuffix)))
+                        if (GUILayout.Button(new GUIContent("Start Client", "Starts a client instance" + buttonDisabledReasonSuffix)))
+                        {
+                            m_NetworkManager.StartClient();
+                        }
+                    }
+                    else
                     {
-                        m_NetworkManager.StartClient();
+                        if (GUILayout.Button(new GUIContent("Start Client", "Starts a distributed authority client instance" + buttonDisabledReasonSuffix)))
+                        {
+                            m_NetworkManager.StartClient();
+                        }
                     }
 
+
                     if (!EditorApplication.isPlaying)
                     {
                         GUI.enabled = true;

com.unity.netcode.gameobjects/Editor/NetworkManagerEditor.cs

@@ -1,5 +1,5 @@
 using System.Collections.Generic;
-#if MULTIPLAYER_SDK_INSTALLED
+#if BYPASS_DEFAULT_ENUM_DRAWER && MULTIPLAYER_SERVICES_SDK_INSTALLED
 using System.Linq;
 #endif
 using UnityEditor;
@@ -148,7 +148,7 @@ private void OnDestroy()
 
     // Keeping this here just in case, but it appears that in Unity 6 the visual bugs with
     // enum flags is resolved
-#if BYPASS_DEFAULT_ENUM_DRAWER && MULTIPLAYER_SDK_INSTALLED
+#if BYPASS_DEFAULT_ENUM_DRAWER && MULTIPLAYER_SERVICES_SDK_INSTALLED
     [CustomPropertyDrawer(typeof(NetworkObject.OwnershipStatus))]
     public class NetworkObjectOwnership : PropertyDrawer
     {

com.unity.netcode.gameobjects/Editor/NetworkObjectEditor.cs

@@ -30,6 +30,7 @@ public class NetworkTransformEditor : UnityEditor.Editor
         private SerializedProperty m_UseQuaternionCompression;
         private SerializedProperty m_UseHalfFloatPrecision;
         private SerializedProperty m_SlerpPosition;
+        private SerializedProperty m_AuthorityMode;
 
         private static int s_ToggleOffset = 45;
         private static float s_MaxRowWidth = EditorGUIUtility.labelWidth + EditorGUIUtility.fieldWidth + 5;
@@ -38,7 +39,7 @@ public class NetworkTransformEditor : UnityEditor.Editor
         private static GUIContent s_ScaleLabel = EditorGUIUtility.TrTextContent("Scale");
 
         /// <inheritdoc/>
-        public void OnEnable()
+        public virtual void OnEnable()
         {
             m_UseUnreliableDeltas = serializedObject.FindProperty(nameof(NetworkTransform.UseUnreliableDeltas));
             m_SyncPositionXProperty = serializedObject.FindProperty(nameof(NetworkTransform.SyncPositionX));
@@ -59,12 +60,13 @@ public void OnEnable()
             m_UseQuaternionCompression = serializedObject.FindProperty(nameof(NetworkTransform.UseQuaternionCompression));
             m_UseHalfFloatPrecision = serializedObject.FindProperty(nameof(NetworkTransform.UseHalfFloatPrecision));
             m_SlerpPosition = serializedObject.FindProperty(nameof(NetworkTransform.SlerpPosition));
+            m_AuthorityMode = serializedObject.FindProperty(nameof(NetworkTransform.AuthorityMode));
         }
 
         /// <inheritdoc/>
         public override void OnInspectorGUI()
         {
-            EditorGUILayout.LabelField("Syncing", EditorStyles.boldLabel);
+            EditorGUILayout.LabelField("Axis to Synchronize", EditorStyles.boldLabel);
             {
                 GUILayout.BeginHorizontal();
 
@@ -126,6 +128,11 @@ public override void OnInspectorGUI()
                 GUILayout.EndHorizontal();
             }
 
+            EditorGUILayout.Space();
+            EditorGUILayout.LabelField("Authority", EditorStyles.boldLabel);
+            {
+                EditorGUILayout.PropertyField(m_AuthorityMode);
+            }
             EditorGUILayout.Space();
             EditorGUILayout.LabelField("Thresholds", EditorStyles.boldLabel);
             EditorGUILayout.PropertyField(m_PositionThresholdProperty);

com.unity.netcode.gameobjects/Editor/NetworkTransformEditor.cs

@@ -57,7 +57,7 @@
         {
             "name": "com.unity.services.multiplayer",
             "expression": "0.2.0",
-            "define": "MULTIPLAYER_SDK_INSTALLED"
+            "define": "MULTIPLAYER_SERVICES_SDK_INSTALLED"
         }
     ],
     "noEngineReferences": false

com.unity.netcode.gameobjects/Editor/com.unity.netcode.editor.asmdef

@@ -45,6 +45,9 @@ public abstract class NetworkRigidbodyBase : NetworkBehaviour
         private Rigidbody m_Rigidbody;
         private Rigidbody2D m_Rigidbody2D;
         internal NetworkTransform NetworkTransform;
+        private float m_TickFrequency;
+        private float m_TickRate;
+
         private enum InterpolationTypes
         {
             None,
@@ -120,6 +123,129 @@ protected void Initialize(RigidbodyTypes rigidbodyType, NetworkTransform network
             }
         }
 
+        internal Vector3 GetAdjustedPositionThreshold()
+        {
+            // Since the threshold is a measurement of unity world space units per tick, we will allow for the maximum threshold
+            // to be no greater than the threshold measured in unity world space units per second
+            var thresholdMax = NetworkTransform.PositionThreshold * m_TickRate;
+            // Get the velocity in unity world space units per tick
+            var perTickVelocity = GetLinearVelocity() * m_TickFrequency;
+            // Since a rigid body can have "micro-motion" when allowed to come to rest (based on friction etc), we will allow for
+            // no less than 1/10th the threshold value.
+            var minThreshold = NetworkTransform.PositionThreshold * 0.1f;
+
+            // Finally, we adjust the threshold based on the body's current velocity
+            perTickVelocity.x = Mathf.Clamp(Mathf.Abs(perTickVelocity.x), minThreshold, thresholdMax);
+            perTickVelocity.y = Mathf.Clamp(Mathf.Abs(perTickVelocity.y), minThreshold, thresholdMax);
+            // 2D Rigidbody only moves on x & y axis
+            if (!m_IsRigidbody2D)
+            {
+                perTickVelocity.z = Mathf.Clamp(Mathf.Abs(perTickVelocity.z), minThreshold, thresholdMax);
+            }
+
+            return perTickVelocity;
+        }
+
+        internal Vector3 GetAdjustedRotationThreshold()
+        {
+            // Since the rotation threshold is a measurement pf degrees per tick, we get the maximum threshold
+            // by calculating the threshold in degrees per second.
+            var thresholdMax = NetworkTransform.RotAngleThreshold * m_TickRate;
+            // Angular velocity is expressed in radians per second where as the rotation being checked is in degrees.
+            // Convert the angular velocity to degrees per second and then convert that to degrees per tick.
+            var rotationPerTick = (GetAngularVelocity() * Mathf.Rad2Deg) * m_TickFrequency;
+            var minThreshold = NetworkTransform.RotAngleThreshold * m_TickFrequency;
+
+            // 2D Rigidbody only rotates around Z axis
+            if (!m_IsRigidbody2D)
+            {
+                rotationPerTick.x = Mathf.Clamp(Mathf.Abs(rotationPerTick.x), minThreshold, thresholdMax);
+                rotationPerTick.y = Mathf.Clamp(Mathf.Abs(rotationPerTick.y), minThreshold, thresholdMax);
+            }
+            rotationPerTick.z = Mathf.Clamp(Mathf.Abs(rotationPerTick.z), minThreshold, thresholdMax);
+
+            return rotationPerTick;
+        }
+
+        /// <summary>
+        /// Sets the linear velocity of the Rigidbody.
+        /// </summary>
+        /// <remarks>
+        /// For <see cref="Rigidbody2D"/>, only the x and y components of the <see cref="Vector3"/> are applied.
+        /// </remarks>        
+        public void SetLinearVelocity(Vector3 linearVelocity)
+        {
+            if (m_IsRigidbody2D)
+            {
+                m_Rigidbody2D.velocity = linearVelocity;
+            }
+            else
+            {
+                m_Rigidbody.linearVelocity = linearVelocity;
+            }
+        }
+
+        /// <summary>
+        /// Gets the linear velocity of the Rigidbody.
+        /// </summary>
+        /// <remarks>
+        /// For <see cref="Rigidbody2D"/>, the <see cref="Vector3"/> velocity returned is only applied to the x and y components.
+        /// </remarks>
+        /// <returns><see cref="Vector3"/> as the linear velocity</returns>
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public Vector3 GetLinearVelocity()
+        {
+            if (m_IsRigidbody2D)
+            {
+                return m_Rigidbody2D.velocity;
+            }
+            else
+            {
+                return m_Rigidbody.linearVelocity;
+            }
+        }
+
+        /// <summary>
+        /// Sets the angular velocity for the Rigidbody.
+        /// </summary>
+        /// <remarks>
+        /// For <see cref="Rigidbody2D"/>, the z component of <param name="angularVelocity"/> is only used to set the angular velocity.
+        /// A quick way to pass in a 2D angular velocity component is: <see cref="Vector3.forward"/> * angularVelocity (where angularVelocity is a float)
+        /// </remarks>
+        /// <param name="angularVelocity">the angular velocity to apply to the body</param>
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public void SetAngularVelocity(Vector3 angularVelocity)
+        {
+            if (m_IsRigidbody2D)
+            {
+                m_Rigidbody2D.angularVelocity = angularVelocity.z;
+            }
+            else
+            {
+                m_Rigidbody.angularVelocity = angularVelocity;
+            }
+        }
+
+        /// <summary>
+        /// Gets the angular velocity for the Rigidbody.
+        /// </summary>
+        /// <remarks>
+        /// For <see cref="Rigidbody2D"/>, the z component of the <see cref="Vector3"/> returned is the angular velocity of the object.
+        /// </remarks>
+        /// <returns>angular velocity as a <see cref="Vector3"/></returns>
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public Vector3 GetAngularVelocity()
+        {
+            if (m_IsRigidbody2D)
+            {
+                return Vector3.forward * m_Rigidbody2D.velocity;
+            }
+            else
+            {
+                return m_Rigidbody.angularVelocity;
+            }
+        }
+
         /// <summary>
         /// Gets the position of the Rigidbody
         /// </summary>
@@ -501,6 +627,8 @@ internal void UpdateOwnershipAuthority()
         /// <inheritdoc />
         public override void OnNetworkSpawn()
         {
+            m_TickFrequency = 1.0f / NetworkManager.NetworkConfig.TickRate;
+            m_TickRate = NetworkManager.NetworkConfig.TickRate;
             UpdateOwnershipAuthority();
         }