Class LocalizationTable

Abstract base class for all tables. Contains common functionality.

Inheritance
Object
Object
ScriptableObject
LocalizationTable
DetailedLocalizationTable<TEntry>
Inherited Members
Namespace: UnityEngine.Localization.Tables
Syntax
public abstract class LocalizationTable : ScriptableObject, IMetadataCollection, IComparable<LocalizationTable>

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 MetadataEntries.

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

CompareTo(LocalizationTable)

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

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

Contains(IMetadata)

Checks if the Metadata is contained within MetadataEntries.

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 long FindKeyId(string key, bool addKey)
Parameters
Type Name Description
String key

The key to search for.
Boolean addKey

Should a new key be added if one can not be found?
Returns
Type Description
Int64

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 MetadataEntries 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 MetadataEntries 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 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
Name Description
TObject
Implements

RemoveMetadata(IMetadata)

Remove an entry from MetadataEntries.

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