From cdcd31b546ac41806c0f7559d65dd9b24e6323d1 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Thu, 13 May 2021 17:03:17 +0900
Subject: [PATCH] Replace `ISkinSerialisable` with `IsEditable` property

---
 osu.Game/Screens/Play/HUD/SkinnableInfo.cs        |  4 ++--
 .../Skinning/Editor/SkinBlueprintContainer.cs     |  8 ++++++++
 osu.Game/Skinning/Editor/SkinComponentToolbox.cs  |  3 +++
 osu.Game/Skinning/ISkinSerialisable.cs            | 15 ---------------
 osu.Game/Skinning/ISkinnableComponent.cs          |  8 +++++++-
 osu.Game/Skinning/SkinManager.cs                  |  1 -
 osu.Game/Skinning/SkinnableTargetWrapper.cs       |  4 +++-
 7 files changed, 23 insertions(+), 20 deletions(-)
 delete mode 100644 osu.Game/Skinning/ISkinSerialisable.cs

diff --git a/osu.Game/Screens/Play/HUD/SkinnableInfo.cs b/osu.Game/Screens/Play/HUD/SkinnableInfo.cs
index 678885d096..a7c5c33f7d 100644
--- a/osu.Game/Screens/Play/HUD/SkinnableInfo.cs
+++ b/osu.Game/Screens/Play/HUD/SkinnableInfo.cs
@@ -15,7 +15,7 @@ using osuTK;
 namespace osu.Game.Screens.Play.HUD
 {
     /// <summary>
-    /// Serialised information governing custom changes to an <see cref="ISkinSerialisable"/>.
+    /// Serialised information governing custom changes to an <see cref="ISkinnableComponent"/>.
     /// </summary>
     [Serializable]
     public class SkinnableInfo : IJsonSerializable
@@ -55,7 +55,7 @@ namespace osu.Game.Screens.Play.HUD
 
             if (component is Container<Drawable> container)
             {
-                foreach (var child in container.OfType<ISkinSerialisable>().OfType<Drawable>())
+                foreach (var child in container.OfType<ISkinnableComponent>().OfType<Drawable>())
                     Children.Add(child.CreateSkinnableInfo());
             }
         }
diff --git a/osu.Game/Skinning/Editor/SkinBlueprintContainer.cs b/osu.Game/Skinning/Editor/SkinBlueprintContainer.cs
index 09bbf7ffd5..31f89ad0c2 100644
--- a/osu.Game/Skinning/Editor/SkinBlueprintContainer.cs
+++ b/osu.Game/Skinning/Editor/SkinBlueprintContainer.cs
@@ -81,6 +81,14 @@ namespace osu.Game.Skinning.Editor
             }
         }
 
+        protected override void AddBlueprintFor(ISkinnableComponent item)
+        {
+            if (!item.IsEditable)
+                return;
+
+            base.AddBlueprintFor(item);
+        }
+
         protected override SelectionHandler<ISkinnableComponent> CreateSelectionHandler() => new SkinSelectionHandler();
 
         protected override SelectionBlueprint<ISkinnableComponent> CreateBlueprintFor(ISkinnableComponent component)
diff --git a/osu.Game/Skinning/Editor/SkinComponentToolbox.cs b/osu.Game/Skinning/Editor/SkinComponentToolbox.cs
index a000204062..068b2058a6 100644
--- a/osu.Game/Skinning/Editor/SkinComponentToolbox.cs
+++ b/osu.Game/Skinning/Editor/SkinComponentToolbox.cs
@@ -78,6 +78,9 @@ namespace osu.Game.Skinning.Editor
 
                 Debug.Assert(instance != null);
 
+                if (!((ISkinnableComponent)instance).IsEditable)
+                    return null;
+
                 return new ToolboxComponentButton(instance);
             }
             catch
diff --git a/osu.Game/Skinning/ISkinSerialisable.cs b/osu.Game/Skinning/ISkinSerialisable.cs
deleted file mode 100644
index d1777512af..0000000000
--- a/osu.Game/Skinning/ISkinSerialisable.cs
+++ /dev/null
@@ -1,15 +0,0 @@
-// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
-// See the LICENCE file in the repository root for full licence text.
-
-using osu.Framework.Graphics;
-
-namespace osu.Game.Skinning
-{
-    /// <summary>
-    /// Denotes a drawable component which should be serialised as part of a skin.
-    /// Use <see cref="ISkinnableComponent"/> for components which should be mutable by the user / editor.
-    /// </summary>
-    public interface ISkinSerialisable : IDrawable
-    {
-    }
-}
diff --git a/osu.Game/Skinning/ISkinnableComponent.cs b/osu.Game/Skinning/ISkinnableComponent.cs
index e44c7be13d..65ac2d5849 100644
--- a/osu.Game/Skinning/ISkinnableComponent.cs
+++ b/osu.Game/Skinning/ISkinnableComponent.cs
@@ -1,12 +1,18 @@
 // Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
+using osu.Framework.Graphics;
+
 namespace osu.Game.Skinning
 {
     /// <summary>
     /// Denotes a drawable which, as a drawable, can be adjusted via skinning specifications.
     /// </summary>
-    public interface ISkinnableComponent : ISkinSerialisable
+    public interface ISkinnableComponent : IDrawable
     {
+        /// <summary>
+        /// Whether this component should be editable by an end user.
+        /// </summary>
+        bool IsEditable => true;
     }
 }
diff --git a/osu.Game/Skinning/SkinManager.cs b/osu.Game/Skinning/SkinManager.cs
index fbe23482d7..7b27a7a816 100644
--- a/osu.Game/Skinning/SkinManager.cs
+++ b/osu.Game/Skinning/SkinManager.cs
@@ -19,7 +19,6 @@ using osu.Framework.Graphics;
 using osu.Framework.Graphics.OpenGL.Textures;
 using osu.Framework.Graphics.Textures;
 using osu.Framework.IO.Stores;
-using osu.Framework.Logging;
 using osu.Framework.Platform;
 using osu.Framework.Testing;
 using osu.Framework.Utils;
diff --git a/osu.Game/Skinning/SkinnableTargetWrapper.cs b/osu.Game/Skinning/SkinnableTargetWrapper.cs
index d8ad008448..28e8d585fc 100644
--- a/osu.Game/Skinning/SkinnableTargetWrapper.cs
+++ b/osu.Game/Skinning/SkinnableTargetWrapper.cs
@@ -13,8 +13,10 @@ namespace osu.Game.Skinning
     /// Will also optionally apply default cross-element layout dependencies when initialised from a non-deserialised source.
     /// </summary>
     [Serializable]
-    public class SkinnableTargetWrapper : Container, ISkinSerialisable
+    public class SkinnableTargetWrapper : Container, ISkinnableComponent
     {
+        public bool IsEditable => false;
+
         private readonly Action<Container> applyDefaults;
 
         /// <summary>