Struct TableEntryReference

Allows for referencing a table entry via key or key id.

Namespace: UnityEngine.Localization.Tables
Syntax
[Serializable]
public struct TableEntryReference : ISerializationCallbackReceiver, IEquatable<TableEntryReference>

Properties

Key

The key name when ReferenceType is Name.

Declaration
public string Key { get; }
Property Value
Type Description
String

KeyId

The Key Id when ReferenceType is Id.

Declaration
public uint KeyId { get; }
Property Value
Type Description
UInt32

ReferenceType

The type of reference.

Declaration
public TableEntryReference.Type ReferenceType { get; }
Property Value
Type Description
TableEntryReference.Type

Methods

Equals(Object)

Compare the TableEntryReference to another TableEntryReference.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Boolean
Overrides

Equals(TableEntryReference)

Compare the TableEntryReference to another TableEntryReference.

Declaration
public bool Equals(TableEntryReference other)
Parameters
Type Name Description
TableEntryReference other
Returns
Type Description
Boolean

GetHashCode()

Returns the hash code of Key or KeyId.

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides

OnAfterDeserialize()

Determines the ReferenceType.

Declaration
public void OnAfterDeserialize()

OnBeforeSerialize()

Does nothing but is required for OnAfterDeserialize().

Declaration
public void OnBeforeSerialize()

ResolveKeyName(SharedTableData)

Returns the key name. If ReferenceType is Name then Key will be returned. If ReferenceType is Id then sharedData will be used to extract the name.

Declaration
public string ResolveKeyName(SharedTableData sharedData)
Parameters
Type Name Description
SharedTableData sharedData

The SharedTableData to use if the key name is not stored in the reference or null if it could not br resolbved.
Returns
Type Description
String

ToString()

Returns a string representation.

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Operators

Implicit(String to TableEntryReference)

Converts a string name into a reference.

Declaration
public static implicit operator TableEntryReference(string key)
Parameters
Type Name Description
String key
Returns
Type Description
TableEntryReference

Implicit(UInt32 to TableEntryReference)

Converts a key id into a reference.

Declaration
public static implicit operator TableEntryReference(uint keyId)
Parameters
Type Name Description
UInt32 keyId
Returns
Type Description
TableEntryReference

Implicit(TableEntryReference to String)

Returns Key.

Declaration
public static implicit operator string (TableEntryReference tableEntryReference)
Parameters
Type Name Description
TableEntryReference tableEntryReference
Returns
Type Description
String

Implicit(TableEntryReference to UInt32)

Returns KeyId

Declaration
public static implicit operator uint (TableEntryReference tableEntryReference)
Parameters
Type Name Description
TableEntryReference tableEntryReference
Returns
Type Description
UInt32