docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class TableEntry

    Player version of a table entry that can contain additional data that is not serialized.

    Inheritance
    object
    TableEntry
    AssetTableEntry
    StringTableEntry
    Implements
    IMetadataCollection
    Namespace: UnityEngine.Localization.Tables
    Assembly: Unity.Localization.dll
    Syntax
    public class TableEntry : IMetadataCollection

    Properties

    Name Description
    Key

    The Key or Name of this table entry that is stored in SharedEntry.

    KeyId

    Key Id for this table entry.

    LocalizedValue

    Raw localized value.

    MetadataEntries

    The Metadata for this table entry.

    SharedEntry

    The shared table entry contains information for all locales, this is taken from SharedTableData.

    Table

    The table that this entry is part of.

    Methods

    Name Description
    AddMetadata(IMetadata)

    Add an entry to MetadataEntries.

    AddSharedMetadata(SharedTableCollectionMetadata)

    SharedTableCollectionMetadata is Metadata that can be applied to multiple table entries in a table collection. The Metadata is stored in the SharedTableData.

    AddSharedMetadata(SharedTableEntryMetadata)

    SharedTableEntryMetadata is Metadata that can be shared across multiple entries in a single table. The instance reference will be stored in TableData and MetadataEntries.

    AddTagMetadata<TShared>()

    Tags are Metadata that can be shared across multiple table entries, they are often used to indicate an entry has a particular attribute or feature, e.g SmartFormat. Generally Tags do not contains data, for sharing data across multiple table entries see AddSharedMetadata(SharedTableEntryMetadata). A Tag reference will be stored in TableData and MetadataEntries.

    Contains(IMetadata)

    Checks if the Metadata is contained within MetadataEntries.

    GetMetadata<TObject>()

    Returns the first Metadata item from MetadataEntries of type TObject.

    GetMetadatas<TObject>()

    Returns all Metadata from MetadataEntries that is of type TObject.

    GetMetadatas<TObject>(IList<TObject>)

    Populates the list with all Metadata from MetadataEntries that is of type TObject.

    HasTagMetadata<TShared>()

    Returns true if any tag metadata of type TShared contains this entry.

    RemoveMetadata(IMetadata)

    Remove an entry from MetadataEntries.

    RemoveSharedMetadata(SharedTableCollectionMetadata)

    Removes the entry from the Shared Metadata and removes it from the SharedTableData if no other entries are using it.

    RemoveSharedMetadata(SharedTableEntryMetadata)

    Removes the entry from the shared Metadata in the table and removes the shared Metadata if no other entries are using it.

    RemoveTagMetadata<TShared>()

    Removes the Metadata tag from this entry and the table if it is no longer used by any other table entries.

    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)