refactor: remove animation, physics and physics2d dependencies (#1812)

0xFA11 · web-flow · commit 6e69c6e1317c · 2022-03-18T09:49:28.000Z
diff --git a/com.unity.netcode.gameobjects/CHANGELOG.md b/com.unity.netcode.gameobjects/CHANGELOG.md
@@ -14,6 +14,10 @@ Additional documentation and release notes are available at [Multiplayer Documen
 
 ### Changed
 
+### Removed
+
+- Removed `com.unity.modules.animation`, `com.unity.modules.physics` and `com.unity.modules.physics2d` dependencies from the package (#1812)
+
 ### Fixed
 
 - Fixed user never being notified in the editor that a NetworkBehaviour requires a NetworkObject to function properly. (#1808)
diff --git a/com.unity.netcode.gameobjects/Components/NetworkAnimator.cs b/com.unity.netcode.gameobjects/Components/NetworkAnimator.cs
@@ -1,3 +1,4 @@
+#if COM_UNITY_MODULES_ANIMATION
 using Unity.Collections;
 using Unity.Collections.LowLevel.Unsafe;
 using UnityEngine;
@@ -427,3 +428,4 @@ public void ResetTrigger(int hash)
         }
     }
 }
+#endif // COM_UNITY_MODULES_ANIMATION
diff --git a/com.unity.netcode.gameobjects/Components/NetworkRigidbody.cs b/com.unity.netcode.gameobjects/Components/NetworkRigidbody.cs
@@ -1,3 +1,4 @@
+#if COM_UNITY_MODULES_PHYSICS
 using UnityEngine;
 
 namespace Unity.Netcode.Components
@@ -78,3 +79,4 @@ public override void OnNetworkDespawn()
         }
     }
 }
+#endif // COM_UNITY_MODULES_PHYSICS
diff --git a/com.unity.netcode.gameobjects/Components/NetworkRigidbody2D.cs b/com.unity.netcode.gameobjects/Components/NetworkRigidbody2D.cs
@@ -1,3 +1,4 @@
+#if COM_UNITY_MODULES_PHYSICS2D
 using UnityEngine;
 
 namespace Unity.Netcode.Components
@@ -78,3 +79,4 @@ public override void OnNetworkDespawn()
         }
     }
 }
+#endif // COM_UNITY_MODULES_PHYSICS2D
diff --git a/com.unity.netcode.gameobjects/Components/com.unity.netcode.components.asmdef b/com.unity.netcode.gameobjects/Components/com.unity.netcode.components.asmdef
@@ -5,5 +5,22 @@
         "Unity.Netcode.Runtime",
         "Unity.Collections"
     ],
-    "allowUnsafeCode": true
+    "allowUnsafeCode": true,
+    "versionDefines": [
+        {
+            "name": "com.unity.modules.animation",
+            "expression": "",
+            "define": "COM_UNITY_MODULES_ANIMATION"
+        },
+        {
+            "name": "com.unity.modules.physics",
+            "expression": "",
+            "define": "COM_UNITY_MODULES_PHYSICS"
+        },
+        {
+            "name": "com.unity.modules.physics2d",
+            "expression": "",
+            "define": "COM_UNITY_MODULES_PHYSICS2D"
+        }
+    ]
 }
diff --git a/com.unity.netcode.gameobjects/Editor/NetworkTransformEditor.cs b/com.unity.netcode.gameobjects/Editor/NetworkTransformEditor.cs
@@ -112,19 +112,23 @@ public override void OnInspectorGUI()
             EditorGUILayout.PropertyField(m_InLocalSpaceProperty);
             EditorGUILayout.PropertyField(m_InterpolateProperty);
 
+#if COM_UNITY_MODULES_PHYSICS
             // if rigidbody is present but network rigidbody is not present
             var go = ((NetworkTransform)target).gameObject;
             if (go.TryGetComponent<Rigidbody>(out _) && go.TryGetComponent<NetworkRigidbody>(out _) == false)
             {
                 EditorGUILayout.HelpBox("This GameObject contains a Rigidbody but no NetworkRigidbody.\n" +
                     "Add a NetworkRigidbody component to improve Rigidbody synchronization.", MessageType.Warning);
             }
+#endif // COM_UNITY_MODULES_PHYSICS
 
+#if COM_UNITY_MODULES_PHYSICS2D
             if (go.TryGetComponent<Rigidbody2D>(out _) && go.TryGetComponent<NetworkRigidbody2D>(out _) == false)
             {
                 EditorGUILayout.HelpBox("This GameObject contains a Rigidbody2D but no NetworkRigidbody2D.\n" +
                     "Add a NetworkRigidbody2D component to improve Rigidbody2D synchronization.", MessageType.Warning);
             }
