Merge branch 'master' into fix-spectator-seeks

osu.Game/Rulesets/Difficulty/DifficultyCalculator.cs

@@ -15,6 +15,7 @@ using osu.Game.Rulesets.Difficulty.Preprocessing;
 using osu.Game.Rulesets.Difficulty.Skills;
 using osu.Game.Rulesets.Mods;
 using osu.Game.Rulesets.Objects;
+using osu.Game.Utils;
 
 namespace osu.Game.Rulesets.Difficulty
 {
@@ -119,15 +120,23 @@ namespace osu.Game.Rulesets.Difficulty
         /// <summary>
         /// Calculates the difficulty of the beatmap using all mod combinations applicable to the beatmap.
         /// </summary>
+        /// <remarks>
+        /// This can only be used to compute difficulties for legacy mod combinations.
+        /// </remarks>
         /// <returns>A collection of structures describing the difficulty of the beatmap for each mod combination.</returns>
-        public IEnumerable<DifficultyAttributes> CalculateAll(CancellationToken cancellationToken = default)
+        public IEnumerable<DifficultyAttributes> CalculateAllLegacyCombinations(CancellationToken cancellationToken = default)
         {
+            var rulesetInstance = ruleset.CreateInstance();
+
             foreach (var combination in CreateDifficultyAdjustmentModCombinations())
             {
-                if (combination is MultiMod multi)
-                    yield return Calculate(multi.Mods, cancellationToken);
-                else
-                    yield return Calculate(combination.Yield(), cancellationToken);
+                Mod classicMod = rulesetInstance.CreateAllMods().SingleOrDefault(m => m is ModClassic);
+
+                var finalCombination = ModUtils.FlattenMod(combination);
+                if (classicMod != null)
+                    finalCombination = finalCombination.Append(classicMod);
+
+                yield return Calculate(finalCombination.ToArray(), cancellationToken);
             }
         }
 

osu.Game/Rulesets/Edit/DrawableEditorRulesetWrapper.cs

@@ -67,7 +67,7 @@ namespace osu.Game.Rulesets.Edit
         private void regenerateAutoplay()
         {
             var autoplayMod = drawableRuleset.Mods.OfType<ModAutoplay>().Single();
-            drawableRuleset.SetReplayScore(autoplayMod.CreateReplayScore(drawableRuleset.Beatmap, drawableRuleset.Mods));
+            drawableRuleset.SetReplayScore(autoplayMod.CreateScoreFromReplayData(drawableRuleset.Beatmap, drawableRuleset.Mods));
         }
 
         private void addHitObject(HitObject hitObject)

osu.Game/Rulesets/Mods/ICreateReplay.cs

@@ -1,14 +1,22 @@
 // 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 System.Collections.Generic;
 using osu.Game.Beatmaps;
 using osu.Game.Scoring;
 
 namespace osu.Game.Rulesets.Mods
 {
-    public interface ICreateReplay
+    [Obsolete("Use ICreateReplayData instead")] // Can be removed 20220929
+    public interface ICreateReplay : ICreateReplayData
     {
         public Score CreateReplayScore(IBeatmap beatmap, IReadOnlyList<Mod> mods);
+
+        ModReplayData ICreateReplayData.CreateReplayData(IBeatmap beatmap, IReadOnlyList<Mod> mods)
+        {
+            var replayScore = CreateReplayScore(beatmap, mods);
+            return new ModReplayData(replayScore.Replay, new ModCreatedUser { Username = replayScore.ScoreInfo.User.Username });
+        }
     }
 }

osu.Game/Rulesets/Mods/ICreateReplayData.cs

@@ -0,0 +1,63 @@
+// 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.Collections.Generic;
+using osu.Game.Beatmaps;
+using osu.Game.Online.API.Requests.Responses;
+using osu.Game.Replays;
+using osu.Game.Scoring;
+using osu.Game.Users;
+
+namespace osu.Game.Rulesets.Mods
+{
+    /// <summary>
+    /// A mod which creates full replay data, which is to be played back in place of a local user playing the game.
+    /// </summary>
+    public interface ICreateReplayData
+    {
+        /// <summary>
+        /// Create replay data.
+        /// </summary>
+        /// <param name="beatmap">The beatmap to create replay data for.</param>
+        /// <param name="mods">The mods to take into account when creating the replay data.</param>
+        /// <returns>A <see cref="ModReplayData"/> structure, containing the generated replay data.</returns>
+        /// <remarks>
+        /// For callers that want to receive a directly usable <see cref="Score"/> instance,
+        /// the <see cref="ModExtensions.CreateScoreFromReplayData"/> extension method is provided for convenience.
+        /// </remarks>
+        ModReplayData CreateReplayData(IBeatmap beatmap, IReadOnlyList<Mod> mods);
+    }
+
+    /// <summary>
+    /// Data created by a mod that implements <see cref="ICreateReplayData"/>.
+    /// </summary>
+    public class ModReplayData
+    {
+        /// <summary>
+        /// The full replay data.
+        /// </summary>
+        public readonly Replay Replay;
+
+        /// <summary>
+        /// Placeholder user data to show in place of the local user when the associated mod is active.
+        /// </summary>
+        public readonly ModCreatedUser User;
+
+        public ModReplayData(Replay replay, ModCreatedUser user = null)
+        {
+            Replay = replay;
+            User = user ?? new ModCreatedUser();
+        }
+    }
+
+    /// <summary>
+    /// A user which is associated with a replay that was created by a mod (ie. autoplay or cinema).
+    /// </summary>
+    public class ModCreatedUser : IUser
+    {
+        public int OnlineID => APIUser.SYSTEM_USER_ID;
+        public bool IsBot => true;
+
+        public string Username { get; set; } = string.Empty;
+    }
+}

osu.Game/Rulesets/Mods/ModAutoplay.cs

@@ -11,7 +11,7 @@ using osu.Game.Scoring;
 
 namespace osu.Game.Rulesets.Mods
 {
-    public abstract class ModAutoplay : Mod, IApplicableFailOverride, ICreateReplay
+    public abstract class ModAutoplay : Mod, IApplicableFailOverride, ICreateReplayData
     {
         public override string Name => "Autoplay";
         public override string Acronym => "AT";
@@ -26,10 +26,20 @@ namespace osu.Game.Rulesets.Mods
 
         public override bool UserPlayable => false;
 
-        public override Type[] IncompatibleMods => new[] { typeof(ModRelax), typeof(ModFailCondition), typeof(ModNoFail) };
+        public override Type[] IncompatibleMods => new[] { typeof(ModCinema), typeof(ModRelax), typeof(ModFailCondition), typeof(ModNoFail) };
 
         public override bool HasImplementation => GetType().GenericTypeArguments.Length == 0;
 
+        [Obsolete("Override CreateReplayData(IBeatmap, IReadOnlyList<Mod>) instead")] // Can be removed 20220929
         public virtual Score CreateReplayScore(IBeatmap beatmap, IReadOnlyList<Mod> mods) => new Score { Replay = new Replay() };
+
+        public virtual ModReplayData CreateReplayData(IBeatmap beatmap, IReadOnlyList<Mod> mods)
+        {
+#pragma warning disable CS0618
+            var replayScore = CreateReplayScore(beatmap, mods);
+#pragma warning restore CS0618
+
+            return new ModReplayData(replayScore.Replay, new ModCreatedUser { Username = replayScore.ScoreInfo.User.Username });
+        }
     }
 }

osu.Game/Rulesets/Mods/ModBarrelRoll.cs

@@ -37,7 +37,7 @@ namespace osu.Game.Rulesets.Mods
         public override string Description => "The whole playfield is on a wheel!";
         public override double ScoreMultiplier => 1;
 
-        public override string SettingDescription => $"{SpinSpeed.Value} rpm {Direction.Value.GetDescription().ToLowerInvariant()}";
+        public override string SettingDescription => $"{SpinSpeed.Value:N2} rpm {Direction.Value.GetDescription().ToLowerInvariant()}";
 
         public void Update(Playfield playfield)
         {

osu.Game/Rulesets/Mods/ModCinema.cs

@@ -1,6 +1,8 @@
 // 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 System.Linq;
 using osu.Framework.Graphics.Sprites;
 using osu.Game.Graphics;
 using osu.Game.Rulesets.Objects;
@@ -14,8 +16,6 @@ namespace osu.Game.Rulesets.Mods
     {
         public virtual void ApplyToDrawableRuleset(DrawableRuleset<T> drawableRuleset)
         {
-            drawableRuleset.SetReplayScore(CreateReplayScore(drawableRuleset.Beatmap, drawableRuleset.Mods));
-
             // AlwaysPresent required for hitsounds
             drawableRuleset.AlwaysPresent = true;
             drawableRuleset.Hide();
@@ -29,6 +29,8 @@ namespace osu.Game.Rulesets.Mods
         public override IconUsage? Icon => OsuIcon.ModCinema;
         public override string Description => "Watch the video without visual distractions.";
 
+        public override Type[] IncompatibleMods => base.IncompatibleMods.Append(typeof(ModAutoplay)).ToArray();
+
         public void ApplyToHUD(HUDOverlay overlay)
         {
             overlay.ShowHud.Value = false;

osu.Game/Rulesets/Mods/ModExtensions.cs

@@ -0,0 +1,31 @@
+// 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.Collections.Generic;
+using osu.Game.Beatmaps;
+using osu.Game.Online.API.Requests.Responses;
+using osu.Game.Scoring;
+
+namespace osu.Game.Rulesets.Mods
+{
+    public static class ModExtensions
+    {
+        public static Score CreateScoreFromReplayData(this ICreateReplayData mod, IBeatmap beatmap, IReadOnlyList<Mod> mods)
+        {
+            var replayData = mod.CreateReplayData(beatmap, mods);
+
+            return new Score
+            {
+                Replay = replayData.Replay,
+                ScoreInfo =
+                {
+                    User = new APIUser
+                    {
+                        Id = APIUser.SYSTEM_USER_ID,
+                        Username = replayData.User.Username,
+                    }
+                }
+            };
+        }
+    }
+}