Updated translations update event to go through the Localization wrapper (#5052)

* Updated translations update event to go through the Localization wrapper

* Removed useless looking GameWorld compare to null in translations update

in CreatureStageBase.cs

* Fixed a few random comments

that some new text checker in Rider complained about

Author: hhyyrylainen

simulation_parameters/SimulationParameters.cs

@@ -211,12 +211,16 @@ public override void _Ready()
         GD.Print("SimulationParameters are good");
     }
 
-    public override void _Notification(int what)
+    public override void _EnterTree()
     {
-        if (what == NotificationTranslationChanged)
-        {
-            ApplyTranslations();
-        }
+        base._EnterTree();
+        Localization.Instance.OnTranslationsChanged += ApplyTranslations;
+    }
+
+    public override void _ExitTree()
+    {
+        base._ExitTree();
+        Localization.Instance.OnTranslationsChanged -= ApplyTranslations;
     }
 
     public OrganelleDefinition GetOrganelleType(string name)

src/awakening_stage/gui/RecipeListItem.cs

@@ -60,6 +60,18 @@ public override void _Ready()
         UpdateShownRecipe();
     }
 
+    public override void _EnterTree()
+    {
+        base._EnterTree();
+        Localization.Instance.OnTranslationsChanged += UpdateShownRecipe;
+    }
+
+    public override void _ExitTree()
+    {
+        base._ExitTree();
+        Localization.Instance.OnTranslationsChanged -= UpdateShownRecipe;
+    }
+
     public override void _Notification(int what)
     {
         base._Notification(what);
@@ -68,10 +80,6 @@ public override void _Notification(int what)
         {
             SetLabelSize();
         }
-        else if (what == NotificationTranslationChanged)
-        {
-            UpdateShownRecipe();
-        }
     }
 
     private void SetLabelSize()

src/engine/Localization.cs

@@ -24,9 +24,15 @@ private Localization()
         instance = this;
     }
 
-    public Localization Instance => instance ?? throw new InstanceNotLoadedYetException();
+    public delegate void TranslationsChangedEventHandler();
 
-    // TODO: event for when language changes
+    /// <summary>
+    ///   Event to listen to, to know when translations text / language has changed and some GUI elements may need to
+    ///   update their state
+    /// </summary>
+    public event TranslationsChangedEventHandler? OnTranslationsChanged;
+
+    public static Localization Instance => instance ?? throw new InstanceNotLoadedYetException();
 
     /// <summary>
     ///   Returns text for a translation key for the current language
@@ -105,7 +111,7 @@ private void OnLanguageChanged()
 
         try
         {
-            // TODO: trigger localization change callback
+            OnTranslationsChanged?.Invoke();
         }
         catch (Exception e)
         {

src/general/HelpScreen.cs

@@ -58,18 +58,20 @@ public override void _Ready()
         }
     }
 
-    public override void _Notification(int what)
+    public override void _EnterTree()
     {
-        if (what == NotificationTranslationChanged)
-        {
-            leftColumn.QueueFreeChildren();
-            rightColumn.QueueFreeChildren();
-            BuildHelpTexts(Category);
-        }
+        base._EnterTree();
+        Localization.Instance.OnTranslationsChanged += OnTranslationsChanged;
+    }
+
+    public override void _ExitTree()
+    {
+        base._ExitTree();
+        Localization.Instance.OnTranslationsChanged -= OnTranslationsChanged;
     }
 
     /// <summary>
-    ///   Randomizes the easter egg messages
+    ///   Randomizes the Easter egg messages
     ///   and its chance of showing up.
     /// </summary>
     public void RandomizeEasterEgg()
@@ -147,4 +149,11 @@ private void OnCloseButtonPressed()
     {
         EmitSignal(SignalName.HelpScreenClosed);
     }
+
+    private void OnTranslationsChanged()
+    {
+        leftColumn.QueueFreeChildren();
+        rightColumn.QueueFreeChildren();
+        BuildHelpTexts(Category);
+    }
 }

src/general/MainMenu.cs

@@ -256,6 +256,7 @@ public override void _EnterTree()
 
         Settings.Instance.Menu3DBackgroundEnabled.OnChanged += OnMenuBackgroundTypeChanged;
         ThriveopediaManager.Instance.OnPageOpenedHandler += OnThriveopediaOpened;
