From 4d22f262667972c4bf20cf1c117d8a7e1e5f2f45 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Tue, 10 May 2022 19:07:07 +0900
Subject: [PATCH] Rename property and improve xmldoc

---
 osu.Game.Tournament/TournamentGame.cs |  2 +-
 osu.Game/OsuGame.cs                   |  2 +-
 osu.Game/OsuGameBase.cs               | 11 ++++++++---
 3 files changed, 10 insertions(+), 5 deletions(-)

diff --git a/osu.Game.Tournament/TournamentGame.cs b/osu.Game.Tournament/TournamentGame.cs
index d9db0e6d20..042e660122 100644
--- a/osu.Game.Tournament/TournamentGame.cs
+++ b/osu.Game.Tournament/TournamentGame.cs
@@ -40,7 +40,7 @@ namespace osu.Game.Tournament
         private Bindable<WindowMode> windowMode;
         private LoadingSpinner loadingSpinner;
 
-        protected override int SoftHandledExceptions => DebugUtils.IsDebugBuild ? 0 : 1;
+        protected override int ExceptionsBeforeCrash => DebugUtils.IsDebugBuild ? 0 : 1;
 
         [BackgroundDependencyLoader]
         private void load(FrameworkConfigManager frameworkConfig, GameHost host)
diff --git a/osu.Game/OsuGame.cs b/osu.Game/OsuGame.cs
index 6961dce910..0cfb3c2de8 100644
--- a/osu.Game/OsuGame.cs
+++ b/osu.Game/OsuGame.cs
@@ -176,7 +176,7 @@ namespace osu.Game
 
         private readonly List<OverlayContainer> visibleBlockingOverlays = new List<OverlayContainer>();
 
-        protected override int SoftHandledExceptions => DebugUtils.IsDebugBuild ? 0 : 1;
+        protected override int ExceptionsBeforeCrash => DebugUtils.IsDebugBuild ? 0 : 1;
 
         public OsuGame(string[] args = null)
         {
diff --git a/osu.Game/OsuGameBase.cs b/osu.Game/OsuGameBase.cs
index 3a35bce05c..b17526114a 100644
--- a/osu.Game/OsuGameBase.cs
+++ b/osu.Game/OsuGameBase.cs
@@ -182,15 +182,20 @@ namespace osu.Game
         protected DatabaseContextFactory EFContextFactory { get; private set; }
 
         /// <summary>
-        /// Number of exceptions to allow before aborting execution.
+        /// Number of unhandled exceptions to allow before aborting execution.
         /// </summary>
-        protected virtual int SoftHandledExceptions => 0;
+        /// <remarks>
+        /// When an unhandled exception is encountered, an internal count will be decremented.
+        /// If the count hits zero, the game will crash.
+        /// Each second, the count is incremented until reaching the value specified.
+        /// </remarks>
+        protected virtual int ExceptionsBeforeCrash => 0;
 
         public OsuGameBase()
         {
             Name = @"osu!";
 
-            allowableExceptions = SoftHandledExceptions;
+            allowableExceptions = ExceptionsBeforeCrash;
         }
 
         [BackgroundDependencyLoader]