Centralise game language update logic

osu.Game/OsuGameBase.cs

@@ -14,6 +14,7 @@
 using osu.Framework.Audio;
 using osu.Framework.Audio.Track;
 using osu.Framework.Bindables;
+using osu.Framework.Configuration;
 using osu.Framework.Development;
 using osu.Framework.Extensions;
 using osu.Framework.Graphics;
@@ -27,6 +28,7 @@
 using osu.Framework.Input.Handlers.Tablet;
 using osu.Framework.Input.Handlers.Touch;
 using osu.Framework.IO.Stores;
+using osu.Framework.Localisation;
 using osu.Framework.Logging;
 using osu.Framework.Platform;
 using osu.Framework.Timing;
@@ -36,11 +38,13 @@
 using osu.Game.Beatmaps.Formats;
 using osu.Game.Configuration;
 using osu.Game.Database;
+using osu.Game.Extensions;
 using osu.Game.Graphics;
 using osu.Game.Graphics.Cursor;
 using osu.Game.Input;
 using osu.Game.Input.Bindings;
 using osu.Game.IO;
+using osu.Game.Localisation;
 using osu.Game.Online;
 using osu.Game.Online.API;
 using osu.Game.Online.Chat;
@@ -157,6 +161,11 @@ public virtual string Version
 
         protected Storage Storage { get; set; }
 
+        /// <summary>
+        /// The language in which the game is currently displayed in.
+        /// </summary>
+        public Bindable<Language> CurrentLanguage { get; } = new Bindable<Language>();
+
         protected Bindable<WorkingBeatmap> Beatmap { get; private set; } // cached via load() method
 
         /// <summary>
@@ -216,6 +225,10 @@ public virtual string Version
 
         private readonly BindableNumber<double> globalTrackVolumeAdjust = new BindableNumber<double>(global_track_volume_adjust);
 
+        private Bindable<string> frameworkLocale = null!;
+
+        private IBindable<LocalisationParameters> localisationParameters = null!;
+
         /// <summary>
         /// Number of unhandled exceptions to allow before aborting execution.
         /// </summary>
@@ -238,7 +251,7 @@ public OsuGameBase()
         }
 
         [BackgroundDependencyLoader]
