update

NoelStephensUnity · NoelStephensUnity · commit 00525f7ef57a · 2025-08-07T13:03:56.000-05:00
Finalizing editor inspector view UI for excluding animator properties.
Added some additional logic to NetworkAnimator.
Added first test that verifies excluding parameters works.
diff --git a/com.unity.netcode.gameobjects/Editor/NetworkAnimatorEditor.cs b/com.unity.netcode.gameobjects/Editor/NetworkAnimatorEditor.cs
@@ -1,6 +1,7 @@
+using System.Linq;
 using Unity.Netcode.Components;
 using UnityEditor;
-//using UnityEngine;
+using UnityEngine;
 
 namespace Unity.Netcode.Editor
 {
@@ -11,7 +12,7 @@ namespace Unity.Netcode.Editor
     [CanEditMultipleObjects]
     public class NetworkAnimatorEditor : NetcodeEditorBase<NetworkAnimator>    
     {
-
+        private static float s_MaxRowWidth = EditorGUIUtility.labelWidth + EditorGUIUtility.fieldWidth + 5;
         private SerializedProperty m_AuthorityMode;
         private SerializedProperty m_Animator;
 
@@ -30,10 +31,37 @@ private void DisplayNetworkAnimatorProperties()
             if (networkAnimator.Animator != null)
             {
                 EditorGUILayout.Space();
-                EditorGUILayout.LabelField("Animator Parameters", EditorStyles.boldLabel);
+                networkAnimator.AnimatorParametersExpanded = EditorGUILayout.BeginFoldoutHeaderGroup(networkAnimator.AnimatorParametersExpanded, $"Animator Parameters to Synchronize");
                 {
-                    // Add parameter list here
+                    var parameters = networkAnimator.Animator.parameters;
+                    networkAnimator.AnimatorParameterEntryTable.Clear();
+                    foreach (var parameterEntry in networkAnimator.AnimatorParameterEntries)
+                    {
+                        if (!networkAnimator.AnimatorParameterEntryTable.ContainsKey(parameterEntry.NameHash))
+                        {
+                            networkAnimator.AnimatorParameterEntryTable.Add(parameterEntry.NameHash, parameterEntry);
+                        }
+                    }
+                    if (networkAnimator.AnimatorParametersExpanded)
+                    {
+                        foreach (var parameter in parameters)
+                        {
+                            if (!networkAnimator.AnimatorParameterEntryTable.ContainsKey(parameter.nameHash))
+                            {
+                                networkAnimator.AnimatorParameterEntryTable.Add(parameter.nameHash, new NetworkAnimator.AnimatorParameterEntry(parameter));
+                            }
+                            var parameterEntry = networkAnimator.AnimatorParameterEntryTable[parameter.nameHash];
+                            parameterEntry.Synchronize = EditorGUILayout.ToggleLeft($"{parameterEntry.Name}  ({parameterEntry.ParameterType.ToString()})", parameterEntry.Synchronize);
+                            parameterEntry.ParameterType = parameter.type;
+                            parameterEntry.Name = parameter.name;
+                            parameterEntry.NameHash = parameter.nameHash;
+                            networkAnimator.AnimatorParameterEntryTable[parameter.nameHash] = parameterEntry;
+                        }
+                    }
+                    networkAnimator.AnimatorParameterEntries = networkAnimator.AnimatorParameterEntryTable.Values.ToList();
                 }
+
+                EditorGUILayout.EndFoldoutHeaderGroup();
             }
         }
 
diff --git a/com.unity.netcode.gameobjects/Runtime/Components/NetworkAnimator.cs b/com.unity.netcode.gameobjects/Runtime/Components/NetworkAnimator.cs
@@ -221,14 +221,13 @@ public enum AuthorityModes
             Owner,
         }
 
-
         /// <summary>
         /// Determines whether this <see cref="NetworkAnimator"/> instance will have state updates pushed by the server or the client owner.
         /// <see cref="AuthorityModes"/>
         /// </summary>
 #if MULTIPLAYER_SERVICES_SDK_INSTALLED
