TeleportService

Enables transporting Players between places and servers. For more information on how to teleport players between servers, see Teleport between places.

Memory category: Instances
Own members: 35
Inherited members: 75
Subclasses: 0
Siblings: 608

Properties24

Inherited fromObject2

Property categoryData

Object.ClassName: string
A read-only string representing the class this Object belongs to.
- Read only
Object.className: string
Deprecated: This deprecated property is a variant of Object.ClassName which should be used instead.
- Deprecated
- Read only
Use ClassName instead.

Inherited fromInstance21

Property categoryBehavior

Instance.Archivable: boolean
Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published.
Instance.archivable: boolean
Deprecated: This deprecated property is a variant of Instance.Archivable which should be used instead.
- Deprecated
- Hidden
- Not replicated
- Load only
Use Archivable instead.

Property categoryData

Instance.Attributes: string
- Hidden
- Not scriptable
- Read only
- Roblox engine security
Instance.AttributesReplicate: string
- Hidden
- Not scriptable
- Roblox engine security
Instance.AttributesSerialize: string
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.HistoryId: UniqueId
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.Name: string
A non-unique identifier of the Instance.
Instance.Parent: Instance
Determines the hierarchical parent of the Instance.
- Not replicated
- Load only
Instance.PredictionMode: Enum.PredictionMode
Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
- Not scriptable
- Read only
Instance.PropertyStatusStudio: Enum.PropertyStatus
- Hidden
- Not scriptable
- Read only
- Roblox engine security
Instance.RobloxLocked: boolean
A deprecated property that used to protect CoreGui objects.
- Hidden
- Plugin security
Instance.SerializedOverrides: string
- Hidden
- Not replicated
- Not scriptable
- Roblox engine security
Instance.SourceAssetId: number
- Hidden
- Roblox script security
Instance.Tags: SharedString
- Hidden
- Not scriptable
- Roblox engine security
Instance.UniqueId: UniqueId
A unique identifier for the instance.
- Not replicated
- Read: Roblox script security
- Write: Roblox engine security
Instance.numExpectedDirectChildren: number
- Hidden
- Not scriptable
Instance.DataCost: number
- Deprecated
- Hidden
- Read only
- Local user security

Property categoryPermissions

Instance.Capabilities: SecurityCapabilities
The set of capabilities allowed to be used for scripts inside this container.
- Capabilities: CapabilityControl
Instance.DefinesCapabilities: boolean
- Hidden
- Not scriptable
- Roblox engine security
Instance.IsInSandbox: boolean
Indicates whether the instance is inside a sandboxed container.
- Not scriptable
- Read only
Instance.Sandboxed: boolean
When enabled, the instance can only access abilities in its Capabilities list.
- Not replicated
- Capabilities: CapabilityControl

Defined byTeleportService1

Property categoryData

TeleportService.CustomizedTeleportUI: boolean
Deprecated: This item is deprecated since the default message it controls has been removed. Do not use it for new work.
No longer functional.
- Deprecated
- Not replicated
- Read capabilities: Teleport
- Load only

Methods68

Inherited fromObject3

Object:GetPropertyChangedSignal(property: string): RBXScriptSignal
Get an event that fires when a given property of the object changes.
Parameters
Parameter Description
property: string
The property to connect to.
Returns
Type Description
RBXScriptSignal
A signal that fires whenever the property changes.
Object:IsA(className: string): boolean
Returns true if an object's class matches or inherits from a given class.
- Custom Lua state
- Thread safe
Parameters
Parameter Description
className: string
The class against which the Object's class will be checked. Case-sensitive.
Returns
Type Description
boolean
Describes whether the Object's class matched or is a subclass of the given class.
Object:isA(className: string): boolean
Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
- Deprecated
- Custom Lua state
Parameters
Parameter
className: string
Returns
Type
boolean
Use IsA instead.

Parameters
Parameter	Description
`property: string`	The property to connect to.

