mirror of
https://github.com/ppy/osu.git
synced 2024-12-16 21:42:55 +08:00
298 lines
11 KiB
C#
298 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.
|
|
|
|
using System;
|
|
using System.Diagnostics;
|
|
using System.Linq;
|
|
using NUnit.Framework;
|
|
using osu.Framework.Allocation;
|
|
using osu.Framework.Audio.Track;
|
|
using osu.Framework.Extensions.ObjectExtensions;
|
|
using osu.Framework.Graphics;
|
|
using osu.Framework.Testing;
|
|
using osu.Game.Configuration;
|
|
using osu.Game.Graphics.Containers;
|
|
using osu.Game.Rulesets.Mods;
|
|
using osu.Game.Rulesets.Osu;
|
|
using osu.Game.Rulesets.Scoring;
|
|
using osu.Game.Screens.Play;
|
|
using osu.Game.Screens.Play.HUD;
|
|
using osu.Game.Screens.Play.HUD.HitErrorMeters;
|
|
using osu.Game.Skinning;
|
|
using osu.Game.Tests.Gameplay;
|
|
using osuTK.Input;
|
|
|
|
namespace osu.Game.Tests.Visual.Gameplay
|
|
{
|
|
public partial class TestSceneHUDOverlay : OsuManualInputManagerTestScene
|
|
{
|
|
private OsuConfigManager localConfig = null!;
|
|
|
|
private HUDOverlay hudOverlay = null!;
|
|
|
|
[Cached(typeof(ScoreProcessor))]
|
|
private ScoreProcessor scoreProcessor { get; set; }
|
|
|
|
[Cached(typeof(HealthProcessor))]
|
|
private HealthProcessor healthProcessor = new DrainingHealthProcessor(0);
|
|
|
|
[Cached]
|
|
private GameplayState gameplayState = TestGameplayState.Create(new OsuRuleset());
|
|
|
|
[Cached(typeof(IGameplayClock))]
|
|
private readonly IGameplayClock gameplayClock = new GameplayClockContainer(new TrackVirtual(60000), false, false);
|
|
|
|
// best way to check without exposing.
|
|
private Drawable hideTarget => hudOverlay.ChildrenOfType<SkinComponentsContainer>().First();
|
|
private Drawable keyCounterContent => hudOverlay.ChildrenOfType<KeyCounterDisplay>().First().ChildrenOfType<Drawable>().Skip(1).First();
|
|
|
|
public TestSceneHUDOverlay()
|
|
{
|
|
scoreProcessor = gameplayState.ScoreProcessor;
|
|
}
|
|
|
|
[BackgroundDependencyLoader]
|
|
private void load()
|
|
{
|
|
Dependencies.Cache(localConfig = new OsuConfigManager(LocalStorage));
|
|
}
|
|
|
|
[SetUp]
|
|
public void SetUp() => Schedule(() => localConfig.SetValue(OsuSetting.HUDVisibilityMode, HUDVisibilityMode.Always));
|
|
|
|
[Test]
|
|
public void TestComboCounterIncrementing()
|
|
{
|
|
createNew();
|
|
|
|
AddRepeatStep("increase combo", () => { scoreProcessor.Combo.Value++; }, 10);
|
|
|
|
AddStep("reset combo", () => { scoreProcessor.Combo.Value = 0; });
|
|
}
|
|
|
|
[Test]
|
|
public void TestShownByDefault()
|
|
{
|
|
createNew();
|
|
|
|
AddAssert("showhud is set", () => hudOverlay.ShowHud.Value);
|
|
|
|
AddAssert("hidetarget is visible", () => hideTarget.Alpha, () => Is.GreaterThan(0));
|
|
AddAssert("key counter flow is visible", () => keyCounterContent.IsPresent);
|
|
AddAssert("pause button is visible", () => hudOverlay.HoldToQuit.IsPresent);
|
|
}
|
|
|
|
[Test]
|
|
public void TestFadesInOnLoadComplete()
|
|
{
|
|
float? initialAlpha = null;
|
|
|
|
createNew(h => h.OnLoadComplete += _ => initialAlpha = hideTarget.Alpha);
|
|
AddUntilStep("wait for load", () => hudOverlay.IsAlive);
|
|
AddAssert("initial alpha was less than 1", () => initialAlpha < 1);
|
|
}
|
|
|
|
[Test]
|
|
public void TestHideExternally()
|
|
{
|
|
createNew();
|
|
|
|
AddStep("set showhud false", () => hudOverlay.ShowHud.Value = false);
|
|
|
|
AddUntilStep("hidetarget is hidden", () => hideTarget.Alpha, () => Is.LessThanOrEqualTo(0));
|
|
AddAssert("pause button is still visible", () => hudOverlay.HoldToQuit.IsPresent);
|
|
|
|
// Key counter flow container should not be affected by this, only the key counter display will be hidden as checked above.
|
|
AddAssert("key counter flow not affected", () => keyCounterContent.IsPresent);
|
|
}
|
|
|
|
[Test]
|
|
public void TestMomentaryShowHUD()
|
|
{
|
|
createNew();
|
|
|
|
AddStep("set hud to never show", () => localConfig.SetValue(OsuSetting.HUDVisibilityMode, HUDVisibilityMode.Never));
|
|
|
|
AddUntilStep("wait for fade", () => hideTarget.Alpha, () => Is.LessThanOrEqualTo(0));
|
|
|
|
AddStep("trigger momentary show", () => InputManager.PressKey(Key.ControlLeft));
|
|
AddUntilStep("wait for visible", () => hideTarget.Alpha, () => Is.GreaterThan(0));
|
|
|
|
AddStep("stop trigering", () => InputManager.ReleaseKey(Key.ControlLeft));
|
|
AddUntilStep("wait for fade", () => hideTarget.Alpha, () => Is.LessThanOrEqualTo(0));
|
|
}
|
|
|
|
[Test]
|
|
public void TestExternalHideDoesntAffectConfig()
|
|
{
|
|
createNew();
|
|
|
|
AddStep("set showhud false", () => hudOverlay.ShowHud.Value = false);
|
|
AddAssert("config unchanged", () => localConfig.GetBindable<HUDVisibilityMode>(OsuSetting.HUDVisibilityMode).IsDefault);
|
|
|
|
AddStep("set showhud true", () => hudOverlay.ShowHud.Value = true);
|
|
AddAssert("config unchanged", () => localConfig.GetBindable<HUDVisibilityMode>(OsuSetting.HUDVisibilityMode).IsDefault);
|
|
}
|
|
|
|
[Test]
|
|
public void TestChangeHUDVisibilityOnHiddenKeyCounter()
|
|
{
|
|
createNew();
|
|
|
|
AddStep("hide key overlay", () =>
|
|
{
|
|
localConfig.SetValue(OsuSetting.KeyOverlay, false);
|
|
var kcd = hudOverlay.ChildrenOfType<KeyCounterDisplay>().FirstOrDefault();
|
|
if (kcd != null)
|
|
kcd.AlwaysVisible.Value = false;
|
|
});
|
|
|
|
AddStep("set showhud false", () => hudOverlay.ShowHud.Value = false);
|
|
AddUntilStep("hidetarget is hidden", () => hideTarget.Alpha, () => Is.LessThanOrEqualTo(0));
|
|
AddUntilStep("key counters hidden", () => !keyCounterContent.IsPresent);
|
|
|
|
AddStep("set showhud true", () => hudOverlay.ShowHud.Value = true);
|
|
AddUntilStep("hidetarget is visible", () => hideTarget.Alpha, () => Is.GreaterThan(0));
|
|
AddUntilStep("key counters still hidden", () => !keyCounterContent.IsPresent);
|
|
}
|
|
|
|
[Test]
|
|
public void TestHoldForMenuDoesWorkWhenHidden()
|
|
{
|
|
bool activated = false;
|
|
|
|
HoldForMenuButton getHoldForMenu() => hudOverlay.ChildrenOfType<HoldForMenuButton>().Single();
|
|
|
|
createNew();
|
|
|
|
AddStep("bind action", () =>
|
|
{
|
|
activated = false;
|
|
|
|
var holdForMenu = getHoldForMenu();
|
|
|
|
holdForMenu.Action += () => activated = true;
|
|
});
|
|
|
|
AddStep("set hold button always visible", () => localConfig.SetValue(OsuSetting.AlwaysShowHoldForMenuButton, true));
|
|
AddStep("set showhud false", () => hudOverlay.ShowHud.Value = false);
|
|
AddUntilStep("hidetarget is hidden", () => hideTarget.Alpha, () => Is.LessThanOrEqualTo(0));
|
|
|
|
AddStep("attempt activate", () =>
|
|
{
|
|
InputManager.MoveMouseTo(getHoldForMenu().OfType<HoldToConfirmContainer>().Single());
|
|
InputManager.PressButton(MouseButton.Left);
|
|
});
|
|
|
|
AddUntilStep("activated", () => activated);
|
|
|
|
AddStep("release mouse button", () =>
|
|
{
|
|
InputManager.ReleaseButton(MouseButton.Left);
|
|
});
|
|
}
|
|
|
|
[Test]
|
|
public void TestInputDoesntWorkWhenHUDHidden()
|
|
{
|
|
ArgonSongProgress? getSongProgress() => hudOverlay.ChildrenOfType<ArgonSongProgress>().SingleOrDefault();
|
|
|
|
bool seeked = false;
|
|
|
|
createNew();
|
|
|
|
AddUntilStep("wait for song progress", () => getSongProgress() != null);
|
|
|
|
AddStep("bind seek", () =>
|
|
{
|
|
seeked = false;
|
|
|
|
var progress = getSongProgress();
|
|
|
|
Debug.Assert(progress != null);
|
|
|
|
progress.Interactive.Value = true;
|
|
progress.ChildrenOfType<ArgonSongProgressBar>().Single().OnSeek += _ => seeked = true;
|
|
});
|
|
|
|
AddStep("set hold button always visible", () => localConfig.SetValue(OsuSetting.AlwaysShowHoldForMenuButton, true));
|
|
AddStep("set showhud false", () => hudOverlay.ShowHud.Value = false);
|
|
AddUntilStep("hidetarget is hidden", () => hideTarget.Alpha, () => Is.LessThanOrEqualTo(0));
|
|
|
|
AddStep("attempt seek", () =>
|
|
{
|
|
InputManager.MoveMouseTo(getSongProgress().AsNonNull());
|
|
InputManager.Click(MouseButton.Left);
|
|
});
|
|
|
|
AddAssert("seek not performed", () => !seeked);
|
|
|
|
AddStep("set showhud true", () => hudOverlay.ShowHud.Value = true);
|
|
|
|
AddStep("attempt seek", () => InputManager.Click(MouseButton.Left));
|
|
AddAssert("seek performed", () => seeked);
|
|
}
|
|
|
|
[Test]
|
|
public void TestHiddenHUDDoesntBlockComponentUpdates()
|
|
{
|
|
int updateCount = 0;
|
|
|
|
AddStep("set hud to never show", () => localConfig.SetValue(OsuSetting.HUDVisibilityMode, HUDVisibilityMode.Never));
|
|
|
|
createNew();
|
|
|
|
AddUntilStep("wait for components to be hidden", () => hudOverlay.ChildrenOfType<SkinComponentsContainer>().Single().Alpha == 0);
|
|
AddUntilStep("wait for hud load", () => hudOverlay.ChildrenOfType<SkinComponentsContainer>().All(c => c.ComponentsLoaded));
|
|
|
|
AddStep("bind on update", () =>
|
|
{
|
|
hudOverlay.ChildrenOfType<BarHitErrorMeter>().First().OnUpdate += _ => updateCount++;
|
|
});
|
|
|
|
AddUntilStep("wait for updates", () => updateCount > 0);
|
|
}
|
|
|
|
[Test]
|
|
public void TestHiddenHUDDoesntBlockSkinnableComponentsLoad()
|
|
{
|
|
AddStep("set hud to never show", () => localConfig.SetValue(OsuSetting.HUDVisibilityMode, HUDVisibilityMode.Never));
|
|
|
|
createNew();
|
|
|
|
AddUntilStep("wait for components to be hidden", () => hudOverlay.ChildrenOfType<SkinComponentsContainer>().Single().Alpha == 0);
|
|
|
|
AddStep("reload components", () => hudOverlay.ChildrenOfType<SkinComponentsContainer>().Single().Reload());
|
|
AddUntilStep("skinnable components loaded", () => hudOverlay.ChildrenOfType<SkinComponentsContainer>().Single().ComponentsLoaded);
|
|
}
|
|
|
|
private void createNew(Action<HUDOverlay>? action = null)
|
|
{
|
|
AddStep("create overlay", () =>
|
|
{
|
|
hudOverlay = new HUDOverlay(null, Array.Empty<Mod>());
|
|
|
|
// Add any key just to display the key counter visually.
|
|
hudOverlay.InputCountController.Add(new KeyCounterKeyboardTrigger(Key.Space));
|
|
|
|
scoreProcessor.Combo.Value = 1;
|
|
|
|
action?.Invoke(hudOverlay);
|
|
|
|
Child = hudOverlay;
|
|
});
|
|
|
|
AddUntilStep("wait for hud load", () => hudOverlay.IsLoaded);
|
|
AddUntilStep("wait for components present", () => hudOverlay.ChildrenOfType<KeyCounterDisplay>().FirstOrDefault() != null);
|
|
}
|
|
|
|
protected override void Dispose(bool isDisposing)
|
|
{
|
|
if (localConfig.IsNotNull())
|
|
localConfig.Dispose();
|
|
|
|
base.Dispose(isDisposing);
|
|
}
|
|
}
|
|
}
|