-        [Tooltip("Selects who has authority (sends state updates) over the <see cref="NetworkAnimator"/> instance. When the network topology is set to distributed authority, this always defaults to owner authority. If server (the default), then only server-side adjustments to the " +
-            "<see cref="NetworkAnimator"/> instance will be synchronized with clients. If owner (or client), then only the owner-side adjustments to the <see cref="NetworkAnimator"/> instance will be synchronized with both the server and other clients.")]
+        [Tooltip("Selects who has authority(sends state updates) over the<see cref=\"NetworkAnimator\"/> instance.When the network topology is set to distributed authority, this always defaults to owner authority.If server (the default), then only server-side adjustments to the " +
+            "<see cref=\"NetworkAnimator\"> instance will be synchronized with clients. If owner (or client), then only the owner-side adjustments to the <see cref=\"NetworkAnimator\"/> instance will be synchronized with both the server and other clients.")]
 #else
         [Tooltip("Selects who has authority (sends state updates) over the <see cref=\"NetworkAnimator\"/> instance. If server (the default), then only server-side adjustments to the <see cref=\"NetworkAnimator\"/> instance will be synchronized with clients. If owner (or client), " +
             "then only the owner-side adjustments to the <see cref=\"NetworkAnimator\"/> instance will be synchronized with both the server and other clients.")]
@@ -265,8 +264,34 @@ private void BuildDestinationToTransitionInfoTable()
             }
         }
 
+        [Serializable]
+        internal class AnimatorParameterEntry
+        {
+            public bool Synchronize;
+            public int NameHash;
+            public string Name;
+            public AnimatorControllerParameterType ParameterType;
+#if UNITY_EDITOR
+            public AnimatorParameterEntry(AnimatorControllerParameter parameter)
+            {
+                Synchronize = true;
+                NameHash = parameter.nameHash;
+                Name = parameter.name;
+                ParameterType = parameter.type;
+            }
+#endif
+            public AnimatorParameterEntry() { }
+        }
+
+        [HideInInspector]
+        [SerializeField]
+        internal List<AnimatorParameterEntry> AnimatorParameterEntries;
+
+        internal Dictionary<int, AnimatorParameterEntry> AnimatorParameterEntryTable = new Dictionary<int, AnimatorParameterEntry>();
 
 #if UNITY_EDITOR
+        internal bool AnimatorParametersExpanded;
+
         private void ParseStateMachineStates(int layerIndex, ref AnimatorController animatorController, ref AnimatorStateMachine stateMachine)
         {
             for (int y = 0; y < stateMachine.states.Length; y++)
@@ -639,6 +664,14 @@ protected virtual void Awake()
                 return;
             }
 
+            foreach (var parameterEntry in AnimatorParameterEntries)
+            {
+                if (!AnimatorParameterEntryTable.ContainsKey(parameterEntry.NameHash))
+                {
+                    AnimatorParameterEntryTable.Add(parameterEntry.NameHash, parameterEntry);
+                }
+            }
+
             int layers = m_Animator.layerCount;
             // Initializing the below arrays for everyone handles an issue
             // when running in owner authoritative mode and the owner changes.
