Class StringTableEntry | Localization | 0.9.0-preview
docs.unity3d.com
    Show / Hide Table of Contents

    Class StringTableEntry

    A StringTable entry.

    Inheritance
    Object
    TableEntry
    StringTableEntry
    Inherited Members
    TableEntry.Table
    TableEntry.KeyId
    TableEntry.LocalizedValue
    TableEntry.MetadataEntries
    TableEntry.GetMetadata<TObject>()
    TableEntry.GetMetadatas<TObject>(IList<TObject>)
    TableEntry.GetMetadatas<TObject>()
    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)
    TableEntry.ToString()
    Namespace: UnityEngine.Localization.Tables
    Syntax
    public class StringTableEntry : TableEntry, IMetadataCollection

    Properties

    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 raw localized value without any formatting applied.

    Declaration
    public string GetLocalizedString()
    Returns
    Type Description
    String

    GetLocalizedString(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(params object[] args)
    Parameters
    Type Name Description
    Object[] args
    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()
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023