Returns
Type	Description
`RBXScriptSignal`	A signal that fires whenever the property changes.

Parameters
Parameter	Description
`className: string`	The class against which the Object's class will be checked. Case-sensitive.

Returns
Type	Description
`boolean`	Describes whether the Object's class matched or is a subclass of the given class.

Parameters
Parameter
`className: string`

Returns
Type
`boolean`

Inherited fromInstance39

Instance:AddTag(tag: string)
Applies a tag to the instance.
Parameters
Parameter Description
tag: string
The tag to apply to the instance.
Instance:ClearAllChildren()
This method destroys all of an instance's children.
Instance:Clone(): Instance
Create a copy of an instance and all its descendants, ignoring instances that are not Archivable.
- Capabilities: CreateInstances
- Simulation access
Returns
Type Description
Instance
A copy of the instance, or nil if the instance is not Archivable.
Instance:Destroy()
Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children.
Instance:FindFirstAncestor(name: string): Instance
Returns the first ancestor of the Instance whose Instance.Name is equal to the given name.
- Thread safe
Parameters
Parameter Description
name: string
The Instance.Name to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstAncestorOfClass(className: string): Instance
Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstAncestorWhichIsA(className: string): Instance
Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChild(name: string, recursive: boolean? = false): Instance
Returns the first child of the Instance found with the given name.
- Thread safe
- Simulation access
Parameters
Parameter Description
name: string
The Instance.Name to be searched for.
recursive: boolean? = false
Whether or not the search should be conducted recursively.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChildOfClass(className: string): Instance
Returns the first child of the Instance whose ClassName is equal to the given class name.
- Thread safe
Parameters
Parameter Description
className: string
The Object.ClassName to be looked for.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstChildWhichIsA(className: string,recursive: boolean? = false,): Instance
Returns the first child of the Instance for whom Object:IsA() returns true for the given className.
- Thread safe
- Simulation access
Parameters
Parameter Description
className: string
The Object.ClassName to be searched for.
recursive: boolean? = false
Whether or not the search should be conducted recursively.
Returns
Type Description
Instance
The Instance found.
Instance:FindFirstDescendant(name: string): Instance
Returns the first descendant found with the given Instance.Name.
- Thread safe
Parameters
Parameter Description
name: string
The Instance.Name to search for.
Returns
Type Description
Instance
The Instance found.
Instance:GetActor(): Actor
Returns the Actor associated with the Instance, if any.
- Thread safe
Returns
Type Description
Actor
The Actor found.
Instance:GetAttribute(attribute: string): any
Returns the value which has been assigned to the given attribute name.
- Thread safe
- Simulation access
Parameters
Parameter Description
attribute: string
The name of the attribute being retrieved.
Returns
Type Description
any
The value which has been assigned to the given attribute name. If no attribute has been assigned, nil is returned.
Instance:GetAttributeChangedSignal(attribute: string): RBXScriptSignal
Returns an event that fires when the given attribute changes.
Parameters
Parameter Description
attribute: string
The name of the specified attribute for which the change signal is being returned.
Returns
Type Description
RBXScriptSignal
An event that fires when the given attribute changes.
Instance:GetAttributes(): { [string]: any }
Returns a dictionary of the instance's attributes.
- Custom Lua state
- Thread safe
- Simulation access
Returns
Type Description
{ [string]: any }
A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value.
Instance:GetChildren(): { Instance }
Returns an array containing all of the instance's children.
- Thread safe
- Simulation access
Returns
Type Description
{ Instance }
An array containing the instance's children.
Instance:GetDebugId(scopeLength: number? = 4): string
Returns a coded string of the debug ID used internally by Roblox.
- Not browsable
- Plugin security
Parameters
Parameter Description
scopeLength: number? = 4
The scope length.
Returns
Type Description
string
The Debug ID string.
Instance:GetDescendants(): { Instance }
Returns an array containing all of the descendants of the instance.
- Custom Lua state
- Thread safe
- Simulation access
Returns
Type Description
{ Instance }
An array containing the instance's descendants.
Instance:GetFullName(): string
Returns a string describing the instance's ancestry.
- Thread safe
- Simulation access
Returns
Type Description
string
The full name of the Instance.
Instance:GetStyled(name: string, selector: string?): any
Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Parameters
Parameter Description
name: string
Name of the property to query.
selector: string?
Optional selector for the pseudo instance you are targeting on the instance.
Returns
Type Description
any
The styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
Returns an event that fires when the given style property changes on the instance.
Parameters
Parameter Description
property: string
Name of the style property for which to listen for changes.
Returns
Type Description
RBXScriptSignal
Event that fires when the given style property changes.
Instance:GetTags(): { any }
Gets an array of all tags applied to the instance.
- Thread safe
- Simulation access
Returns
Type Description
{ any }
An array of strings, each representing a tag applied to the instance.
Instance:HasTag(tag: string): boolean
Check whether the instance has a given tag.
- Thread safe
- Simulation access
Parameters
Parameter Description
tag: string
The tag to check for on the instance.
Returns
Type Description
boolean
true if the instance has the given tag, false otherwise.
Instance:IsAncestorOf(descendant: Instance): boolean
Returns true if an Instance is an ancestor of the given descendant.
- Thread safe
- Simulation access
Parameters
Parameter Description
descendant: Instance
The descendant Instance.
Returns
Type Description
boolean
True if the Instance is an ancestor of the given descendant.
Instance:IsDescendantOf(ancestor: Instance): boolean
Returns true if an Instance is a descendant of the given ancestor.
- Thread safe
- Simulation access
Parameters
Parameter Description
ancestor: Instance
The ancestor Instance.
Returns
Type Description
boolean
True if the Instance is a descendant of the given ancestor.
Instance:IsPropertyModified(property: string): boolean
Returns true if the value stored in the specified property is not equal to the code-instantiated default.
- Simulation access
Parameters
Parameter Description
property: string
Name of the property to query.
Returns
Type Description
boolean
Boolean indicating whether the property is modified from its code‑instantiated default.
Instance:QueryDescendants(selector: string): { Instance }
Returns an array containing all descendants of the instance that match the selector string.
- Custom Lua state
- Simulation access
Parameters
Parameter Description
selector: string
Selector string used to filter elements.
Returns
Type Description
{ Instance }
An array of instances (empty if nothing matched the selector).
Instance:RemoveTag(tag: string)
Removes a tag from the instance.
Parameters
Parameter Description
tag: string
The tag to remove from the instance.
Instance:ResetPropertyToDefault(property: string)
Resets a property to its default value.
Parameters
Parameter Description
property: string
Name of the property to reset.
Instance:SetAttribute(attribute: string, value: any)
Sets the attribute with the given name to the given value.
- Simulation access
Parameters
Parameter Description
attribute: string
The name of the attribute being set.
value: any
The value to set the specified attribute to.
Instance:WaitForChild(childName: string, timeOut: number): Instance
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.
- Can yield
- Custom Lua state
Parameters
Parameter Description
childName: string
The Instance.Name to be looked for.
timeOut: number
An optional time out parameter.
Returns
Type Description
Instance
The Instance found.
Instance:Remove()
Deprecated: This item is deprecated in favor of Instance:Destroy() and Instance:ClearAllChildren(). If you must remove an object from the game, and wish to use the object later, set its Parent property to nil instead of using this method.
Sets the object's Parent to nil, and does the same for all its descendants.
- Deprecated
Instance:children(): { Instance }
Deprecated: This item has been superseded by Instance:GetChildren() which should be used in all new work.
Returns an array of the object's children.
- Deprecated
Returns
Type Description
{ Instance }
Array of child objects/instances.
Use GetChildren instead.
Instance:clone(): Instance
Deprecated: This deprecated function is a variant of Instance:Clone() which should be used instead.
- Deprecated
- Capabilities: CreateInstances
- Simulation access
Returns
Type
Instance
Use Clone instead.
Instance:destroy()
Deprecated: This deprecated function is a variant of Instance:Destroy() which should be used instead.
- Deprecated
Use Destroy instead.
Instance:findFirstChild(name: string, recursive: boolean? = false): Instance
Deprecated: This deprecated function is a variant of Instance:FindFirstChild() which should be used instead.
- Deprecated
- Simulation access
Parameters
Parameter
name: string
recursive: boolean? = false
Returns
Type
Instance
Use FindFirstChild instead.
Instance:getChildren(): { Instance }
Deprecated: This deprecated function is a variant of Instance:GetChildren() which should be used instead.
- Deprecated
Returns
Type
{ Instance }
Use GetChildren instead.
Instance:isDescendantOf(ancestor: Instance): boolean
Deprecated: This deprecated function is a variant of Instance:IsDescendantOf() which should be used instead.
- Deprecated
- Simulation access
Parameters
Parameter
ancestor: Instance
Returns
Type
boolean
Use IsDescendantOf instead.
Instance:remove()
Deprecated: This deprecated function is a variant of Instance:Remove() which has also been deprecated. Neither function should be used in new work.
- Deprecated
Use Remove instead.

