Roblox Wiki
Advertisement
Roblox Wiki
24,328
pages

Allows players to seamlessly leave a game and join another.

Contents

Properties

Pubfield.gif bool CustomizedTeleportUI [NotReplicated] [Deprecated]

  • Category: Data.
  • Serialization: can load only.

Functions

Pubmethod.gif Instance GetArrivingTeleportGui()

Pubmethod.gif Variant GetLocalPlayerTeleportData()

Pubmethod.gif Tuple GetPlayerPlaceInstanceAsync(int64 userId) [Yields]

Pubmethod.gif Variant GetTeleportSetting(string setting)

Pubmethod.gif Tuple ReserveServer(int64 placeId) [Yields]

Pubmethod.gif void SetTeleportGui(Instance gui)

Pubmethod.gif void SetTeleportSetting(string setting, Variant value)

Pubmethod.gif void Teleport(int64 placeId, Instance player = nil, Variant teleportData, Instance customLoadingScreen = nil)

Pubmethod.gif Instance TeleportAsync(int64 placeId, Objects players, Instance teleportOptions = nil) [Yields]

Protmethod.gif void TeleportCancel()

  • Security: RobloxScriptSecurity.

Pubmethod.gif string TeleportPartyAsync(int64 placeId, Objects players, Variant teleportData, Instance customLoadingScreen = nil) [Yields]

Pubmethod.gif void TeleportToPlaceInstance(int64 placeId, string instanceId, Instance player = nil, string spawnName = , Variant teleportData, Instance customLoadingScreen = nil)

Pubmethod.gif void TeleportToPrivateServer(int64 placeId, string reservedServerAccessCode, Objects players, string spawnName = , Variant teleportData, Instance customLoadingScreen = nil)

Pubmethod.gif void TeleportToSpawnByName(int64 placeId, string spawnName, Instance player = nil, Variant teleportData, Instance customLoadingScreen = nil)

Events

Pubevent.gif LocalPlayerArrivedFromTeleport(Instance loadingGui, Variant dataTable)

Pubevent.gif TeleportInitFailed(Instance player, TeleportResult teleportResult, string errorMessage)

External links