EntityId Struct

Namespace: Improbable.Gdk.CoreSource

A unique identifier used to look up an entity in SpatialOS.

Inheritance

IEquatable<EntityId>
IComparable<EntityId>
IComparable

Notes

  • Instances of this type should be treated as transient identifiers that will not be consistent between different runs of the same simulation.


Fields

Id Source
readonly long Id

The value of the EntityId.

Notes:
  • Though this value is numeric, you should not perform any mathematical operations on it.


Constructors

EntityId Source
EntityId(long id)

Constructs a new instance of an EntityId.

Parameters
  • long id :


Methods

IsValid Source
bool IsValid()

Whether this represents a valid SpatialOS entity ID. Specifically,

Returns:
True iff valid.

Notes:
  • Id > 0.

Equals Source
bool Equals(EntityId obj)

Parameters

CompareTo Source
int CompareTo(EntityId other)

Parameters

CompareTo Source
int CompareTo(object obj)

Parameters
  • object obj :


Overrides

Equals Source
override bool Equals(object obj)

Parameters
  • object obj :

GetHashCode Source
override int GetHashCode()


ToString Source
override string ToString()


Operators

operator== Source
bool operator==(EntityId entityId1, EntityId entityId2)

Returns true if entityId1 is exactly equal to entityId2.

Parameters

operator!= Source
bool operator!=(EntityId entityId1, EntityId entityId2)

Returns true if entityId1 is not exactly equal to entityId2.

Parameters

operator< Source
bool operator<(EntityId left, EntityId right)

Parameters

operator> Source
bool operator>(EntityId left, EntityId right)

Parameters

operator<= Source
bool operator<=(EntityId left, EntityId right)

Parameters

operator>= Source
bool operator>=(EntityId left, EntityId right)

Parameters

Updated about a year ago


EntityId Struct


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.