+        Localization.Instance.OnTranslationsChanged += OnTranslationsChanged;
     }
 
     public override void _ExitTree()
@@ -264,6 +265,7 @@ public override void _ExitTree()
 
         Settings.Instance.Menu3DBackgroundEnabled.OnChanged -= OnMenuBackgroundTypeChanged;
         ThriveopediaManager.Instance.OnPageOpenedHandler -= OnThriveopediaOpened;
+        Localization.Instance.OnTranslationsChanged -= OnTranslationsChanged;
     }
 
     public override void _Process(double delta)
@@ -340,13 +342,6 @@ public override void _Notification(int notification)
             GD.Print("Main window close signal detected");
             Invoke.Instance.Queue(QuitPressed);
         }
-        else if (notification == NotificationTranslationChanged)
-        {
-            if (SteamHandler.Instance.IsLoaded)
-            {
-                UpdateSteamLoginText();
-            }
-        }
     }
 
     public void StartMusic()
@@ -1175,4 +1170,12 @@ private void ResetPerformanceTracking()
         secondsInMenu = 0;
         averageFrameRate = 0;
     }
+
+    private void OnTranslationsChanged()
+    {
+        if (SteamHandler.Instance.IsLoaded)
+        {
+            UpdateSteamLoginText();
+        }
+    }
 }

src/general/OptionsMenu.cs

@@ -674,29 +674,22 @@ public override void _EnterTree()
         guiLightEffectsToggle.RegisterToolTipForControl("guiLightEffects", "options", false);
         assumeHyperthreading.RegisterToolTipForControl("assumeHyperthreading", "options", false);
         unsavedProgressWarningEnabled.RegisterToolTipForControl("unsavedProgressWarning", "options", false);
+
+        Localization.Instance.OnTranslationsChanged += OnTranslationsChanged;
     }
 
     public override void _ExitTree()
     {
         base._ExitTree();
 
+        Localization.Instance.OnTranslationsChanged -= OnTranslationsChanged;
+
         cloudResolutionTitle.UnRegisterToolTipForControl("cloudResolution", "options");
         guiLightEffectsToggle.UnRegisterToolTipForControl("guiLightEffects", "options");
         assumeHyperthreading.UnRegisterToolTipForControl("assumeHyperthreading", "options");
         unsavedProgressWarningEnabled.UnRegisterToolTipForControl("unsavedProgressWarning", "options");
     }
 
-    public override void _Notification(int what)
-    {
-        if (what == NotificationTranslationChanged)
-        {
-            BuildInputRebindControls();
-            UpdateDefaultAudioOutputDeviceText();
-            DisplayResolution();
-            DisplayGpuInfo();
-        }
-    }
-
     /// <summary>
     ///   Opens the options menu with main menu configuration settings.
     /// </summary>
@@ -1102,6 +1095,14 @@ private void DisplayGpuInfo()
             .FormatSafe(Math.Round(videoMemoryInMebibytes, 2));
     }
 
+    private void OnTranslationsChanged()
+    {
+        BuildInputRebindControls();
+        UpdateDefaultAudioOutputDeviceText();
+        DisplayResolution();
+        DisplayGpuInfo();
+    }
+
     /// <summary>
     ///   Changes the active settings tab that is displayed, or returns if the tab is already active.
     /// </summary>

src/general/base_stage/CreatureStageBase.cs

@@ -161,16 +161,6 @@ public override void _Process(double delta)
         }
     }
 
-    public override void _Notification(int what)
-    {
-        if (what == NotificationTranslationChanged)
-        {
-            // TODO: the following doesn't seem to do anything so confirm that and remove
-            if (CurrentGame?.GameWorld.Map.CurrentPatch == null)
-                throw new InvalidOperationException("Stage not initialized properly");
-        }
-    }
-
     public override void StartNewGame()
     {
         SpawnPlayer();
@@ -194,15 +184,15 @@ public virtual void OnReturnFromEditor()
             GameWorld.GenerationHistory[lastGeneration].UpdateSpeciesData(GameWorld.PlayerSpecies);
         }
 