-        private void load(ReadableKeyCombinationProvider keyCombinationProvider)
+        private void load(ReadableKeyCombinationProvider keyCombinationProvider, FrameworkConfigManager frameworkConfig)
         {
             try
             {
@@ -284,6 +297,14 @@ private void load(ReadableKeyCombinationProvider keyCombinationProvider)
             MessageFormatter.WebsiteRootUrl = endpoints.WebsiteRootUrl;
 
             dependencies.CacheAs(API ??= new APIAccess(LocalConfig, endpoints, VersionHash));
+            frameworkLocale = frameworkConfig.GetBindable<string>(FrameworkSetting.Locale);
+            frameworkLocale.BindValueChanged(_ => updateLanguage());
+
+            localisationParameters = Localisation.CurrentParameters.GetBoundCopy();
+            localisationParameters.BindValueChanged(_ => updateLanguage(), true);
+
+            CurrentLanguage.BindValueChanged(val => frameworkLocale.Value = val.NewValue.ToCultureCode());
+
 
             var defaultBeatmap = new DummyWorkingBeatmap(Audio, Textures);
 
@@ -394,6 +415,8 @@ private void load(ReadableKeyCombinationProvider keyCombinationProvider)
             Beatmap.BindValueChanged(onBeatmapChanged);
         }
 
+        private void updateLanguage() => CurrentLanguage.Value = LanguageExtensions.GetLanguageFor(frameworkLocale.Value, localisationParameters.Value);
+
         private void addFilesWarning()
         {
             var realmStore = new RealmFileStore(realm, Storage);

osu.Game/Overlays/FirstRunSetup/ScreenWelcome.cs

@@ -13,7 +13,6 @@
 using osu.Framework.Input.Events;
 using osu.Framework.Localisation;
 using osu.Framework.Threading;
-using osu.Game.Extensions;
 using osu.Game.Graphics;
 using osu.Game.Graphics.Containers;
 using osu.Game.Graphics.Sprites;
@@ -68,13 +67,12 @@ private void load(FrameworkConfigManager frameworkConfig)
 
         private partial class LanguageSelectionFlow : FillFlowContainer
         {
-            private Bindable<string> frameworkLocale = null!;
-            private IBindable<LocalisationParameters> localisationParameters = null!;
+            private Bindable<Language> language = null!;
 
             private ScheduledDelegate? updateSelectedDelegate;
 
             [BackgroundDependencyLoader]
-            private void load(FrameworkConfigManager frameworkConfig, LocalisationManager localisation)
+            private void load(OsuGameBase game)
             {
                 Direction = FillDirection.Full;
                 Spacing = new Vector2(5);
@@ -82,25 +80,18 @@ private void load(FrameworkConfigManager frameworkConfig, LocalisationManager lo
                 ChildrenEnumerable = Enum.GetValues<Language>()
                                          .Select(l => new LanguageButton(l)
                                          {
-                                             Action = () => frameworkLocale.Value = l.ToCultureCode()
+                                             Action = () => language.Value = l,
                                          });
 
-                frameworkLocale = frameworkConfig.GetBindable<string>(FrameworkSetting.Locale);
-                frameworkLocale.BindValueChanged(_ => onLanguageChange());
-
-                localisationParameters = localisation.CurrentParameters.GetBoundCopy();
-                localisationParameters.BindValueChanged(_ => onLanguageChange(), true);
-            }
-
-            private void onLanguageChange()
-            {
-                var language = LanguageExtensions.GetLanguageFor(frameworkLocale.Value, localisationParameters.Value);
-
-                // Changing language may cause a short period of blocking the UI thread while the new glyphs are loaded.
-                // Scheduling ensures the button animation plays smoothly after any blocking operation completes.
-                // Note that a delay is required (the alternative would be a double-schedule; delay feels better).
-                updateSelectedDelegate?.Cancel();
-                updateSelectedDelegate = Scheduler.AddDelayed(() => updateSelectedStates(language), 50);
+                language = game.CurrentLanguage.GetBoundCopy();
+                language.BindValueChanged(v =>
+                {
+                    // Changing language may cause a short period of blocking the UI thread while the new glyphs are loaded.
+                    // Scheduling ensures the button animation plays smoothly after any blocking operation completes.
+                    // Note that a delay is required (the alternative would be a double-schedule; delay feels better).
+                    updateSelectedDelegate?.Cancel();
+                    updateSelectedDelegate = Scheduler.AddDelayed(() => updateSelectedStates(v.NewValue), 50);
+                }, true);
             }
 
             private void updateSelectedStates(Language language)

osu.Game/Overlays/Settings/Sections/General/LanguageSettings.cs

@@ -2,35 +2,27 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using osu.Framework.Allocation;
-using osu.Framework.Bindables;
 using osu.Framework.Configuration;
 using osu.Framework.Graphics;
 using osu.Framework.Localisation;
 using osu.Game.Configuration;
-using osu.Game.Extensions;
 using osu.Game.Localisation;
 
 namespace osu.Game.Overlays.Settings.Sections.General
 {
     public partial class LanguageSettings : SettingsSubsection
     {
-        private SettingsDropdown<Language> languageSelection = null!;
-        private Bindable<string> frameworkLocale = null!;
-        private IBindable<LocalisationParameters> localisationParameters = null!;
-
         protected override LocalisableString Header => GeneralSettingsStrings.LanguageHeader;
 
         [BackgroundDependencyLoader]
-        private void load(FrameworkConfigManager frameworkConfig, OsuConfigManager config, LocalisationManager localisation)
+        private void load(OsuGame game, OsuConfigManager config, FrameworkConfigManager frameworkConfig)
         {
-            frameworkLocale = frameworkConfig.GetBindable<string>(FrameworkSetting.Locale);
-            localisationParameters = localisation.CurrentParameters.GetBoundCopy();
-
             Children = new Drawable[]
             {
-                languageSelection = new SettingsEnumDropdown<Language>
+                new SettingsEnumDropdown<Language>
                 {
                     LabelText = GeneralSettingsStrings.LanguageDropdown,
+                    Current = game.CurrentLanguage,
                 },
                 new SettingsCheckbox
                 {
@@ -43,14 +35,6 @@ private void load(FrameworkConfigManager frameworkConfig, OsuConfigManager confi
                     Current = config.GetBindable<bool>(OsuSetting.Prefer24HourTime)
                 },
             };
-
-            frameworkLocale.BindValueChanged(_ => updateSelection());
-            localisationParameters.BindValueChanged(_ => updateSelection(), true);
-
-            languageSelection.Current.BindValueChanged(val => frameworkLocale.Value = val.NewValue.ToCultureCode());
         }
-
-        private void updateSelection() =>
-            languageSelection.Current.Value = LanguageExtensions.GetLanguageFor(frameworkLocale.Value, localisationParameters.Value);
     }
 }