osu/osu.Game/Screens/Menu/IntroScreen.cs

245 lines
8.1 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.
using System;
using System.Linq;
using JetBrains.Annotations;
using osu.Framework.Allocation;
using osu.Framework.Audio;
using osu.Framework.Audio.Sample;
2019-09-23 12:52:44 +00:00
using osu.Framework.Audio.Track;
using osu.Framework.Bindables;
using osu.Framework.Graphics;
using osu.Framework.Screens;
using osu.Framework.Utils;
using osu.Game.Beatmaps;
using osu.Game.Configuration;
2019-09-23 12:52:44 +00:00
using osu.Game.IO.Archives;
using osu.Game.Overlays;
using osu.Game.Screens.Backgrounds;
2019-09-23 12:52:44 +00:00
using osu.Game.Skinning;
using osuTK;
using osuTK.Graphics;
namespace osu.Game.Screens.Menu
{
public abstract class IntroScreen : StartupScreen
{
2019-10-08 03:05:52 +00:00
/// <summary>
/// Whether we have loaded the menu previously.
/// </summary>
public bool DidLoadMenu { get; private set; }
2019-10-08 02:52:16 +00:00
/// <summary>
/// A hash used to find the associated beatmap if already imported.
/// </summary>
2019-09-23 12:52:44 +00:00
protected abstract string BeatmapHash { get; }
2019-10-08 02:52:16 +00:00
/// <summary>
/// A source file to use as an import source if the intro beatmap is not yet present.
/// Should be within the "Tracks" namespace of game resources.
/// </summary>
2019-09-23 12:52:44 +00:00
protected abstract string BeatmapFile { get; }
2019-10-08 03:08:47 +00:00
protected IBindable<bool> MenuVoice { get; private set; }
2019-09-23 12:52:44 +00:00
2019-10-08 03:08:47 +00:00
protected IBindable<bool> MenuMusic { get; private set; }
2019-09-23 12:52:44 +00:00
private WorkingBeatmap initialBeatmap;
2019-10-08 03:05:52 +00:00
2020-08-06 09:54:08 +00:00
protected ITrack Track { get; private set; }
2019-09-23 12:52:44 +00:00
2019-10-08 03:05:52 +00:00
private const int exit_delay = 3000;
2021-01-19 08:11:40 +00:00
private Sample seeya;
protected virtual string SeeyaSampleName => "Intro/seeya";
private LeasedBindable<WorkingBeatmap> beatmap;
private OsuScreen nextScreen;
2019-10-08 03:05:52 +00:00
[Resolved]
private AudioManager audio { get; set; }
2019-10-08 03:03:42 +00:00
[Resolved]
private MusicController musicController { get; set; }
[CanBeNull]
private readonly Func<OsuScreen> createNextScreen;
/// <summary>
/// Whether the <see cref="Track"/> is provided by osu! resources, rather than a user beatmap.
2020-08-21 06:50:14 +00:00
/// Only valid during or after <see cref="LogoArriving"/>.
/// </summary>
protected bool UsingThemedIntro { get; private set; }
protected IntroScreen([CanBeNull] Func<MainMenu> createNextScreen = null)
{
this.createNextScreen = createNextScreen;
}
[BackgroundDependencyLoader]
2019-09-24 10:17:27 +00:00
private void load(OsuConfigManager config, SkinManager skinManager, BeatmapManager beatmaps, Framework.Game game)
{
2019-08-21 05:01:07 +00:00
// prevent user from changing beatmap while the intro is still runnning.
2019-10-08 03:04:13 +00:00
beatmap = Beatmap.BeginLease(false);
2019-09-23 12:52:44 +00:00
MenuVoice = config.GetBindable<bool>(OsuSetting.MenuVoice);
MenuMusic = config.GetBindable<bool>(OsuSetting.MenuMusic);
seeya = audio.Samples.Get(SeeyaSampleName);
2019-09-23 12:52:44 +00:00
BeatmapSetInfo setInfo = null;
// if the user has requested not to play theme music, we should attempt to find a random beatmap from their collection.
2019-09-23 12:52:44 +00:00
if (!MenuMusic.Value)
{
var sets = beatmaps.GetAllUsableBeatmapSets(IncludedDetails.Minimal);
2019-09-23 12:52:44 +00:00
if (sets.Count > 0)
{
2019-09-23 12:52:44 +00:00
setInfo = beatmaps.QueryBeatmapSet(s => s.ID == sets[RNG.Next(0, sets.Count - 1)].ID);
initialBeatmap = beatmaps.GetWorkingBeatmap(setInfo.Beatmaps[0]);
}
2019-09-23 12:52:44 +00:00
}
// we generally want a song to be playing on startup, so use the intro music even if a user has specified not to if no other track is available.
2019-09-23 12:52:44 +00:00
if (setInfo == null)
{
if (!loadThemedIntro())
2019-09-23 12:52:44 +00:00
{
// if we detect that the theme track or beatmap is unavailable this is either first startup or things are in a bad state.
// this could happen if a user has nuked their files store. for now, reimport to repair this.
var import = beatmaps.Import(new ZipArchiveReader(game.Resources.GetStream($"Tracks/{BeatmapFile}"), BeatmapFile)).Result;
import.PerformWrite(b =>
{
b.Protected = true;
beatmaps.Update(b);
});
2019-09-23 12:52:44 +00:00
loadThemedIntro();
2019-09-23 12:52:44 +00:00
}
}
bool loadThemedIntro()
{
setInfo = beatmaps.QueryBeatmapSets(b => b.Hash == BeatmapHash, IncludedDetails.AllButRuleset).FirstOrDefault();
if (setInfo == null)
return false;
initialBeatmap = beatmaps.GetWorkingBeatmap(setInfo.Beatmaps[0]);
return UsingThemedIntro = initialBeatmap != null;
}
2019-09-23 12:52:44 +00:00
}
public override void OnResuming(IScreen last)
{
this.FadeIn(300);
2019-10-08 02:54:39 +00:00
double fadeOutTime = exit_delay;
2020-09-03 04:13:48 +00:00
var track = musicController.CurrentTrack;
// ensure the track doesn't change or loop as we are exiting.
track.Looping = false;
Beatmap.Disabled = true;
2020-05-05 01:31:11 +00:00
// we also handle the exit transition.
2019-09-23 12:52:44 +00:00
if (MenuVoice.Value)
2020-09-03 04:13:48 +00:00
{
seeya.Play();
2020-09-03 04:13:48 +00:00
// if playing the outro voice, we have more time to have fun with the background track.
// initially fade to almost silent then ramp out over the remaining time.
const double initial_fade = 200;
track
.VolumeTo(0.03f, initial_fade).Then()
.VolumeTo(0, fadeOutTime - initial_fade, Easing.In);
2020-09-03 04:13:48 +00:00
}
else
2020-09-03 04:13:48 +00:00
{
fadeOutTime = 500;
2020-09-03 04:13:48 +00:00
// if outro voice is turned off, just do a simple fade out.
track.VolumeTo(0, fadeOutTime, Easing.Out);
2020-09-03 04:13:48 +00:00
}
//don't want to fade out completely else we will stop running updates.
2020-09-03 04:13:48 +00:00
Game.FadeTo(0.01f, fadeOutTime).OnComplete(_ => this.Exit());
base.OnResuming(last);
}
2019-10-08 03:05:52 +00:00
public override void OnSuspending(IScreen next)
{
base.OnSuspending(next);
initialBeatmap = null;
2019-10-08 03:05:52 +00:00
}
protected override BackgroundScreen CreateBackground() => new BackgroundScreenBlack();
protected virtual void StartTrack()
2019-10-08 03:05:52 +00:00
{
// Only start the current track if it is the menu music. A beatmap's track is started when entering the Main Menu.
2020-06-28 23:41:47 +00:00
if (UsingThemedIntro)
Track.Start();
2019-10-08 03:05:52 +00:00
}
protected override void LogoArriving(OsuLogo logo, bool resuming)
{
base.LogoArriving(logo, resuming);
logo.Colour = Color4.White;
logo.Triangles = false;
logo.Ripple = false;
if (!resuming)
{
beatmap.Value = initialBeatmap;
Track = initialBeatmap.Track;
2019-10-08 03:03:42 +00:00
// ensure the track starts at maximum volume
musicController.CurrentTrack.FinishTransforms();
logo.MoveTo(new Vector2(0.5f));
logo.ScaleTo(Vector2.One);
logo.Hide();
}
else
{
const int quick_appear = 350;
int initialMovementTime = logo.Alpha > 0.2f ? quick_appear : 0;
logo.MoveTo(new Vector2(0.5f), initialMovementTime, Easing.OutQuint);
logo
.ScaleTo(1, initialMovementTime, Easing.OutQuint)
.FadeIn(quick_appear, Easing.OutQuint)
.Then()
2019-10-08 02:54:39 +00:00
.RotateTo(20, exit_delay * 1.5f)
.FadeOut(exit_delay);
}
}
protected void PrepareMenuLoad()
{
nextScreen = createNextScreen?.Invoke();
if (nextScreen != null)
LoadComponentAsync(nextScreen);
}
protected void LoadMenu()
{
2019-08-20 09:18:41 +00:00
beatmap.Return();
2019-08-21 05:01:07 +00:00
DidLoadMenu = true;
if (nextScreen != null)
this.Push(nextScreen);
}
}
}