VRChat.Model.Instance (vrchat v1.20.0)

View Source
  • hidden field is only present if InstanceType is hidden aka "Friends+", and is instance creator. friends field is only present if InstanceType is friends aka "Friends", and is instance creator. private field is only present if InstanceType is private aka "Invite" or "Invite+", and is instance creator.

Summary

Types

t()

@type t() :: %VRChat.Model.Instance{
  active: boolean(),
  ageGate: boolean() | nil,
  canRequestInvite: boolean(),
  capacity: integer(),
  clientNumber: String.t(),
  closedAt: DateTime.t() | nil,
  contentSettings: VRChat.Model.InstanceContentSettings.t(),
  displayName: String.t() | nil,
  friends: String.t() | nil,
  full: boolean(),
  gameServerVersion: integer() | nil,
  groupAccessType: VRChat.Model.GroupAccessType.t() | nil,
  hardClose: boolean() | nil,
  hasCapacityForYou: boolean() | nil,
  hidden: String.t() | nil,
  id: String.t(),
  instanceId: String.t(),
  instancePersistenceEnabled: String.t() | nil,
  location: String.t(),
  n_users: integer(),
  name: String.t(),
  nonce: String.t() | nil,
  ownerId: String.t() | nil,
  permanent: boolean(),
  photonRegion: VRChat.Model.Region.t(),
  platforms: VRChat.Model.InstancePlatforms.t(),
  playerPersistenceEnabled: boolean() | nil,
  private: String.t() | nil,
  queueEnabled: boolean(),
  queueSize: integer(),
  recommendedCapacity: integer(),
  region: VRChat.Model.InstanceRegion.t(),
  roleRestricted: boolean() | nil,
  secureName: String.t(),
  shortName: String.t() | nil,
  strict: boolean(),
  tags: [String.t()],
  type: VRChat.Model.InstanceType.t(),
  userCount: integer(),
  users: [VRChat.Model.LimitedUserInstance.t()] | nil,
  world: VRChat.Model.World.t(),
  worldId: String.t()
}

Functions

decode(value)