fix: NetworkAnimator does not work using the server authoritative model [MTT-3745] (#2003)

Author: NoelStephensUnity

com.unity.netcode.gameobjects/CHANGELOG.md

@@ -21,6 +21,7 @@ Additional documentation and release notes are available at [Multiplayer Documen
 
 ### Fixed
 
+- Fixed `NetworkAnimator` could not run in the server authoritative mode. (#2003)
 - Fixed issue where late joining clients would get a soft synchronization error if any in-scene placed NetworkObjects were parented under another `NetworkObject`. (#1985)
 - Fixed issue where `NetworkBehaviourReference` would throw a type cast exception if using `NetworkBehaviourReference.TryGet` and the component type was not found. (#1984)
 - Fixed `NetworkSceneManager` was not sending scene event notifications for the currently active scene and any additively loaded scenes when loading a new scene in `LoadSceneMode.Single` mode. (#1975)

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

@@ -58,11 +58,10 @@ public void NetworkUpdate(NetworkUpdateStage updateStage)
                         m_ProcessParameterUpdates.Clear();
 
                         // Only owners check for Animator changes
-                        if (m_NetworkAnimator.IsOwner)
+                        if (m_NetworkAnimator.IsOwner && !m_NetworkAnimator.IsServerAuthoritative() || m_NetworkAnimator.IsServerAuthoritative() && m_NetworkAnimator.NetworkManager.IsServer)
                         {
                             m_NetworkAnimator.CheckForAnimatorChanges();
                         }
-
                         break;
                     }
             }
@@ -209,6 +208,19 @@ public Animator Animator
             }
         }
 
+        internal bool IsServerAuthoritative()
+        {
+            return OnIsServerAuthoritative();
+        }
+
+        /// <summary>
+        /// Override this method and return false to switch to owner authoritative mode
+        /// </summary>
+        protected virtual bool OnIsServerAuthoritative()
+        {
+            return true;
+        }
+
         // Animators only support up to 32 params
         private const int k_MaxAnimationParams = 32;
 
@@ -276,13 +288,10 @@ public override void OnDestroy()
             base.OnDestroy();
         }
 
-
         private List<int> m_ParametersToUpdate;
-
         private List<ulong> m_ClientSendList;
         private ClientRpcParams m_ClientRpcParams;
 
-
         public override void OnNetworkSpawn()
         {
             if (IsOwner || IsServer)
@@ -439,7 +448,7 @@ private void OnClientConnectedCallback(ulong playerId)
 
         internal void CheckForAnimatorChanges()
         {
-            if (!IsOwner)
+            if (!IsOwner && !IsServerAuthoritative() || IsServerAuthoritative() && !IsServer)
             {
                 return;
             }
@@ -747,25 +756,32 @@ private unsafe void UpdateAnimationState(AnimationMessage animationState)
         }
 
         /// <summary>
-        /// Sever-side animator parameter update request
+        /// Server-side animator parameter update request
         /// The server sets its local parameters and then forwards the message to the remaining clients
         /// </summary>
         [ServerRpc]
         private unsafe void SendParametersUpdateServerRpc(ParametersUpdateMessage parametersUpdate, ServerRpcParams serverRpcParams = default)
         {
-            if (serverRpcParams.Receive.SenderClientId != OwnerClientId)
+            if (IsServerAuthoritative())
             {
-                return;
+                m_NetworkAnimatorStateChangeHandler.SendParameterUpdate(parametersUpdate);
             }
-            UpdateParameters(parametersUpdate);
-            if (NetworkManager.ConnectedClientsIds.Count - 2 > 0)
+            else
             {
-                m_ClientSendList.Clear();
-                m_ClientSendList.AddRange(NetworkManager.ConnectedClientsIds);
-                m_ClientSendList.Remove(serverRpcParams.Receive.SenderClientId);
-                m_ClientSendList.Remove(NetworkManager.ServerClientId);
-                m_ClientRpcParams.Send.TargetClientIds = m_ClientSendList;
-                m_NetworkAnimatorStateChangeHandler.SendParameterUpdate(parametersUpdate, m_ClientRpcParams);
+                if (serverRpcParams.Receive.SenderClientId != OwnerClientId)
+                {
+                    return;
+                }
+                UpdateParameters(parametersUpdate);
+                if (NetworkManager.ConnectedClientsIds.Count - 2 > 0)
+                {
+                    m_ClientSendList.Clear();
+                    m_ClientSendList.AddRange(NetworkManager.ConnectedClientsIds);
+                    m_ClientSendList.Remove(serverRpcParams.Receive.SenderClientId);
+                    m_ClientSendList.Remove(NetworkManager.ServerClientId);
+                    m_ClientRpcParams.Send.TargetClientIds = m_ClientSendList;
+                    m_NetworkAnimatorStateChangeHandler.SendParameterUpdate(parametersUpdate, m_ClientRpcParams);
+                }
             }
         }
 
@@ -775,33 +791,40 @@ private unsafe void SendParametersUpdateServerRpc(ParametersUpdateMessage parame
         [ClientRpc]
         internal unsafe void SendParametersUpdateClientRpc(ParametersUpdateMessage parametersUpdate, ClientRpcParams clientRpcParams = default)
         {
-            if (!IsOwner)
+            var isServerAuthoritative = IsServerAuthoritative();
+            if (!isServerAuthoritative && !IsOwner || isServerAuthoritative)
             {
                 m_NetworkAnimatorStateChangeHandler.ProcessParameterUpdate(parametersUpdate);
             }
         }
 
         /// <summary>
-        /// Sever-side animation state update request
+        /// Server-side animation state update request
         /// The server sets its local state and then forwards the message to the remaining clients
         /// </summary>
         [ServerRpc]
         private unsafe void SendAnimStateServerRpc(AnimationMessage animSnapshot, ServerRpcParams serverRpcParams = default)
         {
-            if (serverRpcParams.Receive.SenderClientId != OwnerClientId)
+            if (IsServerAuthoritative())
             {
-                return;
+                m_NetworkAnimatorStateChangeHandler.SendAnimationUpdate(animSnapshot);
             }
-
-            UpdateAnimationState(animSnapshot);
-            if (NetworkManager.ConnectedClientsIds.Count - 2 > 0)
+            else
             {
-                m_ClientSendList.Clear();
-                m_ClientSendList.AddRange(NetworkManager.ConnectedClientsIds);
-                m_ClientSendList.Remove(serverRpcParams.Receive.SenderClientId);
-                m_ClientSendList.Remove(NetworkManager.ServerClientId);
-                m_ClientRpcParams.Send.TargetClientIds = m_ClientSendList;
-                m_NetworkAnimatorStateChangeHandler.SendAnimationUpdate(animSnapshot, m_ClientRpcParams);
+                if (serverRpcParams.Receive.SenderClientId != OwnerClientId)
+                {
+                    return;
+                }
+                UpdateAnimationState(animSnapshot);
+                if (NetworkManager.ConnectedClientsIds.Count - 2 > 0)
+                {
+                    m_ClientSendList.Clear();
+                    m_ClientSendList.AddRange(NetworkManager.ConnectedClientsIds);
+                    m_ClientSendList.Remove(serverRpcParams.Receive.SenderClientId);
+                    m_ClientSendList.Remove(NetworkManager.ServerClientId);
+                    m_ClientRpcParams.Send.TargetClientIds = m_ClientSendList;
+                    m_NetworkAnimatorStateChangeHandler.SendAnimationUpdate(animSnapshot, m_ClientRpcParams);
+                }
             }
         }
 
@@ -811,36 +834,44 @@ private unsafe void SendAnimStateServerRpc(AnimationMessage animSnapshot, Server
         [ClientRpc]
         private unsafe void SendAnimStateClientRpc(AnimationMessage animSnapshot, ClientRpcParams clientRpcParams = default)
         {
-            if (!IsOwner)
+            var isServerAuthoritative = IsServerAuthoritative();
+            if (!isServerAuthoritative && !IsOwner || isServerAuthoritative)
             {
                 UpdateAnimationState(animSnapshot);
             }
         }
 
         /// <summary>
-        /// Sever-side trigger state update request
+        /// Server-side trigger state update request
         /// The server sets its local state and then forwards the message to the remaining clients
         /// </summary>
         [ServerRpc]
         private void SendAnimTriggerServerRpc(AnimationTriggerMessage animationTriggerMessage, ServerRpcParams serverRpcParams = default)
         {
-            if (serverRpcParams.Receive.SenderClientId != OwnerClientId)
+            if (IsServerAuthoritative())
             {
-                return;
+                m_NetworkAnimatorStateChangeHandler.SendTriggerUpdate(animationTriggerMessage);
             }
-
-            //  trigger the animation locally on the server...
-            m_Animator.SetBool(animationTriggerMessage.Hash, animationTriggerMessage.IsTriggerSet);
-
-            if (NetworkManager.ConnectedClientsIds.Count - 2 > 0)
+            else
             {
-                m_ClientSendList.Clear();
-                m_ClientSendList.AddRange(NetworkManager.ConnectedClientsIds);
-                m_ClientSendList.Remove(serverRpcParams.Receive.SenderClientId);
-                m_ClientSendList.Remove(NetworkManager.ServerClientId);
-                m_ClientRpcParams.Send.TargetClientIds = m_ClientSendList;
-                m_NetworkAnimatorStateChangeHandler.SendTriggerUpdate(animationTriggerMessage, m_ClientRpcParams);
+                if (serverRpcParams.Receive.SenderClientId != OwnerClientId)
+                {
+                    return;
+                }
+                //  trigger the animation locally on the server...
+                m_Animator.SetBool(animationTriggerMessage.Hash, animationTriggerMessage.IsTriggerSet);
+
+                if (NetworkManager.ConnectedClientsIds.Count - 2 > 0)
+                {
+                    m_ClientSendList.Clear();
+                    m_ClientSendList.AddRange(NetworkManager.ConnectedClientsIds);
+                    m_ClientSendList.Remove(serverRpcParams.Receive.SenderClientId);
+                    m_ClientSendList.Remove(NetworkManager.ServerClientId);
+                    m_ClientRpcParams.Send.TargetClientIds = m_ClientSendList;
+                    m_NetworkAnimatorStateChangeHandler.SendTriggerUpdate(animationTriggerMessage, m_ClientRpcParams);
+                }
             }
+
         }
 
         /// <summary>
@@ -852,7 +883,8 @@ private void SendAnimTriggerServerRpc(AnimationTriggerMessage animationTriggerMe
         [ClientRpc]
         internal void SendAnimTriggerClientRpc(AnimationTriggerMessage animationTriggerMessage, ClientRpcParams clientRpcParams = default)
         {
-            if (!IsOwner)
+            var isServerAuthoritative = IsServerAuthoritative();
+            if (!isServerAuthoritative && !IsOwner || isServerAuthoritative)
             {
                 m_Animator.SetBool(animationTriggerMessage.Hash, animationTriggerMessage.IsTriggerSet);
             }
@@ -869,10 +901,11 @@ public void SetTrigger(string triggerName)
 
         /// <inheritdoc cref="SetTrigger(string)" />
         /// <param name="hash">The hash for the trigger to activate</param>
-        /// <param name="reset">If true, resets the trigger</param>
+        /// <param name="setTrigger">sets (true) or resets (false) the trigger. The default is to set it (true).</param>
         public void SetTrigger(int hash, bool setTrigger = true)
         {
-            if (IsOwner)
+            var isServerAuthoritative = IsServerAuthoritative();
+            if (IsOwner && !isServerAuthoritative || IsServer && isServerAuthoritative)
             {
                 var animTriggerMessage = new AnimationTriggerMessage() { Hash = hash, IsTriggerSet = setTrigger };
                 if (IsServer)

testproject/Assets/Tests/Manual/NetworkAnimatorTests/AnimatedCubeController.cs

@@ -12,37 +12,112 @@ public class AnimatedCubeController : NetworkBehaviour
         private Animator m_Animator;
         private bool m_Rotate;
         private NetworkAnimator m_NetworkAnimator;
+        private bool m_IsServerAuthoritative = true;
 
         private void Awake()
         {
             m_Animator = GetComponent<Animator>();
             m_NetworkAnimator = GetComponent<NetworkAnimator>();
+            if (m_NetworkAnimator == null)
+            {
+                m_NetworkAnimator = GetComponent<OwnerNetworkAnimator>();
+                if (m_NetworkAnimator != null)
+                {
+                    m_IsServerAuthoritative = false;
+                }
+                else
+                {
+                    throw new System.Exception($"{nameof(AnimatedCubeController)} requires that it is paired with either a {nameof(NetworkAnimator)} or {nameof(OwnerNetworkAnimator)}.  Neither of the two components were found!");
+                }
+            }
             m_Rotate = m_Animator.GetBool("Rotate");
         }
 
         public override void OnNetworkSpawn()
         {
-            if (!IsOwner)
+            if (HasAuthority())
             {
                 enabled = false;
             }
         }
 
+        private bool HasAuthority()
+        {
+            if (IsOwnerAuthority() || IsServerAuthority())
+            {
+                return true;
+            }
+            return false;
+        }
+
+        private bool IsServerAuthority()
+        {
+            if (IsServer && m_IsServerAuthoritative)
+            {
+                return true;
+            }
+            return false;
+        }
+
+        private bool IsOwnerAuthority()
+        {
+            if (IsOwner && !m_IsServerAuthoritative)
+            {
+                return true;
+            }
+            return false;
+        }
+
+
+        [ServerRpc(RequireOwnership = false)]
+        private void ToggleRotateAnimationServerRpc(bool rotate)
+        {
+            m_Rotate = rotate;
+            m_Animator.SetBool("Rotate", m_Rotate);
+        }
+
         internal void ToggleRotateAnimation()
         {
             m_Rotate = !m_Rotate;
-            m_Animator.SetBool("Rotate", m_Rotate);
+            if (m_IsServerAuthoritative)
+            {
+                if (!IsServer && IsOwner)
+                {
+                    ToggleRotateAnimationServerRpc(m_Rotate);
+                }
+                else if (IsServer && IsOwner)
+                {
+                    m_Animator.SetBool("Rotate", m_Rotate);
+                }
+            }
+            else if (IsOwner)
+            {
+                m_Animator.SetBool("Rotate", m_Rotate);
+            }
+        }
+
+        [ServerRpc(RequireOwnership = false)]
+        private void PlayPulseAnimationServerRpc(bool rotate)
+        {
+            m_NetworkAnimator.SetTrigger("Pulse");
         }
 
-        internal void PlayPulseAnimation(bool useNetworkAnimator = true)
+        internal void PlayPulseAnimation()
         {
-            if (useNetworkAnimator)
+            if (m_IsServerAuthoritative)
             {
-                m_NetworkAnimator.SetTrigger("Pulse");
+                if (!IsServer && IsOwner)
+                {
+                    PlayPulseAnimationServerRpc(m_Rotate);
+                }
+                else if (IsServer && IsOwner)
+                {
+                    m_NetworkAnimator.SetTrigger("Pulse");
+                }
             }
-            else
+            else if (IsOwner)
             {
-                m_Animator.SetBool("Pulse", true);
+                m_NetworkAnimator.SetTrigger("Pulse");
             }
         }
 

testproject/Assets/Tests/Manual/NetworkAnimatorTests/AnimationUserInput.cs

@@ -17,7 +17,7 @@ private void Start()
         // Update is called once per frame
         private void LateUpdate()
         {
-            if (!IsSpawned || !IsOwner)
+            if (!IsSpawned || !IsOwner && !IsServer)
             {
                 return;
             }
@@ -37,22 +37,6 @@ private void LateUpdate()
                     controller.PlayPulseAnimation();
                 }
             }
-
-            if (Input.GetKeyDown(KeyCode.Return))
-            {
-                foreach (var controller in m_Controllers)
-                {
-                    controller.PlayPulseAnimation(false);
-                }
-            }
-
-            if (Input.GetKeyDown(KeyCode.T))
-            {
-                foreach (var controller in m_Controllers)
-                {
-                    controller.TestAnimator();
-                }
-            }
         }
     }
 }