Reference API Roblox

Engine API

Website

Related

Reference API Roblox

TeleportService

Summary

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.
Tags: [NotCreatable, Service]

Member index 23

HistoryMember
553CustomizedTeleportUI: bool
573Block(): null
462GetArrivingTeleportGui(): Instance
462GetLocalPlayerTeleportData(): Variant
462GetPlayerPlaceInstanceAsync(userId: int64): Tuple
462GetTeleportSetting(setting: string): Variant
462ReserveServer(placeId: int64): Tuple
573SetTeleportGui(gui: Instance): null
573SetTeleportSetting(setting: string, value: Variant): null
573Teleport(placeId: int64, player: Instance = Instance, teleportData: Variant, customLoadingScreen: Instance = Instance): null
462TeleportAsync(placeId: int64, players: Objects, teleportOptions: Instance = Instance): Instance
573TeleportCancel(): null
462TeleportPartyAsync(placeId: int64, players: Objects, teleportData: Variant, customLoadingScreen: Instance = Instance): string
573TeleportToPlaceInstance(placeId: int64, instanceId: string, player: Instance = Instance, spawnName: string = , teleportData: Variant, customLoadingScreen: Instance = Instance): null
573TeleportToPrivateServer(placeId: int64, reservedServerAccessCode: string, players: Objects, spawnName: string = , teleportData: Variant, customLoadingScreen: Instance = Instance): null
573TeleportToSpawnByName(placeId: int64, spawnName: string, player: Instance = Instance, teleportData: Variant, customLoadingScreen: Instance = Instance): null
547UnblockAsync(): Tuple
462LocalPlayerArrivedFromTeleport(loadingGui: Instance, dataTable: Variant)
546MenuTeleportAttempt()
511TeleportInitFailed(player: Instance, teleportResult: TeleportResult, errorMessage: string, placeId: int64, teleportOptions: Instance)
inherited from Instance
553Archivable: bool
619Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
619Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
486GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Removed member index 3

HistoryMember
210TeleportImpl(placeId: int, spawnName: string): void
311ConfirmationCallback(message: string, placeId: int, spawnName: string): bool
311ErrorCallback(message: string): void

History 83

Members 23

Block

Parameters (0)
No parameters.
Returns (1)
null

History 2

CustomizedTeleportUI

TypeDefault
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.

History 7

Tags: [NotReplicated, Deprecated]

GetArrivingTeleportGui

Parameters (0)
No parameters.
Returns (1)
Instance

History 2

GetLocalPlayerTeleportData

Parameters (0)
No parameters.
Returns (1)
Variant

History 4

GetPlayerPlaceInstanceAsync

Parameters (1)
userIdint64
Returns (1)
Tuple
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

GetTeleportSetting

Parameters (1)
settingstring
Returns (1)
Variant

History 4

LocalPlayerArrivedFromTeleport

Parameters (2)
loadingGuiInstance
dataTableVariant

History 2

MenuTeleportAttempt

Parameters (0)
No parameters.

History 1

ReserveServer

Parameters (1)
placeIdint64
Returns (1)
Tuple
This function yields. It will block the calling thread until completion.

History 4

Tags: [Yields]

SetTeleportGui

Parameters (1)
guiInstance
Returns (1)
null

History 3

SetTeleportSetting

Parameters (2)
settingstring
valueVariant
Returns (1)
null

History 5

Teleport

Parameters (4)Default
placeIdint64
playerInstanceInstance
teleportDataVariant
customLoadingScreenInstanceInstance
Returns (1)
null

History 6

TeleportAsync

Parameters (3)Default
placeIdint64
playersObjects
teleportOptionsInstanceInstance
Returns (1)
Instance
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

TeleportCancel

Parameters (0)
No parameters.
Returns (1)
null

History 3

TeleportInitFailed

Parameters (5)
playerInstance
teleportResultTeleportResult
errorMessagestring
placeIdint64
teleportOptionsInstance

History 3

TeleportPartyAsync

Parameters (4)Default
placeIdint64
playersObjects
teleportDataVariant
customLoadingScreenInstanceInstance
Returns (1)
string
This function yields. It will block the calling thread until completion.

History 2

Tags: [Yields]

TeleportToPlaceInstance

Parameters (6)Default
placeIdint64
instanceIdstring
playerInstanceInstance
spawnNamestring
teleportDataVariant
customLoadingScreenInstanceInstance
Returns (1)
null

History 6

TeleportToPrivateServer

Parameters (6)Default
placeIdint64
reservedServerAccessCodestring
playersObjects
spawnNamestring
teleportDataVariant
customLoadingScreenInstanceInstance
Returns (1)
null

History 4

TeleportToSpawnByName

Parameters (5)Default
placeIdint64
spawnNamestring
playerInstanceInstance
teleportDataVariant
customLoadingScreenInstanceInstance
Returns (1)
null

History 6

UnblockAsync

Parameters (0)
No parameters.
Returns (1)
Tuple
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

Removed members 3

ConfirmationCallback

Parameters (3)
messagestring
placeIdint
spawnNamestring
Returns (1)
bool

History 3

Tags: [NoYield]

ErrorCallback

Parameters (1)
messagestring
Returns (1)
void

History 3

Tags: [NoYield]

TeleportImpl

Parameters (2)
placeIdint
spawnNamestring
Returns (1)
void

History 2

Settings