osu/osu.Game/Rulesets/UI/DrawableRuleset.cs

537 lines
20 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 osu.Framework.Allocation;
using osu.Framework.Graphics;
using osu.Framework.Graphics.Containers;
using osu.Game.Beatmaps;
using osu.Game.Rulesets.Judgements;
using osu.Game.Rulesets.Mods;
using osu.Game.Rulesets.Objects;
using osu.Game.Rulesets.Objects.Drawables;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using JetBrains.Annotations;
2019-02-21 10:04:31 +00:00
using osu.Framework.Bindables;
2018-04-13 09:19:50 +00:00
using osu.Framework.Graphics.Cursor;
using osu.Framework.Input;
using osu.Framework.Input.Events;
2018-04-13 09:19:50 +00:00
using osu.Game.Configuration;
using osu.Game.Graphics.Cursor;
2018-04-13 09:19:50 +00:00
using osu.Game.Input.Handlers;
using osu.Game.Overlays;
2018-11-28 08:20:37 +00:00
using osu.Game.Replays;
2018-04-13 09:19:50 +00:00
using osu.Game.Rulesets.Configuration;
using osu.Game.Rulesets.Scoring;
using osu.Game.Scoring;
using osu.Game.Screens.Play;
using osuTK;
2018-04-13 09:19:50 +00:00
namespace osu.Game.Rulesets.UI
{
/// <summary>
/// Displays an interactive ruleset gameplay instance.
2018-04-13 09:19:50 +00:00
/// </summary>
/// <typeparam name="TObject">The type of HitObject contained by this DrawableRuleset.</typeparam>
public abstract class DrawableRuleset<TObject> : DrawableRuleset, IProvideCursor, ICanAttachKeyCounter
where TObject : HitObject
2018-04-13 09:19:50 +00:00
{
public override event Action<JudgementResult> NewResult;
public override event Action<JudgementResult> RevertResult;
2019-12-11 08:25:06 +00:00
2018-04-13 09:19:50 +00:00
/// <summary>
/// The selected variant.
/// </summary>
public virtual int Variant => 0;
/// <summary>
/// The key conversion input manager for this DrawableRuleset.
2018-04-13 09:19:50 +00:00
/// </summary>
public PassThroughInputManager KeyBindingInputManager;
2020-04-28 05:47:45 +00:00
public override double GameplayStartTime => Objects.FirstOrDefault()?.StartTime - 2000 ?? 0;
2018-04-13 09:19:50 +00:00
private readonly Lazy<Playfield> playfield;
2018-06-06 05:20:51 +00:00
2018-04-13 09:19:50 +00:00
/// <summary>
/// The playfield.
/// </summary>
2019-06-04 07:13:16 +00:00
public override Playfield Playfield => playfield.Value;
2018-04-13 09:19:50 +00:00
public override Container Overlays { get; } = new Container { RelativeSizeAxes = Axes.Both };
public override Container FrameStableComponents { get; } = new Container { RelativeSizeAxes = Axes.Both };
2020-10-27 05:10:12 +00:00
public override IFrameStableClock FrameStableClock => frameStabilityContainer.FrameStableClock;
private bool frameStablePlayback = true;
/// <summary>
/// Whether to enable frame-stable playback.
/// </summary>
internal bool FrameStablePlayback
{
get => frameStablePlayback;
set
{
frameStablePlayback = value;
if (frameStabilityContainer != null)
frameStabilityContainer.FrameStablePlayback = value;
}
}
2019-03-20 05:55:38 +00:00
/// <summary>
/// The beatmap.
/// </summary>
[Cached(typeof(IBeatmap))]
public readonly Beatmap<TObject> Beatmap;
2018-04-13 09:19:50 +00:00
2019-03-20 05:55:38 +00:00
public override IEnumerable<HitObject> Objects => Beatmap.HitObjects;
2018-04-13 09:19:50 +00:00
2018-07-11 08:25:57 +00:00
protected IRulesetConfigManager Config { get; private set; }
2019-04-10 08:11:17 +00:00
[Cached(typeof(IReadOnlyList<Mod>))]
public sealed override IReadOnlyList<Mod> Mods { get; }
2019-03-20 05:55:38 +00:00
private FrameStabilityContainer frameStabilityContainer;
2018-04-13 09:19:50 +00:00
private OnScreenDisplay onScreenDisplay;
private DrawableRulesetDependencies dependencies;
2018-04-13 09:19:50 +00:00
/// <summary>
/// Creates a ruleset visualisation for the provided ruleset and beatmap.
2018-04-13 09:19:50 +00:00
/// </summary>
2019-03-20 05:55:38 +00:00
/// <param name="ruleset">The ruleset being represented.</param>
/// <param name="beatmap">The beatmap to create the hit renderer for.</param>
2019-04-25 08:36:17 +00:00
/// <param name="mods">The <see cref="Mod"/>s to apply.</param>
protected DrawableRuleset(Ruleset ruleset, IBeatmap beatmap, IReadOnlyList<Mod> mods = null)
: base(ruleset)
2018-04-13 09:19:50 +00:00
{
if (beatmap == null)
throw new ArgumentNullException(nameof(beatmap), "Beatmap cannot be null.");
2019-04-08 09:32:05 +00:00
if (!(beatmap is Beatmap<TObject> tBeatmap))
throw new ArgumentException($"{GetType()} expected the beatmap to contain hitobjects of type {typeof(TObject)}.", nameof(beatmap));
Beatmap = tBeatmap;
2020-04-28 10:23:33 +00:00
Mods = mods?.ToArray() ?? Array.Empty<Mod>();
RelativeSizeAxes = Axes.Both;
KeyBindingInputManager = CreateInputManager();
playfield = new Lazy<Playfield>(() => CreatePlayfield().With(p =>
{
p.NewResult += (_, r) => NewResult?.Invoke(r);
p.RevertResult += (_, r) => RevertResult?.Invoke(r);
}));
2018-04-13 09:19:50 +00:00
IsPaused.ValueChanged += paused =>
2018-07-11 08:01:27 +00:00
{
2019-02-21 09:56:34 +00:00
if (HasReplayLoaded.Value)
2018-07-11 08:01:27 +00:00
return;
KeyBindingInputManager.UseParentInput = !paused.NewValue;
2018-07-11 08:01:27 +00:00
};
2018-04-13 09:19:50 +00:00
}
2018-05-06 10:57:52 +00:00
2018-07-11 08:07:14 +00:00
protected override IReadOnlyDependencyContainer CreateChildDependencies(IReadOnlyDependencyContainer parent)
2018-04-13 09:19:50 +00:00
{
dependencies = new DrawableRulesetDependencies(Ruleset, base.CreateChildDependencies(parent));
Config = dependencies.RulesetConfigManager;
onScreenDisplay = dependencies.Get<OnScreenDisplay>();
2018-07-11 08:25:57 +00:00
if (Config != null)
onScreenDisplay?.BeginTracking(this, Config);
2018-04-13 09:19:50 +00:00
return dependencies;
}
2018-06-11 03:57:26 +00:00
public virtual PlayfieldAdjustmentContainer CreatePlayfieldAdjustmentContainer() => new PlayfieldAdjustmentContainer();
[Resolved]
private OsuConfigManager config { get; set; }
2019-03-20 05:55:38 +00:00
[BackgroundDependencyLoader]
private void load(CancellationToken? cancellationToken)
2019-03-20 05:55:38 +00:00
{
InternalChildren = new Drawable[]
{
frameStabilityContainer = new FrameStabilityContainer(GameplayStartTime)
2019-03-20 05:55:38 +00:00
{
FrameStablePlayback = FrameStablePlayback,
Children = new Drawable[]
{
FrameStableComponents,
KeyBindingInputManager
.WithChild(CreatePlayfieldAdjustmentContainer()
.WithChild(Playfield)
),
Overlays,
}
2019-03-20 05:55:38 +00:00
},
};
if ((ResumeOverlay = CreateResumeOverlay()) != null)
{
AddInternal(CreateInputManager()
.WithChild(CreatePlayfieldAdjustmentContainer()
.WithChild(ResumeOverlay)));
}
applyRulesetMods(Mods, config);
2019-03-20 05:55:38 +00:00
loadObjects(cancellationToken ?? default);
}
2018-04-13 09:19:50 +00:00
/// <summary>
/// Creates and adds drawable representations of hit objects to the play field.
/// </summary>
private void loadObjects(CancellationToken cancellationToken)
{
foreach (TObject h in Beatmap.HitObjects)
{
cancellationToken.ThrowIfCancellationRequested();
AddHitObject(h);
}
cancellationToken.ThrowIfCancellationRequested();
2018-04-13 09:19:50 +00:00
Playfield.PostProcess();
2020-04-28 10:23:33 +00:00
foreach (var mod in Mods.OfType<IApplicableToDrawableHitObjects>())
mod.ApplyToDrawableHitObjects(Playfield.AllHitObjects);
}
2018-04-13 09:19:50 +00:00
2019-03-21 07:57:40 +00:00
public override void RequestResume(Action continueResume)
{
2019-03-25 13:00:33 +00:00
if (ResumeOverlay != null && (Cursor == null || (Cursor.LastFrameState == Visibility.Visible && Contains(Cursor.ActiveCursor.ScreenSpaceDrawQuad.Centre))))
2019-03-21 07:57:40 +00:00
{
ResumeOverlay.GameplayCursor = Cursor;
2019-03-21 07:57:40 +00:00
ResumeOverlay.ResumeAction = continueResume;
ResumeOverlay.Show();
}
else
continueResume();
}
2019-10-25 19:57:49 +00:00
public override void CancelResume()
{
// called if the user pauses while the resume overlay is open
ResumeOverlay?.Hide();
2019-10-25 19:57:49 +00:00
}
2020-11-12 03:55:42 +00:00
/// <summary>
/// Adds a <see cref="HitObject"/> to this <see cref="DrawableRuleset"/>.
/// </summary>
/// <remarks>
/// This does not add the <see cref="HitObject"/> to the beatmap.
/// </remarks>
/// <param name="hitObject">The <see cref="HitObject"/> to add.</param>
public void AddHitObject(TObject hitObject)
2018-04-13 09:19:50 +00:00
{
var drawableRepresentation = CreateDrawableRepresentation(hitObject);
// If a drawable representation exists, use it, otherwise assume the hitobject is being pooled.
if (drawableRepresentation != null)
Playfield.Add(drawableRepresentation);
else
Playfield.Add(hitObject);
}
2018-04-13 09:19:50 +00:00
2020-11-12 03:55:42 +00:00
/// <summary>
/// Removes a <see cref="HitObject"/> from this <see cref="DrawableRuleset"/>.
2020-11-12 03:55:42 +00:00
/// </summary>
/// <remarks>
/// This does not remove the <see cref="HitObject"/> from the beatmap.
/// </remarks>
/// <param name="hitObject">The <see cref="HitObject"/> to remove.</param>
public bool RemoveHitObject(TObject hitObject)
{
if (Playfield.Remove(hitObject))
return true;
// If the entry was not removed from the playfield, assume the hitobject is not being pooled and attempt a direct drawable removal.
var drawableObject = Playfield.AllHitObjects.SingleOrDefault(d => d.HitObject == hitObject);
if (drawableObject != null)
return Playfield.Remove(drawableObject);
return false;
2018-04-13 09:19:50 +00:00
}
public sealed override void SetRecordTarget(Score score)
2020-03-23 10:31:43 +00:00
{
2020-03-24 06:39:01 +00:00
if (!(KeyBindingInputManager is IHasRecordingHandler recordingInputManager))
2020-03-23 10:31:43 +00:00
throw new InvalidOperationException($"A {nameof(KeyBindingInputManager)} which supports recording is not available");
var recorder = CreateReplayRecorder(score);
2020-03-24 05:13:46 +00:00
if (recorder == null)
return;
2020-03-23 10:31:43 +00:00
recorder.ScreenSpaceToGamefield = Playfield.ScreenSpaceToGamefield;
2020-03-24 06:39:01 +00:00
recordingInputManager.Recorder = recorder;
2020-03-23 10:31:43 +00:00
}
2019-03-20 05:55:38 +00:00
public override void SetReplayScore(Score replayScore)
2018-04-13 09:19:50 +00:00
{
2019-03-20 05:55:38 +00:00
if (!(KeyBindingInputManager is IHasReplayHandler replayInputManager))
throw new InvalidOperationException($"A {nameof(KeyBindingInputManager)} which supports replay loading is not available");
2018-04-13 09:19:50 +00:00
2019-03-20 05:55:38 +00:00
var handler = (ReplayScore = replayScore) != null ? CreateReplayInputHandler(replayScore.Replay) : null;
2018-04-13 09:19:50 +00:00
2019-03-20 05:55:38 +00:00
replayInputManager.ReplayInputHandler = handler;
frameStabilityContainer.ReplayInputHandler = handler;
2019-03-20 05:55:38 +00:00
HasReplayLoaded.Value = replayInputManager.ReplayInputHandler != null;
2018-04-13 09:19:50 +00:00
2019-03-20 05:55:38 +00:00
if (replayInputManager.ReplayInputHandler != null)
replayInputManager.ReplayInputHandler.GamefieldToScreenSpace = Playfield.GamefieldToScreenSpace;
if (!ProvidingUserCursor)
2019-04-23 04:45:51 +00:00
{
// The cursor is hidden by default (see Playfield.load()), but should be shown when there's a replay
Playfield.Cursor?.Show();
2019-04-23 04:45:51 +00:00
}
2019-03-20 05:55:38 +00:00
}
2018-04-13 09:19:50 +00:00
/// <summary>
/// Creates a <see cref="DrawableHitObject{TObject}"/> to represent a <see cref="HitObject"/>.
2018-04-13 09:19:50 +00:00
/// </summary>
/// <remarks>
2020-11-13 15:41:18 +00:00
/// If this method returns <c>null</c>, then this <see cref="DrawableRuleset"/> will assume the requested <see cref="HitObject"/> type is being pooled inside the <see cref="Playfield"/>,
/// and will instead attempt to retrieve the <see cref="DrawableHitObject"/>s at the point they should become alive via pools registered in the <see cref="Playfield"/>.
/// </remarks>
/// <param name="h">The <see cref="HitObject"/> to represent.</param>
/// <returns>The representing <see cref="DrawableHitObject{TObject}"/>.</returns>
public abstract DrawableHitObject<TObject> CreateDrawableRepresentation(TObject h);
2018-04-13 09:19:50 +00:00
public void Attach(KeyCounterDisplay keyCounter) =>
(KeyBindingInputManager as ICanAttachKeyCounter)?.Attach(keyCounter);
2018-04-13 09:19:50 +00:00
/// <summary>
/// Creates a key conversion input manager. An exception will be thrown if a valid <see cref="RulesetInputManager{T}"/> is not returned.
2018-04-13 09:19:50 +00:00
/// </summary>
/// <returns>The input manager.</returns>
protected abstract PassThroughInputManager CreateInputManager();
2018-04-13 09:19:50 +00:00
protected virtual ReplayInputHandler CreateReplayInputHandler(Replay replay) => null;
protected virtual ReplayRecorder CreateReplayRecorder(Score score) => null;
2020-03-23 10:03:42 +00:00
2018-04-13 09:19:50 +00:00
/// <summary>
/// Creates a Playfield.
/// </summary>
/// <returns>The Playfield.</returns>
protected abstract Playfield CreatePlayfield();
2018-04-13 09:19:50 +00:00
/// <summary>
/// Applies the active mods to this DrawableRuleset.
2018-04-13 09:19:50 +00:00
/// </summary>
2019-04-25 08:36:17 +00:00
/// <param name="mods">The <see cref="Mod"/>s to apply.</param>
/// <param name="config">The <see cref="OsuConfigManager"/> to apply.</param>
private void applyRulesetMods(IReadOnlyList<Mod> mods, OsuConfigManager config)
2018-04-13 09:19:50 +00:00
{
if (mods == null)
return;
foreach (var mod in mods.OfType<IApplicableToDrawableRuleset<TObject>>())
mod.ApplyToDrawableRuleset(this);
2018-06-06 05:20:51 +00:00
foreach (var mod in mods.OfType<IReadFromConfig>())
mod.ReadFromConfig(config);
2018-04-13 09:19:50 +00:00
}
2019-03-20 05:55:38 +00:00
#region IProvideCursor
protected override bool OnHover(HoverEvent e) => true; // required for IProvideCursor
// only show the cursor when within the playfield, by default.
public override bool ReceivePositionalInputAt(Vector2 screenSpacePos) => Playfield.ReceivePositionalInputAt(screenSpacePos);
CursorContainer IProvideCursor.Cursor => Playfield.Cursor;
public override GameplayCursorContainer Cursor => Playfield.Cursor;
2019-03-20 05:55:38 +00:00
public bool ProvidingUserCursor => Playfield.Cursor != null && !HasReplayLoaded.Value;
#endregion
protected override void Dispose(bool isDisposing)
2018-04-13 09:19:50 +00:00
{
base.Dispose(isDisposing);
2018-04-13 09:19:50 +00:00
if (Config != null)
{
onScreenDisplay?.StopTracking(this, Config);
Config = null;
}
// Dispose the components created by this dependency container.
dependencies?.Dispose();
2018-04-13 09:19:50 +00:00
}
}
2018-04-13 09:19:50 +00:00
/// <summary>
/// Displays an interactive ruleset gameplay instance.
/// <remarks>
/// This type is required only for adding non-generic type to the draw hierarchy.
/// </remarks>
/// </summary>
2020-11-10 15:22:36 +00:00
[Cached(typeof(DrawableRuleset))]
public abstract class DrawableRuleset : CompositeDrawable
{
2019-12-11 08:25:06 +00:00
/// <summary>
/// Invoked when a <see cref="JudgementResult"/> has been applied by a <see cref="DrawableHitObject"/>.
/// </summary>
public abstract event Action<JudgementResult> NewResult;
2019-12-11 08:25:06 +00:00
/// <summary>
/// Invoked when a <see cref="JudgementResult"/> is being reverted by a <see cref="DrawableHitObject"/>.
/// </summary>
public abstract event Action<JudgementResult> RevertResult;
2019-12-11 08:25:06 +00:00
2018-04-13 09:19:50 +00:00
/// <summary>
/// Whether a replay is currently loaded.
2018-04-13 09:19:50 +00:00
/// </summary>
public readonly BindableBool HasReplayLoaded = new BindableBool();
2018-04-13 09:19:50 +00:00
/// <summary>
/// Whether the game is paused. Used to block user input.
/// </summary>
public readonly BindableBool IsPaused = new BindableBool();
2018-04-13 09:19:50 +00:00
2019-06-04 07:13:16 +00:00
/// <summary>
/// The playfield.
/// </summary>
public abstract Playfield Playfield { get; }
/// <summary>
2020-03-26 03:50:00 +00:00
/// Content to be placed above hitobjects. Will be affected by frame stability.
/// </summary>
public abstract Container Overlays { get; }
/// <summary>
/// Components to be run potentially multiple times in line with frame-stable gameplay.
/// </summary>
public abstract Container FrameStableComponents { get; }
/// <summary>
/// The frame-stable clock which is being used for playfield display.
/// </summary>
2020-10-27 05:10:12 +00:00
public abstract IFrameStableClock FrameStableClock { get; }
2020-11-06 13:09:54 +00:00
/// <summary>
/// The mods which are to be applied.
/// </summary>
public abstract IReadOnlyList<Mod> Mods { get; }
2020-11-06 13:09:54 +00:00
/// <summary>~
/// The associated ruleset.
/// </summary>
public readonly Ruleset Ruleset;
2018-04-13 09:19:50 +00:00
/// <summary>
/// Creates a ruleset visualisation for the provided ruleset.
/// </summary>
/// <param name="ruleset">The ruleset.</param>
internal DrawableRuleset(Ruleset ruleset)
{
Ruleset = ruleset;
}
/// <summary>
/// All the converted hit objects contained by this hit renderer.
/// </summary>
public abstract IEnumerable<HitObject> Objects { get; }
/// <summary>
/// The point in time at which gameplay starts, including any required lead-in for display purposes.
/// Defaults to two seconds before the first <see cref="HitObject"/>. Override as necessary.
/// </summary>
public abstract double GameplayStartTime { get; }
/// <summary>
/// The currently loaded replay. Usually null in the case of a local player.
/// </summary>
public Score ReplayScore { get; protected set; }
2018-04-13 09:19:50 +00:00
/// <summary>
/// The cursor being displayed by the <see cref="Playfield"/>. May be null if no cursor is provided.
2018-04-13 09:19:50 +00:00
/// </summary>
public abstract GameplayCursorContainer Cursor { get; }
2018-04-13 09:19:50 +00:00
/// <summary>
/// An optional overlay used when resuming gameplay from a paused state.
/// </summary>
public ResumeOverlay ResumeOverlay { get; protected set; }
/// <summary>
/// Returns first available <see cref="HitWindows"/> provided by a <see cref="HitObject"/>.
/// </summary>
[CanBeNull]
public HitWindows FirstAvailableHitWindows
{
get
{
foreach (var h in Objects)
{
2019-10-09 10:08:31 +00:00
if (h.HitWindows.WindowFor(HitResult.Miss) > 0)
return h.HitWindows;
foreach (var n in h.NestedHitObjects)
2019-11-11 11:53:22 +00:00
{
2019-10-09 10:08:31 +00:00
if (h.HitWindows.WindowFor(HitResult.Miss) > 0)
return n.HitWindows;
2019-11-11 11:53:22 +00:00
}
}
return null;
}
}
protected virtual ResumeOverlay CreateResumeOverlay() => null;
/// <summary>
2020-05-10 11:09:41 +00:00
/// Whether to display gameplay overlays, such as <see cref="HUDOverlay"/> and <see cref="BreakOverlay"/>.
/// </summary>
public virtual bool AllowGameplayOverlays => true;
2018-04-13 09:19:50 +00:00
/// <summary>
/// Sets a replay to be used, overriding local input.
/// </summary>
/// <param name="replayScore">The replay, null for local input.</param>
public abstract void SetReplayScore(Score replayScore);
2020-03-23 10:31:43 +00:00
/// <summary>
/// Sets a replay to be used to record gameplay.
/// </summary>
/// <param name="score">The target to be recorded to.</param>
public abstract void SetRecordTarget(Score score);
2020-03-23 10:31:43 +00:00
/// <summary>
/// Invoked when the interactive user requests resuming from a paused state.
/// Allows potentially delaying the resume process until an interaction is performed.
2018-04-13 09:19:50 +00:00
/// </summary>
/// <param name="continueResume">The action to run when resuming is to be completed.</param>
public abstract void RequestResume(Action continueResume);
2018-04-13 09:19:50 +00:00
/// <summary>
/// Invoked when the user requests to pause while the resume overlay is active.
/// </summary>
2019-10-25 19:57:49 +00:00
public abstract void CancelResume();
2018-04-13 09:19:50 +00:00
}
public class BeatmapInvalidForRulesetException : ArgumentException
{
public BeatmapInvalidForRulesetException(string text)
: base(text)
{
}
}
}