Parameters
Parameter	Description
`tag: string`	The tag to apply to the instance.

Returns
Type	Description
`Instance`	A copy of the instance, or `nil` if the instance is not `Archivable`.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to be searched for.
`recursive: boolean? = false`	Whether or not the search should be conducted recursively.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be looked for.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`className: string`	The `Object.ClassName` to be searched for.
`recursive: boolean? = false`	Whether or not the search should be conducted recursively.

Returns
Type	Description
`Instance`	The `Instance` found.

Parameters
Parameter	Description
`name: string`	The `Instance.Name` to search for.

Returns
Type	Description
`Instance`	The `Instance` found.

Returns
Type	Description
`Actor`	The `Actor` found.

Parameters
Parameter	Description
`attribute: string`	The name of the attribute being retrieved.

Returns
Type	Description
`any`	The value which has been assigned to the given attribute name. If no attribute has been assigned, `nil` is returned.

Parameters
Parameter	Description
`attribute: string`	The name of the specified attribute for which the change signal is being returned.

Returns
Type	Description
`RBXScriptSignal`	An event that fires when the given attribute changes.

Returns
Type	Description
`{ [string]: any }`	A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value.

Returns
Type	Description
`{ Instance }`	An array containing the instance's children.

Parameters
Parameter	Description
`scopeLength: number? = 4`	The scope length.

