RSX Code Reference
    Preparing search index...

    Class UUID

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

    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).

    Index
    constructor
    empty
    data0 data1 data2 data3
    clone isEmpty isEqual toBigInt toString fromBigInt fromString generateRandom isEqual isValidUUID

    • Parameters

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

      Returns UUID

    empty: UUID

    A zero initialized UUID.

    • get data0(): number

      The data part of the UUID.

      Returns number

    • get data1(): number

      The data part of the UUID.

      Returns number

    • get data2(): number

      The data part of the UUID.

      Returns number

    • get data3(): number

      The data part of the UUID.

      Returns number

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

      Returns UUID

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

      Returns boolean

      True if UUID is initialized.

    • Determines if both UUIDs are equal.

      Parameters

      Returns boolean

    • Converts the UUID to a BigInt representation.

      Returns UUIDBigInt

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

    • Converts the UUID to a string representation.

      Returns string

    • Creates a new UUID from the specified BigInt value.

      Parameters

      • value: UUIDBigInt

        The UUID in BigInt representation.

      Returns UUID

      A new UUID.

    • Creates a new UUID from the specified uuid string.

      Parameters

      • uuid: string

        The UUID string

      Returns UUID

      A new UUID.

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

      Returns UUID

    • Determines if the specified string is a valid UUID.

      Parameters

      • uuid: string

        The UUID string to validate.

      Returns boolean

      True if the string is a valid UUID, false otherwise.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods