diff --git a/osu.Game.Rulesets.Catch.Tests/Editor/Checks/TestCheckBananaShowerGap.cs b/osu.Game.Rulesets.Catch.Tests/Editor/Checks/TestCheckBananaShowerGap.cs new file mode 100644 index 0000000000..055c8429d7 --- /dev/null +++ b/osu.Game.Rulesets.Catch.Tests/Editor/Checks/TestCheckBananaShowerGap.cs @@ -0,0 +1,118 @@ +// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. +// See the LICENCE file in the repository root for full licence text. + +using System.Collections.Generic; +using System.Linq; +using NUnit.Framework; +using osu.Game.Beatmaps; +using osu.Game.Rulesets.Catch.Edit.Checks; +using osu.Game.Rulesets.Catch.Objects; +using osu.Game.Rulesets.Edit; +using osu.Game.Rulesets.Objects; +using osu.Game.Tests.Beatmaps; + +namespace osu.Game.Rulesets.Catch.Tests.Editor.Checks +{ + [TestFixture] + public class TestCheckBananaShowerGap + { + private CheckBananaShowerGap check; + + [SetUp] + public void Setup() + { + check = new CheckBananaShowerGap(); + } + + [Test] + public void TestAllowedSpinnerGaps() + { + assertOk(mockBeatmap(250, 1000, 1250), DifficultyRating.Easy); + assertOk(mockBeatmap(250, 1000, 1250), DifficultyRating.Normal); + assertOk(mockBeatmap(125, 1000, 1250), DifficultyRating.Hard); + assertOk(mockBeatmap(125, 1000, 1125), DifficultyRating.Insane); + assertOk(mockBeatmap(62, 1000, 1125), DifficultyRating.Expert); + assertOk(mockBeatmap(62, 1000, 1125), DifficultyRating.ExpertPlus); + } + + [Test] + public void TestDisallowedSpinnerGapStart() + { + assertTooShortSpinnerStart(mockBeatmap(249, 1000, 1250), DifficultyRating.Easy); + assertTooShortSpinnerStart(mockBeatmap(249, 1000, 1250), DifficultyRating.Normal); + assertTooShortSpinnerStart(mockBeatmap(124, 1000, 1250), DifficultyRating.Hard); + assertTooShortSpinnerStart(mockBeatmap(124, 1000, 1250), DifficultyRating.Insane); + assertTooShortSpinnerStart(mockBeatmap(61, 1000, 1250), DifficultyRating.Expert); + assertTooShortSpinnerStart(mockBeatmap(61, 1000, 1250), DifficultyRating.ExpertPlus); + } + + [Test] + public void TestDisallowedSpinnerGapEnd() + { + assertTooShortSpinnerEnd(mockBeatmap(250, 1000, 1249), DifficultyRating.Easy); + assertTooShortSpinnerEnd(mockBeatmap(250, 1000, 1249), DifficultyRating.Normal); + assertTooShortSpinnerEnd(mockBeatmap(125, 1000, 1249), DifficultyRating.Hard); + assertTooShortSpinnerEnd(mockBeatmap(125, 1000, 1124), DifficultyRating.Insane); + assertTooShortSpinnerEnd(mockBeatmap(62, 1000, 1124), DifficultyRating.Expert); + assertTooShortSpinnerEnd(mockBeatmap(62, 1000, 1124), DifficultyRating.ExpertPlus); + } + + [Test] + public void TestConsecutiveSpinners() + { + var spinnerConsecutiveBeatmap = new Beatmap + { + HitObjects = new List + { + new BananaShower { StartTime = 0, EndTime = 100, X = 0 }, + new BananaShower { StartTime = 101, EndTime = 200, X = 0 }, + new BananaShower { StartTime = 201, EndTime = 300, X = 0 } + } + }; + + assertOk(spinnerConsecutiveBeatmap, DifficultyRating.Easy); + assertOk(spinnerConsecutiveBeatmap, DifficultyRating.Normal); + assertOk(spinnerConsecutiveBeatmap, DifficultyRating.Hard); + assertOk(spinnerConsecutiveBeatmap, DifficultyRating.Insane); + assertOk(spinnerConsecutiveBeatmap, DifficultyRating.Expert); + assertOk(spinnerConsecutiveBeatmap, DifficultyRating.ExpertPlus); + } + + private Beatmap mockBeatmap(double bananaShowerStart, double bananaShowerEnd, double nextFruitStart) + { + return new Beatmap + { + HitObjects = new List + { + new Fruit { StartTime = 0, X = 0 }, + new BananaShower { StartTime = bananaShowerStart, EndTime = bananaShowerEnd, X = 0 }, + new Fruit { StartTime = nextFruitStart, X = 0 } + } + }; + } + + private void assertOk(IBeatmap beatmap, DifficultyRating difficultyRating) + { + var context = new BeatmapVerifierContext(beatmap, new TestWorkingBeatmap(beatmap), difficultyRating); + Assert.That(check.Run(context), Is.Empty); + } + + private void assertTooShortSpinnerStart(IBeatmap beatmap, DifficultyRating difficultyRating) + { + var context = new BeatmapVerifierContext(beatmap, new TestWorkingBeatmap(beatmap), difficultyRating); + var issues = check.Run(context).ToList(); + + Assert.That(issues, Has.Count.EqualTo(1)); + Assert.That(issues.All(issue => issue.Template is CheckBananaShowerGap.IssueTemplateBananaShowerStartGap)); + } + + private void assertTooShortSpinnerEnd(IBeatmap beatmap, DifficultyRating difficultyRating) + { + var context = new BeatmapVerifierContext(beatmap, new TestWorkingBeatmap(beatmap), difficultyRating); + var issues = check.Run(context).ToList(); + + Assert.That(issues, Has.Count.EqualTo(1)); + Assert.That(issues.All(issue => issue.Template is CheckBananaShowerGap.IssueTemplateBananaShowerEndGap)); + } + } +} diff --git a/osu.Game.Rulesets.Catch/CatchRuleset.cs b/osu.Game.Rulesets.Catch/CatchRuleset.cs index c256172177..93240d312b 100644 --- a/osu.Game.Rulesets.Catch/CatchRuleset.cs +++ b/osu.Game.Rulesets.Catch/CatchRuleset.cs @@ -189,5 +189,7 @@ namespace osu.Game.Rulesets.Catch public override IConvertibleReplayFrame CreateConvertibleReplayFrame() => new CatchReplayFrame(); public override HitObjectComposer CreateHitObjectComposer() => new CatchHitObjectComposer(this); + + public override IBeatmapVerifier CreateBeatmapVerifier() => new CatchBeatmapVerifier(); } } diff --git a/osu.Game.Rulesets.Catch/Edit/CatchBeatmapVerifier.cs b/osu.Game.Rulesets.Catch/Edit/CatchBeatmapVerifier.cs new file mode 100644 index 0000000000..c7a41a4e22 --- /dev/null +++ b/osu.Game.Rulesets.Catch/Edit/CatchBeatmapVerifier.cs @@ -0,0 +1,24 @@ +// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. +// See the LICENCE file in the repository root for full licence text. + +using System.Collections.Generic; +using System.Linq; +using osu.Game.Rulesets.Catch.Edit.Checks; +using osu.Game.Rulesets.Edit; +using osu.Game.Rulesets.Edit.Checks.Components; + +namespace osu.Game.Rulesets.Catch.Edit +{ + public class CatchBeatmapVerifier : IBeatmapVerifier + { + private readonly List checks = new List + { + new CheckBananaShowerGap() + }; + + public IEnumerable Run(BeatmapVerifierContext context) + { + return checks.SelectMany(check => check.Run(context)); + } + } +} diff --git a/osu.Game.Rulesets.Catch/Edit/Checks/CheckBananaShowerGap.cs b/osu.Game.Rulesets.Catch/Edit/Checks/CheckBananaShowerGap.cs new file mode 100644 index 0000000000..4b2933c0e1 --- /dev/null +++ b/osu.Game.Rulesets.Catch/Edit/Checks/CheckBananaShowerGap.cs @@ -0,0 +1,102 @@ +// Copyright (c) ppy Pty Ltd . 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.Rulesets.Catch.Objects; +using osu.Game.Rulesets.Edit; +using osu.Game.Rulesets.Edit.Checks.Components; +using osu.Game.Rulesets.Objects; + +namespace osu.Game.Rulesets.Catch.Edit.Checks +{ + /// + /// Check the spinner/banana shower gaps specified in the osu!catch difficulty specific ranking criteria. + /// + public class CheckBananaShowerGap : ICheck + { + private static readonly Dictionary spinner_delta_threshold = new Dictionary + { + [DifficultyRating.Easy] = (250, 250), + [DifficultyRating.Normal] = (250, 250), + [DifficultyRating.Hard] = (125, 250), + [DifficultyRating.Insane] = (125, 125), + [DifficultyRating.Expert] = (62, 125), + [DifficultyRating.ExpertPlus] = (62, 125) + }; + + public CheckMetadata Metadata { get; } = new CheckMetadata(CheckCategory.Compose, "Too short spinner gap"); + + public IEnumerable PossibleTemplates => new IssueTemplate[] + { + new IssueTemplateBananaShowerStartGap(this), + new IssueTemplateBananaShowerEndGap(this) + }; + + public IEnumerable Run(BeatmapVerifierContext context) + { + var hitObjects = context.Beatmap.HitObjects; + (int expectedStartDelta, int expectedEndDelta) = spinner_delta_threshold[context.InterpretedDifficulty]; + + for (int i = 0; i < hitObjects.Count - 1; ++i) + { + if (!(hitObjects[i] is BananaShower bananaShower)) + continue; + + // Skip if the previous hitobject is a banana shower, consecutive spinners are allowed + if (i != 0 && hitObjects[i - 1] is CatchHitObject previousHitObject && !(previousHitObject is BananaShower)) + { + double spinnerStartDelta = bananaShower.StartTime - previousHitObject.GetEndTime(); + + if (spinnerStartDelta < expectedStartDelta) + { + yield return new IssueTemplateBananaShowerStartGap(this) + .Create(spinnerStartDelta, expectedStartDelta, bananaShower, previousHitObject); + } + } + + // Skip if the next hitobject is a banana shower, consecutive spinners are allowed + if (hitObjects[i + 1] is CatchHitObject nextHitObject && !(nextHitObject is BananaShower)) + { + double spinnerEndDelta = nextHitObject.StartTime - bananaShower.EndTime; + + if (spinnerEndDelta < expectedEndDelta) + { + yield return new IssueTemplateBananaShowerEndGap(this) + .Create(spinnerEndDelta, expectedEndDelta, bananaShower, nextHitObject); + } + } + } + } + + public abstract class IssueTemplateBananaShowerGap : IssueTemplate + { + protected IssueTemplateBananaShowerGap(ICheck check, IssueType issueType, string unformattedMessage) + : base(check, issueType, unformattedMessage) + { + } + + public Issue Create(double deltaTime, int expectedDeltaTime, params HitObject[] hitObjects) + { + return new Issue(hitObjects, this, Math.Floor(deltaTime), expectedDeltaTime); + } + } + + public class IssueTemplateBananaShowerStartGap : IssueTemplateBananaShowerGap + { + public IssueTemplateBananaShowerStartGap(ICheck check) + : base(check, IssueType.Problem, "There is only {0} ms between the start of the spinner and the last object, it should not be less than {1} ms.") + { + } + } + + public class IssueTemplateBananaShowerEndGap : IssueTemplateBananaShowerGap + { + public IssueTemplateBananaShowerEndGap(ICheck check) + : base(check, IssueType.Problem, "There is only {0} ms between the end of the spinner and the next object, it should not be less than {1} ms.") + { + } + } + } +}