quick find and replace for InstanceID to EntityId (#626)

varinotmUnity · jonbro · web-flow · commit 56d073891932 · 2025-10-10T22:39:25.000-04:00
* quick find and replace for InstanceID to EntityId

* add ifdef depending on unity version

---------

Co-authored-by: Jonathan Brodsky &lt;jonathan.brodsky@unity3d.com&gt;
diff --git a/AssetIdRemapUtility/Editor/AssetIdRemapBuilderEditor.cs b/AssetIdRemapUtility/Editor/AssetIdRemapBuilderEditor.cs
@@ -455,7 +455,11 @@ static string GetSelectedDirectory()
 
             if (o != null)
             {
+#if UNITY_6000_4_OR_NEWER
+                string path = AssetDatabase.GetAssetPath(o.GetEntityId());
+#else
                 string path = AssetDatabase.GetAssetPath(o.GetInstanceID());
+#endif
 
                 if (!string.IsNullOrEmpty(path))
                 {
diff --git a/Debug/Editor/DebugEditor.cs b/Debug/Editor/DebugEditor.cs
@@ -70,7 +70,7 @@ static void EndSectionHeader()
 
         static string GetPropertyId(ProBuilderMesh mesh, string property)
         {
-            return string.Format("{0}.{1}", mesh.GetInstanceID(), property);
+            return string.Format("{0}.{1}", mesh.GetObjectId(), property);
         }
 
         void DoSharedVerticesInfo(ProBuilderMesh mesh)
diff --git a/Editor/EditorCore/EditorHandleDrawing.cs b/Editor/EditorCore/EditorHandleDrawing.cs
@@ -240,7 +240,7 @@ static Material CreateMaterial(Shader shader, string materialName)
         static Mesh CreateMesh()
         {
             var mesh = new Mesh();
-            mesh.name = "EditorMeshHandles.MeshHandle" + mesh.GetInstanceID();
+            mesh.name = "EditorMeshHandles.MeshHandle" + mesh.GetObjectId();
             mesh.hideFlags = HideFlags.HideAndDontSave;
             return mesh;
         }
diff --git a/Editor/EditorCore/EditorUtility.cs b/Editor/EditorCore/EditorUtility.cs
@@ -168,7 +168,7 @@ internal static bool AssetStoreWindowIsOpen()
         [Conditional("DEBUG_MESH_SYNC")]
         static void LogMeshSyncEvent(ProBuilderMesh mesh, MeshSyncState state, string msg)
         {
-            Debug.Log($"{mesh} {mesh.GetInstanceID()} {state} {msg}");
+            Debug.Log($"{mesh} {mesh.GetObjectId()} {state} {msg}");
         }
 
         /// <summary>
@@ -300,7 +300,7 @@ internal static void InitObject(ProBuilderMesh pb)
 
             pb.unwrapParameters = new UnwrapParameters(Lightmapping.s_UnwrapParameters);
             pb.Optimize();
-            
+
             // PBLD-137 - if Resident Drawer is on, it will start throwing errors if submeshCount != materialCount
             if (pb.mesh.subMeshCount == 0)
                 pb.renderer.sharedMaterial = null;
diff --git a/Editor/EditorCore/FileUtility.cs b/Editor/EditorCore/FileUtility.cs
@@ -158,7 +158,7 @@ internal static string GetSelectedDirectory()
 
             if (o != null)
             {
-                string path = AssetDatabase.GetAssetPath(o.GetInstanceID());
+                string path = AssetDatabase.GetAssetPath(o.GetObjectId());
 
                 if (!string.IsNullOrEmpty(path))
                 {
diff --git a/Editor/EditorCore/ProBuilderMeshEditor.cs b/Editor/EditorCore/ProBuilderMeshEditor.cs
@@ -177,8 +177,8 @@ public override void OnInspectorGUI()
 
             GUILayout.Label("Identifiers", EditorStyles.boldLabel);
             EditorGUI.showMixedValue = targets.Length > 1;
-            EditorGUILayout.IntField("ProBuilderMesh", m_Mesh.GetInstanceID());
-            EditorGUILayout.IntField("UnityEngine.Mesh", sharedMesh != null ? sharedMesh.GetInstanceID() : -1);
+            EditorGUILayout.IntField("ProBuilderMesh", m_Mesh.GetObjectId());
+            EditorGUILayout.IntField("UnityEngine.Mesh", sharedMesh != null ? sharedMesh.GetObjectId() : -1);
             EditorGUILayout.TextField("UnityEngine.Mesh.name", sharedMesh != null ? sharedMesh.name : "null");
             EditorGUI.showMixedValue = false;
 #endif
diff --git a/Editor/EditorCore/RepairActions.cs b/Editor/EditorCore/RepairActions.cs
@@ -25,7 +25,7 @@ public static void MenuForceSceneRefresh()
             {
                 UnityEditor.EditorUtility.DisplayProgressBar(
                     "Refreshing ProBuilder Objects",
-                    "Reshaping pb_Object " + all[i].GetInstanceID() + ".",
+                    "Reshaping pb_Object " + all[i].GetObjectId() + ".",
                     ((float)i / all.Length));
 
                 try
@@ -103,7 +103,7 @@ static void RebuildSharedIndexes(ProBuilderMesh[] targets)
             {
                 UnityEditor.EditorUtility.DisplayProgressBar(
                     "Refreshing ProBuilder Objects",
-                    "Rebuilding mesh " + targets[i].GetInstanceID() + ".",
+                    "Rebuilding mesh " + targets[i].GetObjectId() + ".",
                     ((float)i / targets.Length));
 
                 ProBuilderMesh pb = targets[i];
diff --git a/Editor/EditorCore/StripProBuilderScripts.cs b/Editor/EditorCore/StripProBuilderScripts.cs
@@ -40,7 +40,7 @@ public static void StripAllScenes()
             {
                 if (c > 32 && UnityEditor.EditorUtility.DisplayCancelableProgressBar(
                         "Stripping ProBuilder Scripts",
-                        "Working over " + all[i].GetInstanceID() + ".",
+                        "Working over " + all[i].GetObjectId() + ".",
                         ((float)i / all.Count)))
                     break;
 
diff --git a/Runtime/Core/InternalUtility.cs b/Runtime/Core/InternalUtility.cs
@@ -135,5 +135,39 @@ public static T DemandComponent<T>(this GameObject gameObject) where T : Compone
                 component = gameObject.AddComponent<T>();
             return component;
         }
+
+#if UNITY_6000_4_OR_NEWER
+        /// <summary>
+        /// Returns the <see cref="EntityId"/> identifier for the given <see cref="UnityEngine.Object"/>.
+        /// This method abstracts the Unity version differences between <c>GetEntityId()</c>
+        /// (available in Unity 6000.4 or newer) and <c>GetInstanceID()</c> in older Unity versions.
+        ///
+        /// Use this method to obtain an object identifier that is compatible with APIs expecting
+        /// <see cref="EntityId"/> in newer Unity versions, such as
+        /// <see cref="UnityEditor.AssetDatabase.GetAssetPath(EntityId)"/>.
+        /// </summary>
+        /// <param name="o">The Unity object to get an identifier for.</param>
+        /// <returns>The object's unique <see cref="EntityId"/>.</returns>
+        internal static EntityId GetObjectId(this Object o)
+        {
+            return o.GetEntityId();
+        }
+#else
+        /// <summary>
+        /// Returns the integer identifier for the given <see cref="UnityEngine.Object"/>.
+        /// This method abstracts the Unity version differences between <c>GetEntityId()</c>
+        /// (available in Unity 6000.4 or newer) and <c>GetInstanceID()</c> in older Unity versions.
+        ///
+        /// Use this method to obtain an object identifier that is compatible with APIs expecting
+        /// an integer in older Unity versions, such as
+        /// <see cref="UnityEditor.AssetDatabase.GetAssetPath(int)"/>.
+        /// </summary>
+        /// <param name="o">The Unity object to get an identifier for.</param>
+        /// <returns>The object's unique integer identifier.</returns>
+        internal static int GetObjectId(this Object o)
+        {
+            return o.GetInstanceID();
+        }
+#endif
     }
 }
diff --git a/Runtime/Core/MeshHandles.cs b/Runtime/Core/MeshHandles.cs
@@ -58,7 +58,7 @@ internal static void CreateEdgeMesh(ProBuilderMesh mesh, Mesh target)
 
             target.Clear();
             target.indexFormat = edgeCount * 2 > ushort.MaxValue ? Rendering.IndexFormat.UInt32 : Rendering.IndexFormat.UInt16;
-            target.name = "ProBuilder::EdgeMesh" + target.GetInstanceID();
+            target.name = "ProBuilder::EdgeMesh" + target.GetObjectId();
             target.vertices = mesh.positionsInternal;
             target.subMeshCount = 1;
             target.SetIndices(s_IndexList, MeshTopology.Lines, 0);
@@ -81,7 +81,7 @@ internal static void CreateEdgeMesh(ProBuilderMesh mesh, Mesh target, Edge[] edg
 
             target.Clear();
             target.indexFormat = vertexCount > ushort.MaxValue ? Rendering.IndexFormat.UInt32 : Rendering.IndexFormat.UInt16;
-            target.name = "ProBuilder::EdgeMesh" + target.GetInstanceID();
+            target.name = "ProBuilder::EdgeMesh" + target.GetObjectId();
             target.vertices = mesh.positionsInternal;
             target.subMeshCount = 1;
             target.SetIndices(s_IndexList, MeshTopology.Lines, 0);
diff --git a/Runtime/Core/ProBuilderMesh.cs b/Runtime/Core/ProBuilderMesh.cs
@@ -978,7 +978,7 @@ internal Mesh mesh
         }
 
         [Obsolete("InstanceID is not used to track mesh references as of 2023/04/12")]
-        internal int id => gameObject.GetInstanceID();
+        internal int id => gameObject.GetObjectId();
 
         /// <summary>
         /// Gets a flag that indicates whether the <see cref="UnityEngine.Mesh" /> is in sync with the ProBuilderMesh.
diff --git a/Runtime/Core/ProBuilderMeshFunction.cs b/Runtime/Core/ProBuilderMeshFunction.cs
@@ -335,7 +335,7 @@ public void ToMesh(MeshTopology preferredTopology = MeshTopology.Triangles)
 #if ENABLE_DRIVEN_PROPERTIES
                 SerializationUtility.RegisterDrivenProperty(this, this, "m_Mesh");
 #endif
-                mesh = new Mesh() { name = $"pb_Mesh{GetInstanceID()}" };
+                mesh = new Mesh() { name = $"pb_Mesh{this.GetObjectId()}" };
             }
             else if (mesh.vertexCount != vertexCount)
             {
@@ -484,7 +484,7 @@ public void MakeUnique()
         {
             mesh = mesh != null
                 ? Instantiate(mesh)
-                : new Mesh() { name = $"pb_Mesh{GetInstanceID()}" };
+                : new Mesh() { name = $"pb_Mesh{this.GetObjectId()}" };
 
             if (meshSyncState == MeshSyncState.InSync)
             {
diff --git a/Samples~/Editor/RenameNewObjects.cs b/Samples~/Editor/RenameNewObjects.cs
@@ -34,7 +34,7 @@ static RenameNewObjects()
 		/// <param name="pb"></param>
 		static void OnProBuilderObjectCreated(pb_Object pb)
 		{
-			pb.gameObject.name = string.Format("pb_{0}{1}", pb.gameObject.name, pb.GetInstanceID());
+			pb.gameObject.name = string.Format("pb_{0}{1}", pb.gameObject.name, pb.GetObjectId());
 		}
 	}
 }
diff --git a/Tests/Editor/Editor/MeshSyncTests.cs b/Tests/Editor/Editor/MeshSyncTests.cs
@@ -52,7 +52,7 @@ public void ExecuteCopyPasteDuplicate_CreatesUniqueMesh(string[] commands)
         var cube = ShapeGenerator.CreateShape(ShapeType.Cube, PivotLocation.FirstVertex);
         cube.transform.parent = parent;
         Assume.That(parent.childCount, Is.EqualTo(1));
-        int originalMeshId = cube.GetComponent<MeshFilter>().sharedMesh.GetInstanceID();
+        int originalMeshId = cube.GetComponent<MeshFilter>().sharedMesh.GetObjectId();
 
         Selection.activeObject = cube.gameObject;
 
@@ -72,7 +72,7 @@ public void ExecuteCopyPasteDuplicate_CreatesUniqueMesh(string[] commands)
         HierarchyListener.OnObjectCreated(copy);
 
         Assume.That(copy, Is.Not.EqualTo(cube));
-        Assert.That(copy.GetComponent<MeshFilter>().sharedMesh.GetInstanceID(), Is.Not.EqualTo(originalMeshId));
+        Assert.That(copy.GetComponent<MeshFilter>().sharedMesh.GetObjectId(), Is.Not.EqualTo(originalMeshId));
     }
 
     //[PBLD-75] Sending the event to the scene view is needed as just calling HierarchyListener.OnObjectCreated
@@ -89,7 +89,7 @@ public IEnumerator ExecuteCopyPasteDuplicateOnParent_CreatesUniqueMesh()
         cube.transform.parent = emptyGO;
 
         Assume.That(parent.childCount, Is.EqualTo(1));
-        int originalMeshId = cube.GetComponent<MeshFilter>().sharedMesh.GetInstanceID();
+        int originalMeshId = cube.GetComponent<MeshFilter>().sharedMesh.GetObjectId();
 
         Selection.objects = new[] { emptyGO.gameObject };
         ActiveEditorTracker.sharedTracker.ForceRebuild();
@@ -117,7 +117,7 @@ public IEnumerator ExecuteCopyPasteDuplicateOnParent_CreatesUniqueMesh()
         HierarchyListener.OnObjectCreated(copy);
 
         Assume.That(copy, Is.Not.EqualTo(cube));
-        Assert.That(copy.GetComponent<MeshFilter>().sharedMesh.GetInstanceID(), Is.Not.EqualTo(originalMeshId));
+        Assert.That(copy.GetComponent<MeshFilter>().sharedMesh.GetObjectId(), Is.Not.EqualTo(originalMeshId));
     }
 
     [Test]
@@ -129,36 +129,36 @@ public void OpenSceneDoesNotDirtyScene()
         EditorUtility.SynchronizeWithMeshFilter(mesh);
         Assert.That(EditorSceneManager.GetActiveScene().isDirty, Is.False);
     }
-    
+
     // [PBLD-138] Duplicating PBMesh would dirty all scenes
     [UnityTest]
     public IEnumerator GivenMultipleScenes_DuplicatePBMesh_OnlyOneSceneIsDirty()
     {
         // Load two scenes
         Scene firstScene = EditorSceneManager.GetActiveScene();
         Assume.That(firstScene, Is.Not.Null, "First scene should not be null.");
-        Assume.That(firstScene.isDirty, Is.False, "First scene should not be dirty.");        
-        
+        Assume.That(firstScene.isDirty, Is.False, "First scene should not be dirty.");
+
         Scene secondScene = OpenScene(emptyScene, OpenSceneMode.Additive);
         Assume.That(secondScene, Is.Not.Null, "Second scene should not be null");
-        Assume.That(secondScene.isDirty, Is.False, "Second scene should not be dirty.");        
-        
-        Assume.That(EditorSceneManager.sceneCount, Is.EqualTo(2), "There should be two scenes loaded.");        
-        
+        Assume.That(secondScene.isDirty, Is.False, "Second scene should not be dirty.");
+
+        Assume.That(EditorSceneManager.sceneCount, Is.EqualTo(2), "There should be two scenes loaded.");
+
         SceneManager.SetActiveScene(firstScene);
-        
+
         // Create a cube in first scene
         var cube = GameObject.Find("Cube");
         Assume.That(cube, Is.Not.Null, "Finding Cube shape should succeed.");
-        
+
         // Select cube
         Selection.activeGameObject = cube.gameObject;
         ActiveEditorTracker.sharedTracker.ForceRebuild();
-        
+
         // Duplicate cube
         var evt = new Event(){type = EventType.ExecuteCommand, commandName = "Duplicate"};
         SceneView.lastActiveSceneView.SendEvent(evt);
-        
+
         // Wait until we can confirm duplication command
         var count = 0;
         while (firstScene.rootCount < 2 && count < 100)
@@ -170,16 +170,16 @@ public IEnumerator GivenMultipleScenes_DuplicatePBMesh_OnlyOneSceneIsDirty()
 
         // Wait one frame for the Undo commands to flush
         yield return null;
-        
+
         // Second scene should stay untouched
         Assert.That(firstScene.isDirty, Is.True, "First scene should be dirty after cube duplication.");
         Assert.That(secondScene.isDirty, Is.False, "Second scene should remain clean after cube duplication.");
-        
+
         // Clean-up
         var rootGOs = firstScene.GetRootGameObjects();
         for (int i = 0; i < rootGOs.Length; ++i)
             GameObject.DestroyImmediate(rootGOs[i]);
-        
+
         CloseScene(firstScene);
         CloseScene(secondScene);
     }
diff --git a/Tests/Editor/Object/PrefabTests.cs b/Tests/Editor/Object/PrefabTests.cs
@@ -75,7 +75,7 @@ public void InstantiateCreatesUniqueMesh()
         Assume.That(instance2, Is.Not.Null);
         var mesh1 = instance1.GetComponent<ProBuilderMesh>().mesh;
         var mesh2 = instance2.GetComponent<ProBuilderMesh>().mesh;
-        Assert.That(mesh1.GetInstanceID(), Is.Not.EqualTo(mesh2.GetInstanceID()));
+        Assert.That(mesh1.GetObjectId(), Is.Not.EqualTo(mesh2.GetObjectId()));
     }
 
     [Test]

Original file line number	Diff line number	Diff line change
`@@ -455,7 +455,11 @@ static string GetSelectedDirectory()`
`455`	`455`
`456`	`456`	`if (o != null)`
`457`	`457`	`{`
	`458`	`+#if UNITY_6000_4_OR_NEWER`
	`459`	`+ string path = AssetDatabase.GetAssetPath(o.GetEntityId());`
	`460`	`+#else`
`458`	`461`	`string path = AssetDatabase.GetAssetPath(o.GetInstanceID());`
	`462`	`+#endif`
`459`	`463`
`460`	`464`	`if (!string.IsNullOrEmpty(path))`
`461`	`465`	`{`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ static void EndSectionHeader()`
`70`	`70`
`71`	`71`	`static string GetPropertyId(ProBuilderMesh mesh, string property)`
`72`	`72`	`{`
`73`		`- return string.Format("{0}.{1}", mesh.GetInstanceID(), property);`
	`73`	`+ return string.Format("{0}.{1}", mesh.GetObjectId(), property);`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`void DoSharedVerticesInfo(ProBuilderMesh mesh)`
Original file line number	Diff line number	Diff line change
`@@ -240,7 +240,7 @@ static Material CreateMaterial(Shader shader, string materialName)`
`240`	`240`	`static Mesh CreateMesh()`
`241`	`241`	`{`
`242`	`242`	`var mesh = new Mesh();`
`243`		`- mesh.name = "EditorMeshHandles.MeshHandle" + mesh.GetInstanceID();`
	`243`	`+ mesh.name = "EditorMeshHandles.MeshHandle" + mesh.GetObjectId();`
`244`	`244`	`mesh.hideFlags = HideFlags.HideAndDontSave;`
`245`	`245`	`return mesh;`
`246`	`246`	`}`
Original file line number	Diff line number	Diff line change
`@@ -158,7 +158,7 @@ internal static string GetSelectedDirectory()`
`158`	`158`
`159`	`159`	`if (o != null)`
`160`	`160`	`{`
`161`		`- string path = AssetDatabase.GetAssetPath(o.GetInstanceID());`
	`161`	`+ string path = AssetDatabase.GetAssetPath(o.GetObjectId());`
`162`	`162`
`163`	`163`	`if (!string.IsNullOrEmpty(path))`
`164`	`164`	`{`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public static void StripAllScenes()`
`40`	`40`	`{`
`41`	`41`	`if (c > 32 && UnityEditor.EditorUtility.DisplayCancelableProgressBar(`
`42`	`42`	`"Stripping ProBuilder Scripts",`
`43`		`- "Working over " + all[i].GetInstanceID() + ".",`
	`43`	`+ "Working over " + all[i].GetObjectId() + ".",`
`44`	`44`	`((float)i / all.Count)))`
`45`	`45`	`break;`
`46`	`46`