Struct TableReference | Localization | 0.6.1-preview
docs.unity3d.com
    Show / Hide Table of Contents

    Struct TableReference

    It is possible to reference a table via either the table name of the table name guid. The TableReference provides a flexible way to reference via either of these methods and also includes editor functionality.

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

    Properties

    ReferenceType

    The type of reference.

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

    TableName

    The table name when ReferenceType is .

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

    TableNameGuid

    The table name guid when ReferenceType is Guid.

    Declaration
    public Guid TableNameGuid { get; set; }
    Property Value
    Type Description
    Guid

    Methods

    Equals(Object)

    Compare the TableReference to another TableReference.

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

    Equals(TableReference)

    Compare 2 TableReferences.

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

    GetHashCode()

    Returns the hash code of TableNameGuid or TableName.

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

    OnAfterDeserialize()

    Converts the serializable string into the correct reference type.

    Declaration
    public void OnAfterDeserialize()

    OnBeforeSerialize()

    Converts the reference into a serializable string.

    Declaration
    public void OnBeforeSerialize()

    ToString()

    Returns a string representation.

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

    Operators

    Implicit(Guid to TableReference)

    Convert a table name guid into a TableReference.

    Declaration
    public static implicit operator TableReference(Guid tableNameGuid)
    Parameters
    Type Name Description
    Guid tableNameGuid

    The table name guid.

    Returns
    Type Description
    TableReference

    Implicit(String to TableReference)

    Convert a table name into a TableReference.

    Declaration
    public static implicit operator TableReference(string tableName)
    Parameters
    Type Name Description
    String tableName

    The name of the table.

    Returns
    Type Description
    TableReference

    Implicit(TableReference to Guid)

    Returns TableNameGuid.

    Declaration
    public static implicit operator Guid(TableReference tableReference)
    Parameters
    Type Name Description
    TableReference tableReference
    Returns
    Type Description
    Guid

    Implicit(TableReference to String)

    Returns TableName.

    Declaration
    public static implicit operator string (TableReference tableReference)
    Parameters
    Type Name Description
    TableReference tableReference
    Returns
    Type Description
    String
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023