// NOTE: this class assumes that you designate StringTable keys in label fields (as seen in Label, Button, etc) // and start them all with '#' char (so other labels will be left be)
LocaleList (https://gist.github.com/andrew-raphael-lukasik/e4ae9b45a2c24672c0d1218f77235948)
| /// void* src = https://gist.github.com/andrew-raphael-lukasik/72a4d3d14dd547a1d61ae9dc4c4513da | |
| /// | |
| /// Copyright (C) 2022 Andrzej Rafał Łukasik (also known as: Andrew Raphael Lukasik) | |
| /// | |
| /// This program is free software: you can redistribute it and/or modify | |
| /// it under the terms of the GNU General Public License as published by | |
| /// the Free Software Foundation, version 3 of the License. | |
| /// | |
| /// This program is distributed in the hope that it will be useful, | |
| /// but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| /// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | |
| /// See the GNU General Public License for details https://www.gnu.org/licenses/ | |
| /// | |
| using UnityEngine; | |
| using UnityEngine.UIElements; | |
| using UnityEngine.Localization; | |
| using UnityEngine.Localization.Tables; | |
| using UnityEngine.ResourceManagement.AsyncOperations; | |
| // NOTE: this class assumes that you designate StringTable keys in label fields (as seen in Label, Button, etc) | |
| // and start them all with '#' char (so other labels will be left be) | |
| // example: https://i.imgur.com/H5RUIej.gif | |
| [DisallowMultipleComponent] | |
| [RequireComponent( typeof(UIDocument) )] | |
| public class UIDocumentLocalization : MonoBehaviour | |
| { | |
| [SerializeField] LocalizedStringTable _table = null; | |
| UIDocument _document; | |
| /// <summary> Executed after hierarchy is cloned fresh and translated. </summary> | |
| public event System.Action onCompleted = ()=>{}; | |
| void OnEnable () | |
| { | |
| if( _document==null ) | |
| _document = this.gameObject.GetComponent<UIDocument>(); | |
| _table.TableChanged += OnTableChanged; | |
| } | |
| void OnDisable () | |
| { | |
| _table.TableChanged -= OnTableChanged; | |
| } | |
| void OnTableChanged ( StringTable table ) | |
| { | |
| var root = _document.rootVisualElement; | |
| root.Clear(); | |
| _document.visualTreeAsset.CloneTree( root ); | |
| var op = _table.GetTableAsync(); | |
| op.Completed -= OnTableLoaded; | |
| op.Completed += OnTableLoaded; | |
| } | |
| void OnTableLoaded ( AsyncOperationHandle<StringTable> op ) | |
| { | |
| StringTable table = op.Result; | |
| var root = _document.rootVisualElement; | |
| LocalizeChildrenRecursively( root , table ); | |
| onCompleted(); | |
| root.MarkDirtyRepaint(); | |
| } | |
| void Localize ( VisualElement next , StringTable table ) | |
| { | |
| if( typeof(TextElement).IsInstanceOfType(next) ) | |
| { | |
| TextElement textElement = (TextElement) next; | |
| string key = textElement.text; | |
| if( !string.IsNullOrEmpty(key) && key[0]=='#' ) | |
| { | |
| key = key.TrimStart('#'); | |
| StringTableEntry entry = table[ key ]; | |
| if( entry!=null ) | |
| textElement.text = entry.LocalizedValue; | |
| else | |
| Debug.LogWarning($"No {table.LocaleIdentifier.Code} translation for key: '{key}'"); | |
| } | |
| } | |
| } | |
| void LocalizeChildrenRecursively ( VisualElement element , StringTable table ) | |
| { | |
| VisualElement.Hierarchy elementHierarchy = element.hierarchy; | |
| int numChildren = elementHierarchy.childCount; | |
| for( int i=0 ; i<numChildren ; i++ ) | |
| { | |
| VisualElement child = elementHierarchy.ElementAt( i ); | |
| Localize( child , table ); | |
| } | |
| for( int i=0 ; i<numChildren ; i++ ) | |
| { | |
| VisualElement child = elementHierarchy.ElementAt( i ); | |
| VisualElement.Hierarchy childHierarchy = child.hierarchy; | |
| int numGrandChildren = childHierarchy.childCount; | |
| if( numGrandChildren!=0 ) | |
| LocalizeChildrenRecursively( child , table ); | |
| } | |
| } | |
| } |