We use cookies on this site to enhance your user experience

TeleportService

TeleportService

This service makes it possible to teleport players from one place to another. Since a game can contain multiple places, this allows a game to contain different levels and players can be transported from one place to another.


Functions

Name Type Description
Variant

Returns what was set as the LocalPlayer’s teleportData parameter, when either Teleport, TeleportToPlaceInstance, TeleportToPrivateServer, or TeleportToBySpawnName was called from a previous game.

Tuple

Returns information about which place a player is currently in, if it’s in the same universe.

Variant

Retrieves a previously stored value with the given key, or nil if the given key doesn’t exist. Note: This method is intended for storing information on the client that can persist between game instances when teleporting, it should not be used on the server.

string

Returns a server access code that can be used with TeleportService/TeleportToPrivateServer

void

Stores a given value for later use under the given key. The value will persist across place teleportations as long as they are in the same game. Note: this method is intended for use on the client only and should not be used on the server.

void

Used to teleport a player to the place with ID placeId.

string
void

Will teleport the given player to a specific place instance given a placeId and an instanceId.

void

Used to teleport one or more players to a reserved server

void

Teleports player to a specific SpawnLocation.

Inherited from Instance

ClearAllChildren Clone Destroy FindFirstAncestor FindFirstAncestorOfClass FindFirstAncestorWhichIsA FindFirstChild FindFirstChildOfClass FindFirstChildWhichIsA GetChildren GetDebugId GetDescendants GetFullName GetPropertyChangedSignal IsA IsAncestorOf IsDescendantOf WaitForChild

Events

Name Type Description

The teleportData and customLoadingScreen from the TeleportService/Teleport methods.

Fires if a request to teleport a player fails.

Inherited from Instance

AncestryChanged Changed ChildAdded ChildRemoved DescendantAdded DescendantRemoving