docs.unity3d.com
    Show / Hide Table of Contents

    Struct TableReference

    It is possible to reference a table via either the table collection name of the table collection 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

    TableCollectionName

    The table collection name when ReferenceType is Name. If the ReferenceType is not Name then an attempt will be made to extract the Table Collection Name, for debugging purposes, through the AssetDatabase(in Editor) or by checking the LocalizationSettings to see if the UnityEngine.Localization.Tables.TableReference.SharedTableData has been loaded by the LocalizedStringDatabase or LocalizedAssetDatabase, if the name can not be resolved then null will be returned.

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

    TableCollectionNameGuid

    The table collection name guid when ReferenceType is Guid.

    Declaration
    public Guid TableCollectionNameGuid { get; }
    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 TableCollectionNameGuid or TableCollectionName.

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

    Operators

    Implicit(Guid to TableReference)

    Convert a table collection name guid into a TableReference.

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

    The table collection name guid.

    Returns
    Type Description
    TableReference

    Implicit(String to TableReference)

    Convert a table collection name into a TableReference.

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

    The name of the table.

    Returns
    Type Description
    TableReference

    Implicit(TableReference to Guid)

    Returns TableCollectionNameGuid.

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

    Implicit(TableReference to String)

    Returns TableCollectionName.

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

    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    In This Article
    • Properties
      • ReferenceType
      • TableCollectionName
      • TableCollectionNameGuid
    • Methods
      • Equals(Object)
      • Equals(TableReference)
      • GetHashCode()
    • Operators
      • Implicit(Guid to TableReference)
      • Implicit(String to TableReference)
      • Implicit(TableReference to Guid)
      • Implicit(TableReference to 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