FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [View Raw Code]   [Original HTTPS Page]

vrchatapi-python/docs/Instance.md at main · EinDev/vrchatapi-python · GitHub

/ vrchatapi-python Public
forked from vrchatapi/vrchatapi-python

Breadcrumbs

  1. vrchatapi-python
  2. docs

Instance.md

Latest commit

 

History

History
34 lines (29 loc) · 2.79 KB

Breadcrumbs

  1. vrchatapi-python
  2. docs

Instance.md

File metadata and controls

34 lines (29 loc) · 2.79 KB
Raw

Instance

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

Properties

Name Type Description Notes
active bool [default to True]
can_request_invite bool [default to True]
capacity int
client_number str Always returns "unknown".
full bool [default to False]
id str InstanceID can be "offline" on User profiles if you are not friends with that user and "private" if you are friends and user is in private instance.
instance_id str
location str InstanceID can be "offline" on User profiles if you are not friends with that user and "private" if you are friends and user is in private instance.
n_users int
name str
owner_id str A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. [optional]
permanent bool [default to False]
photon_region Region
platforms InstancePlatforms
region Region
secure_name str
short_name str [optional]
tags list[str] The tags array on Instances usually contain the language tags of the people in the instance.
type InstanceType
world_id str WorldID be "offline" on User profiles if you are not friends with that user.
hidden str A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. [optional]
friends str A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. [optional]
private str A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. [optional]

[Back to Model list] [Back to API list] [Back to README]

Back | FazBrowse Home | New Git URL