docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class StringTableEntry

    A StringTable entry.

    Inheritance
    object
    TableEntry
    StringTableEntry
    Implements
    IMetadataCollection
    Inherited Members
    TableEntry.Table
    TableEntry.SharedEntry
    TableEntry.Key
    TableEntry.KeyId
    TableEntry.LocalizedValue
    TableEntry.MetadataEntries
    TableEntry.GetMetadata<TObject>()
    TableEntry.GetMetadatas<TObject>(IList<TObject>)
    TableEntry.GetMetadatas<TObject>()
    TableEntry.HasTagMetadata<TShared>()
    TableEntry.AddTagMetadata<TShared>()
    TableEntry.AddSharedMetadata(SharedTableEntryMetadata)
    TableEntry.AddSharedMetadata(SharedTableCollectionMetadata)
    TableEntry.AddMetadata(IMetadata)
    TableEntry.RemoveTagMetadata<TShared>()
    TableEntry.RemoveSharedMetadata(SharedTableEntryMetadata)
    TableEntry.RemoveSharedMetadata(SharedTableCollectionMetadata)
    TableEntry.RemoveMetadata(IMetadata)
    TableEntry.Contains(IMetadata)
    Namespace: UnityEngine.Localization.Tables
    Assembly: Unity.Localization.dll
    Syntax
    public class StringTableEntry : TableEntry, IMetadataCollection

    Properties

    Name Description
    FormatCache

    Used when IsSmart is true and GetLocalizedString() is called. Contains information about the format including any IGlobalVariableValueChanged that were used.

    IsSmart

    Is the entry marked with the SmartFormatTag? Entries that are smart will use UnityEngine.Localization.SmartFormat to format the localized text.

    Value

    The raw localized value without any formatting applied.

    Methods

    Name Description
    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.

    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.

    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.

    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.

    GetLocalizedString(params 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.

    RemoveFromTable()

    Attempts to remove the entry from the StringTable that it belongs to. If Table is null then a warning will be produced.

    In This Article
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)