fix: Set state private RPC handlers were not honoring local vs world space assignment of position and rotation (#2203)

* fix

SetStateClientRpc and SetStateServerRpc were not updated to use SetStateInternal which honors local vs world space transform setting.s

* update changelog

* test

Modified existing tests to include testing SetState which validates the changes made to NetworkTransform.SetState and associated private methods.

* update

adding the PR number to the changelog entry.

* test

removing conditional check that was not needed.

* update

adding further clarity as to where the two rpc methods were located.

Author: NoelStephensUnity

com.unity.netcode.gameobjects/CHANGELOG.md

@@ -19,6 +19,7 @@ Additional documentation and release notes are available at [Multiplayer Documen
 
 ### Fixed
 
+- Fixed issue where `NetworkTransform.SetStateServerRpc` and `NetworkTransform.SetStateClientRpc` were not honoring local vs world space settings when applying the position and rotation. (#2203)
 - Fixed ILPP `TypeLoadException` on WebGL on MacOS Editor and potentially other platforms. (#2199)
 - Implicit conversion of NetworkObjectReference to GameObject will now return null instead of throwing an exception if the referenced object could not be found (i.e., was already despawned) (#2158)
 - Fixed warning resulting from a stray NetworkAnimator.meta file (#2153)

com.unity.netcode.gameobjects/Components/NetworkTransform.cs

@@ -1169,11 +1169,7 @@ private void SetStateInternal(Vector3 pos, Quaternion rot, Vector3 scale, bool s
         private void SetStateClientRpc(Vector3 pos, Quaternion rot, Vector3 scale, bool shouldTeleport, ClientRpcParams clientRpcParams = default)
         {
             // Server dictated state is always applied
-            transform.position = pos;
-            transform.rotation = rot;
-            transform.localScale = scale;
-            m_LocalAuthoritativeNetworkState.IsTeleportingNextFrame = shouldTeleport;
-            TryCommitTransform(transform, m_CachedNetworkManager.LocalTime.Time);
+            SetStateInternal(pos, rot, scale, shouldTeleport);
         }
 
         /// <summary>
@@ -1190,12 +1186,7 @@ private void SetStateServerRpc(Vector3 pos, Quaternion rot, Vector3 scale, bool
             {
                 (pos, rot, scale) = OnClientRequestChange(pos, rot, scale);
             }
-
-            transform.position = pos;
-            transform.rotation = rot;
-            transform.localScale = scale;
-            m_LocalAuthoritativeNetworkState.IsTeleportingNextFrame = shouldTeleport;
-            TryCommitTransform(transform, m_CachedNetworkManager.LocalTime.Time);
+            SetStateInternal(pos, rot, scale, shouldTeleport);
         }
 
         /// <summary>

com.unity.netcode.gameobjects/Tests/Runtime/NetworkTransform/NetworkTransformTests.cs

@@ -189,7 +189,8 @@ public enum TransformSpace
         public enum OverrideState
         {
             Update,
-            CommitToTransform
+            CommitToTransform,
+            SetState
         }
 
         /// <summary>
@@ -299,9 +300,8 @@ private IEnumerator WaitForAllChildrenLocalTransformValuesToMatch()
         /// parented under another NetworkTransform
         /// </summary>
         [UnityTest]
-        public IEnumerator NetworkTransformParentedLocalSpaceTest([Values] Interpolation interpolation, [Values] OverrideState overideState)
+        public IEnumerator NetworkTransformParentedLocalSpaceTest([Values] Interpolation interpolation)
         {
-            var overrideUpdate = overideState == OverrideState.CommitToTransform;
             m_AuthoritativeTransform.Interpolate = interpolation == Interpolation.EnableInterpolate;
             m_NonAuthoritativeTransform.Interpolate = interpolation == Interpolation.EnableInterpolate;
             var authoritativeChildObject = SpawnObject(m_ChildObjectToBeParented.gameObject, m_AuthoritativeTransform.NetworkManager);
@@ -334,15 +334,28 @@ public IEnumerator NetworkTransformParentedLocalSpaceTest([Values] Interpolation
         /// Validates that moving, rotating, and scaling the authority side with a single
         /// tick will properly synchronize the non-authoritative side with the same values.
         /// </summary>
-        private IEnumerator MoveRotateAndScaleAuthority(Vector3 position, Vector3 rotation, Vector3 scale)
+        private IEnumerator MoveRotateAndScaleAuthority(Vector3 position, Vector3 rotation, Vector3 scale, OverrideState overrideState)
         {
-            m_AuthoritativeTransform.transform.position = position;
-            yield return null;
-            var authoritativeRotation = m_AuthoritativeTransform.transform.rotation;
-            authoritativeRotation.eulerAngles = rotation;
-            m_AuthoritativeTransform.transform.rotation = authoritativeRotation;
-            yield return null;
-            m_AuthoritativeTransform.transform.localScale = scale;
+            switch (overrideState)
+            {
+                case OverrideState.SetState:
+                    {
+                        m_AuthoritativeTransform.SetState(position, Quaternion.Euler(rotation), scale);
+                        break;
+                    }
+                case OverrideState.Update:
+                default:
+                    {
+                        m_AuthoritativeTransform.transform.position = position;
+                        yield return null;
+                        var authoritativeRotation = m_AuthoritativeTransform.transform.rotation;
+                        authoritativeRotation.eulerAngles = rotation;
+                        m_AuthoritativeTransform.transform.rotation = authoritativeRotation;
+                        yield return null;
+                        m_AuthoritativeTransform.transform.localScale = scale;
+                        break;
+                    }
+            }
         }
 
         /// <summary>
@@ -400,7 +413,6 @@ protected override void OnNewClientCreated(NetworkManager networkManager)
         [UnityTest]
         public IEnumerator NetworkTransformMultipleChangesOverTime([Values] TransformSpace testLocalTransform, [Values] OverrideState overideState)
         {
-            var overrideUpdate = overideState == OverrideState.CommitToTransform;
             m_AuthoritativeTransform.InLocalSpace = testLocalTransform == TransformSpace.Local;
 
             var positionStart = new Vector3(1.0f, 0.5f, 2.0f);
@@ -422,7 +434,7 @@ public IEnumerator NetworkTransformMultipleChangesOverTime([Values] TransformSpa
                 yield return WaitForNextTick();
 
                 // Apply deltas
-                MoveRotateAndScaleAuthority(position, rotation, scale);
+                MoveRotateAndScaleAuthority(position, rotation, scale, overideState);
 
                 // Wait for deltas to synchronize on non-authoritative side
                 yield return WaitForPositionRotationAndScaleToMatch(4);
@@ -455,7 +467,7 @@ public IEnumerator NetworkTransformMultipleChangesOverTime([Values] TransformSpa
                 // to apply both deltas within the same tick period.
                 yield return WaitForNextTick();
 
-                MoveRotateAndScaleAuthority(position, rotation, scale);
+                MoveRotateAndScaleAuthority(position, rotation, scale, overideState);
                 yield return WaitForPositionRotationAndScaleToMatch(4);
             }
 
@@ -471,7 +483,7 @@ public IEnumerator NetworkTransformMultipleChangesOverTime([Values] TransformSpa
                 rotation = rotationStart * i;
                 scale = scaleStart * i;
 
-                MoveRotateAndScaleAuthority(position, rotation, scale);
+                MoveRotateAndScaleAuthority(position, rotation, scale, overideState);
             }
 
             yield return WaitForPositionRotationAndScaleToMatch(1);
@@ -486,7 +498,7 @@ public IEnumerator NetworkTransformMultipleChangesOverTime([Values] TransformSpa
                 position = positionStart * i;
                 rotation = rotationStart * i;
                 scale = scaleStart * i;
-                MoveRotateAndScaleAuthority(position, rotation, scale);
+                MoveRotateAndScaleAuthority(position, rotation, scale, overideState);
             }
             yield return WaitForPositionRotationAndScaleToMatch(1);
         }
@@ -513,32 +525,47 @@ public IEnumerator TestAuthoritativeTransformChangeOneAtATime([Values] Transform
 
             Assert.AreEqual(Vector3.zero, m_NonAuthoritativeTransform.transform.position, "server side pos should be zero at first"); // sanity check
 
-            authPlayerTransform.position = new Vector3(10, 20, 30);
-            if (overrideUpdate)
+            var nextPosition = new Vector3(10, 20, 30);
+            if (overideState != OverrideState.SetState)
             {
+                authPlayerTransform.position = nextPosition;
                 m_OwnerTransform.CommitToTransform();
             }
+            else
+            {
+                m_OwnerTransform.SetState(nextPosition, null, null, m_AuthoritativeTransform.Interpolate);
+            }
 
             yield return WaitForConditionOrTimeOut(PositionsMatch);
             AssertOnTimeout($"Timed out waiting for positions to match");
 
             // test rotation
             Assert.AreEqual(Quaternion.identity, m_NonAuthoritativeTransform.transform.rotation, "wrong initial value for rotation"); // sanity check
 
-            authPlayerTransform.rotation = Quaternion.Euler(45, 40, 35); // using euler angles instead of quaternions directly to really see issues users might encounter
-            if (overrideUpdate)
+            var nextRotation = Quaternion.Euler(45, 40, 35); // using euler angles instead of quaternions directly to really see issues users might encounter
+            if (overideState != OverrideState.SetState)
             {
+                authPlayerTransform.rotation = nextRotation;
                 m_OwnerTransform.CommitToTransform();
             }
+            else
+            {
+                m_OwnerTransform.SetState(null, nextRotation, null, m_AuthoritativeTransform.Interpolate);
+            }
 
             yield return WaitForConditionOrTimeOut(RotationsMatch);
             AssertOnTimeout($"Timed out waiting for rotations to match");
 
-            authPlayerTransform.localScale = new Vector3(2, 3, 4);
+            var nextScale = new Vector3(2, 3, 4);
             if (overrideUpdate)
             {
+                authPlayerTransform.localScale = nextScale;
                 m_OwnerTransform.CommitToTransform();
             }
+            else
+            {
+                m_OwnerTransform.SetState(null, null, nextScale, m_AuthoritativeTransform.Interpolate);
+            }
 
             yield return WaitForConditionOrTimeOut(ScaleValuesMatch);
             AssertOnTimeout($"Timed out waiting for scale values to match");