Class StringTableEntry
A StringTable entry.
Inherited Members
Namespace: UnityEngine.Localization.Tables
Syntax
public class StringTableEntry : TableEntry, IMetadataCollectionProperties
FormatCache
Used when IsSmart is true and GetLocalizedString() is called. Contains information about the format including any IGlobalVariableValueChanged that were used.
Declaration
public FormatCache FormatCache { get; set; }Property Value
| Type | Description |
|---|---|
| UnityEngine.Localization.SmartFormat.Core.Formatting.FormatCache |
IsSmart
Is the entry marked with the SmartFormatTag? Entries that are smart will use UnityEngine.Localization.SmartFormat to format the localized text.
Declaration
public bool IsSmart { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
Value
The raw localized value without any formatting applied.
Declaration
public string Value { get; set; }Property Value
| Type | Description |
|---|---|
| String |
Methods
GetLocalizedString()
Returns the localized text after formatting has been applied. This will use SmartFormat if IsSmart is true else it will return the raw unformatted value.
Declaration
public string GetLocalizedString()Returns
| Type | Description |
|---|---|
| String |
Remarks
The following process is applied when generating a localized string:
GetLocalizedString(IList<Object>)
Returns the localized text after formatting has been applied. Formatting will use SmartFormat if IsSmart is true else it will default to String.Format.
Declaration
public string GetLocalizedString(IList<object> args)Parameters
| Type | Name | Description |
|---|---|---|
| IList<Object> | args | Arguments that will be applied to Smart Format or |
Returns
| Type | Description |
|---|---|
| String |
GetLocalizedString(IFormatProvider, IList<Object>)
Returns the localized text after formatting has been applied. Formatting will use SmartFormat is IsSmart is true else it will default to String.Format.
Declaration
public string GetLocalizedString(IFormatProvider formatProvider, IList<object> args)Parameters
| Type | Name | Description |
|---|---|---|
| IFormatProvider | formatProvider | Custom format provider used with String.Format and smart strings. If formatProvider is null, RemoveFromTable uses the LocaleIdentifier's Formatter. |
| IList<Object> | args | Arguments that will be applied to Smart Format or |
Returns
| Type | Description |
|---|---|
| String |
GetLocalizedString(IFormatProvider, IList<Object>, PseudoLocale)
Returns the localized text after formatting has been applied. Formatting will use SmartFormat is IsSmart is true else it will default to String.Format.
Declaration
public string GetLocalizedString(IFormatProvider formatProvider, IList<object> args, PseudoLocale pseudoLocale)Parameters
| Type | Name | Description |
|---|---|---|
| IFormatProvider | formatProvider | Custom format provider used with String.Format and smart strings. If formatProvider is null, RemoveFromTable uses the LocaleIdentifier's Formatter. |
| IList<Object> | args | Arguments that are be applied to Smart Format or |
| PseudoLocale | pseudoLocale | Optional PseudoLocale that will be applied to the final string. |
Returns
| Type | Description |
|---|---|
| String |
GetLocalizedString(Object[])
Returns the localized text after formatting has been applied. Formatting will use SmartFormat if IsSmart is true else it will default to String.Format.
Declaration
public string GetLocalizedString(params object[] args)Parameters
| Type | Name | Description |
|---|---|---|
| Object[] | args | Arguments that will be applied to Smart Format or |
Returns
| Type | Description |
|---|---|
| String |
RemoveFromTable()
Attempts to remove the entry from the StringTable that it belongs to. If Table is null then a warning will be produced.
Declaration
public void RemoveFromTable()