SharedTableData

Description

The shared key table for a localization table collection: the set of string keys and their stable ids that every per-locale table in the collection uses.

Each key maps to a stable long id that never changes for the life of the key, so renaming a key keeps its translations intact. Ids come from the SharedTableData.KeyGenerator, a DistributedUIDGenerator by default, so they are non-sequential and an id of 0 means "no key". Every per-locale ResourceTable in the collection stores its values against these ids. Add and look up keys with SharedTableData.AddKey, SharedTableData.GetId, and SharedTableData.GetKey, and rename in place with SharedTableData.RenameKey. This type derives from ScriptableObject, so create an instance with ScriptableObject factory methods rather than the new operator.

Additional resources: SharedTableEntry, SharedEntryFlags, IKeyGenerator, ResourceTable

<para>Create shared data, add a key, and resolve between key text and id.</para>

using Unity.Localization;
using UnityEngine;

namespace Unity.Localization.Samples
{
    public class SharedTableDataOverviewExample
    {
        public void Run()
        {
            var sharedData = ScriptableObject.CreateInstance<SharedTableData>();
            sharedData.TableCollectionName = "UI Text";

            SharedTableData.SharedTableEntry entry = sharedData.AddKey("GREETING");
            long id = entry.Id;

            Debug.Log(sharedData.GetId("GREETING"));   // the same id
            Debug.Log(sharedData.GetKey(id));          // GREETING
        }
    }
}

Properties

Public Methods

Inherited Members