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
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>
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
| Property | Description |
| hideFlags | Controls whether the object is hidden, saved with the scene, and editable by the user. |
| name | The name of the object. |
Public Methods
| Method | Description |
| GetEntityId | Gets the EntityId of the object. |
| GetHashCode | Returns the hash code for the object. |
| ToString | Returns the name of the object. |
Static Methods
| Method | Description |
| Destroy | Removes a GameObject, component, or asset. |
| DestroyImmediate | Destroys the specified object immediately. Use with caution and in Edit mode only. |
| DontDestroyOnLoad | Do not destroy the target Object when loading a new Scene. |
| FindAnyObjectByType | Retrieves any active loaded object of Type T. |
| FindObjectsByType | Retrieves a list of all loaded objects of Type type. |
| Instantiate | Clones the object original and returns the clone. |
| InstantiateAsync | Captures a snapshot of the original object that's related to another GameObject and obtains an AsyncInstantiateOperation instance of the resulting objects. |
| CreateInstance | Creates an instance of a scriptable object. |
Operators
| Operator | Description |
| bool | Determines 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
| Message | Description |
| Awake | Called when an instance of ScriptableObject is created. |
| OnDestroy | This function is called when the scriptable object will be destroyed. |
| OnDisable | This function is called when the scriptable object goes out of scope. |
| OnEnable | This function is called when the object is loaded. |
| OnValidate | Editor-only function that Unity calls when the script is loaded or a value changes in the Inspector. |
| Reset | Reset to default values. |