feat: NetworkAnimator warns if you use it incorrectly (#1424)

* Added warnings to NetworkAnimator * Updated ChangeLog * pauls suggestions
MirageNet · Jan 11, 2020 · c30e4a9 · c30e4a9
1 parent f858f4d
commit c30e4a9
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 13 deletions.
diff --git a/Assets/Mirror/Components/NetworkAnimator.cs b/Assets/Mirror/Components/NetworkAnimator.cs
@@ -379,17 +379,31 @@ public void ResetTrigger(string triggerName)
         /// <param name="hash">Hash id of trigger (from the Animator).</param>
         public void SetTrigger(int hash)
         {
-            if (hasAuthority && clientAuthority)
+            if (clientAuthority)
             {
-                if (ClientScene.readyConnection != null)
+                if (!isClient)
                 {
-                    CmdOnAnimationTriggerServerMessage(hash);
+                    Debug.LogWarning("Tried to set animation in the server for a client-controlled animator");
+                    return;
+                }
+
+                if (!hasAuthority)
+                {
+                    Debug.LogWarning("Only the client with authority can set animations");
+                    return;
                 }
-                return;
-            }
 
-            if (isServer && !clientAuthority)
+                if (ClientScene.readyConnection != null)
+                    CmdOnAnimationTriggerServerMessage(hash);
+            }
+            else
             {
+                if (!isServer)
+                {
+                    Debug.LogWarning("Tried to set animation in the client for a server-controlled animator");
+                    return;
+                }
+
                 RpcOnAnimationTriggerClientMessage(hash);
             }
         }
@@ -400,17 +414,31 @@ public void SetTrigger(int hash)
         /// <param name="hash">Hash id of trigger (from the Animator).</param>
         public void ResetTrigger(int hash)
         {
-            if (hasAuthority && clientAuthority)
+            if (clientAuthority)
             {
-                if (ClientScene.readyConnection != null)
+                if (!isClient)
                 {
-                    CmdOnAnimationResetTriggerServerMessage(hash);
+                    Debug.LogWarning("Tried to reset animation in the server for a client-controlled animator");
+                    return;
+                }
+
+                if (!hasAuthority)
+                {
+                    Debug.LogWarning("Only the client with authority can reset animations");
+                    return;
                 }
-                return;
-            }
 
-            if (isServer && !clientAuthority)
+                if (ClientScene.readyConnection != null)
+                    CmdOnAnimationResetTriggerServerMessage(hash);
+            }
+            else
             {
+                if (!isServer)
+                {
+                    Debug.LogWarning("Tried to reset animation in the client for a server-controlled animator");
+                    return;
+                }
+
                 RpcOnAnimationResetTriggerClientMessage(hash);
             }
         }

diff --git a/doc/General/ChangeLog.md b/doc/General/ChangeLog.md
@@ -1,7 +1,7 @@
 # Change Log
 
 ## Version 7.x.x - In Progress
-- Added: NetworkAnimator now has a ResetTrigger function
+- Added: NetworkAnimator now has a ResetTrigger function and server / client authority warnings
 - Fixed: NetworkTransform and NetworkAnimator now uses NetworkWriterPool
 - Fixed: NetworkTransform and NetworkAnimator now respect `hasAuthority` for client owned objects
 - Fixed: NetworkTransform will now correctly teleport if time / distance are too large