osu/osu.Game.Rulesets.Osu/OsuRuleset.cs

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

348 lines
12 KiB
C#
Raw Normal View History

// 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.
2018-04-13 09:19:50 +00:00
using System;
using System.Collections.Generic;
using System.Linq;
using osu.Framework.Extensions.EnumExtensions;
using osu.Framework.Graphics;
using osu.Framework.Graphics.Sprites;
using osu.Framework.Input.Bindings;
using osu.Framework.Localisation;
using osu.Game.Beatmaps;
2018-04-13 13:41:35 +00:00
using osu.Game.Beatmaps.Legacy;
2019-01-23 10:46:53 +00:00
using osu.Game.Configuration;
using osu.Game.Graphics;
using osu.Game.Overlays.Settings;
2019-01-23 10:46:53 +00:00
using osu.Game.Rulesets.Configuration;
using osu.Game.Rulesets.Difficulty;
using osu.Game.Rulesets.Edit;
using osu.Game.Rulesets.Mods;
using osu.Game.Rulesets.Osu.Beatmaps;
2019-01-23 10:46:53 +00:00
using osu.Game.Rulesets.Osu.Configuration;
2018-05-15 08:36:29 +00:00
using osu.Game.Rulesets.Osu.Difficulty;
using osu.Game.Rulesets.Osu.Edit;
2021-08-22 14:49:27 +00:00
using osu.Game.Rulesets.Osu.Edit.Setup;
using osu.Game.Rulesets.Osu.Mods;
using osu.Game.Rulesets.Osu.Objects;
using osu.Game.Rulesets.Osu.Replays;
using osu.Game.Rulesets.Osu.Scoring;
using osu.Game.Rulesets.Osu.Skinning.Argon;
using osu.Game.Rulesets.Osu.Skinning.Legacy;
using osu.Game.Rulesets.Osu.Statistics;
using osu.Game.Rulesets.Osu.UI;
using osu.Game.Rulesets.Replays.Types;
using osu.Game.Rulesets.Scoring;
using osu.Game.Rulesets.UI;
using osu.Game.Scoring;
2021-08-22 14:49:27 +00:00
using osu.Game.Screens.Edit.Setup;
using osu.Game.Screens.Ranking.Statistics;
using osu.Game.Skinning;
2018-04-13 09:19:50 +00:00
2017-04-18 07:05:58 +00:00
namespace osu.Game.Rulesets.Osu
{
2019-12-24 04:48:27 +00:00
public class OsuRuleset : Ruleset, ILegacyRuleset
{
public override DrawableRuleset CreateDrawableRulesetWith(IBeatmap beatmap, IReadOnlyList<Mod>? mods = null) => new DrawableOsuRuleset(this, beatmap, mods);
2019-12-17 11:08:13 +00:00
public override ScoreProcessor CreateScoreProcessor() => new OsuScoreProcessor();
public override IBeatmapConverter CreateBeatmapConverter(IBeatmap beatmap) => new OsuBeatmapConverter(beatmap, this);
2019-12-17 11:08:13 +00:00
public override IBeatmapProcessor CreateBeatmapProcessor(IBeatmap beatmap) => new OsuBeatmapProcessor(beatmap);
2018-04-13 09:19:50 +00:00
public const string SHORT_NAME = "osu";
public override string RulesetAPIVersionSupported => CURRENT_RULESET_API_VERSION;
2022-08-22 07:10:55 +00:00
public override IEnumerable<KeyBinding> GetDefaultKeyBindings(int variant = 0) => new[]
{
new KeyBinding(InputKey.Z, OsuAction.LeftButton),
new KeyBinding(InputKey.X, OsuAction.RightButton),
2022-09-18 19:08:34 +00:00
new KeyBinding(InputKey.C, OsuAction.Smoke),
2017-08-20 12:56:28 +00:00
new KeyBinding(InputKey.MouseLeft, OsuAction.LeftButton),
new KeyBinding(InputKey.MouseRight, OsuAction.RightButton),
};
2018-04-13 09:19:50 +00:00
public override IEnumerable<Mod> ConvertFromLegacyMods(LegacyMods mods)
2018-04-13 13:41:35 +00:00
{
2021-02-25 06:38:56 +00:00
if (mods.HasFlagFast(LegacyMods.Nightcore))
2018-04-13 13:41:35 +00:00
yield return new OsuModNightcore();
2021-02-25 06:38:56 +00:00
else if (mods.HasFlagFast(LegacyMods.DoubleTime))
2018-04-13 13:41:35 +00:00
yield return new OsuModDoubleTime();
2021-02-25 06:38:56 +00:00
if (mods.HasFlagFast(LegacyMods.Perfect))
yield return new OsuModPerfect();
2021-02-25 06:38:56 +00:00
else if (mods.HasFlagFast(LegacyMods.SuddenDeath))
yield return new OsuModSuddenDeath();
2021-02-25 06:38:56 +00:00
if (mods.HasFlagFast(LegacyMods.Autopilot))
2018-04-13 13:41:35 +00:00
yield return new OsuModAutopilot();
2021-02-25 06:38:56 +00:00
if (mods.HasFlagFast(LegacyMods.Cinema))
2019-11-23 17:32:16 +00:00
yield return new OsuModCinema();
2021-02-25 06:38:56 +00:00
else if (mods.HasFlagFast(LegacyMods.Autoplay))
2018-04-13 13:41:35 +00:00
yield return new OsuModAutoplay();
2021-02-25 06:38:56 +00:00
if (mods.HasFlagFast(LegacyMods.Easy))
2018-04-13 13:41:35 +00:00
yield return new OsuModEasy();
2021-02-25 06:38:56 +00:00
if (mods.HasFlagFast(LegacyMods.Flashlight))
2018-04-13 13:41:35 +00:00
yield return new OsuModFlashlight();
2021-02-25 06:38:56 +00:00
if (mods.HasFlagFast(LegacyMods.HalfTime))
2018-04-13 13:41:35 +00:00
yield return new OsuModHalfTime();
2021-02-25 06:38:56 +00:00
if (mods.HasFlagFast(LegacyMods.HardRock))
2018-04-13 13:41:35 +00:00
yield return new OsuModHardRock();
2021-02-25 06:38:56 +00:00
if (mods.HasFlagFast(LegacyMods.Hidden))
2018-04-13 13:41:35 +00:00
yield return new OsuModHidden();
2021-02-25 06:38:56 +00:00
if (mods.HasFlagFast(LegacyMods.NoFail))
2018-04-13 13:41:35 +00:00
yield return new OsuModNoFail();
2021-02-25 06:38:56 +00:00
if (mods.HasFlagFast(LegacyMods.Relax))
2018-04-13 13:41:35 +00:00
yield return new OsuModRelax();
2021-02-25 06:38:56 +00:00
if (mods.HasFlagFast(LegacyMods.SpunOut))
2018-04-13 13:41:35 +00:00
yield return new OsuModSpunOut();
2021-02-25 06:38:56 +00:00
if (mods.HasFlagFast(LegacyMods.Target))
2022-11-01 10:47:20 +00:00
yield return new OsuModTargetPractice();
2021-02-25 06:38:56 +00:00
if (mods.HasFlagFast(LegacyMods.TouchDevice))
yield return new OsuModTouchDevice();
2018-04-13 13:41:35 +00:00
}
2020-11-15 14:40:31 +00:00
public override LegacyMods ConvertToLegacyMods(Mod[] mods)
{
var value = base.ConvertToLegacyMods(mods);
foreach (var mod in mods)
{
switch (mod)
{
2022-06-24 12:25:23 +00:00
case OsuModAutopilot:
2020-11-15 14:40:31 +00:00
value |= LegacyMods.Autopilot;
break;
2022-06-24 12:25:23 +00:00
case OsuModSpunOut:
2020-11-15 14:40:31 +00:00
value |= LegacyMods.SpunOut;
break;
2022-11-01 10:47:20 +00:00
case OsuModTargetPractice:
2020-11-15 14:40:31 +00:00
value |= LegacyMods.Target;
break;
2022-06-24 12:25:23 +00:00
case OsuModTouchDevice:
2020-11-15 14:40:31 +00:00
value |= LegacyMods.TouchDevice;
break;
}
}
return value;
}
public override IEnumerable<Mod> GetModsFor(ModType type)
{
switch (type)
{
case ModType.DifficultyReduction:
return new Mod[]
{
new OsuModEasy(),
new OsuModNoFail(),
2018-06-06 05:07:50 +00:00
new MultiMod(new OsuModHalfTime(), new OsuModDaycore()),
};
2019-04-01 03:44:46 +00:00
case ModType.DifficultyIncrease:
return new Mod[]
{
new OsuModHardRock(),
2018-06-06 05:07:50 +00:00
new MultiMod(new OsuModSuddenDeath(), new OsuModPerfect()),
new MultiMod(new OsuModDoubleTime(), new OsuModNightcore()),
new OsuModHidden(),
2018-08-05 12:20:56 +00:00
new MultiMod(new OsuModFlashlight(), new OsuModBlinds()),
2022-03-08 21:47:54 +00:00
new OsuModStrictTracking()
};
2019-04-01 03:44:46 +00:00
case ModType.Conversion:
return new Mod[]
{
2022-11-01 10:47:20 +00:00
new OsuModTargetPractice(),
2019-12-20 10:30:23 +00:00
new OsuModDifficultyAdjust(),
2021-04-24 23:19:06 +00:00
new OsuModClassic(),
new OsuModRandom(),
2021-07-26 00:40:50 +00:00
new OsuModMirror(),
2022-07-12 22:07:26 +00:00
new MultiMod(new OsuModAlternate(), new OsuModSingleTap())
};
2019-04-01 03:44:46 +00:00
case ModType.Automation:
return new Mod[]
{
2019-11-23 17:32:16 +00:00
new MultiMod(new OsuModAutoplay(), new OsuModCinema()),
new OsuModRelax(),
new OsuModAutopilot(),
2020-02-09 05:34:35 +00:00
new OsuModSpunOut(),
};
2019-04-01 03:44:46 +00:00
2018-08-03 22:30:46 +00:00
case ModType.Fun:
2019-02-28 04:31:40 +00:00
return new Mod[]
{
2018-08-22 19:19:28 +00:00
new OsuModTransform(),
new OsuModWiggle(),
2018-09-20 23:06:37 +00:00
new OsuModSpinIn(),
2019-07-01 11:53:40 +00:00
new MultiMod(new OsuModGrow(), new OsuModDeflate()),
new MultiMod(new ModWindUp(), new ModWindDown()),
new OsuModTraceable(),
2021-04-14 07:52:29 +00:00
new OsuModBarrelRoll(),
2021-06-16 06:09:42 +00:00
new OsuModApproachDifferent(),
2021-07-28 10:21:08 +00:00
new OsuModMuted(),
2021-10-15 04:22:57 +00:00
new OsuModNoScope(),
2022-05-26 04:08:00 +00:00
new MultiMod(new OsuModMagnetised(), new OsuModRepel()),
2022-09-07 22:05:48 +00:00
new ModAdaptiveSpeed(),
2022-09-08 13:17:22 +00:00
new OsuModFreezeFrame()
};
2019-04-01 03:44:46 +00:00
case ModType.System:
return new Mod[]
{
new OsuModTouchDevice(),
};
default:
2019-11-28 13:41:29 +00:00
return Array.Empty<Mod>();
}
}
2018-04-13 09:19:50 +00:00
public override Drawable CreateIcon() => new SpriteIcon { Icon = OsuIcon.RulesetOsu };
2018-04-13 09:19:50 +00:00
public override DifficultyCalculator CreateDifficultyCalculator(IWorkingBeatmap beatmap) => new OsuDifficultyCalculator(RulesetInfo, beatmap);
2018-04-13 09:19:50 +00:00
2022-03-15 03:37:39 +00:00
public override PerformanceCalculator CreatePerformanceCalculator() => new OsuPerformanceCalculator();
2018-04-13 09:19:50 +00:00
public override HitObjectComposer CreateHitObjectComposer() => new OsuHitObjectComposer(this);
2018-04-13 09:19:50 +00:00
2021-04-13 08:40:56 +00:00
public override IBeatmapVerifier CreateBeatmapVerifier() => new OsuBeatmapVerifier();
2021-04-07 12:36:43 +00:00
public override string Description => "osu!";
2018-04-13 09:19:50 +00:00
public override string ShortName => SHORT_NAME;
2018-04-13 09:19:50 +00:00
public override string PlayingVerb => "Clicking circles";
2019-01-23 10:46:53 +00:00
public override RulesetSettingsSubsection CreateSettings() => new OsuSettingsSubsection(this);
2018-04-13 09:19:50 +00:00
public override ISkin? CreateSkinTransformer(ISkin skin, IBeatmap beatmap)
{
switch (skin)
{
case LegacySkin:
return new OsuLegacySkinTransformer(skin);
case ArgonSkin:
return new OsuArgonSkinTransformer(skin);
}
return null;
}
2019-12-24 04:48:27 +00:00
public int LegacyID => 0;
2018-04-13 09:19:50 +00:00
public override IConvertibleReplayFrame CreateConvertibleReplayFrame() => new OsuReplayFrame();
2018-04-13 09:19:50 +00:00
public override IRulesetConfigManager CreateConfig(SettingsStore? settings) => new OsuRulesetConfigManager(settings, RulesetInfo);
protected override IEnumerable<HitResult> GetValidHitResults()
{
return new[]
{
HitResult.Great,
HitResult.Ok,
HitResult.Meh,
HitResult.LargeTickHit,
HitResult.SmallTickHit,
HitResult.SmallBonus,
HitResult.LargeBonus,
};
}
2022-08-14 18:54:02 +00:00
public override LocalisableString GetDisplayNameForHitResult(HitResult result)
{
switch (result)
{
case HitResult.LargeTickHit:
return "slider tick";
case HitResult.SmallTickHit:
return "slider end";
case HitResult.SmallBonus:
return "spinner spin";
case HitResult.LargeBonus:
return "spinner bonus";
}
return base.GetDisplayNameForHitResult(result);
}
2020-08-27 18:07:30 +00:00
public override StatisticRow[] CreateStatisticsForScore(ScoreInfo score, IBeatmap playableBeatmap)
{
var timedHitEvents = score.HitEvents.Where(e => e.HitObject is HitCircle && !(e.HitObject is SliderTailCircle)).ToList();
2020-08-27 18:07:30 +00:00
return new[]
{
new StatisticRow
{
Columns = new[]
2020-06-19 12:02:20 +00:00
{
new StatisticItem("Performance Breakdown", () => new PerformanceBreakdownChart(score, playableBeatmap)
{
RelativeSizeAxes = Axes.X,
AutoSizeAxes = Axes.Y
}),
}
},
new StatisticRow
{
Columns = new[]
{
new StatisticItem("Timing Distribution", () => new HitEventTimingDistributionGraph(timedHitEvents)
{
RelativeSizeAxes = Axes.X,
Height = 250
}, true),
}
},
2020-08-27 18:46:49 +00:00
new StatisticRow
{
Columns = new[]
{
new StatisticItem("Accuracy Heatmap", () => new AccuracyHeatmap(score, playableBeatmap)
{
RelativeSizeAxes = Axes.X,
Height = 250
}, true),
}
},
new StatisticRow
2020-08-27 18:46:49 +00:00
{
Columns = new[]
{
new StatisticItem(string.Empty, () => new SimpleStatisticTable(3, new SimpleStatisticItem[]
{
new AverageHitError(timedHitEvents),
new UnstableRate(timedHitEvents)
}), true)
2020-08-27 18:46:49 +00:00
}
}
};
}
2021-08-22 14:49:27 +00:00
public override RulesetSetupSection CreateEditorSetupSection() => new OsuSetupSection();
}
}