mirror of https://github.com/ppy/osu
291 lines
11 KiB
C#
291 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.Collections.Generic;
|
|
using System.ComponentModel;
|
|
using System.Linq;
|
|
using osu.Framework.Allocation;
|
|
using osu.Framework.Graphics;
|
|
using osu.Framework.Graphics.Containers;
|
|
using osu.Framework.Logging;
|
|
using osu.Game.Input.Bindings;
|
|
using osu.Game.Screens.Play;
|
|
using osuTK;
|
|
using osuTK.Input;
|
|
|
|
namespace osu.Game.Tests.Visual.Gameplay
|
|
{
|
|
[Description("player pause/fail screens")]
|
|
public class TestSceneGameplayMenuOverlay : ManualInputManagerTestScene
|
|
{
|
|
public override IReadOnlyList<Type> RequiredTypes => new[] { typeof(FailOverlay), typeof(PauseOverlay) };
|
|
|
|
private FailOverlay failOverlay;
|
|
private PauseOverlay pauseOverlay;
|
|
|
|
private GlobalActionContainer globalActionContainer;
|
|
|
|
[BackgroundDependencyLoader]
|
|
private void load(OsuGameBase game)
|
|
{
|
|
Child = globalActionContainer = new GlobalActionContainer(game)
|
|
{
|
|
Children = new Drawable[]
|
|
{
|
|
pauseOverlay = new PauseOverlay
|
|
{
|
|
OnResume = () => Logger.Log(@"Resume"),
|
|
OnRetry = () => Logger.Log(@"Retry"),
|
|
OnQuit = () => Logger.Log(@"Quit"),
|
|
},
|
|
failOverlay = new FailOverlay
|
|
|
|
{
|
|
OnRetry = () => Logger.Log(@"Retry"),
|
|
OnQuit = () => Logger.Log(@"Quit"),
|
|
}
|
|
}
|
|
};
|
|
|
|
var retryCount = 0;
|
|
|
|
AddStep("Add retry", () =>
|
|
{
|
|
retryCount++;
|
|
pauseOverlay.Retries = failOverlay.Retries = retryCount;
|
|
});
|
|
|
|
AddToggleStep("Toggle pause overlay", t => pauseOverlay.ToggleVisibility());
|
|
AddToggleStep("Toggle fail overlay", t => failOverlay.ToggleVisibility());
|
|
|
|
testHideResets();
|
|
|
|
testEnterWithoutSelection();
|
|
testKeyUpFromInitial();
|
|
testKeyDownFromInitial();
|
|
testKeyUpWrapping();
|
|
testKeyDownWrapping();
|
|
|
|
testMouseSelectionAfterKeySelection();
|
|
testKeySelectionAfterMouseSelection();
|
|
|
|
testMouseDeselectionResets();
|
|
|
|
testClickSelection();
|
|
testEnterKeySelection();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Test that hiding the overlay after hovering a button will reset the overlay to the initial state with no buttons selected.
|
|
/// </summary>
|
|
private void testHideResets()
|
|
{
|
|
AddStep("Show overlay", () => failOverlay.Show());
|
|
|
|
AddStep("Hover first button", () => InputManager.MoveMouseTo(failOverlay.Buttons.First()));
|
|
AddStep("Hide overlay", () => failOverlay.Hide());
|
|
|
|
AddAssert("Overlay state is reset", () => !failOverlay.Buttons.Any(b => b.Selected.Value));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Tests that pressing enter after an overlay shows doesn't trigger an event because a selection hasn't occurred.
|
|
/// </summary>
|
|
private void testEnterWithoutSelection()
|
|
{
|
|
AddStep("Show overlay", () => pauseOverlay.Show());
|
|
|
|
AddStep("Press select", () => press(GlobalAction.Select));
|
|
AddAssert("Overlay still open", () => pauseOverlay.State.Value == Visibility.Visible);
|
|
|
|
AddStep("Hide overlay", () => pauseOverlay.Hide());
|
|
}
|
|
|
|
/// <summary>
|
|
/// Tests that pressing the up arrow from the initial state selects the last button.
|
|
/// </summary>
|
|
private void testKeyUpFromInitial()
|
|
{
|
|
AddStep("Show overlay", () => pauseOverlay.Show());
|
|
|
|
AddStep("Up arrow", () => press(Key.Up));
|
|
AddAssert("Last button selected", () => pauseOverlay.Buttons.Last().Selected.Value);
|
|
|
|
AddStep("Hide overlay", () => pauseOverlay.Hide());
|
|
}
|
|
|
|
/// <summary>
|
|
/// Tests that pressing the down arrow from the initial state selects the first button.
|
|
/// </summary>
|
|
private void testKeyDownFromInitial()
|
|
{
|
|
AddStep("Show overlay", () => pauseOverlay.Show());
|
|
|
|
AddStep("Down arrow", () => press(Key.Down));
|
|
AddAssert("First button selected", () => pauseOverlay.Buttons.First().Selected.Value);
|
|
|
|
AddStep("Hide overlay", () => pauseOverlay.Hide());
|
|
}
|
|
|
|
/// <summary>
|
|
/// Tests that pressing the up arrow repeatedly causes the selected button to wrap correctly.
|
|
/// </summary>
|
|
private void testKeyUpWrapping()
|
|
{
|
|
AddStep("Show overlay", () => failOverlay.Show());
|
|
|
|
AddStep("Up arrow", () => press(Key.Up));
|
|
AddAssert("Last button selected", () => failOverlay.Buttons.Last().Selected.Value);
|
|
AddStep("Up arrow", () => press(Key.Up));
|
|
AddAssert("First button selected", () => failOverlay.Buttons.First().Selected.Value);
|
|
AddStep("Up arrow", () => press(Key.Up));
|
|
AddAssert("Last button selected", () => failOverlay.Buttons.Last().Selected.Value);
|
|
|
|
AddStep("Hide overlay", () => failOverlay.Hide());
|
|
}
|
|
|
|
/// <summary>
|
|
/// Tests that pressing the down arrow repeatedly causes the selected button to wrap correctly.
|
|
/// </summary>
|
|
private void testKeyDownWrapping()
|
|
{
|
|
AddStep("Show overlay", () => failOverlay.Show());
|
|
|
|
AddStep("Down arrow", () => press(Key.Down));
|
|
AddAssert("First button selected", () => failOverlay.Buttons.First().Selected.Value);
|
|
AddStep("Down arrow", () => press(Key.Down));
|
|
AddAssert("Last button selected", () => failOverlay.Buttons.Last().Selected.Value);
|
|
AddStep("Down arrow", () => press(Key.Down));
|
|
AddAssert("First button selected", () => failOverlay.Buttons.First().Selected.Value);
|
|
|
|
AddStep("Hide overlay", () => failOverlay.Hide());
|
|
}
|
|
|
|
/// <summary>
|
|
/// Tests that hovering a button that was previously selected with the keyboard correctly selects the new button and deselects the previous button.
|
|
/// </summary>
|
|
private void testMouseSelectionAfterKeySelection()
|
|
{
|
|
AddStep("Show overlay", () => pauseOverlay.Show());
|
|
|
|
var secondButton = pauseOverlay.Buttons.Skip(1).First();
|
|
|
|
AddStep("Down arrow", () => press(Key.Down));
|
|
AddStep("Hover second button", () => InputManager.MoveMouseTo(secondButton));
|
|
AddAssert("First button not selected", () => !pauseOverlay.Buttons.First().Selected.Value);
|
|
AddAssert("Second button selected", () => secondButton.Selected.Value);
|
|
|
|
AddStep("Hide overlay", () => pauseOverlay.Hide());
|
|
}
|
|
|
|
/// <summary>
|
|
/// Tests that pressing a key after selecting a button with a hover event correctly selects a new button and deselects the previous button.
|
|
/// </summary>
|
|
private void testKeySelectionAfterMouseSelection()
|
|
{
|
|
AddStep("Show overlay", () =>
|
|
{
|
|
pauseOverlay.Show();
|
|
InputManager.MoveMouseTo(Vector2.Zero);
|
|
});
|
|
|
|
var secondButton = pauseOverlay.Buttons.Skip(1).First();
|
|
|
|
AddStep("Hover second button", () => InputManager.MoveMouseTo(secondButton));
|
|
AddStep("Up arrow", () => press(Key.Up));
|
|
AddAssert("Second button not selected", () => !secondButton.Selected.Value);
|
|
AddAssert("First button selected", () => pauseOverlay.Buttons.First().Selected.Value);
|
|
|
|
AddStep("Hide overlay", () => pauseOverlay.Hide());
|
|
}
|
|
|
|
/// <summary>
|
|
/// Tests that deselecting with the mouse by losing hover will reset the overlay to the initial state.
|
|
/// </summary>
|
|
private void testMouseDeselectionResets()
|
|
{
|
|
AddStep("Show overlay", () => pauseOverlay.Show());
|
|
|
|
var secondButton = pauseOverlay.Buttons.Skip(1).First();
|
|
|
|
AddStep("Hover second button", () => InputManager.MoveMouseTo(secondButton));
|
|
AddStep("Unhover second button", () => InputManager.MoveMouseTo(Vector2.Zero));
|
|
AddStep("Down arrow", () => press(Key.Down));
|
|
AddAssert("First button selected", () => pauseOverlay.Buttons.First().Selected.Value); // Initial state condition
|
|
|
|
AddStep("Hide overlay", () => pauseOverlay.Hide());
|
|
}
|
|
|
|
/// <summary>
|
|
/// Tests that clicking on a button correctly causes a click event for that button.
|
|
/// </summary>
|
|
private void testClickSelection()
|
|
{
|
|
AddStep("Show overlay", () => pauseOverlay.Show());
|
|
|
|
var retryButton = pauseOverlay.Buttons.Skip(1).First();
|
|
|
|
bool triggered = false;
|
|
AddStep("Click retry button", () =>
|
|
{
|
|
var lastAction = pauseOverlay.OnRetry;
|
|
pauseOverlay.OnRetry = () => triggered = true;
|
|
|
|
retryButton.Click();
|
|
pauseOverlay.OnRetry = lastAction;
|
|
});
|
|
|
|
AddAssert("Action was triggered", () => triggered);
|
|
AddAssert("Overlay is closed", () => pauseOverlay.State.Value == Visibility.Hidden);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Tests that pressing the enter key with a button selected correctly causes a click event for that button.
|
|
/// </summary>
|
|
private void testEnterKeySelection()
|
|
{
|
|
AddStep("Show overlay", () => pauseOverlay.Show());
|
|
|
|
AddStep("Select second button", () =>
|
|
{
|
|
press(Key.Down);
|
|
press(Key.Down);
|
|
});
|
|
|
|
bool triggered = false;
|
|
Action lastAction = null;
|
|
AddStep("Press enter", () =>
|
|
{
|
|
lastAction = pauseOverlay.OnRetry;
|
|
pauseOverlay.OnRetry = () => triggered = true;
|
|
press(Key.Enter);
|
|
});
|
|
|
|
AddAssert("Action was triggered", () =>
|
|
{
|
|
if (lastAction != null)
|
|
{
|
|
pauseOverlay.OnRetry = lastAction;
|
|
lastAction = null;
|
|
}
|
|
|
|
return triggered;
|
|
});
|
|
AddAssert("Overlay is closed", () => pauseOverlay.State.Value == Visibility.Hidden);
|
|
}
|
|
|
|
private void press(Key key)
|
|
{
|
|
InputManager.PressKey(key);
|
|
InputManager.ReleaseKey(key);
|
|
}
|
|
|
|
private void press(GlobalAction action)
|
|
{
|
|
globalActionContainer.TriggerPressed(action);
|
|
globalActionContainer.TriggerReleased(action);
|
|
}
|
|
}
|
|
}
|