TeleportOptions

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

The access code is obtained either from TeleportService:ReserveServerAsync() or from TeleportAsyncResult.ReservedServerAccessCode.

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

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.

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.

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.

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():

-- Server
local teleportOptions = Instance.new("TeleportOptions")
local teleportData = {
    placeId = game.PlaceId,
    jobId = game.JobId
}
teleportOptions:SetTeleportData(teleportData)
TeleportService:TeleportAsync(game.PlaceId, {player}, teleportOptions)

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

-- Client
local TeleportService = game:GetService("TeleportService")

local teleportData = TeleportService:GetLocalPlayerTeleportData()
if teleportData then
    local placeId = teleportData.placeId
    local jobId = teleportData.JobId
end

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

Allowed data types#

Teleport data may only contain value types. It cannot contain Instances or other types that reference engine state, as these cannot safely cross the boundary between servers.

Allowed:

• Primitives: bool, number, and string
• Value types such as Vector3, CFrame, Color3, UDim2, NumberSequence, ColorSequence, Enum items, and similar
• Tables and arrays (without mixed keys) containing only the allowed types above, nested up to a reasonable depth and size

Not allowed (these will be removed from the data before the teleport completes):

• Instance and instance references
• Connections, RBXScriptSignal, and functions
• SharedTable
• Types that reference engine or DataModel state, such as InputObject, RaycastParams, and RaycastResult

If teleport data contains a disallowed type, that value is removed and an error is written to the developer console. Convert instance references to plain values (for example, a numeric ID or a string path).

For more information on how to send and receive user data along with teleports, see, see Teleporting Between Places.