Merge pull request #20320 from peppy/skin-transformers

Allow skin transformers to be created for all skins

osu.Game.Rulesets.Catch/CatchRuleset.cs

@@ -182,7 +182,16 @@ public override LocalisableString GetDisplayNameForHitResult(HitResult result)
 
         public override DifficultyCalculator CreateDifficultyCalculator(IWorkingBeatmap beatmap) => new CatchDifficultyCalculator(RulesetInfo, beatmap);
 
-        public override ISkin CreateLegacySkinProvider(ISkin skin, IBeatmap beatmap) => new CatchLegacySkinTransformer(skin);
+        public override ISkin? CreateSkinTransformer(ISkin skin, IBeatmap beatmap)
+        {
+            switch (skin)
+            {
+                case LegacySkin:
+                    return new CatchLegacySkinTransformer(skin);
+            }
+
+            return null;
+        }
 
         public override PerformanceCalculator CreatePerformanceCalculator() => new CatchPerformanceCalculator();
 

osu.Game.Rulesets.Mania/ManiaRuleset.cs

@@ -62,7 +62,16 @@ public class ManiaRuleset : Ruleset, ILegacyRuleset
 
         public override HitObjectComposer CreateHitObjectComposer() => new ManiaHitObjectComposer(this);
 
-        public override ISkin CreateLegacySkinProvider(ISkin skin, IBeatmap beatmap) => new ManiaLegacySkinTransformer(skin, beatmap);
+        public override ISkin? CreateSkinTransformer(ISkin skin, IBeatmap beatmap)
+        {
+            switch (skin)
+            {
+                case LegacySkin:
+                    return new ManiaLegacySkinTransformer(skin, beatmap);
+            }
+
+            return null;
+        }
 
         public override IEnumerable<Mod> ConvertFromLegacyMods(LegacyMods mods)
         {

osu.Game.Rulesets.Osu.Tests/TestSceneSliderApplication.cs

@@ -71,7 +71,7 @@ public void TestBallTintChangedOnAccentChange()
                 var tintingSkin = skinManager.GetSkin(DefaultLegacySkin.CreateInfo());
                 tintingSkin.Configuration.ConfigDictionary["AllowSliderBallTint"] = "1";
 
-                var provider = Ruleset.Value.CreateInstance().CreateLegacySkinProvider(tintingSkin, Beatmap.Value.Beatmap);
+                var provider = Ruleset.Value.CreateInstance().CreateSkinTransformer(tintingSkin, Beatmap.Value.Beatmap);
 
                 Child = new SkinProvidingContainer(provider)
                 {

osu.Game.Rulesets.Osu/OsuRuleset.cs

@@ -231,7 +231,16 @@ public override IEnumerable<Mod> GetModsFor(ModType type)
 
         public override RulesetSettingsSubsection CreateSettings() => new OsuSettingsSubsection(this);
 
-        public override ISkin CreateLegacySkinProvider(ISkin skin, IBeatmap beatmap) => new OsuLegacySkinTransformer(skin);
+        public override ISkin? CreateSkinTransformer(ISkin skin, IBeatmap beatmap)
+        {
+            switch (skin)
+            {
+                case LegacySkin:
+                    return new OsuLegacySkinTransformer(skin);
+            }
+
+            return null;
+        }
 
         public int LegacyID => 0;
 

osu.Game.Rulesets.Taiko/TaikoRuleset.cs

@@ -43,7 +43,16 @@ public class TaikoRuleset : Ruleset, ILegacyRuleset
 
         public override IBeatmapConverter CreateBeatmapConverter(IBeatmap beatmap) => new TaikoBeatmapConverter(beatmap, this);
 
-        public override ISkin CreateLegacySkinProvider(ISkin skin, IBeatmap beatmap) => new TaikoLegacySkinTransformer(skin);
+        public override ISkin? CreateSkinTransformer(ISkin skin, IBeatmap beatmap)
+        {
+            switch (skin)
+            {
+                case LegacySkin:
+                    return new TaikoLegacySkinTransformer(skin);
+            }
+
+            return null;
+        }
 
         public const string SHORT_NAME = "taiko";
 

osu.Game.Tests/Visual/Gameplay/TestSceneBeatmapSkinFallbacks.cs

@@ -122,7 +122,7 @@ public CustomSkinWorkingBeatmap(IBeatmap beatmap, Storyboard storyboard, IFrameB
 
         private class TestOsuRuleset : OsuRuleset
         {
-            public override ISkin CreateLegacySkinProvider(ISkin skin, IBeatmap beatmap) => new TestOsuLegacySkinTransformer(skin);
+            public override ISkin CreateSkinTransformer(ISkin skin, IBeatmap beatmap) => new TestOsuLegacySkinTransformer(skin);
 
             private class TestOsuLegacySkinTransformer : OsuLegacySkinTransformer
             {

osu.Game/Rulesets/Ruleset.cs

@@ -200,7 +200,13 @@ public virtual LegacyMods ConvertToLegacyMods(Mod[] mods)
 
         public ModAutoplay? GetAutoplayMod() => CreateMod<ModAutoplay>();
 
-        public virtual ISkin? CreateLegacySkinProvider(ISkin skin, IBeatmap beatmap) => null;
+        /// <summary>
+        /// Create a transformer which adds lookups specific to a ruleset to skin sources.
+        /// </summary>
+        /// <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) => null;
 
         protected Ruleset()
         {

osu.Game/Skinning/RulesetSkinProvidingContainer.cs

@@ -41,7 +41,7 @@ public RulesetSkinProvidingContainer(Ruleset ruleset, IBeatmap beatmap, [CanBeNu
             Ruleset = ruleset;
             Beatmap = beatmap;
 
-            InternalChild = new BeatmapSkinProvidingContainer(beatmapSkin is LegacySkin ? GetLegacyRulesetTransformedSkin(beatmapSkin) : beatmapSkin)
+            InternalChild = new BeatmapSkinProvidingContainer(beatmapSkin is LegacySkin ? GetRulesetTransformedSkin(beatmapSkin) : beatmapSkin)
             {
                 Child = Content = new Container
                 {
@@ -67,16 +67,16 @@ protected override void RefreshSources()
 
             Debug.Assert(ParentSource != null);
 
-            foreach (var skin in ParentSource.AllSources)
+            foreach (var source in ParentSource.AllSources)
             {
-                switch (skin)
+                switch (source)
                 {
-                    case LegacySkin legacySkin:
-                        sources.Add(GetLegacyRulesetTransformedSkin(legacySkin));
+                    case Skin skin:
+                        sources.Add(GetRulesetTransformedSkin(skin));
                         break;
 
                     default:
-                        sources.Add(skin);
+                        sources.Add(source);
                         break;
                 }
             }
@@ -94,16 +94,16 @@ protected override void RefreshSources()
             SetSources(sources);
         }
 
-        protected ISkin GetLegacyRulesetTransformedSkin(ISkin legacySkin)
+        protected ISkin GetRulesetTransformedSkin(ISkin skin)
         {
-            if (legacySkin == null)
+            if (skin == null)
                 return null;
 
-            var rulesetTransformed = Ruleset.CreateLegacySkinProvider(legacySkin, Beatmap);
+            var rulesetTransformed = Ruleset.CreateSkinTransformer(skin, Beatmap);
             if (rulesetTransformed != null)
                 return rulesetTransformed;
 
-            return legacySkin;
+            return skin;
         }
 
         protected override void Dispose(bool isDisposing)

osu.Game/Tests/Visual/SkinnableTestScene.cs

@@ -83,7 +83,7 @@ private Drawable createProvider(Skin skin, Func<ISkin, Drawable> creationFunctio
             ISkin provider = skin;
 
             if (provider is LegacySkin legacyProvider)
-                provider = Ruleset.Value.CreateInstance().CreateLegacySkinProvider(legacyProvider, beatmap);
+                provider = Ruleset.Value.CreateInstance().CreateSkinTransformer(legacyProvider, beatmap);
 
             var children = new Container
             {