Roblox API Reference

TeleportService On DevHub

Summary

This class is not creatable. An object of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.

Tags: [NotCreatable, Service]

Inherits (1)

Member index (20)

Type Member History
bool CustomizedTeleportUI 130 223 222 223
null Block () 547 573
Instance GetArrivingTeleportGui () 350
Variant GetLocalPlayerTeleportData () 223 222 223
Tuple GetPlayerPlaceInstanceAsync (int64 userId) 139 322
Variant GetTeleportSetting (string setting) 223 222 223
Tuple ReserveServer (int64 placeId) 210 322 352
null SetTeleportGui (Instance gui) 347 573
null SetTeleportSetting (string setting, Variant value) 223 222 223 573
null Teleport (int64 placeId, Instance player = nil, Variant teleportData, Instance customLoadingScreen = nil) 127 206 322 573
Instance TeleportAsync (int64 placeId, Objects players, Instance teleportOptions = nil) 458
null TeleportCancel () 573
string TeleportPartyAsync (int64 placeId, Objects players, Variant teleportData, Instance customLoadingScreen = nil) 331
null TeleportToPlaceInstance (int64 placeId, string instanceId, Instance player = nil, string spawnName = , Variant teleportData, Instance customLoadingScreen = nil) 139 206 210 322 573
null TeleportToPrivateServer (int64 placeId, string reservedServerAccessCode, Objects players, string spawnName = , Variant teleportData, Instance customLoadingScreen = nil) 210 322 573
null TeleportToSpawnByName (int64 placeId, string spawnName, Instance player = nil, Variant teleportData, Instance customLoadingScreen = nil) 127 206 322 573
Tuple UnblockAsync () 547
LocalPlayerArrivedFromTeleport (Instance loadingGui, Variant dataTable) 206
MenuTeleportAttempt () 546
TeleportInitFailed (Instance player, TeleportResult teleportResult, string errorMessage, int64 placeId, Instance teleportOptions) 320 511
57 members inherited from Instance

Removed member index (3)

Type Member History
void TeleportImpl (int placeId, string spawnName) 210
bool ConfirmationCallback (string message, int placeId, string spawnName) 131 311
void ErrorCallback (string message) 131 311

History

Members

Block On DevHub

Name Type Default
No parameters.

History

CustomizedTeleportUI On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
This item is not replicated. Its interface does not cross the network boundary.

History

Tags: [NotReplicated, Deprecated]

GetArrivingTeleportGui On DevHub

Name Type Default
No parameters.

History

GetLocalPlayerTeleportData On DevHub

Name Type Default
No parameters.

History

GetPlayerPlaceInstanceAsync On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
userId int64 none

History

Tags: [Yields]

GetTeleportSetting On DevHub

Name Type Default
setting string none

History

LocalPlayerArrivedFromTeleport On DevHub

Name Type Default
loadingGui Instance none
dataTable Variant none

History

MenuTeleportAttempt On DevHub

Name Type Default
No parameters.

History

ReserveServer On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
placeId int64 none

History

Tags: [Yields]

SetTeleportGui On DevHub

Name Type Default
gui Instance none

History

SetTeleportSetting On DevHub

Name Type Default
setting string none
value Variant none

History

Teleport On DevHub

Name Type Default
placeId int64 none
player Instance nil
teleportData Variant none
customLoadingScreen Instance nil

History

TeleportAsync On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
placeId int64 none
players Objects none
teleportOptions Instance nil

History

Tags: [Yields]

TeleportCancel On DevHub

Name Type Default
No parameters.

History

TeleportInitFailed On DevHub

Name Type Default
player Instance none
teleportResult TeleportResult none
errorMessage string none
placeId int64 none
teleportOptions Instance none

History

TeleportPartyAsync On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
placeId int64 none
players Objects none
teleportData Variant none
customLoadingScreen Instance nil

History

Tags: [Yields]

TeleportToPlaceInstance On DevHub

Name Type Default
placeId int64 none
instanceId string none
player Instance nil
spawnName string
teleportData Variant none
customLoadingScreen Instance nil

History

TeleportToPrivateServer On DevHub

Name Type Default
placeId int64 none
reservedServerAccessCode string none
players Objects none
spawnName string
teleportData Variant none
customLoadingScreen Instance nil

History

TeleportToSpawnByName On DevHub

Name Type Default
placeId int64 none
spawnName string none
player Instance nil
teleportData Variant none
customLoadingScreen Instance nil

History

UnblockAsync On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
No parameters.

History

Tags: [Yields]

Removed members

ConfirmationCallback

This callback cannot yield. Attempting to yield within this callback will result in an error.
Name Type Default
message string none
placeId int none
spawnName string none

History

Tags: [noyield]

ErrorCallback

This callback cannot yield. Attempting to yield within this callback will result in an error.
Name Type Default
message string none

History

Tags: [noyield]

TeleportImpl

Name Type Default
placeId int none
spawnName string none

History

Relevant classes (1)

Relevant enums (1)