+#endif // COM_UNITY_MODULES_PHYSICS2D
 
             serializedObject.ApplyModifiedProperties();
         }
diff --git a/com.unity.netcode.gameobjects/Tests/Runtime/NetworkAnimator/NetworkAnimatorTests.cs b/com.unity.netcode.gameobjects/Tests/Runtime/NetworkAnimator/NetworkAnimatorTests.cs
@@ -1,3 +1,4 @@
+#if COM_UNITY_MODULES_ANIMATION
 using System.Collections;
 using System.Collections.Generic;
 using NUnit.Framework;
@@ -235,3 +236,4 @@ public IEnumerator AnimationStateSyncTestWithOverride()
         }
     }
 }
+#endif // COM_UNITY_MODULES_ANIMATION
diff --git a/com.unity.netcode.gameobjects/Tests/Runtime/Physics/NetworkRigidbody2DTest.cs b/com.unity.netcode.gameobjects/Tests/Runtime/Physics/NetworkRigidbody2DTest.cs
@@ -1,3 +1,4 @@
+#if COM_UNITY_MODULES_PHYSICS2D
 using System.Collections;
 using NUnit.Framework;
 using Unity.Netcode.Components;
@@ -76,3 +77,4 @@ public IEnumerator TestRigidbodyKinematicEnableDisable()
         }
     }
 }
+#endif // COM_UNITY_MODULES_PHYSICS2D
diff --git a/com.unity.netcode.gameobjects/Tests/Runtime/Physics/NetworkRigidbodyTest.cs b/com.unity.netcode.gameobjects/Tests/Runtime/Physics/NetworkRigidbodyTest.cs
@@ -1,3 +1,4 @@
+#if COM_UNITY_MODULES_PHYSICS
 using System.Collections;
 using NUnit.Framework;
 using Unity.Netcode.Components;
@@ -75,3 +76,4 @@ public IEnumerator TestRigidbodyKinematicEnableDisable()
         }
     }
 }
+#endif // COM_UNITY_MODULES_PHYSICS
diff --git a/com.unity.netcode.gameobjects/package.json b/com.unity.netcode.gameobjects/package.json
@@ -5,9 +5,6 @@
     "version": "1.0.0-pre.6",
     "unity": "2020.3",
     "dependencies": {
-        "com.unity.modules.animation": "1.0.0",
-        "com.unity.modules.physics": "1.0.0",
-        "com.unity.modules.physics2d": "1.0.0",
         "com.unity.nuget.mono-cecil": "1.10.1",
         "com.unity.collections": "1.1.0"
     }
diff --git a/minimalproject/Packages/packages-lock.json b/minimalproject/Packages/packages-lock.json
@@ -38,9 +38,6 @@
       "depth": 0,
       "source": "local",
       "dependencies": {
-        "com.unity.modules.animation": "1.0.0",
-        "com.unity.modules.physics": "1.0.0",
-        "com.unity.modules.physics2d": "1.0.0",
         "com.unity.nuget.mono-cecil": "1.10.1",
         "com.unity.collections": "1.1.0"
       }
@@ -63,12 +60,6 @@
       },
       "url": "https://packages.unity.com"
     },
-    "com.unity.modules.animation": {
-      "version": "1.0.0",
-      "depth": 1,
-      "source": "builtin",
-      "dependencies": {}
-    },
     "com.unity.modules.imgui": {
       "version": "1.0.0",
       "depth": 3,
@@ -80,18 +71,6 @@
       "depth": 3,
       "source": "builtin",
       "dependencies": {}
-    },
-    "com.unity.modules.physics": {
-      "version": "1.0.0",
-      "depth": 1,
-      "source": "builtin",
-      "dependencies": {}
-    },
-    "com.unity.modules.physics2d": {
-      "version": "1.0.0",
-      "depth": 1,
-      "source": "builtin",
-      "dependencies": {}
     }
   }
 }