Returns
Type	Description
`string`	The Debug ID string.

Returns
Type	Description
`{ Instance }`	An array containing the instance's descendants.

Returns
Type	Description
`string`	The full name of the `Instance`.

Parameters
Parameter	Description
`name: string`	Name of the property to query.
`selector: string?`	Optional selector for the pseudo instance you are targeting on the instance.

Returns
Type	Description
`any`	The styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.

Parameters
Parameter	Description
`property: string`	Name of the style property for which to listen for changes.

Returns
Type	Description
`RBXScriptSignal`	Event that fires when the given style property changes.

Returns
Type	Description
`{ any }`	An array of strings, each representing a tag applied to the instance.

Parameters
Parameter	Description
`tag: string`	The tag to check for on the instance.

Returns
Type	Description
`boolean`	`true` if the instance has the given tag, `false` otherwise.

Parameters
Parameter	Description
`descendant: Instance`	The descendant `Instance`.

Returns
Type	Description
`boolean`	True if the `Instance` is an ancestor of the given descendant.

Parameters
Parameter	Description
`ancestor: Instance`	The ancestor `Instance`.

Returns
Type	Description
`boolean`	True if the `Instance` is a descendant of the given ancestor.

Parameters
Parameter	Description
`property: string`	Name of the property to query.