@@ -682,11 +715,17 @@ protected virtual void Awake()
             for (var i = 0; i < parameters.Length; i++)
             {
                 var parameter = parameters[i];
+                var synchronizeParameter = true;
+                if (AnimatorParameterEntryTable.ContainsKey(parameter.nameHash))
+                {
+                    synchronizeParameter = AnimatorParameterEntryTable[parameter.nameHash].Synchronize;
+                }
 
                 var cacheParam = new AnimatorParamCache
                 {
                     Type = UnsafeUtility.EnumToInt(parameter.type),
-                    Hash = parameter.nameHash
+                    Hash = parameter.nameHash,
+                    Exclude = !synchronizeParameter
                 };
 
                 unsafe
@@ -793,6 +832,10 @@ private void WriteSynchronizationData<T>(ref BufferSerializer<T> serializer) whe
                 m_ParametersToUpdate.Clear();
                 for (int i = 0; i < m_CachedAnimatorParameters.Length; i++)
                 {
+                    if (m_CachedAnimatorParameters[i].Exclude)
+                    {
+                        continue;
+                    }
                     m_ParametersToUpdate.Add(i);
                 }
                 // Write, apply, and serialize
@@ -1184,6 +1227,7 @@ private unsafe void WriteParameters(ref FastBufferWriter writer)
 
                 if (cacheValue.Exclude)
                 {
+                    Debug.LogWarning($"Parameter hash:{cacheValue.Hash} should be excluded but is in the parameters to update list when writing parameter values!");
                     continue;
                 }
 
diff --git a/testproject/Assets/DefaultNetworkPrefabs.asset b/testproject/Assets/DefaultNetworkPrefabs.asset
@@ -224,3 +224,21 @@ MonoBehaviour:
     SourcePrefabToOverride: {fileID: 0}
     SourceHashToOverride: 0
     OverridingTargetPrefab: {fileID: 0}
+  - Override: 0
+    Prefab: {fileID: 8188135024827620138, guid: c000e98bc12da2941a59ec61c260dd6a,
+      type: 3}
+    SourcePrefabToOverride: {fileID: 0}
+    SourceHashToOverride: 0
+    OverridingTargetPrefab: {fileID: 0}
+  - Override: 0
+    Prefab: {fileID: 1488386875393216933, guid: 7752ac8c0bfaed64c8de839537204114,
+      type: 3}
+    SourcePrefabToOverride: {fileID: 0}
+    SourceHashToOverride: 0
+    OverridingTargetPrefab: {fileID: 0}
+  - Override: 0
+    Prefab: {fileID: 6958138586392507362, guid: 4b31f769283d3c24ca2a5d6baf28a806,
+      type: 3}
+    SourcePrefabToOverride: {fileID: 0}
+    SourceHashToOverride: 0
+    OverridingTargetPrefab: {fileID: 0}
diff --git a/testproject/Assets/Tests/Manual/NetworkAnimatorTests/CubeAnimatorController.controller b/testproject/Assets/Tests/Manual/NetworkAnimatorTests/CubeAnimatorController.controller
@@ -761,6 +761,12 @@ AnimatorController:
     m_DefaultInt: 0
     m_DefaultBool: 0
     m_Controller: {fileID: 9100000}
+  - m_Name: ExcludeFromSync
+    m_Type: 1
+    m_DefaultFloat: 0
+    m_DefaultInt: 0
+    m_DefaultBool: 0
+    m_Controller: {fileID: 9100000}
   m_AnimatorLayers:
   - serializedVersion: 5
     m_Name: Base Layer
diff --git a/testproject/Assets/Tests/Runtime/Animation/AnimatorTestHelper.cs b/testproject/Assets/Tests/Runtime/Animation/AnimatorTestHelper.cs
@@ -108,6 +108,16 @@ public void UpdateParameters(ParameterValues parameterValues)
             m_Animator.SetBool("TestBool", parameterValues.BoolValue);
         }
 
