2019-01-24 08:43:03 +00:00
|
|
|
|
// 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
|
|
|
|
|
2020-10-30 21:40:24 +00:00
|
|
|
|
using System.Threading;
|
2018-04-13 09:19:50 +00:00
|
|
|
|
using osu.Framework.Allocation;
|
2019-02-21 10:04:31 +00:00
|
|
|
|
using osu.Framework.Bindables;
|
2018-04-13 09:19:50 +00:00
|
|
|
|
using osu.Framework.Graphics;
|
|
|
|
|
using osu.Framework.Threading;
|
2021-06-07 08:22:30 +00:00
|
|
|
|
using osu.Framework.Utils;
|
2019-09-24 09:42:06 +00:00
|
|
|
|
using osu.Game.Beatmaps;
|
|
|
|
|
using osu.Game.Configuration;
|
2018-04-13 09:19:50 +00:00
|
|
|
|
using osu.Game.Graphics.Backgrounds;
|
2018-12-27 08:25:28 +00:00
|
|
|
|
using osu.Game.Online.API;
|
2021-11-04 09:02:44 +00:00
|
|
|
|
using osu.Game.Online.API.Requests.Responses;
|
2018-12-27 08:25:28 +00:00
|
|
|
|
using osu.Game.Skinning;
|
2018-04-13 09:19:50 +00:00
|
|
|
|
|
|
|
|
|
namespace osu.Game.Screens.Backgrounds
|
|
|
|
|
{
|
2019-03-14 07:09:17 +00:00
|
|
|
|
public class BackgroundScreenDefault : BackgroundScreen
|
2018-04-13 09:19:50 +00:00
|
|
|
|
{
|
2019-03-20 05:17:35 +00:00
|
|
|
|
private Background background;
|
|
|
|
|
|
2018-04-13 09:19:50 +00:00
|
|
|
|
private int currentDisplay;
|
2019-07-02 08:57:23 +00:00
|
|
|
|
private const int background_count = 7;
|
2021-11-04 09:02:44 +00:00
|
|
|
|
private IBindable<APIUser> user;
|
2018-12-27 08:25:28 +00:00
|
|
|
|
private Bindable<Skin> skin;
|
2019-11-21 17:38:31 +00:00
|
|
|
|
private Bindable<BackgroundSource> mode;
|
2020-07-02 17:12:45 +00:00
|
|
|
|
private Bindable<IntroSequence> introSequence;
|
2020-10-29 16:43:10 +00:00
|
|
|
|
private readonly SeasonalBackgroundLoader seasonalBackgroundLoader = new SeasonalBackgroundLoader();
|
2019-09-24 09:42:06 +00:00
|
|
|
|
|
|
|
|
|
[Resolved]
|
|
|
|
|
private IBindable<WorkingBeatmap> beatmap { get; set; }
|
2018-12-27 08:25:28 +00:00
|
|
|
|
|
2021-06-03 05:24:21 +00:00
|
|
|
|
protected virtual bool AllowStoryboardBackground => true;
|
|
|
|
|
|
2019-08-09 11:05:28 +00:00
|
|
|
|
public BackgroundScreenDefault(bool animateOnEnter = true)
|
|
|
|
|
: base(animateOnEnter)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
2018-04-13 09:19:50 +00:00
|
|
|
|
[BackgroundDependencyLoader]
|
2019-09-24 09:42:06 +00:00
|
|
|
|
private void load(IAPIProvider api, SkinManager skinManager, OsuConfigManager config)
|
2018-04-13 09:19:50 +00:00
|
|
|
|
{
|
2018-12-27 08:25:28 +00:00
|
|
|
|
user = api.LocalUser.GetBoundCopy();
|
|
|
|
|
skin = skinManager.CurrentSkin.GetBoundCopy();
|
2019-11-21 17:38:31 +00:00
|
|
|
|
mode = config.GetBindable<BackgroundSource>(OsuSetting.MenuBackgroundSource);
|
2020-07-02 17:12:45 +00:00
|
|
|
|
introSequence = config.GetBindable<IntroSequence>(OsuSetting.IntroSequence);
|
2018-12-27 08:25:28 +00:00
|
|
|
|
|
2020-10-31 13:51:31 +00:00
|
|
|
|
AddInternal(seasonalBackgroundLoader);
|
|
|
|
|
|
2021-12-14 06:17:01 +00:00
|
|
|
|
user.ValueChanged += _ => Scheduler.AddOnce(loadNextIfRequired);
|
|
|
|
|
skin.ValueChanged += _ => Scheduler.AddOnce(loadNextIfRequired);
|
|
|
|
|
mode.ValueChanged += _ => Scheduler.AddOnce(loadNextIfRequired);
|
|
|
|
|
beatmap.ValueChanged += _ => Scheduler.AddOnce(loadNextIfRequired);
|
|
|
|
|
introSequence.ValueChanged += _ => Scheduler.AddOnce(loadNextIfRequired);
|
|
|
|
|
seasonalBackgroundLoader.SeasonalBackgroundChanged += () => Scheduler.AddOnce(loadNextIfRequired);
|
2018-12-27 08:25:28 +00:00
|
|
|
|
|
2018-09-20 17:55:24 +00:00
|
|
|
|
currentDisplay = RNG.Next(0, background_count);
|
2018-12-27 08:25:28 +00:00
|
|
|
|
|
2020-10-30 21:40:24 +00:00
|
|
|
|
Next();
|
2021-12-14 06:17:01 +00:00
|
|
|
|
|
|
|
|
|
// helper function required for AddOnce usage.
|
|
|
|
|
void loadNextIfRequired() => Next();
|
2018-04-13 09:19:50 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private ScheduledDelegate nextTask;
|
2020-10-30 21:40:24 +00:00
|
|
|
|
private CancellationTokenSource cancellationTokenSource;
|
2018-04-13 09:19:50 +00:00
|
|
|
|
|
2021-06-07 08:22:30 +00:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Request loading the next background.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <returns>Whether a new background was queued for load. May return false if the current background is still valid.</returns>
|
2021-12-14 07:10:53 +00:00
|
|
|
|
public virtual bool Next()
|
2018-04-13 09:19:50 +00:00
|
|
|
|
{
|
2021-06-07 08:22:30 +00:00
|
|
|
|
var nextBackground = createBackground();
|
|
|
|
|
|
|
|
|
|
// in the case that the background hasn't changed, we want to avoid cancelling any tasks that could still be loading.
|
|
|
|
|
if (nextBackground == background)
|
|
|
|
|
return false;
|
|
|
|
|
|
2020-10-30 21:40:24 +00:00
|
|
|
|
cancellationTokenSource?.Cancel();
|
|
|
|
|
cancellationTokenSource = new CancellationTokenSource();
|
2019-03-11 15:05:05 +00:00
|
|
|
|
|
2021-06-07 08:22:30 +00:00
|
|
|
|
nextTask?.Cancel();
|
|
|
|
|
nextTask = Scheduler.AddDelayed(() =>
|
|
|
|
|
{
|
|
|
|
|
LoadComponentAsync(nextBackground, displayNext, cancellationTokenSource.Token);
|
|
|
|
|
}, 100);
|
2018-12-27 08:25:28 +00:00
|
|
|
|
|
2021-06-07 08:22:30 +00:00
|
|
|
|
return true;
|
|
|
|
|
}
|
2020-10-30 16:16:51 +00:00
|
|
|
|
|
2021-06-07 08:22:30 +00:00
|
|
|
|
private void displayNext(Background newBackground)
|
|
|
|
|
{
|
|
|
|
|
background?.FadeOut(800, Easing.InOutSine);
|
|
|
|
|
background?.Expire();
|
2020-10-30 16:16:51 +00:00
|
|
|
|
|
2021-06-07 08:22:30 +00:00
|
|
|
|
AddInternal(background = newBackground);
|
|
|
|
|
currentDisplay++;
|
|
|
|
|
}
|
2020-07-02 17:12:45 +00:00
|
|
|
|
|
2021-06-07 08:22:30 +00:00
|
|
|
|
private Background createBackground()
|
|
|
|
|
{
|
|
|
|
|
// seasonal background loading gets highest priority.
|
|
|
|
|
Background newBackground = seasonalBackgroundLoader.LoadNextBackground();
|
2020-07-02 17:12:45 +00:00
|
|
|
|
|
2021-06-07 08:22:30 +00:00
|
|
|
|
if (newBackground == null && user.Value?.IsSupporter == true)
|
2019-09-24 09:42:06 +00:00
|
|
|
|
{
|
|
|
|
|
switch (mode.Value)
|
|
|
|
|
{
|
2019-11-21 17:38:31 +00:00
|
|
|
|
case BackgroundSource.Beatmap:
|
2021-06-02 07:51:43 +00:00
|
|
|
|
case BackgroundSource.BeatmapWithStoryboard:
|
2021-06-07 08:22:30 +00:00
|
|
|
|
{
|
2021-06-07 08:32:04 +00:00
|
|
|
|
if (mode.Value == BackgroundSource.BeatmapWithStoryboard && AllowStoryboardBackground)
|
|
|
|
|
newBackground = new BeatmapBackgroundWithStoryboard(beatmap.Value, getBackgroundTextureName());
|
|
|
|
|
newBackground ??= new BeatmapBackground(beatmap.Value, getBackgroundTextureName());
|
|
|
|
|
|
2019-09-24 09:42:06 +00:00
|
|
|
|
break;
|
2021-06-07 08:22:30 +00:00
|
|
|
|
}
|
2021-06-08 20:04:59 +00:00
|
|
|
|
|
|
|
|
|
case BackgroundSource.Skin:
|
2021-06-09 05:59:47 +00:00
|
|
|
|
// default skins should use the default background rotation, which won't be the case if a SkinBackground is created for them.
|
|
|
|
|
if (skin.Value is DefaultSkin || skin.Value is DefaultLegacySkin)
|
|
|
|
|
break;
|
|
|
|
|
|
2021-06-08 20:04:59 +00:00
|
|
|
|
newBackground = new SkinBackground(skin.Value, getBackgroundTextureName());
|
|
|
|
|
break;
|
2019-09-24 09:42:06 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
2018-12-27 08:25:28 +00:00
|
|
|
|
|
2021-06-08 20:26:15 +00:00
|
|
|
|
// this method is called in many cases where the background might not necessarily need to change.
|
|
|
|
|
// if an equivalent background is currently being shown, we don't want to load it again.
|
|
|
|
|
if (newBackground?.Equals(background) == true)
|
|
|
|
|
return background;
|
|
|
|
|
|
2021-06-07 08:22:30 +00:00
|
|
|
|
newBackground ??= new Background(getBackgroundTextureName());
|
2019-03-20 06:13:59 +00:00
|
|
|
|
newBackground.Depth = currentDisplay;
|
2018-12-27 08:25:28 +00:00
|
|
|
|
|
2019-03-20 06:13:59 +00:00
|
|
|
|
return newBackground;
|
2018-04-13 09:19:50 +00:00
|
|
|
|
}
|
2018-12-27 08:25:28 +00:00
|
|
|
|
|
2021-06-07 08:22:30 +00:00
|
|
|
|
private string getBackgroundTextureName()
|
|
|
|
|
{
|
|
|
|
|
switch (introSequence.Value)
|
|
|
|
|
{
|
|
|
|
|
case IntroSequence.Welcome:
|
|
|
|
|
return @"Intro/Welcome/menu-background";
|
|
|
|
|
|
|
|
|
|
default:
|
|
|
|
|
return $@"Menu/menu-background-{currentDisplay % background_count + 1}";
|
|
|
|
|
}
|
|
|
|
|
}
|
2018-04-13 09:19:50 +00:00
|
|
|
|
}
|
|
|
|
|
}
|