Merge pull request #720 from yellowisher/improve/instantiate_no_dirty

Make Instantiate() revert dirty state of prefab
hadashiA · Nov 12, 2024 · e427251 · e427251
2 parents ec83f21 + 0f8a977
commit e427251
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 0 deletions.
diff --git a/VContainer/Assets/VContainer/Runtime/Unity/InstanceProviders/PrefabComponentProvider.cs b/VContainer/Assets/VContainer/Runtime/Unity/InstanceProviders/PrefabComponentProvider.cs
@@ -29,6 +29,8 @@ public object SpawnInstance(IObjectResolver resolver)
             var parent = destination.GetParent(resolver);
 
             var wasActive = prefab.gameObject.activeSelf;
+            using var dirtyScope = new ObjectResolverUnityExtensions.PrefabDirtyScope(prefab.gameObject);
+
             if (wasActive)
             {
                 prefab.gameObject.SetActive(false);

diff --git a/VContainer/Assets/VContainer/Runtime/Unity/LifetimeScope.cs b/VContainer/Assets/VContainer/Runtime/Unity/LifetimeScope.cs
@@ -263,6 +263,8 @@ public TScope CreateChildFromPrefab<TScope>(TScope prefab, IInstaller installer
             where TScope : LifetimeScope
         {
             var wasActive = prefab.gameObject.activeSelf;
+            using var dirtyScope = new ObjectResolverUnityExtensions.PrefabDirtyScope(prefab.gameObject);
+
             if (wasActive)
             {
                 prefab.gameObject.SetActive(false);

diff --git a/VContainer/Assets/VContainer/Runtime/Unity/ObjectResolverUnityExtensions.cs b/VContainer/Assets/VContainer/Runtime/Unity/ObjectResolverUnityExtensions.cs
@@ -1,10 +1,36 @@
+using System;
 using UnityEngine;
 using VContainer.Internal;
 
 namespace VContainer.Unity
 {
     public static class ObjectResolverUnityExtensions
     {
+        public readonly struct PrefabDirtyScope : IDisposable
+        {
+            private readonly GameObject _prefab;
+            private readonly bool _madeDirty;
+
+            public PrefabDirtyScope(GameObject prefab)
+            {
+                _prefab = prefab;
+
+#if UNITY_EDITOR && UNITY_2020_1_OR_NEWER
+                _madeDirty = prefab.activeSelf && !UnityEditor.EditorUtility.IsDirty(_prefab);
+#endif
+            }
+
+            public void Dispose()
+            {
+#if UNITY_EDITOR && UNITY_2020_1_OR_NEWER
+                if (_madeDirty)
+                {
+                    UnityEditor.EditorUtility.ClearDirty(_prefab);
+                }
+#endif
+            }
+        }
+
         public static void InjectGameObject(this IObjectResolver resolver, GameObject gameObject)
         {
             void InjectGameObjectRecursive(GameObject current)
@@ -45,6 +71,8 @@ public static T Instantiate<T>(this IObjectResolver resolver, T prefab, Transfor
             where T : Component
         {
             var wasActive = prefab.gameObject.activeSelf;
+            using var dirtyScope = new PrefabDirtyScope(prefab.gameObject);
+
             prefab.gameObject.SetActive(false);
 
             var instance = UnityEngine.Object.Instantiate(prefab, parent, worldPositionStays);
@@ -88,6 +116,8 @@ public static T Instantiate<T>(
             where T : Component
         {
             var wasActive = prefab.gameObject.activeSelf;
+            using var dirtyScope = new PrefabDirtyScope(prefab.gameObject);
+
             prefab.gameObject.SetActive(false);
 
             var instance = UnityEngine.Object.Instantiate(prefab, position, rotation, parent);
@@ -111,6 +141,8 @@ static T Instantiate<T>(this LifetimeScope scope, T prefab, Vector3 position, Qu
             where T : Component
         {
             var wasActive = prefab.gameObject.activeSelf;
+            using var dirtyScope = new PrefabDirtyScope(prefab.gameObject);
+
             prefab.gameObject.SetActive(false);
 
             T instance;
@@ -144,6 +176,8 @@ static T Instantiate<T>(this LifetimeScope scope, T prefab, Vector3 position, Qu
         static GameObject Instantiate(this LifetimeScope scope, GameObject prefab, Vector3 position, Quaternion rotation)
         {
             var wasActive = prefab.activeSelf;
+            using var dirtyScope = new PrefabDirtyScope(prefab);
+
             prefab.SetActive(false);
 
             GameObject instance;
@@ -182,6 +216,8 @@ public static GameObject Instantiate(this IObjectResolver resolver, GameObject p
         public static GameObject Instantiate(this IObjectResolver resolver, GameObject prefab, Transform parent, bool worldPositionStays = false)
         {
             var wasActive = prefab.activeSelf;
+            using var dirtyScope = new PrefabDirtyScope(prefab);
+
             prefab.SetActive(false);
 
             GameObject instance = null;
@@ -221,6 +257,8 @@ public static GameObject Instantiate(
             Transform parent)
         {
             var wasActive = prefab.activeSelf;
+            using var dirtyScope = new PrefabDirtyScope(prefab);
+
             prefab.SetActive(false);
 
             var instance = UnityEngine.Object.Instantiate(prefab, position, rotation, parent);