From e5884016ab7ad72fda9be0878afec14bb8363b29 Mon Sep 17 00:00:00 2001
From: John <johntbiddle@gmail.com>
Date: Fri, 12 May 2023 19:07:25 -0700
Subject: [PATCH] Initial commit for the snap colour mod. Implements basic
 functionality.

---
 .../Mods/OsuModSnapColour.cs                  | 42 +++++++++++++++++++
 osu.Game.Rulesets.Osu/OsuRuleset.cs           |  1 +
 osu.Game/Rulesets/Mods/ModSnapColour.cs       | 19 +++++++++
 3 files changed, 62 insertions(+)
 create mode 100644 osu.Game.Rulesets.Osu/Mods/OsuModSnapColour.cs
 create mode 100644 osu.Game/Rulesets/Mods/ModSnapColour.cs

diff --git a/osu.Game.Rulesets.Osu/Mods/OsuModSnapColour.cs b/osu.Game.Rulesets.Osu/Mods/OsuModSnapColour.cs
new file mode 100644
index 0000000000..87a2598695
--- /dev/null
+++ b/osu.Game.Rulesets.Osu/Mods/OsuModSnapColour.cs
@@ -0,0 +1,42 @@
+// 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.
+#nullable disable
+
+using osu.Framework.Allocation;
+using osu.Framework.Extensions.ObjectExtensions;
+using osu.Game.Beatmaps;
+using osu.Game.Graphics;
+using osu.Game.Rulesets.Mods;
+using osu.Game.Rulesets.Objects;
+using osu.Game.Rulesets.Objects.Drawables;
+using osu.Game.Screens.Edit;
+
+namespace osu.Game.Rulesets.Osu.Mods
+{
+    /// <summary>
+    /// Mod that colours <see cref="HitObject"/>s based on the musical division they are on
+    /// </summary>
+    public class OsuModSnapColour : ModSnapColour, IApplicableToBeatmap, IApplicableToDrawableHitObject
+    {
+        [Resolved]
+        private OsuColour colours { get; set; } = new OsuColour();
+
+        [Resolved(canBeNull: true)]
+        private IBeatmap currentBeatmap { get; set; }
+
+        public void ApplyToBeatmap(IBeatmap beatmap)
+        {
+            //Store a reference to the current beatmap to look up the beat divisor when notes are drawn
+            if (this.currentBeatmap != beatmap)
+                this.currentBeatmap = beatmap;
+        }
+
+        public void ApplyToDrawableHitObject(DrawableHitObject drawable)
+        {
+            if (currentBeatmap.IsNull() || drawable.IsNull()) return;
+
+            drawable.OnUpdate += _ =>
+                drawable.AccentColour.Value = BindableBeatDivisor.GetColourFor(currentBeatmap.ControlPointInfo.GetClosestBeatDivisor(drawable.HitObject.StartTime), colours);
+        }
+    }
+}
diff --git a/osu.Game.Rulesets.Osu/OsuRuleset.cs b/osu.Game.Rulesets.Osu/OsuRuleset.cs
index 922594a93a..23eea0e488 100644
--- a/osu.Game.Rulesets.Osu/OsuRuleset.cs
+++ b/osu.Game.Rulesets.Osu/OsuRuleset.cs
@@ -176,6 +176,7 @@ namespace osu.Game.Rulesets.Osu
                         new OsuModClassic(),
                         new OsuModRandom(),
                         new OsuModMirror(),
+                        new OsuModSnapColour(),
                         new MultiMod(new OsuModAlternate(), new OsuModSingleTap())
                     };
 
diff --git a/osu.Game/Rulesets/Mods/ModSnapColour.cs b/osu.Game/Rulesets/Mods/ModSnapColour.cs
new file mode 100644
index 0000000000..6f706f1cb2
--- /dev/null
+++ b/osu.Game/Rulesets/Mods/ModSnapColour.cs
@@ -0,0 +1,19 @@
+// 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.Localisation;
+
+namespace osu.Game.Rulesets.Mods
+{
+    /// <summary>
+    /// Mod that colours hitobjects based on the musical division they are on
+    /// </summary>
+    public class ModSnapColour : Mod
+    {
+        public override string Name => "Snap Colour";
+        public override string Acronym => "SC";
+        public override LocalisableString Description => new LocalisableString("Colours hit objects based on the rhythm.");
+        public override double ScoreMultiplier => 1;
+        public override ModType Type => ModType.Conversion;
+    }
+}