Class LocalizedStringReference
Inherited Members
Namespace: UnityEngine.Localization
Syntax
[Serializable]
public class LocalizedStringReference : LocalizedReferenceMethods
GetLocalizedString()
This function will load the requested string table and return the translated string. The Completed event will provide notification once the operation has finished and the string has been found or an error has occurred, this will be called during LateUpdate. It is possible that a string table may have already been loaded, such as during a previous operation or when using Preload mode, the IsDone property can be checked as it is possible the translated string is immediately available.
Declaration
public AsyncOperationHandle<string> GetLocalizedString()Returns
| Type | Description |
|---|---|
| AsyncOperationHandle<System.String> |
GetLocalizedString(Int32)
This function will load the requested string table and return the translated string formatted using the Locale PluralForm. The Completed event will provide notification once the operation has finished and the string has been found or an error has occurred, this will be called during LateUpdate. It is possible that a string table may have already been loaded, such as during a previous operation or when using Preload mode, the IsDone property can be checked as it is possible the translated string is immediately available.
Declaration
public AsyncOperationHandle<string> GetLocalizedString(int plural)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | plural | A plural value to be used when translating the string. |
Returns
| Type | Description |
|---|---|
| AsyncOperationHandle<System.String> |
GetLocalizedStringTable()
This function will load the requested string table. This is useful when multiple strings are required. The Completed event will provide notification once the operation has finished and the string table has been found or an error has occurred, this will be called during LateUpdate. It is possible that a string table may have already been loaded, such as during a previous operation or when using Preload mode, the IsDone property can be checked as it is possible the translated string is immediately available.
Declaration
public AsyncOperationHandle<StringTableBase> GetLocalizedStringTable()Returns
| Type | Description |
|---|---|
| AsyncOperationHandle<StringTableBase> |