TableEntryReference

Description

A serializable reference to a single table entry, identified either by its key text or by its stable key id.

An entry reference addresses one row inside a table collection without holding a direct object reference. It stores either the key text or the numeric key id; TableEntryReference.ReferenceType reports which form is present, and TableEntryReference.IsEmpty is true when neither is set. Key ids are stable across key renames, so they are the safer choice for serialized data, while key text is more readable in code. Convert between the two forms with TableEntryReference.ResolveKeyId and TableEntryReference.ResolveKeyName, passing the collection's SharedTableData. Combine it with a TableReference to address an entry in a specific collection.

Additional resources: TableReference, ResourceDatabase, ResourceTable

<para>Create entry references by key text and by key id, then resolve one to an id.</para>

using Unity.Localization;
using UnityEngine;

namespace Unity.Localization.Samples
{
    public class TableEntryReferenceOverviewExample
    {
        public void Run(SharedTableData sharedData)
        {
            TableEntryReference byKey = "Menu/Start";   // implicit conversion from string
            TableEntryReference byId = 12345L;           // implicit conversion from long

            long id = byKey.ResolveKeyId(sharedData);
            Debug.Log($"{id} {byId.KeyId}");
        }
    }
}

Properties

Public Methods

Operators