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
2019-03-06 11:30:14 +00:00
using System ;
2019-04-08 09:32:05 +00:00
using System.Collections.Generic ;
2018-04-13 09:19:50 +00:00
using osu.Framework.Allocation ;
2019-02-21 10:04:31 +00:00
using osu.Framework.Bindables ;
2019-12-12 06:05:29 +00:00
using osu.Framework.Extensions.IEnumerableExtensions ;
2018-04-13 09:19:50 +00:00
using osu.Framework.Graphics ;
using osu.Framework.Graphics.Containers ;
2018-10-02 03:02:47 +00:00
using osu.Framework.Input.Events ;
2018-04-13 09:19:50 +00:00
using osu.Game.Configuration ;
using osu.Game.Graphics.UserInterface ;
using osu.Game.Overlays ;
using osu.Game.Overlays.Notifications ;
2019-04-08 09:32:05 +00:00
using osu.Game.Rulesets.Mods ;
2018-04-13 09:19:50 +00:00
using osu.Game.Rulesets.Scoring ;
using osu.Game.Rulesets.UI ;
using osu.Game.Screens.Play.HUD ;
2018-11-20 07:51:59 +00:00
using osuTK ;
using osuTK.Input ;
2018-04-13 09:19:50 +00:00
namespace osu.Game.Screens.Play
{
2020-10-14 08:21:56 +00:00
[Cached]
2018-04-13 09:19:50 +00:00
public class HUDOverlay : Container
{
2019-12-16 09:41:02 +00:00
private const float fade_duration = 400 ;
2019-12-12 07:09:50 +00:00
private const Easing fade_easing = Easing . Out ;
2018-04-13 09:19:50 +00:00
2019-03-26 02:28:43 +00:00
public readonly KeyCounterDisplay KeyCounter ;
2020-10-14 07:46:13 +00:00
public readonly SkinnableComboCounter ComboCounter ;
2020-10-15 07:32:20 +00:00
public readonly SkinnableScoreCounter ScoreCounter ;
2018-04-13 09:19:50 +00:00
public readonly RollingCounter < double > AccuracyCounter ;
public readonly HealthDisplay HealthDisplay ;
public readonly SongProgress Progress ;
public readonly ModDisplay ModDisplay ;
2019-08-30 09:46:42 +00:00
public readonly HitErrorDisplay HitErrorDisplay ;
2018-11-06 16:47:02 +00:00
public readonly HoldForMenuButton HoldToQuit ;
2018-04-13 09:19:50 +00:00
public readonly PlayerSettingsOverlay PlayerSettingsOverlay ;
2020-04-09 05:31:25 +00:00
public readonly FailingLayer FailingLayer ;
2018-04-13 09:19:50 +00:00
2019-07-06 20:30:53 +00:00
public Bindable < bool > ShowHealthbar = new Bindable < bool > ( true ) ;
2019-05-09 09:06:11 +00:00
private readonly ScoreProcessor scoreProcessor ;
2019-12-19 11:03:14 +00:00
private readonly HealthProcessor healthProcessor ;
2019-05-09 09:06:11 +00:00
private readonly DrawableRuleset drawableRuleset ;
private readonly IReadOnlyList < Mod > mods ;
2019-12-12 06:05:29 +00:00
/// <summary>
/// Whether the elements that can optionally be hidden should be visible.
/// </summary>
public Bindable < bool > ShowHud { get ; } = new BindableBool ( ) ;
private Bindable < bool > configShowHud ;
2019-01-17 07:00:11 +00:00
private readonly Container visibilityContainer ;
2019-12-12 06:05:29 +00:00
2018-04-13 09:19:50 +00:00
private readonly BindableBool replayLoaded = new BindableBool ( ) ;
private static bool hasShownNotificationOnce ;
2019-03-06 11:30:14 +00:00
public Action < double > RequestSeek ;
2019-07-06 20:30:53 +00:00
private readonly Container topScoreContainer ;
2020-10-14 10:16:25 +00:00
private readonly FillFlowContainer bottomRightElements ;
2020-10-14 09:51:53 +00:00
2019-12-12 06:05:29 +00:00
private IEnumerable < Drawable > hideTargets = > new Drawable [ ] { visibilityContainer , KeyCounter } ;
2019-12-19 11:03:14 +00:00
public HUDOverlay ( ScoreProcessor scoreProcessor , HealthProcessor healthProcessor , DrawableRuleset drawableRuleset , IReadOnlyList < Mod > mods )
2018-04-13 09:19:50 +00:00
{
2019-05-09 09:06:11 +00:00
this . scoreProcessor = scoreProcessor ;
2019-12-19 11:03:14 +00:00
this . healthProcessor = healthProcessor ;
2019-05-09 09:06:11 +00:00
this . drawableRuleset = drawableRuleset ;
this . mods = mods ;
2018-04-13 09:19:50 +00:00
RelativeSizeAxes = Axes . Both ;
2019-01-17 07:00:11 +00:00
Children = new Drawable [ ]
2018-04-13 09:19:50 +00:00
{
2020-04-09 05:31:25 +00:00
FailingLayer = CreateFailingLayer ( ) ,
2019-01-23 05:51:13 +00:00
visibilityContainer = new Container
{
2019-01-17 07:00:11 +00:00
RelativeSizeAxes = Axes . Both ,
2020-10-14 09:15:29 +00:00
Child = new GridContainer
2019-01-23 05:51:13 +00:00
{
2020-10-14 09:15:29 +00:00
RelativeSizeAxes = Axes . Both ,
Content = new [ ]
2019-01-23 05:51:13 +00:00
{
2020-10-14 09:15:29 +00:00
new Drawable [ ]
2019-01-23 05:51:13 +00:00
{
2020-10-14 09:15:29 +00:00
new Container
{
RelativeSizeAxes = Axes . Both ,
Children = new Drawable [ ]
{
HealthDisplay = CreateHealthDisplay ( ) ,
topScoreContainer = new Container
{
Anchor = Anchor . TopCentre ,
Origin = Anchor . TopCentre ,
AutoSizeAxes = Axes . Both ,
Children = new Drawable [ ]
{
AccuracyCounter = CreateAccuracyCounter ( ) ,
ScoreCounter = CreateScoreCounter ( ) ,
} ,
} ,
ComboCounter = CreateComboCounter ( ) ,
ModDisplay = CreateModsContainer ( ) ,
HitErrorDisplay = CreateHitErrorDisplayOverlay ( ) ,
PlayerSettingsOverlay = CreatePlayerSettingsOverlay ( ) ,
}
} ,
2019-01-21 08:03:06 +00:00
} ,
2020-10-14 09:15:29 +00:00
new Drawable [ ]
{
Progress = CreateProgress ( ) ,
}
2019-01-21 08:03:06 +00:00
} ,
2020-10-14 09:15:29 +00:00
RowDimensions = new [ ]
{
2020-10-14 09:51:53 +00:00
new Dimension ( ) ,
2020-10-14 09:15:29 +00:00
new Dimension ( GridSizeMode . AutoSize )
}
} ,
2019-01-17 07:00:11 +00:00
} ,
2020-10-14 09:51:53 +00:00
bottomRightElements = new FillFlowContainer
2018-04-13 09:19:50 +00:00
{
2019-01-17 07:00:11 +00:00
Anchor = Anchor . BottomRight ,
Origin = Anchor . BottomRight ,
2020-10-14 09:51:53 +00:00
X = - 5 ,
2019-01-17 07:00:11 +00:00
AutoSizeAxes = Axes . Both ,
2019-12-16 09:41:02 +00:00
LayoutDuration = fade_duration / 2 ,
LayoutEasing = fade_easing ,
2019-01-17 07:00:11 +00:00
Direction = FillDirection . Vertical ,
Children = new Drawable [ ]
2018-05-22 07:45:42 +00:00
{
2019-03-05 04:26:54 +00:00
KeyCounter = CreateKeyCounter ( ) ,
2019-01-17 07:00:11 +00:00
HoldToQuit = CreateHoldForMenuButton ( ) ,
2018-05-22 07:45:42 +00:00
}
2018-04-13 09:19:50 +00:00
}
2019-01-17 07:00:11 +00:00
} ;
2019-05-09 09:06:11 +00:00
}
2018-04-13 09:19:50 +00:00
2019-05-09 09:06:11 +00:00
[BackgroundDependencyLoader(true)]
private void load ( OsuConfigManager config , NotificationOverlay notificationOverlay )
{
2019-12-12 07:09:42 +00:00
if ( scoreProcessor ! = null )
2019-12-19 11:03:14 +00:00
BindScoreProcessor ( scoreProcessor ) ;
if ( healthProcessor ! = null )
BindHealthProcessor ( healthProcessor ) ;
2018-04-13 09:19:50 +00:00
2019-12-12 07:09:42 +00:00
if ( drawableRuleset ! = null )
{
BindDrawableRuleset ( drawableRuleset ) ;
Progress . Objects = drawableRuleset . Objects ;
Progress . RequestSeek = time = > RequestSeek ( time ) ;
Progress . ReferenceClock = drawableRuleset . FrameStableClock ;
}
2018-04-13 09:19:50 +00:00
2019-04-08 09:32:05 +00:00
ModDisplay . Current . Value = mods ;
2018-04-13 09:19:50 +00:00
2019-12-12 06:05:29 +00:00
configShowHud = config . GetBindable < bool > ( OsuSetting . ShowInterface ) ;
if ( ! configShowHud . Value & & ! hasShownNotificationOnce )
{
hasShownNotificationOnce = true ;
notificationOverlay ? . Post ( new SimpleNotification
{
Text = @"The score overlay is currently disabled. You can toggle this by pressing Shift+Tab."
} ) ;
}
// start all elements hidden
hideTargets . ForEach ( d = > d . Hide ( ) ) ;
}
public override void Hide ( ) = > throw new InvalidOperationException ( $"{nameof(HUDOverlay)} should not be hidden as it will remove the ability of a user to quit. Use {nameof(ShowHud)} instead." ) ;
protected override void LoadComplete ( )
{
base . LoadComplete ( ) ;
2019-12-12 07:09:50 +00:00
ShowHud . BindValueChanged ( visible = > hideTargets . ForEach ( d = > d . FadeTo ( visible . NewValue ? 1 : 0 , fade_duration , fade_easing ) ) ) ;
2019-07-06 20:30:53 +00:00
ShowHealthbar . BindValueChanged ( healthBar = >
{
if ( healthBar . NewValue )
{
2019-12-12 07:09:50 +00:00
HealthDisplay . FadeIn ( fade_duration , fade_easing ) ;
topScoreContainer . MoveToY ( 30 , fade_duration , fade_easing ) ;
2019-07-06 20:30:53 +00:00
}
else
{
2019-12-12 07:09:50 +00:00
HealthDisplay . FadeOut ( fade_duration , fade_easing ) ;
topScoreContainer . MoveToY ( 0 , fade_duration , fade_easing ) ;
2019-07-06 20:30:53 +00:00
}
} , true ) ;
2018-04-13 09:19:50 +00:00
2019-12-12 06:05:29 +00:00
configShowHud . BindValueChanged ( visible = >
2018-04-13 09:19:50 +00:00
{
2019-12-12 06:05:29 +00:00
if ( ! ShowHud . Disabled )
ShowHud . Value = visible . NewValue ;
} , true ) ;
2018-04-13 09:19:50 +00:00
2019-05-10 06:39:25 +00:00
replayLoaded . BindValueChanged ( replayLoadedValueChanged , true ) ;
2018-04-13 09:19:50 +00:00
}
2020-10-14 09:51:53 +00:00
protected override void Update ( )
{
base . Update ( ) ;
bottomRightElements . Y = - Progress . Height ;
}
2019-02-21 09:56:34 +00:00
private void replayLoadedValueChanged ( ValueChangedEvent < bool > e )
2018-04-13 09:19:50 +00:00
{
2019-02-21 09:56:34 +00:00
PlayerSettingsOverlay . ReplayLoaded = e . NewValue ;
2018-04-13 09:19:50 +00:00
2019-02-21 09:56:34 +00:00
if ( e . NewValue )
2018-04-13 09:19:50 +00:00
{
PlayerSettingsOverlay . Show ( ) ;
ModDisplay . FadeIn ( 200 ) ;
2018-10-30 12:32:12 +00:00
KeyCounter . Margin = new MarginPadding ( 10 ) { Bottom = 30 } ;
2018-04-13 09:19:50 +00:00
}
else
{
PlayerSettingsOverlay . Hide ( ) ;
ModDisplay . Delay ( 2000 ) . FadeOut ( 200 ) ;
2018-10-30 12:32:12 +00:00
KeyCounter . Margin = new MarginPadding ( 10 ) ;
2018-04-13 09:19:50 +00:00
}
}
2019-03-19 14:44:15 +00:00
protected virtual void BindDrawableRuleset ( DrawableRuleset drawableRuleset )
2018-04-13 09:19:50 +00:00
{
2019-03-19 14:44:15 +00:00
( drawableRuleset as ICanAttachKeyCounter ) ? . Attach ( KeyCounter ) ;
2018-04-13 09:19:50 +00:00
2019-03-19 14:44:15 +00:00
replayLoaded . BindTo ( drawableRuleset . HasReplayLoaded ) ;
2018-04-13 09:19:50 +00:00
2019-03-20 05:49:33 +00:00
Progress . BindDrawableRuleset ( drawableRuleset ) ;
2018-04-13 09:19:50 +00:00
}
2018-10-02 03:02:47 +00:00
protected override bool OnKeyDown ( KeyDownEvent e )
2018-04-13 09:19:50 +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:44:14 +00:00
if ( e . ShiftPressed )
2018-04-13 09:19:50 +00:00
{
2018-10-02 03:02:47 +00:00
switch ( e . Key )
2018-04-13 09:19:50 +00:00
{
case Key . Tab :
2019-12-12 06:05:29 +00:00
configShowHud . Value = ! configShowHud . Value ;
2018-04-13 09:19:50 +00:00
return true ;
}
}
2018-10-02 03:02:47 +00:00
return base . OnKeyDown ( e ) ;
2018-04-13 09:19:50 +00:00
}
protected virtual RollingCounter < double > CreateAccuracyCounter ( ) = > new PercentageCounter
{
2019-01-21 08:03:06 +00:00
BypassAutoSizeAxes = Axes . X ,
Anchor = Anchor . TopLeft ,
Origin = Anchor . TopRight ,
Margin = new MarginPadding { Top = 5 , Right = 20 } ,
2018-04-13 09:19:50 +00:00
} ;
2020-10-15 07:32:20 +00:00
protected virtual SkinnableScoreCounter CreateScoreCounter ( ) = > new SkinnableScoreCounter ( ) ;
2019-01-21 08:03:06 +00:00
2020-10-14 07:46:13 +00:00
protected virtual SkinnableComboCounter CreateComboCounter ( ) = > new SkinnableComboCounter ( ) ;
2018-04-13 09:19:50 +00:00
protected virtual HealthDisplay CreateHealthDisplay ( ) = > new StandardHealthDisplay
{
Size = new Vector2 ( 1 , 5 ) ,
RelativeSizeAxes = Axes . X ,
Margin = new MarginPadding { Top = 20 }
} ;
2020-06-26 17:22:30 +00:00
protected virtual FailingLayer CreateFailingLayer ( ) = > new FailingLayer
{
ShowHealth = { BindTarget = ShowHealthbar }
} ;
2020-04-09 05:31:25 +00:00
2019-03-26 02:28:43 +00:00
protected virtual KeyCounterDisplay CreateKeyCounter ( ) = > new KeyCounterDisplay
2018-04-13 09:19:50 +00:00
{
Anchor = Anchor . BottomRight ,
Origin = Anchor . BottomRight ,
Margin = new MarginPadding ( 10 ) ,
} ;
protected virtual SongProgress CreateProgress ( ) = > new SongProgress
{
Anchor = Anchor . BottomLeft ,
Origin = Anchor . BottomLeft ,
RelativeSizeAxes = Axes . X ,
} ;
2018-11-06 16:47:02 +00:00
protected virtual HoldForMenuButton CreateHoldForMenuButton ( ) = > new HoldForMenuButton
2018-04-21 15:24:31 +00:00
{
Anchor = Anchor . BottomRight ,
Origin = Anchor . BottomRight ,
} ;
2018-04-13 09:19:50 +00:00
protected virtual ModDisplay CreateModsContainer ( ) = > new ModDisplay
{
Anchor = Anchor . TopRight ,
Origin = Anchor . TopRight ,
AutoSizeAxes = Axes . Both ,
2020-04-03 18:30:02 +00:00
Margin = new MarginPadding { Top = 20 , Right = 20 } ,
2018-04-13 09:19:50 +00:00
} ;
2019-12-12 07:09:42 +00:00
protected virtual HitErrorDisplay CreateHitErrorDisplayOverlay ( ) = > new HitErrorDisplay ( scoreProcessor , drawableRuleset ? . FirstAvailableHitWindows ) ;
2019-08-20 05:45:51 +00:00
2018-04-13 09:19:50 +00:00
protected virtual PlayerSettingsOverlay CreatePlayerSettingsOverlay ( ) = > new PlayerSettingsOverlay ( ) ;
2019-12-19 11:03:14 +00:00
protected virtual void BindScoreProcessor ( ScoreProcessor processor )
2018-04-13 09:19:50 +00:00
{
ScoreCounter ? . Current . BindTo ( processor . TotalScore ) ;
AccuracyCounter ? . Current . BindTo ( processor . Accuracy ) ;
ComboCounter ? . Current . BindTo ( processor . Combo ) ;
2019-02-28 05:35:00 +00:00
if ( HealthDisplay is StandardHealthDisplay shd )
2018-04-13 09:19:50 +00:00
processor . NewJudgement + = shd . Flash ;
}
2019-12-19 11:03:14 +00:00
protected virtual void BindHealthProcessor ( HealthProcessor processor )
{
2020-04-09 05:31:25 +00:00
HealthDisplay ? . BindHealthProcessor ( processor ) ;
FailingLayer ? . BindHealthProcessor ( processor ) ;
2019-12-19 11:03:14 +00:00
}
2018-04-13 09:19:50 +00:00
}
}