Returns
Type	Description
`boolean`	Boolean indicating whether the property is modified from its code‑instantiated default.

Parameters
Parameter	Description
`selector: string`	Selector string used to filter elements.

Returns
Type	Description
`{ Instance }`	An array of instances (empty if nothing matched the selector).

Parameters
Parameter	Description
`tag: string`	The tag to remove from the instance.

Parameters
Parameter	Description
`property: string`	Name of the property to reset.

Defined byTeleportService26

TeleportService:Block()
- Roblox script security
- Capabilities: Teleport
TeleportService:GetArrivingTeleportGui(): Instance
Returns the customLoadingScreen the LocalPlayer arrived into the place with.
- Capabilities: Teleport + UI
Returns
Type Description
Instance
The customLoadingScreen the LocalPlayer arrived into the place with.
TeleportService:GetLocalPlayerTeleportData(): any
Returns the teleportData the Players.LocalPlayer arrived into the place with.
- Capabilities: Teleport
Returns
Type Description
any
The teleport data the Players.LocalPlayer arrived into the place with.
TeleportService:GetPlayerPlaceInstanceAsync(userId: User): ...any
Returns the PlaceId and JobId of the server the user with the given UserId is in provided it is in the same game as the current place.
- Yields
- Capabilities: Teleport
Parameters
Parameter Description
userId: User
The Player.UserId of the Player.
Returns
Type Description
...any
See the table above.
TeleportService:GetTeleportSetting(setting: string): any
Retrieves a teleport setting saved using TeleportService:SetTeleportSetting() using the given key.
- Capabilities: Teleport
Parameters
Parameter Description
setting: string
The key the value was stored under using TeleportService:SetTeleportSetting().
Returns
Type Description
any
The value stored under the given key.
TeleportService:GetThirdPartyTeleportInfo(goForth: boolean): ...any
- Roblox script security
- Capabilities: Teleport
Parameters
Parameter
goForth: boolean
Returns
Type
...any
TeleportService:PromptExperienceDetailsAsync(player: Player,universeId: number,): Enum.PromptExperienceDetailsResult
Prompts a Player with information about the specified experience. The player can choose to teleport to the target experience through the prompt.
- Yields
- Capabilities: Teleport
Parameters
Parameter Description
player: Player
The Player to be presented the prompt.
universeId: number
DataModel.UniverseId of the experience to be presented to the Player.
Returns
Type Description
Enum.PromptExperienceDetailsResult
PromptExperienceDetailsResult
TeleportService:PromptExperienceDetailsCompleted(resultEnum: Enum.PromptExperienceDetailsResult,errorMessage: string? = "",)
- Roblox script security
- Capabilities: Teleport
Parameters
Parameter
resultEnum: Enum.PromptExperienceDetailsResult
errorMessage: string? = ""
TeleportService:ReserveServerAsync(placeId: number): ...any
Returns an access code that can be used to teleport players to a reserved server, along with the DataModel.PrivateServerId for it.
- Yields
- Capabilities: Teleport
Parameters
Parameter Description
placeId: number
The DataModel.PlaceId of the place the reserved server is being created for.
Returns
Type Description
...any
The server access code required by TeleportService:TeleportToPrivateServer() and the DataModel.PrivateServerId for the reserved server.
TeleportService:SetTeleportGui(gui: Instance)
Sets the custom teleport GUI that will be shown to the local user during teleportation, prior to the teleport being invoked.
- Capabilities: Teleport + UI
Parameters
Parameter Description
gui: Instance
The loading ScreenGui that is to be displayed during teleportation.
TeleportService:SetTeleportSetting(setting: string, value: any)
Stores a value under a given key that persists across all teleportations in the same game.
- Capabilities: Teleport
Parameters
Parameter Description
setting: string
The key to store the value under. This key can be used to retrieve the value using TeleportService:GetTeleportSetting().
value: any
The value to store.

