GSmGpE6CwX2y9JjB25B8
We use cookies on this site to enhance your user experience
Collapse Sidebar

TeleportService

Show Show deprecated

TeleportService

Show deprecated

The TeleportService is responsible for transporting Player|Players between Articles/Place|places and servers.

‘Teleporting’ in Roblox, describes the transportation of Player|Players between different places and servers. TeleportService provides a range of functions allowing single or groups of users to be teleported. As Roblox Articles/Multi Place Games|games can contain multiple places, you can use the TeleportService to teleport players between different levels.

Which teleport function should I use?

A variety of teleportation functions are available and are all suitable for different circumstances:

Studio limitation

This service does not work during playtesting in Roblox Studio — To test aspects of your game using it, you must publish the game and play it in the Roblox application.

See also

  • TeleportService/Teleport|Teleport for teleporting a single Player to a place
  • TeleportService/TeleportToSpawnByName|TeleportToSpawnByName for teleporting a single Player to a place, spawning at a particular SpawnLocation
  • TeleportService/TeleportToPlaceInstance|TeleportToPlaceInstance for teleporting a single Player to a specific server instance in a place that is part of the same game
  • TeleportService/TeleportPartyAsync for teleporting a group of Player|Players to one server in a place that is part of the same game
  • TeleportService/TeleportToPrivateServer for teleporting a group of Player|Players to a reserved server created using TeleportService/ReserveServer

Properties

bool

CustomizedTeleportUI

[NotReplicated] [Deprecated]

No longer does anything

Inherited from Instance: Show Hide

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.

string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to

int

DataCost

[ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.

string

Name

A non-unique identifier of the Instance

Instance

Parent

Determines the hierarchical parent of the Instance

bool

RobloxLocked

If true, the Instance and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted

bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

Instance

GetArrivingTeleportGui ( )

Returns the customLoadingScreen the Players/LocalPlayer|LocalPlayer arrived into the place with

Variant

GetLocalPlayerTeleportData ( )

Returns the teleportData the Players/LocalPlayer arrived into the place with

Tuple

GetPlayerPlaceInstanceAsync ( int64 userId )

[Yields]

Returns the DataModel/PlaceId|PlaceId and DataMode/lJobId|JobId of the server the user with the given Player/UserId|UserId is in provided it is in the same game as the current place

Variant

GetTeleportSetting ( string setting )

Retrieves a teleport setting saved using TeleportService/SetTeleportSetting using the given key

Tuple

ReserveServer ( int64 placeId )

[Yields]

Returns an access code that can be used to teleport players to a reserved server, along with the DataModel/PrivateServerId for it

void

SetTeleportGui ( Instance gui )

Sets the custom ScreenGui|teleport GUI that will be shown to the local user during teleportation, prior to the teleport being invoked

void

SetTeleportSetting ( string setting , Variant value )

Stores a value under a given key that persists across all teleportations in the same game

void

Teleport ( int64 placeId , Instance player , Variant teleportData , Instance customLoadingScreen )

Teleports a Player to the place associated with the given placeId

string

TeleportPartyAsync ( int64 placeId , Objects players , Variant teleportData , Instance customLoadingScreen )

[Yields]

Teleports a group of Player|Players to the same server of the place with the given DataModel/PlaceId|PlaceId, returning the DataModel/JobId|JobId of the server instance they were teleported to

void

TeleportToPlaceInstance ( int64 placeId , string instanceId , Instance player , string spawnName , Variant teleportData , Instance customLoadingScreen )

Teleports a Player to the server instance associated with the given placeId and instanceId

void

TeleportToPrivateServer ( int64 placeId , string reservedServerAccessCode , Objects players , string spawnName , Variant teleportData , Instance customLoadingScreen )

Teleport a group of Player|Players to a reserved server created using TeleportService/ReserveServer

void

TeleportToSpawnByName ( int64 placeId , string spawnName , Instance player , Variant teleportData , Instance customLoadingScreen )

A variant of TeleportService/Teleport that causes the Player to spawn at a SpawnLocation of the given name at the destination place

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance's children.

Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where Archivable = true.

void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections and calls Destroy on all children.

Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.

Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.

Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.

Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.

Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.

Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.

Objects

GetChildren ( )

Returns an array containing all of the Instance's children.

string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.

Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance

string

GetFullName ( )

Returns a string describing the Instance's ancestry.

RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.

bool

IsA ( string className )

[CustomLuaState]

Returns true if an Instance's class matches or inherits from a given class

bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.

bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.

void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.

Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.

Objects

children ( )

[Deprecated]

Returns an array of the object’s children.

Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

Events

RBXScriptSignal

LocalPlayerArrivedFromTeleport ( Instance loadingGui , Variant dataTable )

Fires when the Players/LocalPlayer|LocalPlayer enters the place following a teleport. Provides the Player|Player’s teleportData and customLoadingScreen

RBXScriptSignal

TeleportInitFailed ( Instance player , TeleportResult teleportResult , string errorMessage )

Fires when a teleport fails to start, leaving the player in their current server

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.

RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.

RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this Instance.

RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this Instance.

RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the Instance

RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.

RBXScriptSignal

childAdded ( Instance child )

[Deprecated]