mirror of https://github.com/ppy/osu
304 lines
11 KiB
C#
304 lines
11 KiB
C#
// 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.
|
|
|
|
#nullable disable
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using JetBrains.Annotations;
|
|
using osu.Framework.Allocation;
|
|
using osu.Framework.Audio;
|
|
using osu.Framework.Audio.Sample;
|
|
using osu.Framework.Bindables;
|
|
using osu.Framework.Graphics;
|
|
using osu.Framework.Screens;
|
|
using osu.Game.Beatmaps;
|
|
using osu.Game.Overlays;
|
|
using osu.Game.Rulesets;
|
|
using osu.Game.Rulesets.Mods;
|
|
using osu.Game.Screens.Menu;
|
|
using osu.Game.Users;
|
|
|
|
namespace osu.Game.Screens
|
|
{
|
|
public abstract partial class OsuScreen : Screen, IOsuScreen, IHasDescription
|
|
{
|
|
/// <summary>
|
|
/// The amount of negative padding that should be applied to game background content which touches both the left and right sides of the screen.
|
|
/// This allows for the game content to be pushed by the options/notification overlays without causing black areas to appear.
|
|
/// </summary>
|
|
public const float HORIZONTAL_OVERFLOW_PADDING = 50;
|
|
|
|
/// <summary>
|
|
/// A user-facing title for this screen.
|
|
/// </summary>
|
|
public virtual string Title => GetType().Name;
|
|
|
|
public string Description => Title;
|
|
|
|
public virtual bool AllowBackButton => true;
|
|
|
|
public virtual bool AllowExternalScreenChange => false;
|
|
|
|
public virtual bool HideOverlaysOnEnter => false;
|
|
|
|
public virtual bool HideMenuCursorOnNonMouseInput => false;
|
|
|
|
/// <summary>
|
|
/// The initial overlay activation mode to use when this screen is entered for the first time.
|
|
/// </summary>
|
|
protected virtual OverlayActivation InitialOverlayActivationMode => OverlayActivation.All;
|
|
|
|
public readonly Bindable<OverlayActivation> OverlayActivationMode;
|
|
|
|
IBindable<OverlayActivation> IOsuScreen.OverlayActivationMode => OverlayActivationMode;
|
|
|
|
public virtual bool CursorVisible => true;
|
|
|
|
protected new OsuGameBase Game => base.Game as OsuGameBase;
|
|
|
|
/// <summary>
|
|
/// The <see cref="UserActivity"/> to set the user's activity automatically to when this screen is entered.
|
|
/// <para>This <see cref="Activity"/> will be automatically set to <see cref="InitialActivity"/> for this screen on entering for the first time
|
|
/// unless <see cref="Activity"/> is manually set before.</para>
|
|
/// </summary>
|
|
protected virtual UserActivity InitialActivity => null;
|
|
|
|
/// <summary>
|
|
/// The current <see cref="UserActivity"/> for this screen.
|
|
/// </summary>
|
|
protected readonly Bindable<UserActivity> Activity = new Bindable<UserActivity>();
|
|
|
|
IBindable<UserActivity> IOsuScreen.Activity => Activity;
|
|
|
|
/// <summary>
|
|
/// Whether to disallow changes to game-wise Beatmap/Ruleset bindables for this screen (and all children).
|
|
/// </summary>
|
|
public virtual bool DisallowExternalBeatmapRulesetChanges => false;
|
|
|
|
private Sample sampleExit;
|
|
|
|
protected virtual bool PlayExitSound => true;
|
|
|
|
public virtual float BackgroundParallaxAmount => 1;
|
|
|
|
[Resolved]
|
|
private MusicController musicController { get; set; }
|
|
|
|
public virtual bool? ApplyModTrackAdjustments => null;
|
|
|
|
public virtual bool? AllowGlobalTrackControl => null;
|
|
|
|
public Bindable<WorkingBeatmap> Beatmap { get; private set; } = null!;
|
|
|
|
public Bindable<RulesetInfo> Ruleset { get; private set; } = null!;
|
|
|
|
public Bindable<IReadOnlyList<Mod>> Mods { get; private set; }
|
|
|
|
private OsuScreenDependencies screenDependencies;
|
|
|
|
private bool? globalMusicControlStateAtSuspend;
|
|
|
|
private bool? modTrackAdjustmentStateAtSuspend;
|
|
|
|
internal void CreateLeasedDependencies(IReadOnlyDependencyContainer dependencies) => createDependencies(dependencies);
|
|
|
|
protected override IReadOnlyDependencyContainer CreateChildDependencies(IReadOnlyDependencyContainer parent)
|
|
{
|
|
if (screenDependencies == null)
|
|
{
|
|
if (DisallowExternalBeatmapRulesetChanges)
|
|
throw new InvalidOperationException($"Screens that specify {nameof(DisallowExternalBeatmapRulesetChanges)} must be pushed immediately.");
|
|
|
|
createDependencies(parent);
|
|
}
|
|
|
|
return base.CreateChildDependencies(screenDependencies);
|
|
}
|
|
|
|
private void createDependencies(IReadOnlyDependencyContainer dependencies)
|
|
{
|
|
screenDependencies = new OsuScreenDependencies(DisallowExternalBeatmapRulesetChanges, dependencies);
|
|
|
|
Beatmap = screenDependencies.Beatmap;
|
|
Ruleset = screenDependencies.Ruleset;
|
|
Mods = screenDependencies.Mods;
|
|
}
|
|
|
|
/// <summary>
|
|
/// The background created and owned by this screen. May be null if the background didn't change.
|
|
/// </summary>
|
|
[CanBeNull]
|
|
private BackgroundScreen ownedBackground;
|
|
|
|
[CanBeNull]
|
|
private BackgroundScreen background;
|
|
|
|
[Resolved(canBeNull: true)]
|
|
[CanBeNull]
|
|
private BackgroundScreenStack backgroundStack { get; set; }
|
|
|
|
[Resolved(canBeNull: true)]
|
|
private OsuLogo logo { get; set; }
|
|
|
|
protected OsuScreen()
|
|
{
|
|
Anchor = Anchor.Centre;
|
|
Origin = Anchor.Centre;
|
|
|
|
OverlayActivationMode = new Bindable<OverlayActivation>(InitialOverlayActivationMode);
|
|
}
|
|
|
|
[BackgroundDependencyLoader(true)]
|
|
private void load(AudioManager audio)
|
|
{
|
|
sampleExit = audio.Samples.Get(@"UI/screen-back");
|
|
}
|
|
|
|
protected override void LoadComplete()
|
|
{
|
|
base.LoadComplete();
|
|
Activity.Value ??= InitialActivity;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Apply arbitrary changes to the current background screen in a thread safe manner.
|
|
/// </summary>
|
|
/// <param name="action">The operation to perform.</param>
|
|
public void ApplyToBackground(Action<BackgroundScreen> action)
|
|
{
|
|
if (backgroundStack == null)
|
|
throw new InvalidOperationException("Attempted to apply to background without a background stack being available.");
|
|
|
|
if (background == null)
|
|
throw new InvalidOperationException("Attempted to apply to background before screen is pushed.");
|
|
|
|
background.ApplyToBackground(action);
|
|
}
|
|
|
|
public override void OnResuming(ScreenTransitionEvent e)
|
|
{
|
|
applyArrivingDefaults(true);
|
|
|
|
// it's feasible to resume to a screen if the target screen never loaded successfully.
|
|
// in such a case there's no need to restore this value.
|
|
if (modTrackAdjustmentStateAtSuspend != null)
|
|
musicController.ApplyModTrackAdjustments = modTrackAdjustmentStateAtSuspend.Value;
|
|
if (globalMusicControlStateAtSuspend != null)
|
|
musicController.AllowTrackControl.Value = globalMusicControlStateAtSuspend.Value;
|
|
|
|
base.OnResuming(e);
|
|
}
|
|
|
|
public override void OnSuspending(ScreenTransitionEvent e)
|
|
{
|
|
base.OnSuspending(e);
|
|
|
|
modTrackAdjustmentStateAtSuspend = musicController.ApplyModTrackAdjustments;
|
|
globalMusicControlStateAtSuspend = musicController.AllowTrackControl.Value;
|
|
|
|
onSuspendingLogo();
|
|
}
|
|
|
|
public override void OnEntering(ScreenTransitionEvent e)
|
|
{
|
|
applyArrivingDefaults(false);
|
|
|
|
if (ApplyModTrackAdjustments != null)
|
|
musicController.ApplyModTrackAdjustments = ApplyModTrackAdjustments.Value;
|
|
|
|
if (AllowGlobalTrackControl != null)
|
|
musicController.AllowTrackControl.Value = AllowGlobalTrackControl.Value;
|
|
|
|
if (backgroundStack?.Push(ownedBackground = CreateBackground()) != true)
|
|
{
|
|
// If the constructed instance was not actually pushed to the background stack, we don't want to track it unnecessarily.
|
|
ownedBackground?.Dispose();
|
|
ownedBackground = null;
|
|
}
|
|
|
|
background = backgroundStack?.CurrentScreen as BackgroundScreen;
|
|
base.OnEntering(e);
|
|
}
|
|
|
|
public override bool OnExiting(ScreenExitEvent e)
|
|
{
|
|
// Only play the exit sound if we are the last screen in the exit sequence.
|
|
// This stops many sample playbacks from stacking when a huge screen purge happens (ie. returning to menu via the home button
|
|
// from a deeply nested screen).
|
|
bool arrivingAtFinalDestination = e.Next == e.Destination;
|
|
|
|
if (ValidForResume && PlayExitSound && arrivingAtFinalDestination)
|
|
sampleExit?.Play();
|
|
|
|
if (ValidForResume && logo != null)
|
|
onExitingLogo();
|
|
|
|
if (base.OnExiting(e))
|
|
return true;
|
|
|
|
if (ownedBackground != null && backgroundStack?.CurrentScreen == ownedBackground)
|
|
backgroundStack?.Exit();
|
|
|
|
return false;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Fired when this screen was entered or resumed and the logo state is required to be adjusted.
|
|
/// </summary>
|
|
protected virtual void LogoArriving(OsuLogo logo, bool resuming)
|
|
{
|
|
logo.Action = null;
|
|
logo.FadeOut(300, Easing.OutQuint);
|
|
|
|
logo.Origin = Anchor.Centre;
|
|
|
|
logo.ChangeAnchor(Anchor.TopLeft);
|
|
logo.RelativePositionAxes = Axes.Both;
|
|
|
|
logo.Triangles = true;
|
|
logo.Ripple = true;
|
|
}
|
|
|
|
private void applyArrivingDefaults(bool isResuming)
|
|
{
|
|
logo?.AppendAnimatingAction(() =>
|
|
{
|
|
if (this.IsCurrentScreen()) LogoArriving(logo, isResuming);
|
|
}, true);
|
|
}
|
|
|
|
private void onExitingLogo()
|
|
{
|
|
logo?.AppendAnimatingAction(() => LogoExiting(logo), false);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Fired when this screen was exited to add any outwards transition to the logo.
|
|
/// </summary>
|
|
protected virtual void LogoExiting(OsuLogo logo)
|
|
{
|
|
}
|
|
|
|
private void onSuspendingLogo()
|
|
{
|
|
logo?.AppendAnimatingAction(() => LogoSuspending(logo), false);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Fired when this screen was suspended to add any outwards transition to the logo.
|
|
/// </summary>
|
|
protected virtual void LogoSuspending(OsuLogo logo)
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Override to create a BackgroundMode for the current screen.
|
|
/// Note that the instance created may not be the used instance if it matches the BackgroundMode equality clause.
|
|
/// </summary>
|
|
protected virtual BackgroundScreen CreateBackground() => null;
|
|
|
|
public virtual bool OnBackButton() => false;
|
|
}
|
|
}
|