TeleportService:Teleport(placeId: number,player: Instance? = nil,teleportData: any,customLoadingScreen: Instance? = nil,)

Teleports a Player to the place associated with the given placeId.

Parameters
Parameter	Description
`placeId: number`	The ID of the place to teleport to.
`player: Instance? = nil`	The `Player` to teleport, if this function is being called from the client this defaults to the `Players.LocalPlayer`.
`teleportData: any`	Optional data to be passed to the destination place. Can be retrieved using `TeleportService:GetLocalPlayerTeleportData()`.
`customLoadingScreen: Instance? = nil`	Optional custom loading screen to be placed in the `CoreGui` at the destination place. Can be retrieved using `TeleportService:GetArrivingTeleportGui()`.

TeleportService:TeleportAsync(placeId: number,players: { Instance },teleportOptions: Instance? = nil,): Instance

The all-encompassing method to teleport a player or group of players from one server to another.

Parameters
Parameter	Description
`placeId: number`	The place ID the player(s) should be teleported to.
`players: { Instance }`	An array of the player(s) to teleport.
`teleportOptions: Instance? = nil`	An optional `TeleportOptions` object containing additional arguments to the `TeleportService:TeleportAsync()` call. If this is not passed, no result will be returned.

Returns
Type	Description
`Instance`	If a `TeleportOptions` parameter is passed, this will be a `TeleportAsyncResult` object that provides information about the final teleport destination.

TeleportService:TeleportCancel()
- Roblox script security
- Capabilities: Teleport
TeleportService:TeleportedPlacesBackHistory(): { any }
- Roblox script security
- Capabilities: Teleport
Returns
Type
{ any }
TeleportService:TeleportedUniversesBackHistory(): { any }
- Roblox script security
- Capabilities: Teleport
Returns
Type
{ any }
TeleportService:TeleportReconnect()
- Roblox script security
- Capabilities: Teleport
TeleportService:TeleportSwitchServer(gameIdsToExclude: { any }? = {})
- Roblox script security
- Capabilities: Teleport
Parameters
Parameter
gameIdsToExclude: { any }? = {}
TeleportService:TeleportTrustedBackForth(goForth: boolean)
- Roblox script security
- Capabilities: Teleport
Parameters
Parameter
goForth: boolean
TeleportService:TeleportTrustedBackHistory(placeId: number)
- Roblox script security
- Capabilities: Teleport
Parameters
Parameter
placeId: number
TeleportService:UnblockAsync(): ...any
- Yields
- Roblox script security
- Capabilities: Teleport
Returns
Type
...any
TeleportService:ReserveServer(placeId: number): ...any
Deprecated: Use ReserveServerAsync() instead.
Returns an access code that can be used to teleport players to a reserved server, along with the DataModel.PrivateServerId for it.
- Deprecated
- Yields
- Capabilities: Teleport
Parameters
Parameter Description
placeId: number
The DataModel.PlaceId of the place the reserved server is being created for.
Returns
Type Description
...any
The server access code required by TeleportService:TeleportToPrivateServer() and the DataModel.PrivateServerId for the reserved server.
Use ReserveServerAsync instead.

TeleportService:TeleportPartyAsync(placeId: number,players: { Instance },teleportData: any,customLoadingScreen: Instance? = nil,): string

Deprecated: Use TeleportAsync() instead. For a migration guide, see Teleport between places.
Teleports a group of Players to the same server of the place with the given PlaceId, returning the JobId of the server instance they were teleported to.

