// Copyright (c) ppy Pty Ltd . 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.Linq; using osu.Framework; using osu.Framework.Allocation; using osu.Framework.Audio; using osu.Framework.Audio.Sample; using osu.Framework.Bindables; using osu.Framework.Extensions.IEnumerableExtensions; using osu.Framework.Extensions.LocalisationExtensions; using osu.Framework.Graphics; using osu.Framework.Graphics.Containers; using osu.Framework.Input.Bindings; using osu.Framework.Input.Events; using osu.Framework.Logging; using osu.Framework.Platform; using osu.Framework.Threading; using osu.Game.Graphics; using osu.Game.Graphics.Containers; using osu.Game.Input; using osu.Game.Input.Bindings; using osu.Game.Localisation; using osu.Game.Online.API; using osu.Game.Overlays; using osuTK; using osuTK.Graphics; using osuTK.Input; namespace osu.Game.Screens.Menu { public partial class ButtonSystem : Container, IStateful, IKeyBindingHandler { public const float BUTTON_WIDTH = 140f; public const float WEDGE_WIDTH = 20; public event Action? StateChanged; public Action? OnEditBeatmap; public Action? OnEditSkin; public Action? OnExit; public Action? OnBeatmapListing; public Action? OnSolo; public Action? OnSettings; public Action? OnMultiplayer; public Action? OnPlaylists; private readonly IBindable isIdle = new BindableBool(); private OsuLogo? logo; /// /// Assign the that this ButtonSystem should manage the position of. /// /// The instance of the logo to be assigned. If null, we are suspending from the screen that uses this ButtonSystem. public void SetOsuLogo(OsuLogo? logo) { this.logo = logo; if (this.logo != null) { this.logo.Action = onOsuLogo; // osuLogo.SizeForFlow relies on loading to be complete. buttonArea.Flow.Position = new Vector2(WEDGE_WIDTH * 2 - (BUTTON_WIDTH + this.logo.SizeForFlow / 4), 0); updateLogoState(); } else { // We should stop tracking as the facade is now out of scope. logoTrackingContainer.StopTracking(); } } private readonly ButtonArea buttonArea; private readonly MainMenuButton backButton; private readonly List buttonsTopLevel = new List(); private readonly List buttonsPlay = new List(); private readonly List buttonsEdit = new List(); private Sample? sampleBackToLogo; private Sample? sampleLogoSwoosh; private readonly LogoTrackingContainer logoTrackingContainer; public bool ReturnToTopOnIdle { get; set; } = true; public ButtonSystem() { RelativeSizeAxes = Axes.Both; Child = logoTrackingContainer = new LogoTrackingContainer { RelativeSizeAxes = Axes.Both, Child = buttonArea = new ButtonArea() }; buttonArea.AddRange(new Drawable[] { new MainMenuButton(ButtonSystemStrings.Settings, string.Empty, OsuIcon.Settings, new Color4(85, 85, 85, 255), () => OnSettings?.Invoke(), -WEDGE_WIDTH, Key.O), backButton = new MainMenuButton(ButtonSystemStrings.Back, @"back-to-top", OsuIcon.PrevCircle, new Color4(51, 58, 94, 255), () => State = ButtonSystemState.TopLevel, -WEDGE_WIDTH) { VisibleStateMin = ButtonSystemState.Play, VisibleStateMax = ButtonSystemState.Edit, }, logoTrackingContainer.LogoFacade.With(d => d.Scale = new Vector2(0.74f)) }); buttonArea.Flow.CentreTarget = logoTrackingContainer.LogoFacade; } [Resolved] private IAPIProvider api { get; set; } = null!; [Resolved] private OsuGame? game { get; set; } [Resolved] private LoginOverlay? loginOverlay { get; set; } [BackgroundDependencyLoader] private void load(AudioManager audio, IdleTracker? idleTracker, GameHost host) { buttonsPlay.Add(new MainMenuButton(ButtonSystemStrings.Solo, @"button-default-select", OsuIcon.Player, new Color4(102, 68, 204, 255), () => OnSolo?.Invoke(), WEDGE_WIDTH, Key.P)); buttonsPlay.Add(new MainMenuButton(ButtonSystemStrings.Multi, @"button-default-select", OsuIcon.Online, new Color4(94, 63, 186, 255), onMultiplayer, 0, Key.M)); buttonsPlay.Add(new MainMenuButton(ButtonSystemStrings.Playlists, @"button-default-select", OsuIcon.Tournament, new Color4(94, 63, 186, 255), onPlaylists, 0, Key.L)); buttonsPlay.ForEach(b => b.VisibleState = ButtonSystemState.Play); buttonsEdit.Add(new MainMenuButton(EditorStrings.BeatmapEditor.ToLower(), @"button-default-select", OsuIcon.Beatmap, new Color4(238, 170, 0, 255), () => OnEditBeatmap?.Invoke(), WEDGE_WIDTH, Key.B)); buttonsEdit.Add(new MainMenuButton(SkinEditorStrings.SkinEditor.ToLower(), @"button-default-select", OsuIcon.SkinB, new Color4(220, 160, 0, 255), () => OnEditSkin?.Invoke(), 0, Key.S)); buttonsEdit.ForEach(b => b.VisibleState = ButtonSystemState.Edit); buttonsTopLevel.Add(new MainMenuButton(ButtonSystemStrings.Play, @"button-play-select", OsuIcon.Logo, new Color4(102, 68, 204, 255), () => State = ButtonSystemState.Play, WEDGE_WIDTH, Key.P)); buttonsTopLevel.Add(new MainMenuButton(ButtonSystemStrings.Edit, @"button-play-select", OsuIcon.EditCircle, new Color4(238, 170, 0, 255), () => State = ButtonSystemState.Edit, 0, Key.E)); buttonsTopLevel.Add(new MainMenuButton(ButtonSystemStrings.Browse, @"button-default-select", OsuIcon.Beatmap, new Color4(165, 204, 0, 255), () => OnBeatmapListing?.Invoke(), 0, Key.B, Key.D)); if (host.CanExit) buttonsTopLevel.Add(new MainMenuButton(ButtonSystemStrings.Exit, string.Empty, OsuIcon.CrossCircle, new Color4(238, 51, 153, 255), () => OnExit?.Invoke(), 0, Key.Q)); buttonArea.AddRange(buttonsPlay); buttonArea.AddRange(buttonsEdit); buttonArea.AddRange(buttonsTopLevel); buttonArea.ForEach(b => { if (b is MainMenuButton) { b.Origin = Anchor.CentreLeft; b.Anchor = Anchor.CentreLeft; } }); isIdle.ValueChanged += idle => updateIdleState(idle.NewValue); if (idleTracker != null) isIdle.BindTo(idleTracker.IsIdle); sampleBackToLogo = audio.Samples.Get(@"Menu/back-to-logo"); sampleLogoSwoosh = audio.Samples.Get(@"Menu/osu-logo-swoosh"); } private void onMultiplayer() { if (api.State.Value != APIState.Online) { loginOverlay?.Show(); return; } OnMultiplayer?.Invoke(); } private void onPlaylists() { if (api.State.Value != APIState.Online) { loginOverlay?.Show(); return; } OnPlaylists?.Invoke(); } private void updateIdleState(bool isIdle) { if (!ReturnToTopOnIdle) return; if (isIdle && State != ButtonSystemState.Exit && State != ButtonSystemState.EnteringMode) State = ButtonSystemState.Initial; } /// /// Triggers the if the current is . /// /// true if the was triggered, false otherwise. private bool triggerInitialOsuLogo() { if (State == ButtonSystemState.Initial) { StopSamplePlayback(); logo?.TriggerClick(); return true; } return false; } protected override bool OnKeyDown(KeyDownEvent e) { if (e.Repeat || e.ControlPressed || e.ShiftPressed || e.AltPressed || e.SuperPressed) return false; if (triggerInitialOsuLogo()) return true; return base.OnKeyDown(e); } protected override bool OnJoystickPress(JoystickPressEvent e) { if (triggerInitialOsuLogo()) return true; return base.OnJoystickPress(e); } protected override bool OnMidiDown(MidiDownEvent e) { if (triggerInitialOsuLogo()) return true; return base.OnMidiDown(e); } public bool OnPressed(KeyBindingPressEvent e) { if (e.Repeat) return false; switch (e.Action) { case GlobalAction.Back: return goBack(); case GlobalAction.Select: logo?.TriggerClick(); return true; default: return false; } } public void OnReleased(KeyBindingReleaseEvent e) { } private bool goBack() { switch (State) { case ButtonSystemState.TopLevel: State = ButtonSystemState.Initial; // Samples are explicitly played here in response to user interaction and not when transitioning due to idle. StopSamplePlayback(); sampleBackToLogo?.Play(); return true; case ButtonSystemState.Edit: case ButtonSystemState.Play: StopSamplePlayback(); backButton.TriggerClick(); return true; default: return false; } } public void StopSamplePlayback() { buttonsPlay.ForEach(button => button.StopSamplePlayback()); buttonsTopLevel.ForEach(button => button.StopSamplePlayback()); logo?.StopSamplePlayback(); } private bool onOsuLogo() { switch (state) { default: return false; case ButtonSystemState.Initial: State = ButtonSystemState.TopLevel; return true; case ButtonSystemState.TopLevel: buttonsTopLevel.First().TriggerClick(); return false; case ButtonSystemState.Play: buttonsPlay.First().TriggerClick(); return false; case ButtonSystemState.Edit: buttonsEdit.First().TriggerClick(); return false; } } private ButtonSystemState state = ButtonSystemState.Initial; public override bool HandleNonPositionalInput => state != ButtonSystemState.Exit; public override bool HandlePositionalInput => state != ButtonSystemState.Exit; public ButtonSystemState State { get => state; set { if (state == value) return; ButtonSystemState lastState = state; state = value; updateLogoState(lastState); Logger.Log($"{nameof(ButtonSystem)}'s state changed from {lastState} to {state}"); buttonArea.FinishTransforms(true); using (buttonArea.BeginDelayedSequence(lastState == ButtonSystemState.Initial ? 150 : 0)) { buttonArea.ButtonSystemState = state; foreach (var b in buttonArea.OfType()) b.ButtonSystemState = state; } StateChanged?.Invoke(State); } } private ScheduledDelegate? logoDelayedAction; private void updateLogoState(ButtonSystemState lastState = ButtonSystemState.Initial) { if (logo == null) return; switch (state) { case ButtonSystemState.Exit: case ButtonSystemState.Initial: logoDelayedAction?.Cancel(); logoDelayedAction = Scheduler.AddDelayed(() => { logoTrackingContainer.StopTracking(); game?.Toolbar.Hide(); logo?.ClearTransforms(targetMember: nameof(Position)); logo?.MoveTo(new Vector2(0.5f), 800, Easing.OutExpo); logo?.ScaleTo(1, 800, Easing.OutExpo); }, buttonArea.Alpha * 150); if (lastState == ButtonSystemState.TopLevel) sampleLogoSwoosh?.Play(); break; case ButtonSystemState.TopLevel: case ButtonSystemState.Play: switch (lastState) { case ButtonSystemState.TopLevel: // coming from toplevel to play break; case ButtonSystemState.Initial: logo.ClearTransforms(targetMember: nameof(Position)); bool impact = logo.Scale.X > 0.6f; logo.ScaleTo(0.5f, 200, Easing.In); logoTrackingContainer.StartTracking(logo, 200, Easing.In); logoDelayedAction?.Cancel(); logoDelayedAction = Scheduler.AddDelayed(() => { if (impact) logo?.Impact(); game?.Toolbar.Show(); }, 200); break; default: logo.ClearTransforms(targetMember: nameof(Position)); logoTrackingContainer.StartTracking(logo, 0, Easing.In); logo.ScaleTo(0.5f, 200, Easing.OutQuint); break; } break; case ButtonSystemState.EnteringMode: logoTrackingContainer.StartTracking(logo, lastState == ButtonSystemState.Initial ? MainMenu.FADE_OUT_DURATION : 0, Easing.InSine); break; } } } public enum ButtonSystemState { Exit, Initial, TopLevel, Play, Edit, EnteringMode, } }