Class TableEntry
Player version of a table entry that can contain additional data that is not serialized.
Syntax
public class TableEntry : object, IMetadataCollection
Properties
Key
The Key or Name of this table entry that is stored in SharedEntry.
Declaration
public string Key { get; set; }
Property Value
KeyId
Key Id for this table entry.
Declaration
public long KeyId { get; }
Property Value
LocalizedValue
Declaration
public string LocalizedValue { get; }
Property Value
MetadataEntries
The Metadata for this table entry.
Declaration
public IList<IMetadata> MetadataEntries { get; }
Property Value
Implements
SharedEntry
The shared table entry contains information for all locales, this is taken from SharedTableData.
Declaration
public SharedTableData.SharedTableEntry SharedEntry { get; }
Property Value
Table
The table that this entry is part of.
Declaration
public LocalizationTable Table { get; }
Property Value
Methods
AddMetadata(IMetadata)
Declaration
public void AddMetadata(IMetadata md)
Parameters
Implements
AddSharedMetadata(SharedTableCollectionMetadata)
SharedTableCollectionMetadata is Metadata that can be applied to multiple table entries in a table collection.
The Metadata is stored in the SharedTableData.
Declaration
public void AddSharedMetadata(SharedTableCollectionMetadata md)
Parameters
AddSharedMetadata(SharedTableEntryMetadata)
SharedTableEntryMetadata is Metadata that can be shared across multiple entries in a single table.
The instance reference will be stored in UnityEngine.Localization.Tables.LocalizationTable.TableData and MetadataEntries.
Declaration
public void AddSharedMetadata(SharedTableEntryMetadata md)
Parameters
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 UnityEngine.Localization.Tables.LocalizationTable.TableData and MetadataEntries.
Declaration
public void AddTagMetadata<TShared>()
where TShared : SharedTableEntryMetadata, new()
Type Parameters
Contains(IMetadata)
Declaration
public bool Contains(IMetadata md)
Parameters
Returns
Implements
GetMetadata<TObject>()
Declaration
public TObject GetMetadata<TObject>()
where TObject : IMetadata
Returns
Type Parameters
Implements
GetMetadatas<TObject>()
Declaration
public IList<TObject> GetMetadatas<TObject>()
where TObject : IMetadata
Returns
| Type |
Description |
| IList<TObject> |
|
Type Parameters
Implements
GetMetadatas<TObject>(IList<TObject>)
Populates the list with all Metadata from MetadataEntries that is of type TObject.
Declaration
public void GetMetadatas<TObject>(IList<TObject> foundItems)
where TObject : IMetadata
Parameters
| Type |
Name |
Description |
| IList<TObject> |
foundItems |
|
Type Parameters
Implements
HasTagMetadata<TShared>()
Returns true if any tag metadata of type TShared contains this entry.
Declaration
public bool HasTagMetadata<TShared>()
where TShared : SharedTableEntryMetadata
Returns
Type Parameters
RemoveMetadata(IMetadata)
Declaration
public bool RemoveMetadata(IMetadata md)
Parameters
Returns
Implements
RemoveSharedMetadata(SharedTableCollectionMetadata)
Removes the entry from the Shared Metadata and removes it from the
SharedTableData if no other entries are using it.
Declaration
public void RemoveSharedMetadata(SharedTableCollectionMetadata md)
Parameters
RemoveSharedMetadata(SharedTableEntryMetadata)
Removes the entry from the shared Metadata in the table and removes the
shared Metadata if no other entries are using it.
Declaration
public void RemoveSharedMetadata(SharedTableEntryMetadata md)
Parameters
RemoveTagMetadata<TShared>()
Removes the Metadata tag from this entry and the table if it is no longer used by any other table entries.
Declaration
public void RemoveTagMetadata<TShared>()
where TShared : SharedTableEntryMetadata
Type Parameters