Parameters
Parameter	Description
`placeId: number`	The ID of the place to teleport to.
`players: { Instance }`	An array containing the `Players` to teleport.
`teleportData: any`	Optional data to be passed to the destination place. Can be retrieved using `TeleportService:GetLocalPlayerTeleportData()`.
`customLoadingScreen: Instance? = nil`	Optional custom loading screen to be placed in the `CoreGui` at the destination place. Can be retrieved using `TeleportService:GetArrivingTeleportGui()`.

Returns
Type	Description
`string`	The `DataModel.JobId` of the server instance the `Players` were teleported to.

Use TeleportAsync instead.

TeleportService:TeleportToPlaceInstance(placeId: number,instanceId: string,player: Instance? = nil,spawnName: string? = "",teleportData: any,customLoadingScreen: Instance? = nil,)

Deprecated: Use TeleportAsync() instead. For a migration guide, see Teleport between places.
Teleports a Player to the server instance associated with the given placeId and instanceId.

Parameters
Parameter	Description
`placeId: number`	The ID of the place to teleport to.
`instanceId: string`	The `DataModel.JobId` of the server instance to teleport to.
`player: Instance? = nil`	The `Player` to teleport, if this function is being called from the client this defaults to the `Players.LocalPlayer`.
`spawnName: string? = ""`	Optional name of the `SpawnLocation` to spawn at.
`teleportData: any`	Optional data to be passed to the destination place. Can be retrieved using `TeleportService:GetLocalPlayerTeleportData()`.
`customLoadingScreen: Instance? = nil`	Optional custom loading screen to be placed in the `CoreGui` at the destination place. Can be retrieved using `TeleportService:GetArrivingTeleportGui()`.

Use TeleportAsync instead.

TeleportService:TeleportToPrivateServer(placeId: number,reservedServerAccessCode: string,players: { Instance },spawnName: string? = "",teleportData: any,customLoadingScreen: Instance? = nil,)

Deprecated: Use TeleportAsync() instead. For a migration guide, see Teleport between places.
Teleport a group of Players to a reserved server created using TeleportService:ReserveServerAsync().

Parameters
Parameter	Description
`placeId: number`	The ID of the place to teleport to.
`reservedServerAccessCode: string`	The reserved server access code returned by `TeleportService:ReserveServerAsync()`.
`players: { Instance }`	An array of `Players` to teleport.
`spawnName: string? = ""`	Optional name of the `SpawnLocation` to spawn at.
`teleportData: any`	Optional data to be passed to the destination place. Can be retrieved using `TeleportService:GetLocalPlayerTeleportData()`.
`customLoadingScreen: Instance? = nil`	Optional custom loading screen to be placed in the `CoreGui` at the destination place. Can be retrieved using `TeleportService:GetArrivingTeleportGui()`.

Use TeleportAsync instead.

TeleportService:TeleportToSpawnByName(placeId: number,spawnName: string,player: Instance? = nil,teleportData: any,customLoadingScreen: Instance? = nil,)

Deprecated: Use TeleportAsync() instead. For a migration guide, see Teleport between places.
A variant of TeleportService:Teleport() that causes the Player to spawn at a SpawnLocation of the given name at the destination place.

Parameters
Parameter	Description
`placeId: number`	The ID of the place to teleport to.
`spawnName: string`	The name of the `SpawnLocation` to spawn at.
`player: Instance? = nil`	The `Player` to teleport, if this function is being called from the client this defaults to the `Players.LocalPlayer`.
`teleportData: any`	Optional data to be passed to the destination place. Can be retrieved using `TeleportService:GetLocalPlayerTeleportData()`.
`customLoadingScreen: Instance? = nil`	Optional custom loading screen to be placed in the `CoreGui` at the destination place. Can be retrieved using `TeleportService:GetArrivingTeleportGui()`.

Use TeleportAsync instead.

Events18

Inherited fromObject1

Object.Changed: RBXScriptSignal<(property: string)>
Fires immediately after a property of the object changes, with some limitations.
Parameters
Parameter
property: string

Inherited fromInstance9

