h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2024-11-13 16:47:46 +08:00
Code Issues Releases Wiki Activity

Replace existing epilepsy warning with inline display

Browse Source
This commit is contained in:
Bartłomiej Dach 2024-03-15 09:27:33 +01:00
parent 1aa695add9
commit 42ae18976f
No known key found for this signature in database
3 changed files with 26 additions and 178 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
osu.Game.Tests/Visual/Gameplay/TestScenePlayerLoader.cs
View File

@ -334,13 +334,7 @@ namespace osu.Game.Tests.Visual.Gameplay
AddUntilStep("wait for current", () => loader.IsCurrentScreen());
AddAssert($"epilepsy warning {(warning ? "present" : "absent")}", () => (getWarning() != null) == warning);
if (warning)
{
AddUntilStep("sound volume decreased", () => Beatmap.Value.Track.AggregateVolume.Value == 0.25);
AddUntilStep("sound volume restored", () => Beatmap.Value.Track.AggregateVolume.Value == 1);
}
AddAssert($"epilepsy warning {(warning ? "present" : "absent")}", () => this.ChildrenOfType<PlayerLoaderDisclaimer>().Count(), () => Is.EqualTo(warning ? 1 : 0));
restoreVolumes();
}
@ -357,30 +351,7 @@ namespace osu.Game.Tests.Visual.Gameplay
AddUntilStep("wait for current", () => loader.IsCurrentScreen());
AddUntilStep("epilepsy warning absent", () => getWarning() == null);
restoreVolumes();
}
[Test]
public void TestEpilepsyWarningEarlyExit()
{
saveVolumes();
setFullVolume();
AddStep("enable storyboards", () => config.SetValue(OsuSetting.ShowStoryboard, true));
AddStep("set epilepsy warning", () => epilepsyWarning = true);
AddStep("load dummy beatmap", () => resetPlayer(false));
AddUntilStep("wait for current", () => loader.IsCurrentScreen());
AddUntilStep("wait for epilepsy warning", () => getWarning().Alpha > 0);
AddUntilStep("warning is shown", () => getWarning().State.Value == Visibility.Visible);
AddStep("exit early", () => loader.Exit());
AddUntilStep("warning is hidden", () => getWarning().State.Value == Visibility.Hidden);
AddUntilStep("sound volume restored", () => Beatmap.Value.Track.AggregateVolume.Value == 1);
AddUntilStep("epilepsy warning absent", () => this.ChildrenOfType<PlayerLoaderDisclaimer>().Single().Alpha, () => Is.Zero);
restoreVolumes();
}
@ -479,8 +450,6 @@ namespace osu.Game.Tests.Visual.Gameplay
AddStep("click notification", () => notification.TriggerClick());
}
private EpilepsyWarning getWarning() => loader.ChildrenOfType<EpilepsyWarning>().SingleOrDefault(w => w.IsAlive);
private partial class TestPlayerLoader : PlayerLoader
{
public new VisualSettings VisualSettings => base.VisualSettings;

102
osu.Game/Screens/Play/EpilepsyWarning.cs
View File

@ -1,102 +0,0 @@
// 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 osu.Framework.Allocation;
using osu.Framework.Graphics;
using osu.Framework.Graphics.Containers;
using osu.Framework.Graphics.Sprites;
using osu.Game.Graphics;
using osu.Game.Graphics.Containers;
using osu.Game.Screens.Backgrounds;
using osuTK;
namespace osu.Game.Screens.Play
{
public partial class EpilepsyWarning : VisibilityContainer
{
public const double FADE_DURATION = 250;
public EpilepsyWarning()
{
RelativeSizeAxes = Axes.Both;
Alpha = 0f;
}
private BackgroundScreenBeatmap dimmableBackground;
public BackgroundScreenBeatmap DimmableBackground
{
get => dimmableBackground;
set
{
dimmableBackground = value;
if (IsLoaded)
updateBackgroundFade();
}
}
[BackgroundDependencyLoader]
private void load(OsuColour colours)
{
Children = new Drawable[]
{
new FillFlowContainer
{
Anchor = Anchor.Centre,
Origin = Anchor.Centre,
RelativeSizeAxes = Axes.X,
AutoSizeAxes = Axes.Y,
Direction = FillDirection.Vertical,
Children = new Drawable[]
{
new SpriteIcon
{
Colour = colours.Yellow,
Anchor = Anchor.Centre,
Origin = Anchor.Centre,
Icon = FontAwesome.Solid.ExclamationTriangle,
Size = new Vector2(50),
},
new OsuTextFlowContainer(s => s.Font = OsuFont.GetFont(size: 25))
{
RelativeSizeAxes = Axes.X,
AutoSizeAxes = Axes.Y,
TextAnchor = Anchor.Centre,
Anchor = Anchor.Centre,
Origin = Anchor.Centre,
}.With(tfc =>
{
tfc.AddText("This beatmap contains scenes with ");
tfc.AddText("rapidly flashing colours", s =>
{
s.Font = s.Font.With(weight: FontWeight.Bold);
s.Colour = colours.Yellow;
});
tfc.AddText(".");
tfc.NewParagraph();
tfc.AddText("Please take caution if you are affected by epilepsy.");
}),
}
}
};
}
protected override void PopIn()
{
updateBackgroundFade();
this.FadeIn(FADE_DURATION, Easing.OutQuint);
}
private void updateBackgroundFade()
{
DimmableBackground?.FadeColour(OsuColour.Gray(0.5f), FADE_DURATION, Easing.OutQuint);
}
protected override void PopOut() => this.FadeOut(FADE_DURATION);
}
}

67
osu.Game/Screens/Play/PlayerLoader.cs
View File

@ -71,6 +71,7 @@ namespace osu.Game.Screens.Play
protected Task? DisposalTask { get; private set; }
private FillFlowContainer disclaimers = null!;
private OsuScrollContainer settingsScroll = null!;
private Bindable<bool> showStoryboards = null!;
@ -137,7 +138,7 @@ namespace osu.Game.Screens.Play
private ScheduledDelegate? scheduledPushPlayer;
private EpilepsyWarning? epilepsyWarning;
private PlayerLoaderDisclaimer? epilepsyWarning;
private bool quickRestart;
@ -188,6 +189,16 @@ namespace osu.Game.Screens.Play
Origin = Anchor.Centre,
},
}),
disclaimers = new FillFlowContainer
{
Anchor = Anchor.TopLeft,
Origin = Anchor.TopLeft,
RelativeSizeAxes = Axes.Y,
AutoSizeAxes = Axes.X,
Direction = FillDirection.Vertical,
Padding = new MarginPadding(padding),
Spacing = new Vector2(padding),
},
settingsScroll = new OsuScrollContainer
{
Anchor = Anchor.TopRight,
@ -216,11 +227,7 @@ namespace osu.Game.Screens.Play
if (Beatmap.Value.BeatmapInfo.EpilepsyWarning)
{
AddInternal(epilepsyWarning = new EpilepsyWarning
{
Anchor = Anchor.Centre,
Origin = Anchor.Centre,
});
disclaimers.Add(epilepsyWarning = new PlayerLoaderDisclaimer("This beatmap contains scenes with rapidly flashing colours", "Please take caution if you are affected by epilepsy."));
}
}
@ -229,6 +236,9 @@ namespace osu.Game.Screens.Play
base.LoadComplete();
inputManager = GetContainingInputManager();
showStoryboards.BindValueChanged(val => epilepsyWarning?.FadeTo(val.NewValue ? 1 : 0, 250, Easing.OutQuint), true);
epilepsyWarning?.FinishTransforms(true);
}
#region Screen handling
@ -237,15 +247,10 @@ namespace osu.Game.Screens.Play
{
base.OnEntering(e);
ApplyToBackground(b =>
{
if (epilepsyWarning != null)
epilepsyWarning.DimmableBackground = b;
});
Beatmap.Value.Track.AddAdjustment(AdjustableProperty.Volume, volumeAdjustment);
// Start off-screen.
// Start side content off-screen.
disclaimers.MoveToX(-disclaimers.DrawWidth);
settingsScroll.MoveToX(settingsScroll.DrawWidth);
content.ScaleTo(0.7f);
@ -301,9 +306,6 @@ namespace osu.Game.Screens.Play
cancelLoad();
ContentOut();
// If the load sequence was interrupted, the epilepsy warning may already be displayed (or in the process of being displayed).
epilepsyWarning?.Hide();
// Ensure the screen doesn't expire until all the outwards fade operations have completed.
this.Delay(CONTENT_OUT_DURATION).FadeOut();
@ -433,6 +435,8 @@ namespace osu.Game.Screens.Play
content.FadeInFromZero(500, Easing.OutQuint);
content.ScaleTo(1, 650, Easing.OutQuint).Then().Schedule(prepareNewPlayer);
disclaimers.FadeInFromZero(500, Easing.Out)
.MoveToX(0, 500, Easing.OutQuint);
settingsScroll.FadeInFromZero(500, Easing.Out)
.MoveToX(0, 500, Easing.OutQuint);
@ -466,6 +470,8 @@ namespace osu.Game.Screens.Play
lowPassFilter = null;
});
disclaimers.FadeOut(CONTENT_OUT_DURATION, Easing.Out)
.MoveToX(-disclaimers.DrawWidth, CONTENT_OUT_DURATION * 2, Easing.OutQuint);
settingsScroll.FadeOut(CONTENT_OUT_DURATION, Easing.OutQuint)
.MoveToX(settingsScroll.DrawWidth, CONTENT_OUT_DURATION * 2, Easing.OutQuint);
@ -503,33 +509,8 @@ namespace osu.Game.Screens.Play
TransformSequence<PlayerLoader> pushSequence = this.Delay(0);
// only show if the warning was created (i.e. the beatmap needs it)
// and this is not a restart of the map (the warning expires after first load).
//
// note the late check of storyboard enable as the user may have just changed it
// from the settings on the loader screen.
if (epilepsyWarning?.IsAlive == true && showStoryboards.Value)
{
const double epilepsy_display_length = 3000;
pushSequence
.Delay(CONTENT_OUT_DURATION)
.Schedule(() => epilepsyWarning.State.Value = Visibility.Visible)
.TransformBindableTo(volumeAdjustment, 0.25, EpilepsyWarning.FADE_DURATION, Easing.OutQuint)
.Delay(epilepsy_display_length)
.Schedule(() =>
{
epilepsyWarning.Hide();
epilepsyWarning.Expire();
})
.Delay(EpilepsyWarning.FADE_DURATION);
}
else
{
// This goes hand-in-hand with the restoration of low pass filter in contentOut().
this.TransformBindableTo(volumeAdjustment, 0, CONTENT_OUT_DURATION, Easing.OutCubic);
epilepsyWarning?.Expire();
}
// This goes hand-in-hand with the restoration of low pass filter in contentOut().
this.TransformBindableTo(volumeAdjustment, 0, CONTENT_OUT_DURATION, Easing.OutCubic);
pushSequence.Schedule(() =>
{