TeleportService

Class fields

Field	XML type	Value
`Name`	string	TeleportService
`summary`	string	Allows players to seamlessly leave a game and join another

Properties

CustomizedTeleportUI

bool

Field	XML type	Value
`Name`	string	CustomizedTeleportUI

Functions

GetLocalPlayerTeleportData

() → Variant

Field	XML type	Value
`Name`	string	GetLocalPlayerTeleportData

GetTeleportSetting

(setting: string) → Variant

Field	XML type	Value
`Name`	string	GetTeleportSetting

SetTeleportSetting

(setting: string, value: Variant) → void

Field	XML type	Value
`Name`	string	SetTeleportSetting

Teleport

(placeId: int, player: Instance = …, teleportData: Variant, customLoadingScreen: Instance = …) → void

Field	XML type	Value
`Name`	string	Teleport

TeleportCancel

() → void

Field	XML type	Value
`Name`	string	TeleportCancel

TeleportToPlaceInstance

(placeId: int, instanceId: string, player: Instance = …, spawnName: string = …, teleportData: Variant, customLoadingScreen: Instance = …) → void

Field	XML type	Value
`Name`	string	TeleportToPlaceInstance

TeleportToPrivateServer

(placeId: int, reservedServerAccessCode: string, players: Objects, spawnName: string = …, teleportData: Variant, customLoadingScreen: Instance = …) → void

Field	XML type	Value
`Name`	string	TeleportToPrivateServer

TeleportToSpawnByName

(placeId: int, spawnName: string, player: Instance = …, teleportData: Variant, customLoadingScreen: Instance = …) → void

Field	XML type	Value
`Name`	string	TeleportToSpawnByName

Yield functions

GetPlayerPlaceInstanceAsync

(userId: int) → Tuple

Field	XML type	Value
`Name`	string	GetPlayerPlaceInstanceAsync

ReserveServer

(placeId: int) → string

Field	XML type	Value
`Name`	string	ReserveServer

Events

LocalPlayerArrivedFromTeleport

(loadingGui: Instance, dataTable: Variant) → void

Field	XML type	Value
`Name`	string	LocalPlayerArrivedFromTeleport

Callbacks

ConfirmationCallback

(message: string, placeId: int, spawnName: string) → bool

Field	XML type	Value
`Name`	string	ConfirmationCallback

ErrorCallback

(message: string) → void

Field	XML type	Value
`Name`	string	ErrorCallback