Instance.AncestryChanged: RBXScriptSignal<(child: Instance, parent: Instance)>
Fires when the Instance.Parent property of this object or one of its ancestors is changed.
Parameters
Parameter
child: Instance
parent: Instance
Instance.AttributeChanged: RBXScriptSignal<(attribute: string)>
Fires whenever an attribute is changed on the Instance.
Parameters
Parameter
attribute: string
Instance.ChildAdded: RBXScriptSignal<(child: Instance)>
Fires after an object is parented to this Instance.
Parameters
Parameter
child: Instance
Instance.ChildRemoved: RBXScriptSignal<(child: Instance)>
Fires after a child is removed from this Instance.
Parameters
Parameter
child: Instance
Instance.DescendantAdded: RBXScriptSignal<(descendant: Instance)>
Fires after a descendant is added to the Instance.
Parameters
Parameter
descendant: Instance
Instance.DescendantRemoving: RBXScriptSignal<(descendant: Instance)>
Fires immediately before a descendant of the Instance is removed.
Parameters
Parameter
descendant: Instance
Instance.Destroying: RBXScriptSignal<()>
Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy().
Instance.StyledPropertiesChanged: RBXScriptSignal<()>
Fires whenever any style property is changed on the instance, including when a property is set to nil.
Instance.childAdded: RBXScriptSignal<(child: Instance)>
Deprecated: This deprecated event is a variant of Instance.ChildAdded which should be used instead.
- Deprecated
Parameters
Parameter
child: Instance
Use ChildAdded instead.

Defined byTeleportService8

TeleportService.LocalPlayerArrivedFromTeleport: RBXScriptSignal<(loadingGui: Instance,dataTable: any,)>
Fires when the LocalPlayer enters the place following a teleport.
- Capabilities: Teleport
Parameters
Parameter
loadingGui: Instance
dataTable: any
TeleportService.MenuTeleportAttempt: RBXScriptSignal<()>
- Roblox script security
- Capabilities: Teleport
TeleportService.OpenExperienceDetailsPrompt: RBXScriptSignal<(universeId: number)>
- Roblox script security
- Capabilities: Teleport
Parameters
Parameter
universeId: number
TeleportService.ReconnectTeleportInitFailed: RBXScriptSignal<(player: Instance,teleportResult: Enum.TeleportResult,errorMessage: string,placeId: number,teleportOptions: Instance,)>
- Roblox engine security
- Capabilities: Teleport
Parameters
Parameter
player: Instance
teleportResult: Enum.TeleportResult
errorMessage: string
placeId: number
teleportOptions: Instance
TeleportService.SendVIPData: RBXScriptSignal<(player: Instance,vipServerCode: string,dmPlaceID: number,)>
- Hidden
- Roblox engine security
- Capabilities: Teleport
Parameters
Parameter
player: Instance
vipServerCode: string
dmPlaceID: number
TeleportService.TeleportInitFailed: RBXScriptSignal<(player: Instance,teleportResult: Enum.TeleportResult,errorMessage: string,placeId: number,teleportOptions: Instance,)>
Fires when a teleport fails to start, leaving the player in their current server.
- Capabilities: Teleport
Parameters
Parameter
player: Instance
teleportResult: Enum.TeleportResult
errorMessage: string
placeId: number
teleportOptions: Instance
TeleportService.TeleportInitFailedInternal: RBXScriptSignal<(player: Instance,teleportResult: Enum.TeleportResult,errorMessage: string,guid: string,)>
- Hidden
- Roblox engine security
- Capabilities: Teleport
Parameters
Parameter
player: Instance
teleportResult: Enum.TeleportResult
errorMessage: string
guid: string
TeleportService.TeleportInProgress: RBXScriptSignal<(player: Instance,teleportInfo: { [string]: any },)>
- Hidden
- Roblox engine security
- Capabilities: Teleport
Parameters
Parameter
player: Instance
teleportInfo: { [string]: any }