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.
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
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
Field Value
b
Declaration
Field Value
Null
Declaration
public static readonly EntityGuid Null
Field Value
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 readonly byte NamespaceId { get; }
Property Value
OriginatingId
Session-unique ID for originating object (typically the authoring GameObject's InstanceID).
Declaration
public readonly int OriginatingId { get; }
Property Value
Serial
A unique number used to differentiate Entities associated with the same originating object and namespace.
Declaration
public readonly uint Serial { get; }
Property Value
Methods
CompareTo(EntityGuid)
Declaration
public int CompareTo(EntityGuid other)
Parameters
Returns
Equals(Object)
Declaration
public override bool Equals(object obj)
Parameters
Type |
Name |
Description |
Object |
obj |
|
Returns
Overrides
Equals(EntityGuid)
Declaration
public bool Equals(EntityGuid other)
Parameters
Returns
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Overrides
ToString()
Declaration
public override string ToString()
Returns
Overrides
Operators
Equality(in EntityGuid, in EntityGuid)
Declaration
public static bool operator ==(in EntityGuid lhs, in EntityGuid rhs)
Parameters
Returns
Inequality(in EntityGuid, in EntityGuid)
Declaration
public static bool operator !=(in EntityGuid lhs, in EntityGuid rhs)
Parameters
Returns