Merge pull request #16272 from bdach/animated-hit-circle-overlay

Add support for animated hit circle overlay

osu.Game.Rulesets.Osu/Skinning/Legacy/KiaiFlashingDrawable.cs

@@ -0,0 +1,50 @@
+// 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 System;
+using osu.Framework.Audio.Track;
+using osu.Framework.Graphics;
+using osu.Game.Beatmaps.ControlPoints;
+using osu.Game.Graphics.Containers;
+
+namespace osu.Game.Rulesets.Osu.Skinning.Legacy
+{
+    internal class KiaiFlashingDrawable : BeatSyncedContainer
+    {
+        private readonly Drawable flashingDrawable;
+
+        private const float flash_opacity = 0.3f;
+
+        public KiaiFlashingDrawable(Func<Drawable> creationFunc)
+        {
+            AutoSizeAxes = Axes.Both;
+
+            Children = new[]
+            {
+                creationFunc.Invoke().With(d =>
+                {
+                    d.Anchor = Anchor.Centre;
+                    d.Origin = Anchor.Centre;
+                }),
+                flashingDrawable = creationFunc.Invoke().With(d =>
+                {
+                    d.Anchor = Anchor.Centre;
+                    d.Origin = Anchor.Centre;
+                    d.Alpha = 0;
+                    d.Blending = BlendingParameters.Additive;
+                })
+            };
+        }
+
+        protected override void OnNewBeat(int beatIndex, TimingControlPoint timingPoint, EffectControlPoint effectPoint, ChannelAmplitudes amplitudes)
+        {
+            if (!effectPoint.KiaiMode)
+                return;
+
+            flashingDrawable
+                .FadeTo(flash_opacity)
+                .Then()
+                .FadeOut(timingPoint.BeatLength * 0.75f);
+        }
+    }
+}

osu.Game.Rulesets.Osu/Skinning/Legacy/KiaiFlashingSprite.cs

@@ -1,61 +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.Audio.Track;
-using osu.Framework.Graphics;
-using osu.Framework.Graphics.Sprites;
-using osu.Framework.Graphics.Textures;
-using osu.Game.Beatmaps.ControlPoints;
-using osu.Game.Graphics.Containers;
-
-namespace osu.Game.Rulesets.Osu.Skinning.Legacy
-{
-    internal class KiaiFlashingSprite : BeatSyncedContainer
-    {
-        private readonly Sprite mainSprite;
-        private readonly Sprite flashingSprite;
-
-        public Texture Texture
-        {
-            set
-            {
-                mainSprite.Texture = value;
-                flashingSprite.Texture = value;
-            }
-        }
-
-        private const float flash_opacity = 0.3f;
-
-        public KiaiFlashingSprite()
-        {
-            AutoSizeAxes = Axes.Both;
-
-            Children = new Drawable[]
-            {
-                mainSprite = new Sprite
-                {
-                    Anchor = Anchor.Centre,
-                    Origin = Anchor.Centre,
-                },
-                flashingSprite = new Sprite
-                {
-                    Anchor = Anchor.Centre,
-                    Origin = Anchor.Centre,
-                    Alpha = 0,
-                    Blending = BlendingParameters.Additive,
-                }
-            };
-        }
-
-        protected override void OnNewBeat(int beatIndex, TimingControlPoint timingPoint, EffectControlPoint effectPoint, ChannelAmplitudes amplitudes)
-        {
-            if (!effectPoint.KiaiMode)
-                return;
-
-            flashingSprite
-                .FadeTo(flash_opacity)
-                .Then()
-                .FadeOut(timingPoint.BeatLength * 0.75f);
-        }
-    }
-}

osu.Game.Rulesets.Osu/Skinning/Legacy/LegacyMainCirclePiece.cs

@@ -5,6 +5,7 @@ using osu.Framework.Allocation;
 using osu.Framework.Bindables;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Sprites;
 using osu.Framework.Graphics.Textures;
 using osu.Game.Graphics;
 using osu.Game.Graphics.Sprites;
@@ -68,13 +69,11 @@ namespace osu.Game.Rulesets.Osu.Skinning.Legacy
             // at this point, any further texture fetches should be correctly using the priority source if the base texture was retrieved using it.
             // the flow above handles the case where a sliderendcircle.png is retrieved from the skin, but sliderendcircleoverlay.png doesn't exist.
             // expected behaviour in this scenario is not showing the overlay, rather than using hitcircleoverlay.png (potentially from the default/fall-through skin).
-            Texture overlayTexture = getTextureWithFallback("overlay");
 
             InternalChildren = new[]
             {
-                hitCircleSprite = new KiaiFlashingSprite
+                hitCircleSprite = new KiaiFlashingDrawable(() => new Sprite { Texture = baseTexture })
                 {
-                    Texture = baseTexture,
                     Anchor = Anchor.Centre,
                     Origin = Anchor.Centre,
                 },
@@ -82,9 +81,8 @@ namespace osu.Game.Rulesets.Osu.Skinning.Legacy
                 {
                     Anchor = Anchor.Centre,
                     Origin = Anchor.Centre,
-                    Child = hitCircleOverlay = new KiaiFlashingSprite
+                    Child = hitCircleOverlay = new KiaiFlashingDrawable(() => getAnimationWithFallback(@"overlay", 1000 / 2d))
                     {
-                        Texture = overlayTexture,
                         Anchor = Anchor.Centre,
                         Origin = Anchor.Centre,
                     },
@@ -126,6 +124,21 @@ namespace osu.Game.Rulesets.Osu.Skinning.Legacy
 
                 return tex ?? skin.GetTexture($"hitcircle{name}");
             }
+
+            Drawable getAnimationWithFallback(string name, double frameLength)
+            {
+                Drawable animation = null;
+
+                if (!string.IsNullOrEmpty(priorityLookup))
+                {
+                    animation = skin.GetAnimation($"{priorityLookup}{name}", true, true, frameLength: frameLength);
+
+                    if (!allowFallback)
+                        return animation;
+                }
+
+                return animation ?? skin.GetAnimation($"hitcircle{name}", true, true, frameLength: frameLength);
+            }
         }
 
         protected override void LoadComplete()