TeleportOptions

Show Deprecated

This class is an optional parameter to the TeleportService:TeleportAsync() function that allows developers to provide arguments for the teleport call.

Certain arguments in this class are not compatible with each other and cause an error when passed to TeleportService:TeleportAsync():

  • ReservedServerAccessCode + ServerInstanceId
  • ShouldReserveServer + ServerInstanceId
  • ShouldReserveServer + ReservedServerAccessCode

For more information on how to teleport players between servers, see Teleporting Between Places.

Summary

Properties

The reserved server access code that indicates the reserved server that the teleport should be to.

The DataModel.JobId of the server instance to teleport to.

A flag to indicate if a reserved server should be allocated and the players should then be teleported to this allocation.

Events

Methods


Returns the teleport data stored in the TeleportOptions instance by TeleportOptions:SetTeleportData().

SetTeleportData(teleportData: Variant): void  

Setter function for data to be passed to the destination place.

Properties

ReservedServerAccessCode

This property indicates the reserved server access code for the reserved server that the user(s) should be teleported to.

For more information on how to teleport players between servers, see Teleporting Between Places.

ServerInstanceId

This property indicates the DataModel.JobId of the server instance the user(s) should be teleported to.

For more information on how to teleport players between servers, see Teleporting Between Places.

ShouldReserveServer

This property indicates whether the teleport call should create a new reserved server. When set to true, a reserved server will be created and the player(s) will be teleported to the new server.

If set to false, the player(s) will be teleported to the public server with the specified TeleportOptions.ServerInstanceId if provided. When TeleportOptions.ServerInstanceId is blank or no matching server is found, a new public server will be created to teleport the player(s) to.

For more information on how to teleport players between servers, see Teleporting Between Places.

Events

Methods

GetTeleportData

This function returns the teleport data stored in the TeleportOptions instance by TeleportOptions:SetTeleportData().

Once a player has teleported, teleport data can be retrieved using the Player:GetJoinData() and TeleportService:GetLocalPlayerTeleportData() functions.

For more information on how to teleport players between servers, see Teleporting Between Places.


Returns

SetTeleportData

void

This is a setter function for data to be passed to the destination place. On the destination place, this data can be retrieved using Player:GetJoinData() or TeleportService:GetLocalPlayerTeleportData().

For example, the following snippet would send the DataModel.PlaceId and DataModel.JobId in a dictionary passing the teleport data in a TeleportOptions instance using TeleportOptions:SetTeleportData():


1-- Server
2local teleportOptions = Instance.new("TeleportOptions")
3local teleportData = {
4 placeId = game.PlaceId,
5 jobId = game.JobId
6}
7teleportOptions:SetTeleportData(teleportData)
8TeleportService:TeleportAsync(game.PlaceId, {player}, teleportOptions)
9

This data could then be retrieved upon arrival using the GetLocalPlayerTeleportData() function as follows:


1-- Client
2local TeleportService = game:GetService("TeleportService")
3
4local teleportData = TeleportService:GetLocalPlayerTeleportData()
5if teleportData then
6 local placeId = teleportData.placeId
7 local jobId = teleportData.JobId
8end
9

If no teleportData was set in the teleportation function this GetLocalPlayerTeleportData() will return nil.

For more information on how to teleport players between servers, see Teleporting Between Places.

Parameters

teleportData: Variant

Data to be passed to the destination place.


Returns

void