osu/osu.Game/Screens/Backgrounds/BackgroundScreenDefault.cs

155 lines
5.9 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.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;
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;
using osu.Game.Online.API;
using osu.Game.Online.API.Requests.Responses;
using osu.Game.Skinning;
2018-04-13 09:19:50 +00:00
namespace osu.Game.Screens.Backgrounds
{
public class BackgroundScreenDefault : BackgroundScreen
2018-04-13 09:19:50 +00:00
{
private Background background;
2018-04-13 09:19:50 +00:00
private int currentDisplay;
private const int background_count = 7;
private IBindable<APIUser> user;
private Bindable<Skin> skin;
2019-11-21 17:38:31 +00:00
private Bindable<BackgroundSource> mode;
private Bindable<IntroSequence> introSequence;
private readonly SeasonalBackgroundLoader seasonalBackgroundLoader = new SeasonalBackgroundLoader();
2019-09-24 09:42:06 +00:00
[Resolved]
private IBindable<WorkingBeatmap> beatmap { get; set; }
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
{
user = api.LocalUser.GetBoundCopy();
skin = skinManager.CurrentSkin.GetBoundCopy();
2019-11-21 17:38:31 +00:00
mode = config.GetBindable<BackgroundSource>(OsuSetting.MenuBackgroundSource);
introSequence = config.GetBindable<IntroSequence>(OsuSetting.IntroSequence);
AddInternal(seasonalBackgroundLoader);
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);
currentDisplay = RNG.Next(0, background_count);
Next();
// helper function required for AddOnce usage.
void loadNextIfRequired() => Next();
2018-04-13 09:19:50 +00:00
}
private ScheduledDelegate nextTask;
private CancellationTokenSource cancellationTokenSource;
2018-04-13 09:19:50 +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>
public virtual bool Next()
2018-04-13 09:19:50 +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;
cancellationTokenSource?.Cancel();
cancellationTokenSource = new CancellationTokenSource();
nextTask?.Cancel();
nextTask = Scheduler.AddDelayed(() =>
{
LoadComponentAsync(nextBackground, displayNext, cancellationTokenSource.Token);
}, 100);
return true;
}
private void displayNext(Background newBackground)
{
background?.FadeOut(800, Easing.InOutSine);
background?.Expire();
AddInternal(background = newBackground);
currentDisplay++;
}
private Background createBackground()
{
// seasonal background loading gets highest priority.
Background newBackground = seasonalBackgroundLoader.LoadNextBackground();
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:
case BackgroundSource.BeatmapWithStoryboard:
{
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-08 20:04:59 +00:00
case BackgroundSource.Skin:
// 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
}
}
// 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;
newBackground ??= new Background(getBackgroundTextureName());
2019-03-20 06:13:59 +00:00
newBackground.Depth = currentDisplay;
2019-03-20 06:13:59 +00:00
return newBackground;
2018-04-13 09:19:50 +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
}
}