Struct EntityGuid | Entities | 0.10.0-preview.6
docs.unity3d.com
    Show / Hide Table of Contents

    Struct EntityGuid

    This component is attached to converted Entities and is guaranteed to be unique within a World. It can be used to map back to the authoring GameObject from which it was converted. Note that an EntityGuid does not have enough information to be persistent across sessions.

    Namespace: Unity.Entities
    Syntax
    [Serializable]
    public struct EntityGuid : IComponentData, IEquatable<EntityGuid>, IComparable<EntityGuid>

    Constructors

    EntityGuid(Int32, Byte, UInt32)

    Declaration
    public EntityGuid(int originatingId, byte namespaceId, uint serial)
    Parameters
    Type Name Description
    Int32 originatingId
    Byte namespaceId
    UInt32 serial

    Fields

    a

    This field, when combined with b, is for working with EntityGuid as opaque bits (the packing may change again in the future, as there are still unused bits remaining).

    Declaration
    public ulong a
    Field Value
    Type Description
    UInt64

    b

    Use same as a field.

    Declaration
    public ulong b
    Field Value
    Type Description
    UInt64

    Null

    Declaration
    public static readonly EntityGuid Null
    Field Value
    Type Description
    EntityGuid

    Properties

    NamespaceId

    An ID that supports multiple primary groupings of converted Entities with the same originating object. ID zero is reserved for default conversions. Nonzero ID's are for the developer to manage.

    Declaration
    public byte NamespaceId { get; }
    Property Value
    Type Description
    Byte

    OriginatingId

    Session-unique ID for originating object (typically the authoring GameObject's InstanceID).

    Declaration
    public int OriginatingId { get; }
    Property Value
    Type Description
    Int32

    Serial

    A unique number used to differentiate Entities associated with the same originating object and namespace.

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

    Methods

    CompareTo(EntityGuid)

    Declaration
    public int CompareTo(EntityGuid other)
    Parameters
    Type Name Description
    EntityGuid other
    Returns
    Type Description
    Int32

    Equals(Object)

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

    Equals(EntityGuid)

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

    GetHashCode()

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

    ToString()

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

    Operators

    Equality(EntityGuid, EntityGuid)

    Declaration
    public static bool operator ==(in EntityGuid lhs, in EntityGuid rhs)
    Parameters
    Type Name Description
    EntityGuid lhs
    EntityGuid rhs
    Returns
    Type Description
    Boolean

    Inequality(EntityGuid, EntityGuid)

    Declaration
    public static bool operator !=(in EntityGuid lhs, in EntityGuid rhs)
    Parameters
    Type Name Description
    EntityGuid lhs
    EntityGuid rhs
    Returns
    Type Description
    Boolean
    In This Article
    • Constructors
      • EntityGuid(Int32, Byte, UInt32)
    • Fields
      • a
      • b
      • Null
    • Properties
      • NamespaceId
      • OriginatingId
      • Serial
    • Methods
      • CompareTo(EntityGuid)
      • Equals(Object)
      • Equals(EntityGuid)
      • GetHashCode()
      • ToString()
    • Operators
      • Equality(EntityGuid, EntityGuid)
      • Inequality(EntityGuid, EntityGuid)
    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