TeleportOptions

显示已弃用

*此内容使用人工智能(Beta)翻译,可能包含错误。若要查看英文页面,请点按 此处

此类是 TeleportService:TeleportAsync() 函数的可选参数,允许开发人员为传送调用提供参数。

此类中的某些参数不兼容,并且在传递到 TeleportService:TeleportAsync() 时会导致错误:

  • 保留的服务器访问代码 + ServerInstanceId
  • 应该保留服务器 + ServerInstanceId
  • 应该保留服务器 + 保留服务器访问代码

了解有关玩家在服务器之间如何传送的更多信息,请参阅在不同地点之间传送

概要

属性

方法

属性

ReservedServerAccessCode

读取并联

此属性表示用户(s)应该被传送到的储备服务器的保留服务器访问代码。

了解有关玩家在服务器之间如何传送的更多信息,请参阅在不同地点之间传送

ServerInstanceId

读取并联

此属性表示服务器实例的DataModel.JobId,用户应该传送到。

了解有关玩家在服务器之间如何传送的更多信息,请参阅在不同地点之间传送

ShouldReserveServer

读取并联

此属性表示是否创建新的保留服务器。设置为“真”,将创建一个保留服务器,玩家将被传送到新服务器。

如果设置为“错误”,玩家将被传送到公共服务器,并且提供指定的 TeleportOptions.ServerInstanceId 如果指定为空白或未找到匹配的服务器,将创建一个新的公共服务器,将玩家传送到。

了解有关玩家在服务器之间如何传送的更多信息,请参阅在不同地点之间传送

方法

GetTeleportData

Variant

此函数将传送数据存储在 TeleportOptions 实例中,通过 TeleportOptions:SetTeleportData() 返回。

一旦玩家传送,可以使用 Player:GetJoinData()TeleportService:GetLocalPlayerTeleportData() 函数来恢复传送数据。

了解有关玩家在服务器之间如何传送的更多信息,请参阅在不同地点之间传送


返回

Variant

SetTeleportData

void

此是将数据传递到目的地场景方的设置器函数。在目的地场景方,此数据可以使用 Player:GetJoinData()TeleportService:GetLocalPlayerTeleportData() 来检索。

例如,以下代码将 DataModel.PlaceIdDataModel.JobId 发送到一个典型中,使用 TeleportOptions 实例使用 2>Class.TeleportOptions:SetTeleportData()2> 传送数据:


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

此时,使用 GetLocalPlayerTeleportData() 函数可以检索到以下数据:


-- 客户
local TeleportService = game:GetService("TeleportService")
local teleportData = TeleportService:GetLocalPlayerTeleportData()
if teleportData then
local placeId = teleportData.placeId
local jobId = teleportData.JobId
end

如果没有 teleportData 在传送函数中设置,此 GetLocalPlayerTeleportData() 将返回 nil

有关有关如何发送和接收用户数据以及传送的更多信息,请参阅在地点之间传送

参数

teleportData: Variant

数据将被传递到目的场景。


返回

void

活动