Class LocalizedTable

Abstract base class for all tables. Contains common functionality.

Inheritance
Object
LocalizedTable
LocalizedTableT<TEntry>
Namespace: UnityEngine.Localization.Tables
Syntax
public abstract class LocalizedTable : ScriptableObject, IMetadataCollection, IComparable<LocalizedTable>

Properties

LocaleIdentifier

The locale this asset table supports.

Declaration
public LocaleIdentifier LocaleIdentifier { get; set; }
Property Value
Type Description
LocaleIdentifier

MetadataEntries

Table Metadata.

Declaration
public IList<IMetadata> MetadataEntries { get; }
Property Value
Type Description
IList<IMetadata>
Implements

SharedData

Data shared across all tables.

Declaration
public SharedTableData SharedData { get; set; }
Property Value
Type Description
SharedTableData

TableCollectionName

The name of this asset table collection.

Declaration
public string TableCollectionName { get; }
Property Value
Type Description
String

Methods

AddMetadata(IMetadata)

Add an entry to .

Declaration
public void AddMetadata(IMetadata md)
Parameters
Type Name Description
IMetadata md
Implements

CompareTo(LocalizedTable)

Compare to another LocalizedTable. Performs a comparison against the LocaleIdentifier property.

Declaration
public int CompareTo(LocalizedTable other)
Parameters
Type Name Description
LocalizedTable other
Returns
Type Description
Int32

Contains(IMetadata)

Checks if the Metadata is contained within .

Declaration
public bool Contains(IMetadata md)
Parameters
Type Name Description
IMetadata md
Returns
Type Description
Boolean
Implements

CreateEmpty(TableEntryReference)

Create an empty entry in the table at the specified entry.

Declaration
public abstract void CreateEmpty(TableEntryReference entryReference)
Parameters
Type Name Description
TableEntryReference entryReference

FindKeyId(String, Boolean)

Returns the key with the matching name from the SharedTableData, if one exists.

Declaration
protected uint FindKeyId(string key, bool addKey)
Parameters
Type Name Description
String key
Boolean addKey
Returns
Type Description
UInt32

The found key or null if one could not be found.
Exceptions
Type Condition
Exception

Thrown if the SharedTableData is null.

GetMetadata<TObject>()

Returns the first Metadata item from of type TObject.

Declaration
public TObject GetMetadata<TObject>()
    where TObject : IMetadata
Returns
Type Description
TObject
Type Parameters
Name Description
TObject
Implements

GetMetadatas<TObject>()

Returns all Metadata from that is of type TObject.

Declaration
public IList<TObject> GetMetadatas<TObject>()
    where TObject : IMetadata
Returns
Type Description
IList<TObject>
Type Parameters
Name Description
TObject
Implements

GetMetadatas<TObject>(IList<TObject>)

Populates the list with all Metadata from 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
Name Description
TObject
Implements

RemoveMetadata(IMetadata)

Remove an entry from .

Declaration
public bool RemoveMetadata(IMetadata md)
Parameters
Type Name Description
IMetadata md
Returns
Type Description
Boolean
Implements

ToString()

Returns a string representation of the table in the format "{TableCollectionName}({LocaleIdentifier})".

Declaration
public override string ToString()
Returns
Type Description
String