Skip to content

InstancesAPI

Accessible via the InstancesAPI Global. This API provides access to information about the currently connected instance.

There are some events for instances, they can be checked here: Instance Events

NameDescription
PingPing to Game Server.
IsConnectedIs the local player connected to the Game Server.
IsHomeInstanceIs the current instance the local player’s home world instance.
InstanceIDCurrent instance id.
InstanceNameCurrent instance name.
(Display Name + ID)
InstancePrivacyCurrent instance privacy as string.
(Public, FriendsOfFriends, Friends, Group, EveryoneCanInvite, OwnerMustInvite)