Merge pull request #120 from FishingCactus/fix/memory_singleton

LeanderSimonart · web-flow · commit e5baa84c488a · 2024-07-25T11:40:46.000+02:00
fixes static ref that keeps singletons in memory even when destroyed
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## [2.3.0] - 2024-07-25
+### Fixed
+- Add `OnDestroy` method to set `Singleton` static instance to null when object is destroyed, this fixes a memory leak when destroying singletons
+
 ## [2.2.0] - 2024-06-03
 ### Added
 - Add `SerializableInterface` struct: used to reference objects that implement a specific interface
diff --git a/Runtime/Singleton.cs b/Runtime/Singleton.cs
@@ -48,5 +48,13 @@ public virtual void Awake()
                 Destroy( this );
             }
         }
+
+        protected virtual void OnDestroy()
+        {
+            if( _instance == this )
+            {
+                _instance = null;
+            }
+        }
     }
 }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "com.fishingcactus.common-code",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "displayName": "FC - Common Code",
   "description": "Code, Extensions and extra features for Fishing Cactus Games.",
   "unity": "2020.3",

Original file line number	Diff line number	Diff line change
`@@ -48,5 +48,13 @@ public virtual void Awake()`
`48`	`48`	`Destroy( this );`
`49`	`49`	`}`
`50`	`50`	`}`
	`51`	`+`
	`52`	`+ protected virtual void OnDestroy()`
	`53`	`+ {`
	`54`	`+ if( _instance == this )`
	`55`	`+ {`
	`56`	`+ _instance = null;`
	`57`	`+ }`
	`58`	`+ }`
`51`	`59`	`}`
`52`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "com.fishingcactus.common-code",`
`3`		`- "version": "2.2.0",`
	`3`	`+ "version": "2.3.0",`
`4`	`4`	`"displayName": "FC - Common Code",`
`5`	`5`	`"description": "Code, Extensions and extra features for Fishing Cactus Games.",`
`6`	`6`	`"unity": "2020.3",`