-        // Now the editor increases the generation so we don't do that here anymore
+        // Now the editor increases the generation, so we don't do that here anymore
 
         // Make sure player is spawned
         SpawnPlayer();
 
         BaseHUD.OnEnterStageTransition(false, true);
         BaseHUD.HideReproductionDialog();
 
-        // Pass some extra time to hud messages to make short lived messages from the previous life (like editor ready
+        // Pass some extra time to hud messages to make short-lived messages from the previous life (like editor ready
         // disappear)
         BaseHUD.HUDMessages.PassExtraTime(Constants.HUD_MESSAGES_EXTRA_ELAPSE_TIME_FROM_EDITOR);
 

src/general/base_stage/EditorComponentBase.cs

@@ -59,6 +59,18 @@ public override void _Ready()
         finishOrNextButton = GetNode<Button>(FinishOrNextButtonPath);
     }
 
+    public override void _EnterTree()
+    {
+        base._EnterTree();
+        Localization.Instance.OnTranslationsChanged += OnTranslationsChanged;
+    }
+
+    public override void _ExitTree()
+    {
+        base._ExitTree();
+        Localization.Instance.OnTranslationsChanged -= OnTranslationsChanged;
+    }
+
     public virtual void Init(TEditor owningEditor, bool fresh)
     {
         editor = owningEditor;
@@ -94,20 +106,11 @@ public void Init(IEditor owningEditor, bool fresh)
         Init((TEditor)owningEditor, fresh);
     }
 
-    public override void _Notification(int what)
-    {
-        // Rebuilds and recalculates all value dependent UI elements on language change
-        if (what == NotificationTranslationChanged)
-        {
-            OnTranslationsChanged();
-        }
-    }
-
     /// <summary>
     ///   Called
     /// </summary>
     /// <param name="species">
-    ///   The species that was setup, accessing more specific data through <see cref="Editor"/> rather than casting
+    ///   The species that was set up, accessing more specific data through <see cref="Editor"/> rather than casting
     ///   to a derived class is recommended.
     /// </param>
     public virtual void OnEditorSpeciesSetup(Species species)

src/gui_common/ChemicalEquation.cs

@@ -99,6 +99,18 @@ public override void _Ready()
         UpdateEquation();
     }
 
+    public override void _EnterTree()
+    {
+        base._EnterTree();
+        Localization.Instance.OnTranslationsChanged += OnTranslationsChanged;
+    }
+
+    public override void _ExitTree()
+    {
+        base._ExitTree();
+        Localization.Instance.OnTranslationsChanged -= OnTranslationsChanged;
+    }
+
     public override void _Process(double delta)
     {
         if (ShowSpinner && EquationFromProcess != null)
@@ -115,16 +127,13 @@ public override void _Process(double delta)
             UpdateEquation();
     }
 
-    public override void _Notification(int what)
+    private void OnTranslationsChanged()
     {
-        if (what == NotificationTranslationChanged)
-        {
-            if (perSecondLabel != null)
-                perSecondLabel.Text = Localization.Translate("PER_SECOND_SLASH");
+        if (perSecondLabel != null)
+            perSecondLabel.Text = Localization.Translate("PER_SECOND_SLASH");
 
-            if (environmentSeparator != null)
-                environmentSeparator.Text = GetEnvironmentLabelText();
-        }
+        if (environmentSeparator != null)
+            environmentSeparator.Text = GetEnvironmentLabelText();
     }
 
     private void UpdateEquation()

src/gui_common/CompoundAmount.cs

@@ -151,14 +151,16 @@ public override void _Ready()
             UpdateColour();
     }
 
-    public override void _Notification(int what)
+    public override void _EnterTree()
     {
-        if (what == NotificationTranslationChanged)
-        {
-            UpdateTooltip();
+        base._EnterTree();
+        Localization.Instance.OnTranslationsChanged += OnTranslationsChanged;
+    }
 
-            UpdateLabel();
-        }
+    public override void _ExitTree()
+    {
+        base._ExitTree();
+        Localization.Instance.OnTranslationsChanged -= OnTranslationsChanged;
     }
 
     protected override void Dispose(bool disposing)
@@ -233,4 +235,10 @@ private void UpdateTooltip()
         if (icon != null)
             icon.TooltipText = compound!.Name;
     }
+
+    private void OnTranslationsChanged()
+    {
+        UpdateTooltip();
+        UpdateLabel();
+    }
 }