+        public void UpdateExcludedParameter(float value)
+        {
+            m_Animator.SetFloat("ExcludeFromSync", value);
+        }
+
+        public float GetExcludedParameter()
+        {
+            return m_Animator.GetFloat("ExcludeFromSync");
+        }
+
         public bool GetCurrentTriggerState()
         {
             return m_Animator.GetBool("TestTrigger");
diff --git a/testproject/Assets/Tests/Runtime/Animation/NetworkAnimatorTests.cs b/testproject/Assets/Tests/Runtime/Animation/NetworkAnimatorTests.cs
@@ -157,6 +157,39 @@ private bool ParameterValuesMatch(OwnerShipMode ownerShipMode, AuthoritativeMode
             return true;
         }
 
+        private bool ExcludedParameterValuesDoNotMatch()
+        {
+            var objectToUpdate = AnimatorTestHelper.ServerSideInstance;
+            var excludedParameterValue = objectToUpdate.GetExcludedParameter();
+            if (m_AuthoritativeMode == AuthoritativeMode.OwnerAuth)
+            {
+                objectToUpdate = m_OwnerShipMode == OwnerShipMode.ClientOwner ? AnimatorTestHelper.ClientSideInstances[m_ClientNetworkManagers[0].LocalClientId] : AnimatorTestHelper.ServerSideInstance;
+                excludedParameterValue = objectToUpdate.GetExcludedParameter();
+                if (m_OwnerShipMode == OwnerShipMode.ClientOwner)
+                {
+                    if (excludedParameterValue == AnimatorTestHelper.ServerSideInstance.GetExcludedParameter())
+                    {
+                        return false;
+                    }
+                }
+            }
+
+            foreach (var animatorTestHelper in AnimatorTestHelper.ClientSideInstances)
+            {
+                if (objectToUpdate == animatorTestHelper.Value)
+                {
+                    continue;
+                }
+                var clientExcludedParameter = animatorTestHelper.Value.GetExcludedParameter();
+                if (clientExcludedParameter == excludedParameterValue)
+                {
+                    return false;
+                }
+            }
+            return true;
+        }
+
+
         public enum OwnerShipMode
         {
             ServerOwner,
@@ -268,6 +301,42 @@ public void ParameterUpdateTests()
             VerboseDebug($" ------------------ Parameter Test [{m_OwnerShipMode}] Stopping ------------------ ");
         }
 
+        [Test]
+        public void ParameterExcludedTests()
+        {
+            VerboseDebug($" ++++++++++++++++++ Parameter Excluded Test [{m_OwnerShipMode}] Starting ++++++++++++++++++ ");
+
+            // Spawn our test animator object
+            var objectInstance = SpawnPrefab(m_OwnerShipMode == OwnerShipMode.ClientOwner, m_AuthoritativeMode);
+
+            // Wait for it to spawn server-side
+            var success = WaitForConditionOrTimeOutWithTimeTravel(() => AnimatorTestHelper.ServerSideInstance != null);
+            Assert.True(success, $"Timed out waiting for the server-side instance of {GetNetworkAnimatorName(m_AuthoritativeMode)} to be spawned!");
+
+            // Wait for it to spawn client-side
+            success = WaitForConditionOrTimeOutWithTimeTravel(() => AnimatorTestHelper.ClientSideInstances.ContainsKey(m_ClientNetworkManagers[0].LocalClientId));
+            Assert.True(success, $"Timed out waiting for the client-side instance of {GetNetworkAnimatorName(m_AuthoritativeMode)} to be spawned!");
+
+            if (m_AuthoritativeMode == AuthoritativeMode.OwnerAuth)
+            {
+                var objectToUpdate = m_OwnerShipMode == OwnerShipMode.ClientOwner ? AnimatorTestHelper.ClientSideInstances[m_ClientNetworkManagers[0].LocalClientId] : AnimatorTestHelper.ServerSideInstance;
+                // Set the excluded parameter value via the owner instance
+                objectToUpdate.UpdateExcludedParameter(Random.Range(1.5f, 100.0f));
+            }
+            else
+            {
+                // Set the excluded parameter value via the server instance
+                AnimatorTestHelper.ServerSideInstance.UpdateExcludedParameter(Random.Range(1.5f, 100.0f));
+            }
+
+            TimeTravel(0.5, 60);
+            // Wait for the client side to update to the new parameter values
+            success = WaitForConditionOrTimeOutWithTimeTravel(ExcludedParameterValuesDoNotMatch);
+            Assert.True(success, $"The excluded parameter was synchronized!");
+            VerboseDebug($" ------------------ Parameter Test [{m_OwnerShipMode}] Stopping ------------------ ");
+        }
+
+
 
         private bool AllTriggersDetected(OwnerShipMode ownerShipMode)
         {
diff --git a/testproject/Assets/Tests/Runtime/Animation/Resources/AnimatorObject.prefab b/testproject/Assets/Tests/Runtime/Animation/Resources/AnimatorObject.prefab
@@ -386,6 +386,8 @@ MonoBehaviour:
   SpawnWithObservers: 1
   DontDestroyWithOwner: 0
   AutoObjectParentSync: 1
+  SyncOwnerTransformWhenParented: 1
+  AllowOwnerToParent: 0
 --- !u!95 &6515743261518512780
 Animator:
   serializedVersion: 7
@@ -420,6 +422,9 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: e8d0727d5ae3244e3b569694d3912374, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
+  ShowTopMostFoldoutHeaderGroup: 1
+  NetworkAnimatorExpanded: 0
+  AuthorityMode: 0
   TransitionStateInfoList:
   - IsCrossFadeExit: 0
     Layer: 0
@@ -463,6 +468,51 @@ MonoBehaviour:
     TransitionDuration: 0.25
     TriggerNameHash: 1080829965
     TransitionIndex: 2
+  AnimatorParameterEntries:
+  - Synchronize: 1
+    NameHash: 807753530
+    Name: Rotate
+    ParameterType: 4
+  - Synchronize: 1
+    NameHash: -623385122
+    Name: Pulse
+    ParameterType: 9
+  - Synchronize: 1
+    NameHash: -758535706
+    Name: TestFloat
+    ParameterType: 1
+  - Synchronize: 1
+    NameHash: -1682086748
+    Name: TestInt
+    ParameterType: 3
+  - Synchronize: 1
+    NameHash: 953368263
+    Name: TestBool
+    ParameterType: 4
+  - Synchronize: 1
+    NameHash: 1033918907
+    Name: TestTrigger
+    ParameterType: 9
+  - Synchronize: 1
+    NameHash: -1545343146
+    Name: LateJoinTest
+    ParameterType: 4
+  - Synchronize: 1
+    NameHash: 1080829965
+    Name: Attack
+    ParameterType: 9
+  - Synchronize: 1
+    NameHash: -1936256502
+    Name: WeaponType
+    ParameterType: 3
+  - Synchronize: 1
+    NameHash: 1855955664
+    Name: Weapon
+    ParameterType: 3
+  - Synchronize: 0
+    NameHash: -1993481368
+    Name: ExcludeFromSync
+    ParameterType: 1
   m_Animator: {fileID: 6515743261518512780}
 --- !u!114 &-8876216387850298050
 MonoBehaviour:
@@ -476,6 +526,7 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: 48b31fae64dc3c14c98e3c5d09cb1269, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
+  ShowTopMostFoldoutHeaderGroup: 1
 --- !u!114 &5194088446451573146
 MonoBehaviour:
   m_ObjectHideFlags: 0
@@ -488,3 +539,4 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: a915cfb2e4f748e4f9526a8bf5ee84f2, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
+  ShowTopMostFoldoutHeaderGroup: 1
diff --git a/testproject/Assets/Tests/Runtime/Animation/Resources/OwnerAnimatorObject.prefab b/testproject/Assets/Tests/Runtime/Animation/Resources/OwnerAnimatorObject.prefab
diff --git a/testproject/Assets/Tests/Runtime/Animation/Resources/PlayerCheerOwnerAuth.prefab b/testproject/Assets/Tests/Runtime/Animation/Resources/PlayerCheerOwnerAuth.prefab
diff --git a/testproject/Assets/Tests/Runtime/Animation/Resources/PlayerCheerServerAuth.prefab b/testproject/Assets/Tests/Runtime/Animation/Resources/PlayerCheerServerAuth.prefab
