From 9d65d394d3bf6c00502101ca818f470803452d90 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Tue, 5 Nov 2024 12:51:26 +0900
Subject: [PATCH] Add ability to hide breaks from timeline

This was another IRL request from a mapper / team member. The rationale
here is that it can be very annoying to map with break time enabled if
you have a large gap in the beatmap you are trying to fill with
hitobjects, as you are placing objects on top of a very gray area.
---
 osu.Game/Configuration/OsuConfigManager.cs          |  4 +++-
 osu.Game/Localisation/EditorStrings.cs              |  5 +++++
 .../Components/Timeline/TimelineBreakDisplay.cs     | 13 +++++++++++++
 osu.Game/Screens/Edit/Editor.cs                     |  6 ++++++
 4 files changed, 27 insertions(+), 1 deletion(-)

diff --git a/osu.Game/Configuration/OsuConfigManager.cs b/osu.Game/Configuration/OsuConfigManager.cs
index 1c6479e6f52d..f642d23bb03c 100644
--- a/osu.Game/Configuration/OsuConfigManager.cs
+++ b/osu.Game/Configuration/OsuConfigManager.cs
@@ -207,6 +207,7 @@ protected override void InitialiseDefaults()
             SetDefault<UserStatus?>(OsuSetting.UserOnlineStatus, null);
 
             SetDefault(OsuSetting.EditorTimelineShowTimingChanges, true);
+            SetDefault(OsuSetting.EditorTimelineShowBreaks, true);
             SetDefault(OsuSetting.EditorTimelineShowTicks, true);
 
             SetDefault(OsuSetting.EditorContractSidebars, false);
@@ -439,6 +440,7 @@ public enum OsuSetting
         AlwaysShowHoldForMenuButton,
         EditorContractSidebars,
         EditorScaleOrigin,
-        EditorRotationOrigin
+        EditorRotationOrigin,
+        EditorTimelineShowBreaks,
     }
 }
diff --git a/osu.Game/Localisation/EditorStrings.cs b/osu.Game/Localisation/EditorStrings.cs
index f6cce554e97e..1ba03b3fde31 100644
--- a/osu.Game/Localisation/EditorStrings.cs
+++ b/osu.Game/Localisation/EditorStrings.cs
@@ -139,6 +139,11 @@ public static class EditorStrings
         /// </summary>
         public static LocalisableString TimelineShowTimingChanges => new TranslatableString(getKey(@"timeline_show_timing_changes"), @"Show timing changes");
 
+        /// <summary>
+        /// "Show breaks"
+        /// </summary>
+        public static LocalisableString TimelineShowBreaks => new TranslatableString(getKey(@"timeline_show_breaks"), @"Show breaks");
+
         /// <summary>
         /// "Show ticks"
         /// </summary>
diff --git a/osu.Game/Screens/Edit/Compose/Components/Timeline/TimelineBreakDisplay.cs b/osu.Game/Screens/Edit/Compose/Components/Timeline/TimelineBreakDisplay.cs
index eca44672f6fd..381816c54605 100644
--- a/osu.Game/Screens/Edit/Compose/Components/Timeline/TimelineBreakDisplay.cs
+++ b/osu.Game/Screens/Edit/Compose/Components/Timeline/TimelineBreakDisplay.cs
@@ -6,6 +6,7 @@
 using osu.Framework.Bindables;
 using osu.Framework.Caching;
 using osu.Game.Beatmaps.Timing;
+using osu.Game.Configuration;
 using osu.Game.Screens.Edit.Components.Timelines.Summary.Parts;
 
 namespace osu.Game.Screens.Edit.Compose.Components.Timeline
@@ -27,6 +28,15 @@ public partial class TimelineBreakDisplay : TimelinePart<TimelineBreak>
 
         private readonly BindableList<BreakPeriod> breaks = new BindableList<BreakPeriod>();
 
+        private readonly BindableBool showBreaks = new BindableBool(true);
+
+        [BackgroundDependencyLoader]
+        private void load(OsuConfigManager configManager)
+        {
+            configManager.BindWith(OsuSetting.EditorTimelineShowBreaks, showBreaks);
+            showBreaks.BindValueChanged(_ => breakCache.Invalidate());
+        }
+
         protected override void LoadBeatmap(EditorBeatmap beatmap)
         {
             base.LoadBeatmap(beatmap);
@@ -67,6 +77,9 @@ private void recreateBreaks()
         {
             Clear();
 
+            if (!showBreaks.Value)
+                return;
+
             for (int i = 0; i < breaks.Count; i++)
             {
                 var breakPeriod = breaks[i];
diff --git a/osu.Game/Screens/Edit/Editor.cs b/osu.Game/Screens/Edit/Editor.cs
index be493439334e..6262bb7aba32 100644
--- a/osu.Game/Screens/Edit/Editor.cs
+++ b/osu.Game/Screens/Edit/Editor.cs
@@ -214,6 +214,7 @@ protected override IReadOnlyDependencyContainer CreateChildDependencies(IReadOnl
         private Bindable<bool> editorAutoSeekOnPlacement;
         private Bindable<bool> editorLimitedDistanceSnap;
         private Bindable<bool> editorTimelineShowTimingChanges;
+        private Bindable<bool> editorTimelineShowBreaks;
         private Bindable<bool> editorTimelineShowTicks;
         private Bindable<bool> editorContractSidebars;
 
@@ -323,6 +324,7 @@ private void load(OsuConfigManager config)
             editorAutoSeekOnPlacement = config.GetBindable<bool>(OsuSetting.EditorAutoSeekOnPlacement);
             editorLimitedDistanceSnap = config.GetBindable<bool>(OsuSetting.EditorLimitedDistanceSnap);
             editorTimelineShowTimingChanges = config.GetBindable<bool>(OsuSetting.EditorTimelineShowTimingChanges);
+            editorTimelineShowBreaks = config.GetBindable<bool>(OsuSetting.EditorTimelineShowBreaks);
             editorTimelineShowTicks = config.GetBindable<bool>(OsuSetting.EditorTimelineShowTicks);
             editorContractSidebars = config.GetBindable<bool>(OsuSetting.EditorContractSidebars);
 
@@ -390,6 +392,10 @@ private void load(OsuConfigManager config)
                                                     {
                                                         State = { BindTarget = editorTimelineShowTicks }
                                                     },
+                                                    new ToggleMenuItem(EditorStrings.TimelineShowBreaks)
+                                                    {
+                                                        State = { BindTarget = editorTimelineShowBreaks }
+                                                    },
                                                 ]
                                             },
                                             new BackgroundDimMenuItem(editorBackgroundDim),