From 7cfb786b1a1dae5ef00c5d0359de336c4725c757 Mon Sep 17 00:00:00 2001
From: Salman Ahmed <frenzibyte@gmail.com>
Date: Sun, 31 Dec 2023 04:48:06 +0300
Subject: [PATCH] Add helper method for properly formatting score multiplier in
 `ModUtils`

---
 osu.Game/Utils/ModUtils.cs | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/osu.Game/Utils/ModUtils.cs b/osu.Game/Utils/ModUtils.cs
index 1bd60fcdde..dad8c72aa1 100644
--- a/osu.Game/Utils/ModUtils.cs
+++ b/osu.Game/Utils/ModUtils.cs
@@ -5,6 +5,8 @@ using System;
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
 using System.Linq;
+using osu.Framework.Extensions.LocalisationExtensions;
+using osu.Framework.Localisation;
 using osu.Game.Online.API;
 using osu.Game.Rulesets;
 using osu.Game.Rulesets.Mods;
@@ -226,5 +228,21 @@ namespace osu.Game.Utils
 
             return proposedWereValid;
         }
+
+        /// <summary>
+        /// Given a value of a score multiplier, returns a string version with special handling for a value near 1.00x.
+        /// </summary>
+        /// <param name="scoreMultiplier">The value of the score multiplier.</param>
+        /// <returns>A formatted score multiplier with a trailing "x" symbol</returns>
+        public static LocalisableString FormatScoreMultiplier(double scoreMultiplier)
+        {
+            // Round multiplier values away from 1.00x to two significant digits.
+            if (scoreMultiplier > 1)
+                scoreMultiplier = Math.Ceiling(scoreMultiplier * 100) / 100;
+            else
+                scoreMultiplier = Math.Floor(scoreMultiplier * 100) / 100;
+
+            return scoreMultiplier.ToLocalisableString("0.00x");
+        }
     }
 }