Avoid making non-ruleset transformers in Ruleset.CreateSkinTransformer

This didn't make any sense, so let's do it a better way.
ppy · Aug 8, 2024 · 60d3834 · 60d3834
1 parent 3c572ab
commit 60d3834
Show file tree

Hide file tree

Showing 13 changed files with 55 additions and 91 deletions.
diff --git a/osu.Game.Rulesets.Catch/Skinning/Argon/CatchArgonSkinTransformer.cs b/osu.Game.Rulesets.Catch/Skinning/Argon/CatchArgonSkinTransformer.cs
@@ -6,7 +6,7 @@
 
 namespace osu.Game.Rulesets.Catch.Skinning.Argon
 {
-    public class CatchArgonSkinTransformer : ArgonSkinTransformer
+    public class CatchArgonSkinTransformer : SkinTransformer
     {
         public CatchArgonSkinTransformer(ISkin skin)
             : base(skin)

diff --git a/osu.Game.Rulesets.Catch/Skinning/Legacy/CatchLegacySkinTransformer.cs b/osu.Game.Rulesets.Catch/Skinning/Legacy/CatchLegacySkinTransformer.cs
@@ -40,7 +40,7 @@ public CatchLegacySkinTransformer(ISkin skin)
                         return base.GetDrawableComponent(lookup) as Container;
 
                     // Skin has configuration.
-                    if (base.GetDrawableComponent(lookup) is Drawable d)
+                    if (base.GetDrawableComponent(lookup) is UserConfiguredLayoutContainer d)
                         return d;
 
                     // Our own ruleset components default.

diff --git a/osu.Game.Rulesets.Osu/Skinning/Argon/OsuArgonSkinTransformer.cs b/osu.Game.Rulesets.Osu/Skinning/Argon/OsuArgonSkinTransformer.cs
@@ -7,7 +7,7 @@
 
 namespace osu.Game.Rulesets.Osu.Skinning.Argon
 {
-    public class OsuArgonSkinTransformer : ArgonSkinTransformer
+    public class OsuArgonSkinTransformer : SkinTransformer
     {
         public OsuArgonSkinTransformer(ISkin skin)
             : base(skin)

diff --git a/osu.Game.Rulesets.Osu/Skinning/Legacy/OsuLegacySkinTransformer.cs b/osu.Game.Rulesets.Osu/Skinning/Legacy/OsuLegacySkinTransformer.cs
@@ -50,7 +50,7 @@ public OsuLegacySkinTransformer(ISkin skin)
                         return base.GetDrawableComponent(lookup);
 
                     // Skin has configuration.
-                    if (base.GetDrawableComponent(lookup) is Drawable d)
+                    if (base.GetDrawableComponent(lookup) is UserConfiguredLayoutContainer d)
                         return d;
 
                     // Our own ruleset components default.
@@ -74,6 +74,7 @@ public OsuLegacySkinTransformer(ISkin skin)
                             {
                                 Children = new Drawable[]
                                 {
+                                    new LegacyComboCounter(),
                                     new LegacyKeyCounterDisplay(),
                                 }
                             };

diff --git a/osu.Game.Rulesets.Taiko/Skinning/Argon/TaikoArgonSkinTransformer.cs b/osu.Game.Rulesets.Taiko/Skinning/Argon/TaikoArgonSkinTransformer.cs
@@ -7,7 +7,7 @@
 
 namespace osu.Game.Rulesets.Taiko.Skinning.Argon
 {
-    public class TaikoArgonSkinTransformer : ArgonSkinTransformer
+    public class TaikoArgonSkinTransformer : SkinTransformer
     {
         public TaikoArgonSkinTransformer(ISkin skin)
             : base(skin)

diff --git a/osu.Game/Rulesets/Ruleset.cs b/osu.Game/Rulesets/Ruleset.cs
@@ -212,19 +212,7 @@ public virtual LegacyMods ConvertToLegacyMods(Mod[] mods)
         /// <param name="skin">The source skin.</param>
         /// <param name="beatmap">The current beatmap.</param>
         /// <returns>A skin with a transformer applied, or null if no transformation is provided by this ruleset.</returns>
-        public virtual ISkin? CreateSkinTransformer(ISkin skin, IBeatmap beatmap)
-        {
-            switch (skin)
-            {
-                case LegacySkin:
-                    return new LegacySkinTransformer(skin);
-
-                case ArgonSkin:
-                    return new ArgonSkinTransformer(skin);
-            }
-
-            return null;
-        }
+        public virtual ISkin? CreateSkinTransformer(ISkin skin, IBeatmap beatmap) => null;
 
         protected Ruleset()
         {

diff --git a/osu.Game/Skinning/ArgonSkin.cs b/osu.Game/Skinning/ArgonSkin.cs
@@ -7,6 +7,7 @@
 using osu.Framework.Audio.Sample;
 using osu.Framework.Bindables;
 using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Textures;
 using osu.Game.Audio;
 using osu.Game.Beatmaps.Formats;
@@ -93,15 +94,12 @@ public ArgonSkin(SkinInfo skin, IStorageResourceProvider resources)
             // Temporary until default skin has a valid hit lighting.
             if ((lookup as SkinnableSprite.SpriteComponentLookup)?.LookupName == @"lighting") return Drawable.Empty();
 
-            if (base.GetDrawableComponent(lookup) is Drawable c)
+            if (base.GetDrawableComponent(lookup) is UserConfiguredLayoutContainer c)
                 return c;
 
             switch (lookup)
             {
                 case SkinComponentsContainerLookup containerLookup:
-                    // Only handle global level defaults for now.
-                    if (containerLookup.Ruleset != null)
-                        return null;
 
                     switch (containerLookup.Target)
                     {
@@ -114,6 +112,21 @@ public ArgonSkin(SkinInfo skin, IStorageResourceProvider resources)
                             return songSelectComponents;
 
                         case SkinComponentsContainerLookup.TargetArea.MainHUDComponents:
+                            if (containerLookup.Ruleset != null)
+                            {
+                                return new Container
+                                {
+                                    RelativeSizeAxes = Axes.Both,
+                                    Child = new ArgonComboCounter
+                                    {
+                                        Anchor = Anchor.BottomLeft,
+                                        Origin = Anchor.BottomLeft,
+                                        Position = new Vector2(36, -66),
+                                        Scale = new Vector2(1.3f),
+                                    },
+                                };
+                            }
+
                             var mainHUDComponents = new DefaultSkinComponentsContainer(container =>
                             {
                                 var health = container.OfType<ArgonHealthDisplay>().FirstOrDefault();

diff --git a/osu.Game/Skinning/ArgonSkinTransformer.cs b/osu.Game/Skinning/ArgonSkinTransformer.cs
diff --git a/osu.Game/Skinning/LegacySkin.cs b/osu.Game/Skinning/LegacySkin.cs
@@ -13,6 +13,7 @@
 using osu.Framework.Bindables;
 using osu.Framework.Extensions.ObjectExtensions;
 using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Textures;
 using osu.Framework.IO.Stores;
 using osu.Game.Audio;
@@ -349,19 +350,24 @@ protected override void ParseConfigurationStream(Stream stream)
 
         public override Drawable? GetDrawableComponent(ISkinComponentLookup lookup)
         {
-            if (base.GetDrawableComponent(lookup) is Drawable c)
+            if (base.GetDrawableComponent(lookup) is UserConfiguredLayoutContainer c)
                 return c;
 
             switch (lookup)
             {
                 case SkinComponentsContainerLookup containerLookup:
-                    // Only handle global level defaults for now.
-                    if (containerLookup.Ruleset != null)
-                        return null;
-
                     switch (containerLookup.Target)
                     {
                         case SkinComponentsContainerLookup.TargetArea.MainHUDComponents:
+                            if (containerLookup.Ruleset != null)
+                            {
+                                return new Container
+                                {
+                                    RelativeSizeAxes = Axes.Both,
+                                    Child = new LegacyComboCounter(),
+                                };
+                            }
+
                             return new DefaultSkinComponentsContainer(container =>
                             {
                                 var score = container.OfType<LegacyScoreCounter>().FirstOrDefault();

diff --git a/osu.Game/Skinning/LegacySkinTransformer.cs b/osu.Game/Skinning/LegacySkinTransformer.cs
@@ -2,42 +2,24 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using osu.Framework.Audio.Sample;
-using osu.Framework.Graphics;
-using osu.Framework.Graphics.Containers;
 using osu.Game.Audio;
 using osu.Game.Rulesets.Objects.Legacy;
 using static osu.Game.Skinning.SkinConfiguration;
 
 namespace osu.Game.Skinning
 {
-    public class LegacySkinTransformer : SkinTransformer
+    public abstract class LegacySkinTransformer : SkinTransformer
     {
         /// <summary>
         /// Whether the skin being transformed is able to provide legacy resources for the ruleset.
         /// </summary>
         public virtual bool IsProvidingLegacyResources => this.HasFont(LegacyFont.Combo);
 
-        public LegacySkinTransformer(ISkin skin)
+        protected LegacySkinTransformer(ISkin skin)
             : base(skin)
         {
         }
 
-        public override Drawable? GetDrawableComponent(ISkinComponentLookup lookup)
-        {
-            if (lookup is SkinComponentsContainerLookup containerLookup
-                && containerLookup.Target == SkinComponentsContainerLookup.TargetArea.MainHUDComponents
-                && containerLookup.Ruleset != null)
-            {
-                return base.GetDrawableComponent(lookup) ?? new Container
-                {
-                    RelativeSizeAxes = Axes.Both,
-                    Child = new LegacyComboCounter(),
-                };
-            }
-
-            return base.GetDrawableComponent(lookup);
-        }
-
         public override ISample? GetSample(ISampleInfo sampleInfo)
         {
             if (!(sampleInfo is ConvertHitObjectParser.LegacyHitSampleInfo legacySample))

diff --git a/osu.Game/Skinning/Skin.cs b/osu.Game/Skinning/Skin.cs
@@ -14,7 +14,6 @@
 using osu.Framework.Bindables;
 using osu.Framework.Extensions.TypeExtensions;
 using osu.Framework.Graphics;
-using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Textures;
 using osu.Framework.IO.Stores;
 using osu.Framework.Logging;
@@ -26,7 +25,7 @@
 
 namespace osu.Game.Skinning
 {
-    public abstract class Skin : IDisposable, ISkin
+    public abstract partial class Skin : IDisposable, ISkin
     {
         private readonly IStorageResourceProvider? resources;
 
@@ -195,7 +194,7 @@ public void UpdateDrawableTarget(SkinComponentsContainer targetContainer)
                     if (!LayoutInfos.TryGetValue(containerLookup.Target, out var layoutInfo)) return null;
                     if (!layoutInfo.TryGetDrawableInfo(containerLookup.Ruleset, out var drawableInfos)) return null;
 
-                    return new Container
+                    return new UserConfiguredLayoutContainer
                     {
                         RelativeSizeAxes = Axes.Both,
                         ChildrenEnumerable = drawableInfos.Select(i => i.CreateInstance())

diff --git a/osu.Game/Skinning/TrianglesSkin.cs b/osu.Game/Skinning/TrianglesSkin.cs
@@ -64,7 +64,7 @@ public TrianglesSkin(SkinInfo skin, IStorageResourceProvider resources)
             // Temporary until default skin has a valid hit lighting.
             if ((lookup as SkinnableSprite.SpriteComponentLookup)?.LookupName == @"lighting") return Drawable.Empty();
 
-            if (base.GetDrawableComponent(lookup) is Drawable c)
+            if (base.GetDrawableComponent(lookup) is UserConfiguredLayoutContainer c)
                 return c;
 
             switch (lookup)

diff --git a/osu.Game/Skinning/UserConfiguredLayoutContainer.cs b/osu.Game/Skinning/UserConfiguredLayoutContainer.cs
@@ -0,0 +1,15 @@
+// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using osu.Framework.Graphics.Containers;
+
+namespace osu.Game.Skinning
+{
+    /// <summary>
+    /// This signifies that a <see cref="Skin.GetDrawableComponent"/> call resolved a configuration created
+    /// by a user in their skin. Generally this should be given priority over any local defaults or overrides.
+    /// </summary>
+    public partial class UserConfiguredLayoutContainer : Container
+    {
+    }
+}