diff --git a/testproject/Packages/packages-lock.json b/testproject/Packages/packages-lock.json
@@ -70,18 +70,15 @@
       "depth": 0,
       "source": "local",
       "dependencies": {
-        "com.unity.netcode.gameobjects": "1.0.0-pre.5",
-        "com.unity.transport": "1.0.0-pre.13"
+        "com.unity.netcode.gameobjects": "1.0.0-pre.6",
+        "com.unity.transport": "1.0.0-pre.15"
       }
     },
     "com.unity.netcode.gameobjects": {
       "version": "file:../../com.unity.netcode.gameobjects",
       "depth": 0,
       "source": "local",
       "dependencies": {
-        "com.unity.modules.animation": "1.0.0",
-        "com.unity.modules.physics": "1.0.0",
-        "com.unity.modules.physics2d": "1.0.0",
         "com.unity.nuget.mono-cecil": "1.10.1",
         "com.unity.collections": "1.1.0"
       }
@@ -188,7 +185,7 @@
       "url": "https://packages.unity.com"
     },
     "com.unity.transport": {
-      "version": "1.0.0-pre.13",
+      "version": "1.0.0-pre.15",
       "depth": 1,
       "source": "registry",
       "dependencies": {

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+#if COM_UNITY_MODULES_ANIMATION`
`1`	`2`	`using Unity.Collections;`
`2`	`3`	`using Unity.Collections.LowLevel.Unsafe;`
`3`	`4`	`using UnityEngine;`
`@@ -427,3 +428,4 @@ public void ResetTrigger(int hash)`
`427`	`428`	`}`
`428`	`429`	`}`
`429`	`430`	`}`
	`431`	`+#endif // COM_UNITY_MODULES_ANIMATION`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+#if COM_UNITY_MODULES_PHYSICS`
`1`	`2`	`using UnityEngine;`
`2`	`3`
`3`	`4`	`namespace Unity.Netcode.Components`
`@@ -78,3 +79,4 @@ public override void OnNetworkDespawn()`
`78`	`79`	`}`
`79`	`80`	`}`
`80`	`81`	`}`
	`82`	`+#endif // COM_UNITY_MODULES_PHYSICS`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+#if COM_UNITY_MODULES_PHYSICS2D`
`1`	`2`	`using UnityEngine;`
`2`	`3`
`3`	`4`	`namespace Unity.Netcode.Components`
`@@ -78,3 +79,4 @@ public override void OnNetworkDespawn()`
`78`	`79`	`}`
`79`	`80`	`}`
`80`	`81`	`}`
	`82`	`+#endif // COM_UNITY_MODULES_PHYSICS2D`
Original file line number	Diff line number	Diff line change
`@@ -112,19 +112,23 @@ public override void OnInspectorGUI()`
`112`	`112`	`EditorGUILayout.PropertyField(m_InLocalSpaceProperty);`
`113`	`113`	`EditorGUILayout.PropertyField(m_InterpolateProperty);`
`114`	`114`
	`115`	`+#if COM_UNITY_MODULES_PHYSICS`
`115`	`116`	`// if rigidbody is present but network rigidbody is not present`
`116`	`117`	`var go = ((NetworkTransform)target).gameObject;`
`117`	`118`	`if (go.TryGetComponent<Rigidbody>(out _) && go.TryGetComponent<NetworkRigidbody>(out _) == false)`
`118`	`119`	`{`
`119`	`120`	`EditorGUILayout.HelpBox("This GameObject contains a Rigidbody but no NetworkRigidbody.\n" +`
`120`	`121`	`"Add a NetworkRigidbody component to improve Rigidbody synchronization.", MessageType.Warning);`
`121`	`122`	`}`
	`123`	`+#endif // COM_UNITY_MODULES_PHYSICS`
`122`	`124`
	`125`	`+#if COM_UNITY_MODULES_PHYSICS2D`
`123`	`126`	`if (go.TryGetComponent<Rigidbody2D>(out _) && go.TryGetComponent<NetworkRigidbody2D>(out _) == false)`
`124`	`127`	`{`
`125`	`128`	`EditorGUILayout.HelpBox("This GameObject contains a Rigidbody2D but no NetworkRigidbody2D.\n" +`
`126`	`129`	`"Add a NetworkRigidbody2D component to improve Rigidbody2D synchronization.", MessageType.Warning);`
`127`	`130`	`}`
	`131`	`+#endif // COM_UNITY_MODULES_PHYSICS2D`
`128`	`132`
`129`	`133`	`serializedObject.ApplyModifiedProperties();`
`130`	`134`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+#if COM_UNITY_MODULES_ANIMATION`
`1`	`2`	`using System.Collections;`
`2`	`3`	`using System.Collections.Generic;`
`3`	`4`	`using NUnit.Framework;`
`@@ -235,3 +236,4 @@ public IEnumerator AnimationStateSyncTestWithOverride()`
`235`	`236`	`}`
`236`	`237`	`}`
`237`	`238`	`}`
	`239`	`+#endif // COM_UNITY_MODULES_ANIMATION`