Class UUID

The UUID implements an immutable universally unique identifier. It is used to identifier different types of objects uniquely, from SceneObject to Resource.

Note

As all TypeScript types, the UUID is an identity, not a value type. To compare two UUIDs, use the UUID.isEqual method and do not compare by identity (X == Y).

Constructors

constructor

Properties

empty

Accessors

data0 data1 data2 data3

Methods

clone isEmpty isEqual toBigInt toString fromBigInt fromString generateRandom isEqual

Constructors

constructor

  • new UUID(data0?, data1?, data2?, data3?): UUID

  • Parameters

    • Optionaldata0: number
    • Optionaldata1: number
    • Optionaldata2: number
    • Optionaldata3: number

    Returns UUID

Properties

Staticempty

empty: UUID

A zero initialized UUID.

Accessors

data0

  • get data0(): number

  • The data part of the UUID.

    Returns number

data1

  • get data1(): number

  • The data part of the UUID.

    Returns number

data2

  • get data2(): number

  • The data part of the UUID.

    Returns number

data3

  • get data3(): number

  • The data part of the UUID.

    Returns number

Methods

clone

  • clone(): UUID

  • Clones this instance and returns a new UUID with identical values.

    Returns UUID

isEmpty

  • isEmpty(): boolean

  • Checks has the UUID been initialized to a valid value.

    Returns boolean

    True if UUID is initialized.

isEqual

  • isEqual(rhs): boolean

  • Determines if both UUIDs are equal.

    Parameters

    Returns boolean

toBigInt

  • toBigInt(): UUIDBigInt

  • Converts the UUID to a BigInt representation.

    Returns UUIDBigInt

    Note

    This is useful when using the UUID in a Map as key.

toString

  • toString(): string

  • Converts the UUID to a string representation.

    Returns string

StaticfromBigInt

  • fromBigInt(value): UUID

  • Creates a new UUID from the specified BigInt value.

    Parameters

    • value: UUIDBigInt

      The UUID in BigInt representation.

    Returns UUID

    A new UUID.

StaticfromString

  • fromString(uuid): UUID

  • Creates a new UUID from the specified uuid string.

    Parameters

    • uuid: string

      The UUID string

    Returns UUID

    A new UUID.

StaticgenerateRandom

  • generateRandom(): UUID

  • Creates a new universally unique identifier (UUID/UID).

    Returns UUID

StaticisEqual

  • isEqual(lhs, rhs): boolean

  • Determines if both UUIDs are equal.

    Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods