Add obsoletion warning on control dispose

this shouldn't be used anymore
space-wizards · Jul 20, 2024 · 16a93e8 · 16a93e8
1 parent 2e4275a
commit 16a93e8
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
@@ -47,7 +47,7 @@ END TEMPLATE-->
 
 ### Other
 
-*None yet*
+* Added obsoletion warning for `Control.Dispose()`. New code should not rely on it.
 
 ### Internal
 

diff --git a/Robust.Client/UserInterface/Control.cs b/Robust.Client/UserInterface/Control.cs
@@ -602,6 +602,7 @@ protected internal virtual void ModalRemoved()
         ///     Dispose this control, its own scene control, and all its children.
         ///     Basically the big delete button.
         /// </summary>
+        [Obsolete("Controls should only be removed from UI tree instead of being disposed")]
         public void Dispose()
         {
             if (Disposed)
@@ -613,6 +614,7 @@ public void Dispose()
             Disposed = true;
         }
 
+        [Obsolete("Controls should only be removed from UI tree instead of being disposed")]
         protected virtual void Dispose(bool disposing)
         {
             if (!disposing)