osu/osu.Game/Screens/Select/SongSelect.cs

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

911 lines
34 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
2016-11-14 08:23:33 +00:00
using osu.Framework.Allocation;
using osu.Framework.Audio;
using osu.Framework.Audio.Sample;
2019-02-21 10:04:31 +00:00
using osu.Framework.Bindables;
using osu.Framework.Graphics;
using osu.Framework.Graphics.Containers;
2018-10-02 03:02:47 +00:00
using osu.Framework.Input.Events;
2019-01-04 19:13:32 +00:00
using osu.Framework.Logging;
using osu.Framework.Screens;
using osu.Framework.Threading;
2016-11-14 08:23:33 +00:00
using osu.Game.Beatmaps;
using osu.Game.Graphics;
using osu.Game.Graphics.Containers;
using osu.Game.Input.Bindings;
using osu.Game.Overlays;
2018-12-06 10:29:18 +00:00
using osu.Game.Overlays.Mods;
using osu.Game.Rulesets;
using osu.Game.Rulesets.Mods;
2017-10-06 15:59:14 +00:00
using osu.Game.Screens.Edit;
using osu.Game.Screens.Menu;
using osu.Game.Screens.Select.Options;
2019-01-04 19:13:32 +00:00
using osuTK;
using osuTK.Graphics;
2019-01-04 19:13:32 +00:00
using osuTK.Input;
using System;
using System.Collections.Generic;
using System.Linq;
2020-08-05 12:10:38 +00:00
using osu.Framework.Audio.Track;
using osu.Framework.Graphics.Sprites;
using osu.Framework.Input.Bindings;
using osu.Game.Collections;
using osu.Game.Graphics.UserInterface;
using System.Diagnostics;
using JetBrains.Annotations;
using osu.Game.Screens.Play;
using osu.Game.Skinning;
2018-04-13 09:19:50 +00:00
namespace osu.Game.Screens.Select
2016-09-29 11:13:58 +00:00
{
public abstract class SongSelect : ScreenWithBeatmapBackground, IKeyBindingHandler<GlobalAction>
2016-09-29 11:13:58 +00:00
{
public static readonly float WEDGE_HEIGHT = 245;
2019-05-12 06:40:58 +00:00
protected const float BACKGROUND_BLUR = 20;
2017-12-15 03:48:15 +00:00
private const float left_area_padding = 20;
2018-04-13 09:19:50 +00:00
2019-11-15 09:23:35 +00:00
public FilterControl FilterControl { get; private set; }
2018-04-13 09:19:50 +00:00
/// <summary>
/// Whether this song select instance should take control of the global track,
/// applying looping and preview offsets.
/// </summary>
protected virtual bool ControlGlobalMusic => true;
2017-03-15 02:10:59 +00:00
protected virtual bool ShowFooter => true;
2018-04-13 09:19:50 +00:00
public override bool? AllowTrackAdjustments => true;
2017-03-14 13:51:26 +00:00
/// <summary>
2017-03-16 05:08:37 +00:00
/// Can be null if <see cref="ShowFooter"/> is false.
2017-03-14 13:51:26 +00:00
/// </summary>
protected BeatmapOptionsOverlay BeatmapOptions { get; private set; }
2018-04-13 09:19:50 +00:00
2017-03-14 13:51:26 +00:00
/// <summary>
2017-03-16 05:08:37 +00:00
/// Can be null if <see cref="ShowFooter"/> is false.
2017-03-14 13:51:26 +00:00
/// </summary>
protected Footer Footer { get; private set; }
2018-04-13 09:19:50 +00:00
/// <summary>
/// Contains any panel which is triggered by a footer button.
/// Helps keep them located beneath the footer itself.
/// </summary>
protected Container FooterPanels { get; private set; }
2018-04-13 09:19:50 +00:00
/// <summary>
/// Whether entering editor mode should be allowed.
/// </summary>
public virtual bool AllowEditing => true;
2021-11-25 12:11:13 +00:00
public bool BeatmapSetsLoaded => IsLoaded && Carousel?.BeatmapSetsLoaded == true;
[Resolved]
private Bindable<IReadOnlyList<Mod>> selectedMods { get; set; }
protected BeatmapCarousel Carousel { get; private set; }
2021-08-12 09:02:00 +00:00
protected Container LeftArea { get; private set; }
private BeatmapInfoWedge beatmapInfoWedge;
[Resolved(canBeNull: true)]
private IDialogOverlay dialogOverlay { get; set; }
2018-04-13 09:19:50 +00:00
[Resolved]
private BeatmapManager beatmaps { get; set; }
2021-05-17 20:01:05 +00:00
protected ModSelectOverlay ModSelect { get; private set; }
2021-01-19 08:11:40 +00:00
protected Sample SampleConfirm { get; private set; }
2018-12-06 10:29:18 +00:00
2021-01-19 08:11:40 +00:00
private Sample sampleChangeDifficulty;
private Sample sampleChangeBeatmap;
2018-04-13 09:19:50 +00:00
private Container carouselContainer;
protected BeatmapDetailArea BeatmapDetails { get; private set; }
2019-02-01 06:42:15 +00:00
private readonly Bindable<RulesetInfo> decoupledRuleset = new Bindable<RulesetInfo>();
2021-11-11 10:20:50 +00:00
private double audioFeedbackLastPlaybackTime;
[CanBeNull]
private IDisposable modSelectOverlayRegistration;
2020-08-11 03:40:58 +00:00
[Resolved]
private MusicController music { get; set; }
[Resolved(CanBeNull = true)]
internal IOverlayManager OverlayManager { get; private set; }
[BackgroundDependencyLoader(true)]
private void load(AudioManager audio, OsuColour colours, ManageCollectionsDialog manageCollectionsDialog, DifficultyRecommender recommender)
{
// initial value transfer is required for FilterControl (it uses our re-cached bindables in its async load for the initial filter).
transferRulesetValue();
LoadComponentAsync(Carousel = new BeatmapCarousel
{
AllowSelection = false, // delay any selection until our bindables are ready to make a good choice.
Anchor = Anchor.CentreRight,
Origin = Anchor.CentreRight,
RelativeSizeAxes = Axes.Both,
BleedTop = FilterControl.HEIGHT,
BleedBottom = Footer.HEIGHT,
SelectionChanged = updateSelectedBeatmap,
BeatmapSetsChanged = carouselBeatmapsLoaded,
GetRecommendedBeatmap = s => recommender?.GetRecommendedBeatmap(s),
}, c => carouselContainer.Child = c);
AddRangeInternal(new Drawable[]
{
new ResetScrollContainer(() => Carousel.ScrollToSelected())
2016-10-13 20:55:15 +00:00
{
RelativeSizeAxes = Axes.Y,
Width = 250,
},
new VerticalMaskingContainer
{
Children = new Drawable[]
2016-10-19 18:02:03 +00:00
{
2020-01-24 06:00:10 +00:00
new GridContainer // used for max width implementation
2017-12-13 03:46:02 +00:00
{
RelativeSizeAxes = Axes.Both,
2020-01-24 06:00:10 +00:00
ColumnDimensions = new[]
{
new Dimension(),
new Dimension(GridSizeMode.Relative, 0.5f, maxSize: 850),
},
Content = new[]
{
new Drawable[]
{
new ParallaxContainer
2020-01-24 06:00:10 +00:00
{
ParallaxAmount = 0.005f,
2020-01-24 06:00:10 +00:00
RelativeSizeAxes = Axes.Both,
Child = new WedgeBackground
{
RelativeSizeAxes = Axes.Both,
Padding = new MarginPadding { Right = -150 },
},
},
carouselContainer = new Container
{
RelativeSizeAxes = Axes.Both,
Padding = new MarginPadding
{
Top = FilterControl.HEIGHT,
Bottom = Footer.HEIGHT
},
Child = new LoadingSpinner(true) { State = { Value = Visibility.Visible } }
}
},
}
},
FilterControl = new FilterControl
{
RelativeSizeAxes = Axes.X,
Height = FilterControl.HEIGHT,
FilterChanged = ApplyFilterToCarousel,
},
new GridContainer // used for max width implementation
{
RelativeSizeAxes = Axes.Both,
ColumnDimensions = new[]
{
new Dimension(GridSizeMode.Relative, 0.5f, maxSize: 650),
},
Content = new[]
{
new Drawable[]
{
2021-08-12 09:02:00 +00:00
LeftArea = new Container
{
Origin = Anchor.BottomLeft,
Anchor = Anchor.BottomLeft,
RelativeSizeAxes = Axes.Both,
2021-08-12 09:02:00 +00:00
Padding = new MarginPadding { Top = left_area_padding },
Children = new Drawable[]
{
beatmapInfoWedge = new BeatmapInfoWedge
{
Height = WEDGE_HEIGHT,
RelativeSizeAxes = Axes.X,
Margin = new MarginPadding
{
Right = left_area_padding,
2021-08-13 13:29:22 +00:00
Left = -BeatmapInfoWedge.BORDER_THICKNESS, // Hide the left border
},
},
new Container
{
RelativeSizeAxes = Axes.Both,
Padding = new MarginPadding
{
Bottom = Footer.HEIGHT,
2021-08-12 09:02:00 +00:00
Top = WEDGE_HEIGHT,
Left = left_area_padding,
Right = left_area_padding * 2,
},
2020-02-12 10:52:47 +00:00
Child = BeatmapDetails = CreateBeatmapDetailArea().With(d =>
{
2020-02-12 10:52:47 +00:00
d.RelativeSizeAxes = Axes.Both;
d.Padding = new MarginPadding { Top = 10, Right = 5 };
})
},
}
},
},
}
}
}
},
new SkinnableTargetContainer(SkinnableTarget.SongSelect)
{
RelativeSizeAxes = Axes.Both,
},
2017-07-29 14:33:20 +00:00
});
2018-04-13 09:19:50 +00:00
2017-03-15 02:10:59 +00:00
if (ShowFooter)
2017-03-14 13:51:26 +00:00
{
AddRangeInternal(new Drawable[]
2017-02-16 20:05:03 +00:00
{
FooterPanels = new Container
2018-12-06 10:29:18 +00:00
{
Anchor = Anchor.BottomLeft,
Origin = Anchor.BottomLeft,
RelativeSizeAxes = Axes.Both,
Padding = new MarginPadding { Bottom = Footer.HEIGHT },
Children = new Drawable[]
2019-06-25 07:55:49 +00:00
{
BeatmapOptions = new BeatmapOptionsOverlay(),
2019-06-25 07:55:49 +00:00
}
},
Footer = new Footer(),
2018-12-06 10:29:18 +00:00
});
2017-03-14 13:51:26 +00:00
}
2018-04-13 09:19:50 +00:00
// preload the mod select overlay for later use in `LoadComplete()`.
// therein it will be registered at the `OsuGame` level to properly function as a blocking overlay.
LoadComponent(ModSelect = CreateModSelectOverlay());
2017-03-14 13:51:26 +00:00
if (Footer != null)
{
2021-01-27 13:03:51 +00:00
foreach (var (button, overlay) in CreateFooterButtons())
Footer.AddButton(button, overlay);
2018-04-13 09:19:50 +00:00
BeatmapOptions.AddButton(@"Manage", @"collections", FontAwesome.Solid.Book, colours.Green, () => manageCollectionsDialog?.Show());
2020-09-14 18:23:41 +00:00
BeatmapOptions.AddButton(@"Delete", @"all difficulties", FontAwesome.Solid.Trash, colours.Pink, () => delete(Beatmap.Value.BeatmapSetInfo));
BeatmapOptions.AddButton(@"Remove", @"from unplayed", FontAwesome.Regular.TimesCircle, colours.Purple, null);
BeatmapOptions.AddButton(@"Clear", @"local scores", FontAwesome.Solid.Eraser, colours.Purple, () => clearScores(Beatmap.Value.BeatmapInfo));
2017-03-14 13:51:26 +00:00
}
2018-04-13 09:19:50 +00:00
sampleChangeDifficulty = audio.Samples.Get(@"SongSelect/select-difficulty");
sampleChangeBeatmap = audio.Samples.Get(@"SongSelect/select-expand");
SampleConfirm = audio.Samples.Get(@"SongSelect/confirm-selection");
}
protected override void LoadComplete()
{
base.LoadComplete();
modSelectOverlayRegistration = OverlayManager?.RegisterBlockingOverlay(ModSelect);
}
2021-02-01 09:50:32 +00:00
/// <summary>
/// Creates the buttons to be displayed in the footer.
/// </summary>
/// <returns>A set of <see cref="FooterButton"/> and an optional <see cref="OverlayContainer"/> which the button opens when pressed.</returns>
2021-01-27 13:03:51 +00:00
protected virtual IEnumerable<(FooterButton, OverlayContainer)> CreateFooterButtons() => new (FooterButton, OverlayContainer)[]
{
(new FooterButtonMods { Current = Mods }, ModSelect),
(new FooterButtonRandom
{
NextRandom = () => Carousel.SelectNextRandom(),
PreviousRandom = Carousel.SelectPreviousRandom
}, null),
2021-01-27 13:03:51 +00:00
(new FooterButtonOptions(), BeatmapOptions)
};
protected virtual ModSelectOverlay CreateModSelectOverlay() => new UserModSelectOverlay();
2019-11-20 08:24:43 +00:00
protected virtual void ApplyFilterToCarousel(FilterCriteria criteria)
{
// if not the current screen, we want to get carousel in a good presentation state before displaying (resume or enter).
bool shouldDebounce = this.IsCurrentScreen();
Carousel.Filter(criteria, shouldDebounce);
2019-11-20 08:24:43 +00:00
}
2019-11-20 06:43:00 +00:00
private DependencyContainer dependencies;
protected override IReadOnlyDependencyContainer CreateChildDependencies(IReadOnlyDependencyContainer parent)
{
dependencies = new DependencyContainer(base.CreateChildDependencies(parent));
dependencies.CacheAs(this);
2019-02-01 06:42:15 +00:00
dependencies.CacheAs(decoupledRuleset);
dependencies.CacheAs<IBindable<RulesetInfo>>(decoupledRuleset);
return dependencies;
}
2020-02-12 10:52:47 +00:00
/// <summary>
/// Creates the beatmap details to be displayed underneath the wedge.
/// </summary>
protected abstract BeatmapDetailArea CreateBeatmapDetailArea();
2021-10-02 15:55:29 +00:00
public void Edit(BeatmapInfo beatmapInfo = null)
2017-10-06 15:59:14 +00:00
{
if (!AllowEditing)
throw new InvalidOperationException($"Attempted to edit when {nameof(AllowEditing)} is disabled");
2021-10-02 15:55:29 +00:00
Beatmap.Value = beatmaps.GetWorkingBeatmap(beatmapInfo ?? beatmapInfoNoDebounce);
this.Push(new EditorLoader());
2017-10-06 15:59:14 +00:00
}
2018-04-13 09:19:50 +00:00
/// <summary>
/// Call to make a selection and perform the default action for this SongSelect.
/// </summary>
2021-10-02 15:55:29 +00:00
/// <param name="beatmapInfo">An optional beatmap to override the current carousel selection.</param>
/// <param name="ruleset">An optional ruleset to override the current carousel selection.</param>
/// <param name="customStartAction">An optional custom action to perform instead of <see cref="OnStart"/>.</param>
2021-10-02 15:55:29 +00:00
public void FinaliseSelection(BeatmapInfo beatmapInfo = null, RulesetInfo ruleset = null, Action customStartAction = null)
2017-03-14 13:51:26 +00:00
{
// This is very important as we have not yet bound to screen-level bindables before the carousel load is completed.
if (!Carousel.BeatmapSetsLoaded)
return;
if (ruleset != null)
Ruleset.Value = ruleset;
transferRulesetValue();
// while transferRulesetValue will flush, it only does so if the ruleset changes.
// the user could have changed a filter, and we want to ensure we are 100% up-to-date and consistent here.
Carousel.FlushPendingFilterOperations();
2018-04-13 09:19:50 +00:00
// avoid attempting to continue before a selection has been obtained.
// this could happen via a user interaction while the carousel is still in a loading state.
if (Carousel.SelectedBeatmapInfo == null) return;
2021-10-02 15:55:29 +00:00
if (beatmapInfo != null)
Carousel.SelectBeatmap(beatmapInfo);
2018-04-13 09:19:50 +00:00
if (selectionChangedDebounce?.Completed == false)
{
selectionChangedDebounce.RunTask();
selectionChangedDebounce?.Cancel(); // cancel the already scheduled task.
selectionChangedDebounce = null;
}
2018-04-13 09:19:50 +00:00
if (customStartAction != null)
{
customStartAction();
Carousel.AllowSelection = false;
}
else if (OnStart())
Carousel.AllowSelection = false;
2017-03-14 13:51:26 +00:00
}
2018-04-13 09:19:50 +00:00
2017-12-15 03:48:15 +00:00
/// <summary>
/// Called when a selection is made.
/// </summary>
/// <returns>If a resultant action occurred that takes the user away from SongSelect.</returns>
protected abstract bool OnStart();
2018-04-13 09:19:50 +00:00
2017-07-19 04:32:16 +00:00
private ScheduledDelegate selectionChangedDebounce;
2018-04-13 09:19:50 +00:00
2019-02-21 09:56:34 +00:00
private void workingBeatmapChanged(ValueChangedEvent<WorkingBeatmap> e)
2018-03-03 14:24:54 +00:00
{
if (e.NewValue is DummyWorkingBeatmap || !this.IsCurrentScreen()) return;
2018-04-13 09:19:50 +00:00
Logger.Log($"Song select working beatmap updated to {e.NewValue}");
if (!Carousel.SelectBeatmap(e.NewValue.BeatmapInfo, false))
2019-11-11 11:53:22 +00:00
{
// A selection may not have been possible with filters applied.
// There was possibly a ruleset mismatch. This is a case we can help things along by updating the game-wide ruleset to match.
if (!e.NewValue.BeatmapInfo.Ruleset.Equals(decoupledRuleset.Value))
{
2019-02-21 09:56:34 +00:00
Ruleset.Value = e.NewValue.BeatmapInfo.Ruleset;
transferRulesetValue();
}
// Even if a ruleset mismatch was not the cause (ie. a text filter is applied),
// we still want to temporarily show the new beatmap, bypassing filters.
// This will be undone the next time the user changes the filter.
var criteria = FilterControl.CreateCriteria();
criteria.SelectedBeatmapSet = e.NewValue.BeatmapInfo.BeatmapSet;
Carousel.Filter(criteria);
Carousel.SelectBeatmap(e.NewValue.BeatmapInfo);
2019-11-11 11:53:22 +00:00
}
2018-03-03 14:24:54 +00:00
}
2018-04-13 09:19:50 +00:00
// We need to keep track of the last selected beatmap ignoring debounce to play the correct selection sounds.
private BeatmapInfo beatmapInfoPrevious;
2021-10-02 15:55:29 +00:00
private BeatmapInfo beatmapInfoNoDebounce;
private RulesetInfo rulesetNoDebounce;
2021-10-02 15:55:29 +00:00
private void updateSelectedBeatmap(BeatmapInfo beatmapInfo)
{
2021-10-02 15:55:29 +00:00
if (beatmapInfo == null && beatmapInfoNoDebounce == null)
return;
2021-10-02 15:55:29 +00:00
if (beatmapInfo?.Equals(beatmapInfoNoDebounce) == true)
return;
2021-10-02 15:55:29 +00:00
beatmapInfoNoDebounce = beatmapInfo;
performUpdateSelected();
}
private void updateSelectedRuleset(RulesetInfo ruleset)
{
if (ruleset == null && rulesetNoDebounce == null)
return;
if (ruleset?.Equals(rulesetNoDebounce) == true)
return;
rulesetNoDebounce = ruleset;
performUpdateSelected();
}
2017-07-19 04:32:16 +00:00
/// <summary>
/// Selection has been changed as the result of a user interaction.
2017-07-19 04:32:16 +00:00
/// </summary>
private void performUpdateSelected()
2017-07-19 04:32:16 +00:00
{
2021-10-02 15:55:29 +00:00
var beatmap = beatmapInfoNoDebounce;
var ruleset = rulesetNoDebounce;
2019-03-21 11:51:21 +00:00
selectionChangedDebounce?.Cancel();
2021-10-02 15:55:29 +00:00
if (beatmapInfoNoDebounce == null)
2019-03-21 11:51:21 +00:00
run();
else
selectionChangedDebounce = Scheduler.AddDelayed(run, 200);
if (beatmap?.Equals(beatmapInfoPrevious) != true)
{
2021-11-11 10:20:50 +00:00
if (beatmap != null && beatmapInfoPrevious != null && Time.Current - audioFeedbackLastPlaybackTime >= 50)
{
if (beatmap.BeatmapSet?.ID == beatmapInfoPrevious.BeatmapSet?.ID)
sampleChangeDifficulty.Play();
else
sampleChangeBeatmap.Play();
2021-11-11 10:20:50 +00:00
audioFeedbackLastPlaybackTime = Time.Current;
}
beatmapInfoPrevious = beatmap;
}
void run()
2017-07-19 04:32:16 +00:00
{
// clear pending task immediately to track any potential nested debounce operation.
selectionChangedDebounce = null;
Logger.Log($"updating selection with beatmap:{beatmap?.ID.ToString() ?? "null"} ruleset:{ruleset?.ShortName ?? "null"}");
2018-07-19 09:51:08 +00:00
if (transferRulesetValue())
{
Mods.Value = Array.Empty<Mod>();
// transferRulesetValue() may trigger a re-filter. If the current selection does not match the new ruleset, we want to switch away from it.
// The default logic on WorkingBeatmap change is to switch to a matching ruleset (see workingBeatmapChanged()), but we don't want that here.
// We perform an early selection attempt and clear out the beatmap selection to avoid a second ruleset change (revert).
if (beatmap != null && !Carousel.SelectBeatmap(beatmap, false))
beatmap = null;
}
if (selectionChangedDebounce != null)
{
// a new nested operation was started; switch to it for further selection.
// this avoids having two separate debounces trigger from the same source.
selectionChangedDebounce.RunTask();
return;
}
// We may be arriving here due to another component changing the bindable Beatmap.
// In these cases, the other component has already loaded the beatmap, so we don't need to do so again.
if (!EqualityComparer<BeatmapInfo>.Default.Equals(beatmap, Beatmap.Value.BeatmapInfo))
{
Logger.Log($"beatmap changed from \"{Beatmap.Value.BeatmapInfo}\" to \"{beatmap}\"");
Beatmap.Value = beatmaps.GetWorkingBeatmap(beatmap);
}
2018-04-13 09:19:50 +00:00
if (this.IsCurrentScreen())
ensurePlayingSelected();
updateComponentFromBeatmap(Beatmap.Value);
2018-01-15 18:42:17 +00:00
}
2017-07-19 04:32:16 +00:00
}
2018-04-13 09:19:50 +00:00
public override void OnEntering(ScreenTransitionEvent e)
2016-10-28 10:55:48 +00:00
{
base.OnEntering(e);
2018-04-13 09:19:50 +00:00
2019-01-23 11:52:00 +00:00
this.FadeInFromZero(250);
FilterControl.Activate();
ModSelect.SelectedMods.BindTo(selectedMods);
beginLooping();
2016-10-28 10:55:48 +00:00
}
2018-04-13 09:19:50 +00:00
private const double logo_transition = 250;
2018-04-13 09:19:50 +00:00
2017-11-09 08:38:20 +00:00
protected override void LogoArriving(OsuLogo logo, bool resuming)
{
2017-11-09 08:38:20 +00:00
base.LogoArriving(logo, resuming);
2018-04-13 09:19:50 +00:00
Vector2 position = new Vector2(0.95f, 0.96f);
2018-04-13 09:19:50 +00:00
if (logo.Alpha > 0.8f)
{
logo.MoveTo(position, 500, Easing.OutQuint);
}
else
{
logo.Hide();
logo.ScaleTo(0.2f);
logo.MoveTo(position);
}
2018-04-13 09:19:50 +00:00
logo.FadeIn(logo_transition, Easing.OutQuint);
logo.ScaleTo(0.4f, logo_transition, Easing.OutQuint);
2018-04-13 09:19:50 +00:00
logo.Action = () =>
{
FinaliseSelection();
return false;
};
}
2018-04-13 09:19:50 +00:00
2017-11-09 08:38:20 +00:00
protected override void LogoExiting(OsuLogo logo)
{
2017-11-09 08:38:20 +00:00
base.LogoExiting(logo);
logo.ScaleTo(0.2f, logo_transition / 2, Easing.Out);
logo.FadeOut(logo_transition / 2, Easing.Out);
}
2018-04-13 09:19:50 +00:00
public override void OnResuming(ScreenTransitionEvent e)
2016-10-28 10:55:48 +00:00
{
base.OnResuming(e);
// required due to https://github.com/ppy/osu-framework/issues/3218
ModSelect.SelectedMods.Disabled = false;
ModSelect.SelectedMods.BindTo(selectedMods);
Carousel.AllowSelection = true;
2020-02-12 10:52:47 +00:00
BeatmapDetails.Refresh();
beginLooping();
2017-07-19 04:32:16 +00:00
if (Beatmap != null && !Beatmap.Value.BeatmapSetInfo.DeletePending)
2017-07-19 01:59:13 +00:00
{
updateComponentFromBeatmap(Beatmap.Value);
if (ControlGlobalMusic)
{
// restart playback on returning to song select, regardless.
// not sure this should be a permanent thing (we may want to leave a user pause paused even on returning)
music.ResetTrackAdjustments();
music.Play(requestedByUser: true);
}
2017-07-19 01:59:13 +00:00
}
2018-04-13 09:19:50 +00:00
2019-01-23 11:52:00 +00:00
this.FadeIn(250);
2018-04-13 09:19:50 +00:00
2019-01-23 11:52:00 +00:00
this.ScaleTo(1, 250, Easing.OutSine);
2018-04-13 09:19:50 +00:00
FilterControl.Activate();
}
2018-04-13 09:19:50 +00:00
public override void OnSuspending(ScreenTransitionEvent e)
{
// Handle the case where FinaliseSelection is never called (ie. when a screen is pushed externally).
// Without this, it's possible for a transfer to happen while we are not the current screen.
transferRulesetValue();
ModSelect.SelectedMods.UnbindFrom(selectedMods);
2018-12-06 10:29:18 +00:00
ModSelect.Hide();
2019-05-12 04:26:42 +00:00
BeatmapOptions.Hide();
endLooping();
2019-01-23 11:52:00 +00:00
this.ScaleTo(1.1f, 250, Easing.InSine);
2018-04-13 09:19:50 +00:00
2019-01-23 11:52:00 +00:00
this.FadeOut(250);
2018-04-13 09:19:50 +00:00
FilterControl.Deactivate();
base.OnSuspending(e);
}
2018-04-13 09:19:50 +00:00
public override bool OnExiting(ScreenExitEvent e)
{
if (base.OnExiting(e))
return true;
beatmapInfoWedge.Hide();
ModSelect.Hide();
2018-04-13 09:19:50 +00:00
2019-01-23 11:52:00 +00:00
this.FadeOut(100);
2018-04-13 09:19:50 +00:00
FilterControl.Deactivate();
2018-04-13 09:19:50 +00:00
endLooping();
return false;
2016-10-28 10:55:48 +00:00
}
2018-04-13 09:19:50 +00:00
private bool isHandlingLooping;
private void beginLooping()
{
if (!ControlGlobalMusic)
return;
Debug.Assert(!isHandlingLooping);
isHandlingLooping = true;
ensureTrackLooping(Beatmap.Value, TrackChangeDirection.None);
music.TrackChanged += ensureTrackLooping;
}
private void endLooping()
{
// may be called multiple times during screen exit process.
if (!isHandlingLooping)
return;
music.CurrentTrack.Looping = isHandlingLooping = false;
music.TrackChanged -= ensureTrackLooping;
}
private void ensureTrackLooping(IWorkingBeatmap beatmap, TrackChangeDirection changeDirection)
=> beatmap.PrepareTrackForPreviewLooping();
public override bool OnBackButton()
{
if (ModSelect.State.Value == Visibility.Visible)
{
ModSelect.Hide();
return true;
}
return false;
2016-10-28 10:55:48 +00:00
}
2018-04-13 09:19:50 +00:00
2016-10-08 10:12:31 +00:00
protected override void Dispose(bool isDisposing)
{
base.Dispose(isDisposing);
2018-04-13 09:19:50 +00:00
2019-02-01 06:42:15 +00:00
decoupledRuleset.UnbindAll();
if (music != null)
music.TrackChanged -= ensureTrackLooping;
modSelectOverlayRegistration?.Dispose();
2016-10-06 14:33:28 +00:00
}
2018-04-13 09:19:50 +00:00
/// <summary>
/// Allow components in SongSelect to update their loaded beatmap details.
/// This is a debounced call (unlike directly binding to WorkingBeatmap.ValueChanged).
/// </summary>
/// <param name="beatmap">The working beatmap.</param>
private void updateComponentFromBeatmap(WorkingBeatmap beatmap)
2016-10-26 14:52:04 +00:00
{
ApplyToBackground(backgroundModeBeatmap =>
{
backgroundModeBeatmap.Beatmap = beatmap;
backgroundModeBeatmap.BlurAmount.Value = BACKGROUND_BLUR;
backgroundModeBeatmap.FadeColour(Color4.White, 250);
});
2018-04-13 09:19:50 +00:00
beatmapInfoWedge.Beatmap = beatmap;
BeatmapDetails.Beatmap = beatmap;
}
2018-04-13 09:19:50 +00:00
2020-08-05 12:10:38 +00:00
private readonly WeakReference<ITrack> lastTrack = new WeakReference<ITrack>(null);
/// <summary>
/// Ensures some music is playing for the current track.
/// Will resume playback from a manual user pause if the track has changed.
/// </summary>
private void ensurePlayingSelected()
2016-10-28 10:55:48 +00:00
{
if (!ControlGlobalMusic)
return;
2020-08-11 03:40:58 +00:00
ITrack track = music.CurrentTrack;
2018-04-13 09:19:50 +00:00
bool isNewTrack = !lastTrack.TryGetTarget(out var last) || last != track;
if (!track.IsRunning && (music.UserPauseRequested != true || isNewTrack))
2020-08-11 03:40:58 +00:00
music.Play(true);
lastTrack.SetTarget(track);
2016-10-28 10:55:48 +00:00
}
2018-04-13 09:19:50 +00:00
2017-12-15 03:48:15 +00:00
private void carouselBeatmapsLoaded()
{
bindBindables();
Carousel.AllowSelection = true;
2019-06-12 07:07:35 +00:00
// If a selection was already obtained, do not attempt to update the selected beatmap.
2019-05-28 05:04:33 +00:00
if (Carousel.SelectedBeatmapSet != null)
return;
// Attempt to select the current beatmap on the carousel, if it is valid to be selected.
if (!Beatmap.IsDefault && Beatmap.Value.BeatmapSetInfo?.DeletePending == false && Beatmap.Value.BeatmapSetInfo?.Protected == false)
{
if (Carousel.SelectBeatmap(Beatmap.Value.BeatmapInfo, false))
return;
// prefer not changing ruleset at this point, so look for another difficulty in the currently playing beatmap
var found = Beatmap.Value.BeatmapSetInfo.Beatmaps.FirstOrDefault(b => b.Ruleset.Equals(decoupledRuleset.Value));
if (found != null && Carousel.SelectBeatmap(found, false))
return;
}
2018-04-13 09:19:50 +00:00
2019-05-28 05:04:33 +00:00
// If the current active beatmap could not be selected, select a new random beatmap.
if (!Carousel.SelectNextRandom())
{
// in the case random selection failed, we want to trigger selectionChanged
// to show the dummy beatmap (we have nothing else to display).
performUpdateSelected();
}
2017-12-15 03:48:15 +00:00
}
2018-04-13 09:19:50 +00:00
private bool boundLocalBindables;
private void bindBindables()
{
if (boundLocalBindables)
return;
// manual binding to parent ruleset to allow for delayed load in the incoming direction.
transferRulesetValue();
Ruleset.ValueChanged += r => updateSelectedRuleset(r.NewValue);
decoupledRuleset.ValueChanged += r => Ruleset.Value = r.NewValue;
decoupledRuleset.DisabledChanged += r => Ruleset.Disabled = r;
Beatmap.BindValueChanged(workingBeatmapChanged);
boundLocalBindables = true;
}
/// <summary>
/// Transfer the game-wide ruleset to the local decoupled ruleset.
/// Will immediately run filter operations if required.
/// </summary>
/// <returns>Whether a transfer occurred.</returns>
private bool transferRulesetValue()
{
if (decoupledRuleset.Value?.Equals(Ruleset.Value) == true)
return false;
Logger.Log($"decoupled ruleset transferred (\"{decoupledRuleset.Value}\" -> \"{Ruleset.Value}\")");
rulesetNoDebounce = decoupledRuleset.Value = Ruleset.Value;
// if we have a pending filter operation, we want to run it now.
// it could change selection (ie. if the ruleset has been changed).
Carousel?.FlushPendingFilterOperations();
return true;
}
2017-12-15 03:48:15 +00:00
private void delete(BeatmapSetInfo beatmap)
{
if (beatmap == null) return;
2017-08-30 11:41:41 +00:00
dialogOverlay?.Push(new BeatmapDeleteDialog(beatmap));
2017-03-02 12:40:55 +00:00
}
2018-04-13 09:19:50 +00:00
2021-10-02 15:55:29 +00:00
private void clearScores(BeatmapInfo beatmapInfo)
2019-01-04 19:13:32 +00:00
{
if (beatmapInfo == null) return;
2019-01-04 19:13:32 +00:00
2021-10-02 15:55:29 +00:00
dialogOverlay?.Push(new BeatmapClearScoresDialog(beatmapInfo, () =>
// schedule done here rather than inside the dialog as the dialog may fade out and never callback.
2020-02-12 10:52:47 +00:00
Schedule(() => BeatmapDetails.Refresh())));
2019-01-04 19:13:32 +00:00
}
2021-09-16 09:26:12 +00:00
public virtual bool OnPressed(KeyBindingPressEvent<GlobalAction> e)
{
if (e.Repeat)
return false;
2019-01-23 11:52:00 +00:00
if (!this.IsCurrentScreen()) return false;
2021-09-16 09:26:12 +00:00
switch (e.Action)
{
case GlobalAction.Select:
FinaliseSelection();
return true;
}
return false;
}
2021-09-16 09:26:12 +00:00
public void OnReleased(KeyBindingReleaseEvent<GlobalAction> e)
{
}
2018-10-02 03:02:47 +00:00
protected override bool OnKeyDown(KeyDownEvent e)
2016-12-15 11:55:37 +00:00
{
2018-10-02 03:02:47 +00:00
if (e.Repeat) return false;
2018-04-13 09:19:50 +00:00
2018-10-02 03:02:47 +00:00
switch (e.Key)
2016-12-15 11:55:37 +00:00
{
2017-03-14 13:51:26 +00:00
case Key.Delete:
if (e.ShiftPressed)
2017-03-14 13:51:26 +00:00
{
2017-08-30 11:41:41 +00:00
if (!Beatmap.IsDefault)
2017-12-15 03:48:15 +00:00
delete(Beatmap.Value.BeatmapSetInfo);
2017-03-14 13:51:26 +00:00
return true;
}
2018-04-13 09:19:50 +00:00
2017-03-14 13:51:26 +00:00
break;
2016-12-15 11:55:37 +00:00
}
2018-04-13 09:19:50 +00:00
2018-10-02 03:02:47 +00:00
return base.OnKeyDown(e);
2016-12-15 11:55:37 +00:00
}
2018-04-13 09:19:50 +00:00
private class VerticalMaskingContainer : Container
{
private const float panel_overflow = 1.2f;
protected override Container<Drawable> Content { get; }
public VerticalMaskingContainer()
{
RelativeSizeAxes = Axes.Both;
Masking = true;
Anchor = Anchor.Centre;
Origin = Anchor.Centre;
2020-05-05 01:31:11 +00:00
Width = panel_overflow; // avoid horizontal masking so the panels don't clip when screen stack is pushed.
InternalChild = Content = new Container
{
RelativeSizeAxes = Axes.Both,
Anchor = Anchor.Centre,
Origin = Anchor.Centre,
Width = 1 / panel_overflow,
};
}
}
2017-07-31 11:20:12 +00:00
private class ResetScrollContainer : Container
2017-07-29 14:33:20 +00:00
{
2017-07-31 11:20:12 +00:00
private readonly Action onHoverAction;
2018-04-13 09:19:50 +00:00
2017-07-31 11:20:12 +00:00
public ResetScrollContainer(Action onHoverAction)
{
this.onHoverAction = onHoverAction;
}
2018-04-13 09:19:50 +00:00
2018-10-02 03:02:47 +00:00
protected override bool OnHover(HoverEvent e)
2017-07-29 14:33:20 +00:00
{
2017-07-31 11:20:12 +00:00
onHoverAction?.Invoke();
2018-10-02 03:02:47 +00:00
return base.OnHover(e);
2017-07-29 14:33:20 +00:00
}
}
2016-09-29 11:13:58 +00:00
}
}