Version: Unity 6.7 Alpha (6000.7)
LanguageEnglish
  • C#

ResourceTable

class in Unity.Localization

/

Inherits from:ScriptableObject


Implements interfaces:ISerializationCallbackReceiver

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

A localization table that holds the translated values for one locale in a collection.

Each table targets a single locale (reported by ResourceTable.LocaleIdentifier) and shares its keys with every other locale table in the collection through one SharedTableData. Values are stored as polymorphic IResourceEntry objects (strings, assets, variants, or custom kinds) held through [SerializeReference], so a single table type covers every entry kind. Look entries up by stable key id or by key text with the ResourceTable.GetEntry family, add plain strings with ResourceTable.AddStringEntry, and add fully-formed entries with ResourceTable.AddEntry. Create a table through the ScriptableObject.CreateInstance method or the asset menu, and assign ResourceTable.SharedData before resolving keys by text.

Additional resources: SharedTableData, IResourceEntry, IStringEntry, LocaleIdentifier

<para>Create a table, add a string, and read it back.</para>

using Unity.Localization;
using UnityEngine;

namespace Unity.Localization.Samples { public class ResourceTableOverviewExample { public void Run() { var shared = ScriptableObject.CreateInstance<SharedTableData>(); var table = ScriptableObject.CreateInstance<ResourceTable>(); table.SharedData = shared; table.LocaleIdentifier = "en";

table.AddStringEntry("Greeting", "Hello");

var entry = table.GetEntry<IStringEntry>("Greeting"); Debug.Log(entry.Value); // Hello } } }

Properties

Property Description
Entries The entries this table holds for its locale.
LocaleIdentifier The locale this table provides values for.
Metadata The metadata attached to this table for its locale.
SharedData The shared key data for the collection this table belongs to.
TableCollectionName The name of the collection this table belongs to.

Public Methods

Method Description
AddEntry Adds an entry, replacing any existing entry with the same key id.
AddStringEntry Adds or updates a plain string entry for a key.
GetEntry Returns the entry stored for a stable key id.
RemoveAllEntries Removes every entry from this table.
RemoveEntry Removes the entry for a stable key id from this table.

Inherited Members

Properties

PropertyDescription
hideFlagsControls whether the object is hidden, saved with the scene, and editable by the user.
nameThe name of the object.

Public Methods

MethodDescription
GetEntityIdGets the EntityId of the object.
GetHashCodeReturns the hash code for the object.
ToStringReturns the name of the object.

Static Methods

MethodDescription
DestroyRemoves a GameObject, component, or asset.
DestroyImmediateDestroys the specified object immediately. Use with caution and in Edit mode only.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindAnyObjectByTypeRetrieves any active loaded object of Type T.
FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.
InstantiateAsyncCaptures a snapshot of the original object that's related to another GameObject and obtains an AsyncInstantiateOperation instance of the resulting objects.
CreateInstanceCreates an instance of a scriptable object.

Operators

OperatorDescription
boolDetermines whether the object exists.
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.

Messages

MessageDescription
AwakeCalled when an instance of ScriptableObject is created.
OnDestroyThis function is called when the scriptable object will be destroyed.
OnDisableThis function is called when the scriptable object goes out of scope.
OnEnableThis function is called when the object is loaded.
OnValidateEditor-only function that Unity calls when the script is loaded or a value changes in the Inspector.
ResetReset to default values.