Helper methods for checking if Unity object is destroyed

al2me6 · al2me6 · commit 3732858db978 · 2025-06-15T17:30:26.000-04:00
diff --git a/Source/DynamicProperties/MaterialPropertyManager.cs b/Source/DynamicProperties/MaterialPropertyManager.cs
@@ -1,3 +1,5 @@
+#nullable enable
+
 using System.Collections.Generic;
 using KSPBuildTools;
 using UnityEngine;
@@ -9,7 +11,7 @@ public sealed class MaterialPropertyManager : MonoBehaviour
 {
 	#region Fields
 
-	public static MaterialPropertyManager Instance { get; private set; }
+	public static MaterialPropertyManager? Instance { get; private set; }
 
 	private readonly Dictionary<Renderer, PropsCascade> rendererCascades = [];
 
@@ -75,9 +77,9 @@ public bool Unset(Renderer renderer, Props props)
 
 	public bool Unregister(Renderer renderer)
 	{
-		if ((object)renderer == null) return false;
+		if (renderer.IsNullref()) return false;
 		if (!rendererCascades.Remove(renderer, out var cascade)) return false;
-		if (renderer == null) this.LogDebug($"dead renderer {renderer.GetHashCode()}");
+		if (renderer.IsDestroyed()) this.LogDebug($"destroyed renderer {renderer.GetHashCode()}");
 		cascade.Dispose();
 		return true;
 	}
@@ -91,35 +93,43 @@ public static void RegisterPropertyNamesForDebugLogging(params string[] properti
 
 	private bool CheckRendererAlive(Renderer renderer)
 	{
-		if (renderer != null) return true;
-		this.LogWarning($"cannot modify null renderer {renderer?.GetHashCode()}");
-		if ((object)renderer != null) Unregister(renderer);
-		return false;
+		if (renderer.IsNullref()) {
+			Log.LogError(this, "renderer reference is null");
+			return false;
+		}
+
+		if (renderer.IsDestroyed()) {
+			this.LogWarning($"cannot modify destroyed renderer {renderer.GetHashCode()}");
+			Unregister(renderer);
+			return false;
+		}
+
+		return true;
 	}
 
-	private readonly List<Renderer> _deadRenderers = [];
+	private readonly List<Renderer> _destroyedRenderers = [];
 
-	internal void CheckRemoveDeadRenderers()
+	internal void CheckRemoveDestroyedRenderers()
 	{
 		foreach (var renderer in rendererCascades.Keys) {
-			if (renderer == null) _deadRenderers.Add(renderer);
+			if (renderer.IsDestroyed()) _destroyedRenderers.Add(renderer);
 		}
 
-		foreach (var deadRenderer in _deadRenderers) Unregister(deadRenderer);
-		_deadRenderers.Clear();
+		foreach (var destroyed in _destroyedRenderers) Unregister(destroyed);
+		_destroyedRenderers.Clear();
 	}
 
 	/// Public API equivalent is calling `Props.Dispose`.
 	internal void Unregister(Props props)
 	{
 		foreach (var (renderer, cascade) in rendererCascades) {
-			if (renderer != null) cascade.Remove(props);
+			if (!renderer.IsDestroyed()) cascade.Remove(props);
 		}
 
-		CheckRemoveDeadRenderers();
+		CheckRemoveDestroyedRenderers();
 	}
 
-	private bool _propRefreshScheduled = false;
+	private bool _propsUpdateScheduled = false;
 	private static readonly WaitForEndOfFrame WfEoF = new();
 
 	private IEnumerator<YieldInstruction> Co_propsLateUpdate()
@@ -138,14 +148,14 @@ private IEnumerator<YieldInstruction> Co_propsLateUpdate()
 		}
 
 		propsLateUpdateQueue.Clear();
-		_propRefreshScheduled = false;
+		_propsUpdateScheduled = false;
 	}
 
 	internal void ScheduleLateUpdate(Props props)
 	{
 		propsLateUpdateQueue.Add(props);
-		if (_propRefreshScheduled) return;
+		if (_propsUpdateScheduled) return;
 		StartCoroutine(Co_propsLateUpdate());
-		_propRefreshScheduled = true;
+		_propsUpdateScheduled = true;
 	}
 }
