TeleportService
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
| Memory category | Instances |
|---|
Member index 23
Removed member index 3
| History | Member | |
|---|---|---|
| 210 | TeleportImpl(placeId: int, spawnName: string): void | |
| 311 | ConfirmationCallback(message: string, placeId: int, spawnName: string): bool | |
| 311 | ErrorCallback(message: string): void |
History 83
- 594 Add
- 573 Change ReturnType of TeleportToSpawnByName from void to null
- 573 Change ReturnType of TeleportToPrivateServer from void to null
- 573 Change ReturnType of TeleportToPlaceInstance from void to null
- 573 Change ReturnType of TeleportCancel from void to null
- 573 Change ReturnType of Teleport from void to null
- 573 Change ReturnType of SetTeleportSetting from void to null
- 573 Change ReturnType of SetTeleportGui from void to null
- 573 Change ReturnType of Block from void to null
- 553 Add
- 553 Add
- 553 Change Default of CustomizedTeleportUI from to
- 547 Add UnblockAsync
- 547 Add Block
- 546 Add MenuTeleportAttempt
- 511 Change Parameters of TeleportInitFailed from (player: Instance, teleportResult: TeleportResult, errorMessage: string) to (player: Instance, teleportResult: TeleportResult, errorMessage: string, placeId: int64, teleportOptions: Instance)
- 486 Change ThreadSafety of CustomizedTeleportUI from ReadOnly to ReadSafe
- 462 Change ThreadSafety of TeleportInitFailed from to Unsafe
- 462 Change ThreadSafety of LocalPlayerArrivedFromTeleport from to Unsafe
- 462 Change ThreadSafety of TeleportToSpawnByName from to Unsafe
- 462 Change ThreadSafety of TeleportToPrivateServer from to Unsafe
- 462 Change ThreadSafety of TeleportToPlaceInstance from to Unsafe
- 462 Change ThreadSafety of TeleportPartyAsync from to Unsafe
- 462 Change ThreadSafety of TeleportCancel from to Unsafe
- 462 Change ThreadSafety of TeleportAsync from to Unsafe
- 462 Change ThreadSafety of Teleport from to Unsafe
- 462 Change ThreadSafety of SetTeleportSetting from to Unsafe
- 462 Change ThreadSafety of SetTeleportGui from to Unsafe
- 462 Change ThreadSafety of ReserveServer from to Unsafe
- 462 Change ThreadSafety of GetTeleportSetting from to Unsafe
- 462 Change ThreadSafety of GetPlayerPlaceInstanceAsync from to Unsafe
- 462 Change ThreadSafety of GetLocalPlayerTeleportData from to Unsafe
- 462 Change ThreadSafety of GetArrivingTeleportGui from to Unsafe
- 462 Change ThreadSafety of CustomizedTeleportUI from to ReadOnly
- 458 Add TeleportAsync
- 352 Change ReturnType of ReserveServer from string to Tuple
- 350 Add GetArrivingTeleportGui
- 347 Add SetTeleportGui
- 331 Add TeleportPartyAsync
- 322 Change Parameters of TeleportToSpawnByName from (placeId: int, spawnName: string, player: Instance = Instance, teleportData: Variant, customLoadingScreen: Instance = Instance) to (placeId: int64, spawnName: string, player: Instance = Instance, teleportData: Variant, customLoadingScreen: Instance = Instance)
- 322 Change Parameters of TeleportToPrivateServer from (placeId: int, reservedServerAccessCode: string, players: Objects, spawnName: string = , teleportData: Variant, customLoadingScreen: Instance = Instance) to (placeId: int64, reservedServerAccessCode: string, players: Objects, spawnName: string = , teleportData: Variant, customLoadingScreen: Instance = Instance)
- 322 Change Parameters of TeleportToPlaceInstance from (placeId: int, instanceId: string, player: Instance = Instance, spawnName: string = , teleportData: Variant, customLoadingScreen: Instance = Instance) to (placeId: int64, instanceId: string, player: Instance = Instance, spawnName: string = , teleportData: Variant, customLoadingScreen: Instance = Instance)
- 322 Change Parameters of Teleport from (placeId: int, player: Instance = Instance, teleportData: Variant, customLoadingScreen: Instance = Instance) to (placeId: int64, player: Instance = Instance, teleportData: Variant, customLoadingScreen: Instance = Instance)
- 322 Change Parameters of ReserveServer from (placeId: int) to (placeId: int64)
- 322 Change Parameters of GetPlayerPlaceInstanceAsync from (userId: int) to (userId: int64)
- 320 Add TeleportInitFailed
- 311 Remove ErrorCallback
- 311 Remove ConfirmationCallback
- 223 Add SetTeleportSetting
- 223 Add GetTeleportSetting
- 223 Add GetLocalPlayerTeleportData
- 223 Change Tags of CustomizedTeleportUI from [NotReplicated] to [NotReplicated, Deprecated]
- 222 Remove SetTeleportSetting
- 222 Remove GetTeleportSetting
- 222 Remove GetLocalPlayerTeleportData
- 222 Change Tags of CustomizedTeleportUI from [NotReplicated, Deprecated] to [NotReplicated]
- 223 Add SetTeleportSetting
- 223 Add GetTeleportSetting
- 223 Add GetLocalPlayerTeleportData
- 223 Change Tags of CustomizedTeleportUI from [NotReplicated] to [NotReplicated, Deprecated]
- 210 Add TeleportToPrivateServer
- 210 Change Parameters of TeleportToPlaceInstance from (placeId: int, instanceId: string, player: Instance = Instance, teleportData: Variant, customLoadingScreen: Instance = Instance) to (placeId: int, instanceId: string, player: Instance = Instance, spawnName: string = , teleportData: Variant, customLoadingScreen: Instance = Instance)
- 210 Remove TeleportImpl
- 210 Add ReserveServer
- 206 Add LocalPlayerArrivedFromTeleport
- 206 Change Parameters of TeleportToSpawnByName from (placeId: int, spawnName: string, player: Instance = Instance) to (placeId: int, spawnName: string, player: Instance = Instance, teleportData: Variant, customLoadingScreen: Instance = Instance)
- 206 Change Parameters of TeleportToPlaceInstance from (placeId: int, instanceId: string, player: Instance = Instance) to (placeId: int, instanceId: string, player: Instance = Instance, teleportData: Variant, customLoadingScreen: Instance = Instance)
- 206 Change Parameters of Teleport from (placeId: int, player: Instance = Instance) to (placeId: int, player: Instance = Instance, teleportData: Variant, customLoadingScreen: Instance = Instance)
- 139 Add TeleportToPlaceInstance
- 139 Add GetPlayerPlaceInstanceAsync
- 131 Change Tags of ErrorCallback from [] to [NoYield]
- 131 Change Tags of ConfirmationCallback from [] to [NoYield]
- 130 Add CustomizedTeleportUI
- 127 Change Parameters of TeleportToSpawnByName from (placeId: int, spawnName: string) to (placeId: int, spawnName: string, player: Instance = Instance)
- 127 Change Parameters of Teleport from (placeId: int) to (placeId: int, player: Instance = Instance)
- 55 Change Tags of TeleportService from [preliminary, NotCreatable, Service] to [NotCreatable, Service]
- 47 Add ErrorCallback
- 47 Add ConfirmationCallback
- 47 Add TeleportToSpawnByName
- 47 Add TeleportImpl
- 47 Add TeleportCancel
- 47 Add Teleport
- 47 Add TeleportService
Members 23
Block
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
CustomizedTeleportUI
| Type | Default | |
|---|---|---|
| bool | ||
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
This property is not replicated. Its interface does not cross the network boundary.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true/false |
History 7
- 553 Change Default of CustomizedTeleportUI from to
- 486 Change ThreadSafety of CustomizedTeleportUI from ReadOnly to ReadSafe
- 462 Change ThreadSafety of CustomizedTeleportUI from to ReadOnly
- 223 Change Tags of CustomizedTeleportUI from [NotReplicated] to [NotReplicated, Deprecated]
- 222 Change Tags of CustomizedTeleportUI from [NotReplicated, Deprecated] to [NotReplicated]
- 223 Change Tags of CustomizedTeleportUI from [NotReplicated] to [NotReplicated, Deprecated]
- 130 Add CustomizedTeleportUI
GetArrivingTeleportGui
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Instance | ||
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of GetArrivingTeleportGui from to Unsafe
- 350 Add GetArrivingTeleportGui
GetLocalPlayerTeleportData
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Variant | ||
| Thread safety | Unsafe |
|---|
History 4
- 462 Change ThreadSafety of GetLocalPlayerTeleportData from to Unsafe
- 223 Add GetLocalPlayerTeleportData
- 222 Remove GetLocalPlayerTeleportData
- 223 Add GetLocalPlayerTeleportData
GetPlayerPlaceInstanceAsync
| Parameters (1) | ||
|---|---|---|
| userId | int64 | |
| Returns (1) | ||
| Tuple | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 3
- 462 Change ThreadSafety of GetPlayerPlaceInstanceAsync from to Unsafe
- 322 Change Parameters of GetPlayerPlaceInstanceAsync from (userId: int) to (userId: int64)
- 139 Add GetPlayerPlaceInstanceAsync
GetTeleportSetting
| Parameters (1) | ||
|---|---|---|
| setting | string | |
| Returns (1) | ||
| Variant | ||
| Thread safety | Unsafe |
|---|
History 4
- 462 Change ThreadSafety of GetTeleportSetting from to Unsafe
- 223 Add GetTeleportSetting
- 222 Remove GetTeleportSetting
- 223 Add GetTeleportSetting
LocalPlayerArrivedFromTeleport
| Parameters (2) | |
|---|---|
| loadingGui | Instance |
| dataTable | Variant |
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of LocalPlayerArrivedFromTeleport from to Unsafe
- 206 Add LocalPlayerArrivedFromTeleport
MenuTeleportAttempt
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
ReserveServer
| Parameters (1) | ||
|---|---|---|
| placeId | int64 | |
| Returns (1) | ||
| Tuple | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 4
- 462 Change ThreadSafety of ReserveServer from to Unsafe
- 352 Change ReturnType of ReserveServer from string to Tuple
- 322 Change Parameters of ReserveServer from (placeId: int) to (placeId: int64)
- 210 Add ReserveServer
SetTeleportGui
| Parameters (1) | ||
|---|---|---|
| gui | Instance | |
| Returns (1) | ||
| null | ||
| Thread safety | Unsafe |
|---|
History 3
- 573 Change ReturnType of SetTeleportGui from void to null
- 462 Change ThreadSafety of SetTeleportGui from to Unsafe
- 347 Add SetTeleportGui
SetTeleportSetting
| Parameters (2) | ||
|---|---|---|
| setting | string | |
| value | Variant | |
| Returns (1) | ||
| null | ||
| Thread safety | Unsafe |
|---|
History 5
- 573 Change ReturnType of SetTeleportSetting from void to null
- 462 Change ThreadSafety of SetTeleportSetting from to Unsafe
- 223 Add SetTeleportSetting
- 222 Remove SetTeleportSetting
- 223 Add SetTeleportSetting
Teleport
| Parameters (4) | Default | |
|---|---|---|
| placeId | int64 | |
| player | Instance | Instance |
| teleportData | Variant | |
| customLoadingScreen | Instance | Instance |
| Returns (1) | ||
| null | ||
| Thread safety | Unsafe |
|---|
History 6
- 573 Change ReturnType of Teleport from void to null
- 462 Change ThreadSafety of Teleport from to Unsafe
- 322 Change Parameters of Teleport from (placeId: int, player: Instance = Instance, teleportData: Variant, customLoadingScreen: Instance = Instance) to (placeId: int64, player: Instance = Instance, teleportData: Variant, customLoadingScreen: Instance = Instance)
- 206 Change Parameters of Teleport from (placeId: int, player: Instance = Instance) to (placeId: int, player: Instance = Instance, teleportData: Variant, customLoadingScreen: Instance = Instance)
- 127 Change Parameters of Teleport from (placeId: int) to (placeId: int, player: Instance = Instance)
- 47 Add Teleport
TeleportAsync
| Parameters (3) | Default | |
|---|---|---|
| placeId | int64 | |
| players | Objects | |
| teleportOptions | Instance | Instance |
| Returns (1) | ||
| Instance | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of TeleportAsync from to Unsafe
- 458 Add TeleportAsync
TeleportCancel
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 3
- 573 Change ReturnType of TeleportCancel from void to null
- 462 Change ThreadSafety of TeleportCancel from to Unsafe
- 47 Add TeleportCancel
TeleportInitFailed
| Parameters (5) | |
|---|---|
| player | Instance |
| teleportResult | TeleportResult |
| errorMessage | string |
| placeId | int64 |
| teleportOptions | Instance |
| Thread safety | Unsafe |
|---|
History 3
- 511 Change Parameters of TeleportInitFailed from (player: Instance, teleportResult: TeleportResult, errorMessage: string) to (player: Instance, teleportResult: TeleportResult, errorMessage: string, placeId: int64, teleportOptions: Instance)
- 462 Change ThreadSafety of TeleportInitFailed from to Unsafe
- 320 Add TeleportInitFailed
TeleportPartyAsync
| Parameters (4) | Default | |
|---|---|---|
| placeId | int64 | |
| players | Objects | |
| teleportData | Variant | |
| customLoadingScreen | Instance | Instance |
| Returns (1) | ||
| string | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of TeleportPartyAsync from to Unsafe
- 331 Add TeleportPartyAsync
TeleportToPlaceInstance
| Parameters (6) | Default | |
|---|---|---|
| placeId | int64 | |
| instanceId | string | |
| player | Instance | Instance |
| spawnName | string | |
| teleportData | Variant | |
| customLoadingScreen | Instance | Instance |
| Returns (1) | ||
| null | ||
| Thread safety | Unsafe |
|---|
History 6
- 573 Change ReturnType of TeleportToPlaceInstance from void to null
- 462 Change ThreadSafety of TeleportToPlaceInstance from to Unsafe
- 322 Change Parameters of TeleportToPlaceInstance from (placeId: int, instanceId: string, player: Instance = Instance, spawnName: string = , teleportData: Variant, customLoadingScreen: Instance = Instance) to (placeId: int64, instanceId: string, player: Instance = Instance, spawnName: string = , teleportData: Variant, customLoadingScreen: Instance = Instance)
- 210 Change Parameters of TeleportToPlaceInstance from (placeId: int, instanceId: string, player: Instance = Instance, teleportData: Variant, customLoadingScreen: Instance = Instance) to (placeId: int, instanceId: string, player: Instance = Instance, spawnName: string = , teleportData: Variant, customLoadingScreen: Instance = Instance)
- 206 Change Parameters of TeleportToPlaceInstance from (placeId: int, instanceId: string, player: Instance = Instance) to (placeId: int, instanceId: string, player: Instance = Instance, teleportData: Variant, customLoadingScreen: Instance = Instance)
- 139 Add TeleportToPlaceInstance
TeleportToPrivateServer
| Parameters (6) | Default | |
|---|---|---|
| placeId | int64 | |
| reservedServerAccessCode | string | |
| players | Objects | |
| spawnName | string | |
| teleportData | Variant | |
| customLoadingScreen | Instance | Instance |
| Returns (1) | ||
| null | ||
| Thread safety | Unsafe |
|---|
History 4
- 573 Change ReturnType of TeleportToPrivateServer from void to null
- 462 Change ThreadSafety of TeleportToPrivateServer from to Unsafe
- 322 Change Parameters of TeleportToPrivateServer from (placeId: int, reservedServerAccessCode: string, players: Objects, spawnName: string = , teleportData: Variant, customLoadingScreen: Instance = Instance) to (placeId: int64, reservedServerAccessCode: string, players: Objects, spawnName: string = , teleportData: Variant, customLoadingScreen: Instance = Instance)
- 210 Add TeleportToPrivateServer
TeleportToSpawnByName
| Parameters (5) | Default | |
|---|---|---|
| placeId | int64 | |
| spawnName | string | |
| player | Instance | Instance |
| teleportData | Variant | |
| customLoadingScreen | Instance | Instance |
| Returns (1) | ||
| null | ||
| Thread safety | Unsafe |
|---|
History 6
- 573 Change ReturnType of TeleportToSpawnByName from void to null
- 462 Change ThreadSafety of TeleportToSpawnByName from to Unsafe
- 322 Change Parameters of TeleportToSpawnByName from (placeId: int, spawnName: string, player: Instance = Instance, teleportData: Variant, customLoadingScreen: Instance = Instance) to (placeId: int64, spawnName: string, player: Instance = Instance, teleportData: Variant, customLoadingScreen: Instance = Instance)
- 206 Change Parameters of TeleportToSpawnByName from (placeId: int, spawnName: string, player: Instance = Instance) to (placeId: int, spawnName: string, player: Instance = Instance, teleportData: Variant, customLoadingScreen: Instance = Instance)
- 127 Change Parameters of TeleportToSpawnByName from (placeId: int, spawnName: string) to (placeId: int, spawnName: string, player: Instance = Instance)
- 47 Add TeleportToSpawnByName
UnblockAsync
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Tuple | ||
This function yields. It will block the calling thread until completion.
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 1
- 547 Add UnblockAsync
Removed members 3
ConfirmationCallback
| Parameters (3) | ||
|---|---|---|
| message | string | |
| placeId | int | |
| spawnName | string | |
| Returns (1) | ||
| bool | ||
| Security | RobloxScriptSecurity |
|---|
History 3
- 311 Remove ConfirmationCallback
- 131 Change Tags of ConfirmationCallback from [] to [NoYield]
- 47 Add ConfirmationCallback
ErrorCallback
| Parameters (1) | ||
|---|---|---|
| message | string | |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
History 3
- 311 Remove ErrorCallback
- 131 Change Tags of ErrorCallback from [] to [NoYield]
- 47 Add ErrorCallback
TeleportImpl
| Parameters (2) | ||
|---|---|---|
| placeId | int | |
| spawnName | string | |
| Returns (1) | ||
| void | ||
| Security | RobloxScriptSecurity |
|---|
History 2
- 210 Remove TeleportImpl
- 47 Add TeleportImpl