 | LocalisationService Class |
Manages localisation
Inheritance HierarchySystemObject
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
ImmerseSDKLoggingBehaviour
ImmerseSDKSingletonBehaviour
ImmerseSDK.LocalisationLocalisationService
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
ImmerseSDKLoggingBehaviour
ImmerseSDKSingletonBehaviour
ImmerseSDK.LocalisationLocalisationService
Namespace: ImmerseSDK.Localisation
Assembly: ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.5.0.0 (3.5.0.0)
SyntaxC#
public class LocalisationService : SingletonBehaviour
The LocalisationService type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
  | LocalisationService | |
 | LocalisationService | Initializes a new instance of the LocalisationService class |
Properties| Name | Description | |
|---|---|---|
 | IsTestingLocalisation |
Set this to true if you are testing the localisation in the app. This is cause all localised text to be replaced by "TEST". This allows you to very quickly see where there is text that is not localised.
|
Methods| Name | Description | |
|---|---|---|
| AsNormalisedAscii(String) |
Returns the string as a normalised ASCII string. Accents are converted to a normalised character, and all non-ascii parts are mapped to String.Empty.
|
| AsNormalisedAscii(String, Encoding) |
Returns the string as a normalised ASCII string. Accents are converted to a normalised character, and all non-ascii parts are mapped to String.Empty.
|
| ChangeLocale |
Change the current locale to the new specified one.
|
| CoroutineInitialise |
This method is used by our internal systems so do not call it directly.
(Overrides SingletonBehaviourCoroutineInitialise.) |
| GetLocalisedText |
Returns a localised version of the text key passed in
|
| GetLocalisedTextFormatted |
Returns a localised version of the text key passed in
|
| LoadCustomLocalisationFiles |
Loads a set of custom localisation TSV files from a resource location.
|
| MergeLocalisationData |
Merge new localisation data into the current locale data table.
Note: If the locale is changed, you will loose all these entries
and you would need to add them again.
|
 | OnDestroy |
Unity component method
(Overrides SingletonBehaviourOnDestroy.) |
| TryGetLocalisedText |
Returns a localised version of the text key passed in
|
| TryGetLocalisedTextFormatted |
Returns a localised version of the text key passed in
|
Events| Name | Description | |
|---|---|---|
 | OnLocaleChanged |
Fired when the locale changes
|
Fields| Name | Description | |
|---|---|---|
 | FallbackLocale |
Default locale is International English
|
| TestModeString |
The string that would be returned in case we are testing localisation
|
Extension Methods| Name | Description | |
|---|---|---|
 | GetCopyOf |
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.) |
| WaitForT |
Waits for a singleton on a coroutine
(Defined by SingletonManager.) |
See Also