VRCGuid Class

Namespace: VRChat
Inherited: System.Object

The VRCGuid struct represents a Guid tied in with an underlying VRCKind
which may represent a file, avatar, world, or user.
This is a struct used to validate and .NET-ify VRChat's IDs.

Methods

  1. ToString()
  2. Create(VRChat.VRCKind kind, System.Guid underlyingId)
  3. NewGuid(VRChat.VRCKind kind)
  4. TryParse(string incoming, VRChat.VRCGuid@ vrcid)
  5. Parse(string id)

Properties

  1. Guid
  2. Kind
  3. Empty

Methods


public ToString()

Return
Type Description
A string representing the current VRCGuid, formatted with [type]_[guid]
Formats the current VRCGuid as a string with the [type]_[guid] format standard for VRChat.

public Create(VRChat.VRCKind kind, System.Guid underlyingId)

Parameters
Type Name Description
VRChat.VRCKind
 kind The kind of VRCGuid to create.
System.Guid
 underlyingId The Guid of the VRCGuid to create.
Return
Type Description
A new VRCGuid.
Creates a VRCGuid with the specified parameters

public NewGuid(VRChat.VRCKind kind)

Parameters
Type Name Description
VRChat.VRCKind
 kind The kind of VRCGuid to create.
Return
Type Description
A new VRCGuid.
Creates a new VRCGuid randomly, with the specified VRCKind, otherwise VRCGuidType.File

public TryParse(string incoming, VRChat.VRCGuid@ vrcid)

Parameters
Type Name Description
string
 incoming The input string to parse, e.g. usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469
VRChat.VRCGuid@
 vrcid The result VRCGuid of the operation to be returned.
Return
Type Description
A Boolean value representing the success of the operation
Tries to parse a VRCGuid from the input string provided, and returns a Boolean representing the status of the operation.

public Parse(string id)

Parameters
Type Name Description
string
 id The input string to parse, e.g. usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469
Return
Type Description
A VRCGuid value representing the input string
Parses a VRCGuid from the input string provided, otherwise throws a FormatException if unable to parse it.

Properties


public Guid

The underlying Guid that this VRCGuid represents.

public Kind

The underlying VRCKind that this VRCGuid represents.

public Empty

A default VRCGuid that is empty with "file" as it's type. Keep in mind VRCGuid's can not be null.