TeleportService

extends Instance

16 members

Class fields

FieldXML typeValue
NamestringTeleportService
summarystringAllows players to seamlessly leave a game and join another

Properties

1
CustomizedTeleportUI
bool
FieldXML typeValue
NamestringCustomizedTeleportUI

Functions

8
GetLocalPlayerTeleportData
() → Variant
FieldXML typeValue
NamestringGetLocalPlayerTeleportData
GetTeleportSetting
(setting: string) → Variant
FieldXML typeValue
NamestringGetTeleportSetting
SetTeleportSetting
(setting: string, value: Variant) → void
FieldXML typeValue
NamestringSetTeleportSetting
Teleport
(placeId: int64, player: Instance = …, teleportData: Variant, customLoadingScreen: Instance = …) → void
FieldXML typeValue
NamestringTeleport
TeleportCancel
() → void
FieldXML typeValue
NamestringTeleportCancel
TeleportToPlaceInstance
(placeId: int, instanceId: string, player: Instance = …, spawnName: string = …, teleportData: Variant, customLoadingScreen: Instance = …) → void
FieldXML typeValue
NamestringTeleportToPlaceInstance
TeleportToPrivateServer
(placeId: int, reservedServerAccessCode: string, players: Objects, spawnName: string = …, teleportData: Variant, customLoadingScreen: Instance = …) → void
FieldXML typeValue
NamestringTeleportToPrivateServer
TeleportToSpawnByName
(placeId: int, spawnName: string, player: Instance = …, teleportData: Variant, customLoadingScreen: Instance = …) → void
FieldXML typeValue
NamestringTeleportToSpawnByName

Yield functions

3
GetPlayerPlaceInstanceAsync
(userId: int) → Tuple
FieldXML typeValue
NamestringGetPlayerPlaceInstanceAsync
ReserveServer
(placeId: int) → string
FieldXML typeValue
NamestringReserveServer
UnblockAsync
() → Tuple
FieldXML typeValue
NamestringUnblockAsync

Events

2
LocalPlayerArrivedFromTeleport
(loadingGui: Instance, dataTable: Variant) → void
FieldXML typeValue
NamestringLocalPlayerArrivedFromTeleport
MenuTeleportAttempt
() → void
FieldXML typeValue
NamestringMenuTeleportAttempt

Callbacks

2
ConfirmationCallback
(message: string, placeId: int, spawnName: string) → bool
FieldXML typeValue
NamestringConfirmationCallback
ErrorCallback
(message: string) → void
FieldXML typeValue
NamestringErrorCallback