diff --git a/Source/DynamicProperties/MpbCompiler.cs b/Source/DynamicProperties/MpbCompiler.cs
@@ -47,7 +47,7 @@ internal void Register(Renderer renderer)
 	internal void Unregister(Renderer renderer)
 	{
 		linkedRenderers.Remove(renderer);
-		if (renderer != null) renderer.SetPropertyBlock(EmptyMpb);
+		if (!renderer.IsDestroyed()) renderer.SetPropertyBlock(EmptyMpb);
 
 		if (linkedRenderers.Count > 0) return;
 		Log.Debug(
@@ -113,17 +113,17 @@ private void RewriteMpb()
 
 	private void ApplyAll()
 	{
-		var hasDeadRenderer = false;
+		var hasDestroyedRenderer = false;
 
 		foreach (var renderer in linkedRenderers) {
-			if (renderer != null) {
-				Apply(renderer);
+			if (renderer.IsDestroyed()) {
+				hasDestroyedRenderer = true;
 			} else {
-				hasDeadRenderer = true;
+				Apply(renderer);
 			}
 		}
 
-		if (hasDeadRenderer) MaterialPropertyManager.Instance?.CheckRemoveDeadRenderers();
+		if (hasDestroyedRenderer) MaterialPropertyManager.Instance?.CheckRemoveDestroyedRenderers();
 	}
 
 	#endregion
diff --git a/Source/DynamicProperties/Utils.cs b/Source/DynamicProperties/Utils.cs
@@ -6,6 +6,12 @@ namespace Shabby.DynamicProperties;
 
 public static class Utils
 {
+	[MethodImpl(MethodImplOptions.AggressiveInlining)]
+	public static bool IsDestroyed(this UnityEngine.Object obj) => obj.m_CachedPtr != IntPtr.Zero;
+
+	[MethodImpl(MethodImplOptions.AggressiveInlining)]
+	public static bool IsNullref(this UnityEngine.Object obj) => ReferenceEquals(obj, null);
+
 	[MethodImpl(MethodImplOptions.AggressiveInlining)]
 	public static bool ApproxEqualsAbs(float a, float b, float eps) =>
 		Math.Abs(b - a) <= eps;
diff --git a/Source/Shabby.csproj b/Source/Shabby.csproj
@@ -7,7 +7,7 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="KSPBuildTools" Version="0.0.4" />
+    <PackageReference Include="KSPBuildTools" Version="0.0.4"/>
     <PackageReference Include="MinVer" Version="5.0.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
@@ -43,17 +43,8 @@
 
   <!-- Publicizer -->
   <ItemGroup>
-    <Publicize Include="Assembly-CSharp:MaterialColorUpdater.setColor"/>
-    <Publicize Include="Assembly-CSharp:ModuleColorChanger.color"/>
-    <Publicize Include="Assembly-CSharp:ModuleColorChanger.renderers"/>
-    <Publicize Include="Assembly-CSharp:ModuleJettison.jettisonTemperatureRenderer"/>
-    <Publicize Include="Assembly-CSharp:Part.CreateRendererLists"/>
-    <Publicize Include="Assembly-CSharp:Part.highlightRenderer"/>
-    <Publicize Include="Assembly-CSharp:Part.modelRenderersCache"/>
-    <Publicize Include="Assembly-CSharp:Part.temperatureRenderer"/>
-    <Publicize Include="Assembly-CSharp:ProceduralFairings.FairingPanel.mpb"/>
-    <Publicize Include="Assembly-CSharp:ProceduralFairings.FairingPanel.mr"/>
-    <Publicize Include="Assembly-CSharp:ProceduralFairings.FairingPanel.opacity"/>
+    <Publicize Include="Assembly-CSharp"/>
+    <Publicize Include="UnityEngine.CoreModule:UnityEngine.Object.m_CachedPtr"/>
   </ItemGroup>
 
   <!-- Version Files -->

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+#nullable enable`
	`2`	`+`
`1`	`3`	`using System.Collections.Generic;`
`2`	`4`	`using KSPBuildTools;`
`3`	`5`	`using UnityEngine;`
`@@ -9,7 +11,7 @@ public sealed class MaterialPropertyManager : MonoBehaviour`
`9`	`11`	`{`
`10`	`12`	`#region Fields`
`11`	`13`
`12`		`- public static MaterialPropertyManager Instance { get; private set; }`
	`14`	`+ public static MaterialPropertyManager? Instance { get; private set; }`
`13`	`15`
`14`	`16`	`private readonly Dictionary<Renderer, PropsCascade> rendererCascades = [];`
`15`	`17`
`@@ -75,9 +77,9 @@ public bool Unset(Renderer renderer, Props props)`
`75`	`77`
`76`	`78`	`public bool Unregister(Renderer renderer)`
`77`	`79`	`{`
`78`		`- if ((object)renderer == null) return false;`
	`80`	`+ if (renderer.IsNullref()) return false;`
`79`	`81`	`if (!rendererCascades.Remove(renderer, out var cascade)) return false;`
`80`		`- if (renderer == null) this.LogDebug($"dead renderer {renderer.GetHashCode()}");`
	`82`	`+ if (renderer.IsDestroyed()) this.LogDebug($"destroyed renderer {renderer.GetHashCode()}");`
`81`	`83`	`cascade.Dispose();`
`82`	`84`	`return true;`
`83`	`85`	`}`
`@@ -91,35 +93,43 @@ public static void RegisterPropertyNamesForDebugLogging(params string[] properti`
`91`	`93`
`92`	`94`	`private bool CheckRendererAlive(Renderer renderer)`
`93`	`95`	`{`
`94`		`- if (renderer != null) return true;`
`95`		`- this.LogWarning($"cannot modify null renderer {renderer?.GetHashCode()}");`
`96`		`- if ((object)renderer != null) Unregister(renderer);`
`97`		`- return false;`
	`96`	`+ if (renderer.IsNullref()) {`
	`97`	`+ Log.LogError(this, "renderer reference is null");`
	`98`	`+ return false;`
	`99`	`+ }`
	`100`	`+`
	`101`	`+ if (renderer.IsDestroyed()) {`
	`102`	`+ this.LogWarning($"cannot modify destroyed renderer {renderer.GetHashCode()}");`
	`103`	`+ Unregister(renderer);`
	`104`	`+ return false;`
	`105`	`+ }`
	`106`	`+`
	`107`	`+ return true;`
`98`	`108`	`}`
`99`	`109`
`100`		`- private readonly List<Renderer> _deadRenderers = [];`
	`110`	`+ private readonly List<Renderer> _destroyedRenderers = [];`
`101`	`111`
`102`		`- internal void CheckRemoveDeadRenderers()`
	`112`	`+ internal void CheckRemoveDestroyedRenderers()`
`103`	`113`	`{`
`104`	`114`	`foreach (var renderer in rendererCascades.Keys) {`
`105`		`- if (renderer == null) _deadRenderers.Add(renderer);`
	`115`	`+ if (renderer.IsDestroyed()) _destroyedRenderers.Add(renderer);`
`106`	`116`	`}`
`107`	`117`
`108`		`- foreach (var deadRenderer in _deadRenderers) Unregister(deadRenderer);`
`109`		`- _deadRenderers.Clear();`
	`118`	`+ foreach (var destroyed in _destroyedRenderers) Unregister(destroyed);`
	`119`	`+ _destroyedRenderers.Clear();`
`110`	`120`	`}`
`111`	`121`
`112`	`122`	/// Public API equivalent is calling `Props.Dispose`.
`113`	`123`	`internal void Unregister(Props props)`
`114`	`124`	`{`
`115`	`125`	`foreach (var (renderer, cascade) in rendererCascades) {`
`116`		`- if (renderer != null) cascade.Remove(props);`
	`126`	`+ if (!renderer.IsDestroyed()) cascade.Remove(props);`
`117`	`127`	`}`
`118`	`128`
`119`		`- CheckRemoveDeadRenderers();`
	`129`	`+ CheckRemoveDestroyedRenderers();`
`120`	`130`	`}`
`121`	`131`
`122`		`- private bool _propRefreshScheduled = false;`
	`132`	`+ private bool _propsUpdateScheduled = false;`
`123`	`133`	`private static readonly WaitForEndOfFrame WfEoF = new();`
`124`	`134`
`125`	`135`	`private IEnumerator<YieldInstruction> Co_propsLateUpdate()`
`@@ -138,14 +148,14 @@ private IEnumerator<YieldInstruction> Co_propsLateUpdate()`
`138`	`148`	`}`
`139`	`149`
`140`	`150`	`propsLateUpdateQueue.Clear();`
`141`		`- _propRefreshScheduled = false;`
	`151`	`+ _propsUpdateScheduled = false;`
`142`	`152`	`}`
`143`	`153`
`144`	`154`	`internal void ScheduleLateUpdate(Props props)`
`145`	`155`	`{`
`146`	`156`	`propsLateUpdateQueue.Add(props);`
`147`		`- if (_propRefreshScheduled) return;`
	`157`	`+ if (_propsUpdateScheduled) return;`
`148`	`158`	`StartCoroutine(Co_propsLateUpdate());`
`149`		`- _propRefreshScheduled = true;`
	`159`	`+ _propsUpdateScheduled = true;`
`150`	`160`	`}`
`151`	`161`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ internal void Register(Renderer renderer)`
`47`	`47`	`internal void Unregister(Renderer renderer)`
`48`	`48`	`{`
`49`	`49`	`linkedRenderers.Remove(renderer);`
`50`		`- if (renderer != null) renderer.SetPropertyBlock(EmptyMpb);`
	`50`	`+ if (!renderer.IsDestroyed()) renderer.SetPropertyBlock(EmptyMpb);`
`51`	`51`
`52`	`52`	`if (linkedRenderers.Count > 0) return;`
`53`	`53`	`Log.Debug(`
`@@ -113,17 +113,17 @@ private void RewriteMpb()`
`113`	`113`
`114`	`114`	`private void ApplyAll()`
`115`	`115`	`{`
`116`		`- var hasDeadRenderer = false;`
	`116`	`+ var hasDestroyedRenderer = false;`
`117`	`117`
`118`	`118`	`foreach (var renderer in linkedRenderers) {`
`119`		`- if (renderer != null) {`
`120`		`- Apply(renderer);`
	`119`	`+ if (renderer.IsDestroyed()) {`
	`120`	`+ hasDestroyedRenderer = true;`
`121`	`121`	`} else {`
`122`		`- hasDeadRenderer = true;`
	`122`	`+ Apply(renderer);`
`123`	`123`	`}`
`124`	`124`	`}`
`125`	`125`
`126`		`- if (hasDeadRenderer) MaterialPropertyManager.Instance?.CheckRemoveDeadRenderers();`
	`126`	`+ if (hasDestroyedRenderer) MaterialPropertyManager.Instance?.CheckRemoveDestroyedRenderers();`
`127`	`127`	`}`
`128`	`128`
`129`	`129`	`#endregion`