Ensure a valid langauge is always used

[originalfoo]

This fixes an issue where user might select a new language, then revert to older version of mod that doesn't have that language; it would try using the previously selected language, not find it, and crash.

This PR ensures default language will be used in any case where selected language is not available.

Note, however, this will obviously only fix the issue from version 11.0-alpha11 and above. There is no way to retroactively fix it on older versions of the mod.

[krzychu124]

Unfortunately your fix doesn't change anything 😉 You can make quick test: change manually your current language code to xx in Global config and run the game 😃

[originalfoo]

Ah, I should have also checked the method below... will update PR in a few moments after doing some extra testing.

[krzychu124]

I suggest adding new method to Translation class which will set current code to null if (currentCode != null && currentCode != "en" && GetValidLanguageId(currentCode) == "en") Save and reload Global config and call this method as first in method which builds options menu

[originalfoo]

Here is stack trace, will update PR once fixed.

KeyNotFoundException: The given key was not present in the dictionary.
  at System.Collections.Generic.Dictionary`2[System.String,System.Collections.Generic.Dictionary`2[System.String,System.String]].get_Item (System.String key) [0x00000] in <filename unknown>:0 
  at TrafficManager.UI.Localization.LookupTable.Get (System.String lang, System.String key) [0x00000] in <filename unknown>:0 
  at TrafficManager.UI.Localization.LookupTable.Get (System.String key) [0x00000] in <filename unknown>:0 
  at TrafficManager.State.OptionsGeneralTab.T (System.String key) [0x00000] in <filename unknown>:0 
  at TrafficManager.State.OptionsGeneralTab.MakeSettings_General (TrafficManager.UI.Helpers.ExtUITabstrip tabStrip) [0x00000] in <filename unknown>:0 
  at TrafficManager.State.Options.MakeSettings (UIHelperBase helper) [0x00000] in <filename unknown>:0 
  at TrafficManager.TrafficManagerMod.OnSettingsUI (UIHelperBase helper) [0x00000] in <filename unknown>:0 
  at (wrapper managed-to-native) System.Reflection.MonoMethod:InternalInvoke (object,object[],System.Exception&)
  at System.Reflection.MonoMethod.Invoke (System.Object obj, BindingFlags invokeAttr, System.Reflection.Binder binder, System.Object[] parameters, System.Globalization.CultureInfo culture) [0x00000] in <filename unknown>:0 
Rethrow as TargetInvocationException: Exception has been thrown by the target of an invocation.
  at System.Reflection.MonoMethod.Invoke (System.Object obj, BindingFlags invokeAttr, System.Reflection.Binder binder, System.Object[] parameters, System.Globalization.CultureInfo culture) [0x00000] in <filename unknown>:0 
  at System.Reflection.MethodBase.Invoke (System.Object obj, System.Object[] parameters) [0x00000] in <filename unknown>:0 
  at OptionsMainPanel.AddUserMods () [0x00000] in <filename unknown>:0 
UnityEngine.DebugLogHandler:Internal_LogException(Exception, Object)
UnityEngine.DebugLogHandler:LogException(Exception, Object)
UnityEngine.Logger:LogException(Exception, Object)
UnityEngine.Debug:LogException(Exception)
OptionsMainPanel:AddUserMods()
OptionsMainPanel:CreateCategories()
OptionsMainPanel:Awake()
UnityEngine.Object:Internal_CloneSingle(Object)
UnityEngine.Object:Instantiate(GameObject)
ColossalFramework.UI.UIDynamicPanels:Init(UIView)
ColossalFramework.UI.UIView:Awake()

Also updated global config docs in wiki

[krzychu124]

It might look a bit different on current Labs and Stable 😉

[originalfoo]

In latest commit, I made following changes:

• Internal IsLanguageCodeVerified, defaults to false, tracks whether language is validated in the current TM:PE session
• When calling GetCurrentLanguage(), if we've not yet verified the language code it does all the relevant checks, updating GlobalConfig.Instance.LanguageCode in the process (to a valid language code)
  • Note: It does not update the .xml file on disk at this point; although it will if user makes other changes to mod options; this way if user switches back to more recent version, there is chance they will retain their chosen language
  • Subsequent calls to GetCurrentLanguage() shortcut to just returning GlobalConfig.Instance.LanguageCode as they know it's been validated by that point

[originalfoo]

Also, I didn't get any errors on TM:PE STABLE (and I assume LABS will be similar).

I think the issue only occurs on TM:PE 11.0-alpha7 to 11.0-alpha10. In other words, the error was specific to the new localisation system, as far as I can tell.

[krzychu124]

Looks good 👍

[originalfoo]

@kvakvs While I'm in here editing stuff, what is the purpose of GetMenuWidth() in Translation.cs? And how were the magic numbers derived? I'd like to add a code comment just to clarify that for anyone editing in future.

[kvakvs]

@aubergine10 This is legacy function, I did not create it. It is used by DebugMenuPanel.[Start, CreateTextField, CreateButton]

[originalfoo]

Committed some changes that hopefully fix the outstanding issues.

It now works as follows:

• When first used, it will do full verification
• If user changes game locale, it will first check if TM:PE is using game language, and if so it will do the game language-specific verification
• If user changes TM:PE language setting, it will update as applicable (game language or specific TM:PE language) doing verification in the process
• After any change to language (game or TM:PE) the current, verified language code, is cached so translation .Get() calls no longer incur per-call verification overheads.

[krzychu124]

Looks and works good now 👍

[originalfoo]

@kvakvs any comments before I merge this?

[kvakvs]

The version jump from alpha4 to alpha11 is confusing, otherwise i'm ok with that