TeleportOptions

このプロパティは、ユーザーがテレポートする予定のサーバーに対する予約されたサーバーアクセスコードを指します。

プレイヤー間のテレポートに関する詳細は、「場所間テレポート」を参照してください。

このプロパティは、ユーザーがテレポートするべきサーバーインスタンスの DataModel.JobId を指します。

プレイヤー間のテレポートに関する詳細は、「場所間テレポート」を参照してください。

このプロパティは、テレポートコールが新しい予約サーバーを作成するかどうかを示します。設定を「 true 」に設定すると、予約サーバーが作成され、プレイヤーが新しいサーバーにテレポートされます。

設定を「 false 」に設定すると、指定の TeleportOptions.ServerInstanceId が指定された公開サーバーにテレポートされます。TeleportOptions.ServerInstanceId が空の場合または一致するサーバーが見つからない場合、新しい公開プレイヤーーバーが作成されます。

プレイヤー間のテレポートに関する詳細は、「場所間テレポート」を参照してください。

この関数は、TeleportOptions インスタンス内のテレポートデータを TeleportOptions:SetTeleportData() によって返します。

プレイヤーがテレポートされると、Player:GetJoinData() とTeleportService:GetLocalPlayerTeleportData() 機能を使用して、データを取得できます。

プレイヤー間のテレポートに関する詳細は、「場所間テレポート」を参照してください。

戻り値

これは、データを目的プレースに移行するための設定機能です。目的プレースでは、 Class.Player:GetJoinData() または Class.TeleportService:GetLocalPlayerTeleportData() を使用して、このデータを取得できます。

たとえば、次のスナップショットは、DataModel.PlaceId とDataModel.JobId をダイクションで送信し、TeleportOptions インスタンスを使用して、2>Class.TeleportOptions:SetTeleportData() を使用しています：

-- サーバー
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 を返します。

ユーザーデータとテレポートを組み合わせて送信および受信する方法については、「場所間テレポート」を参照してください。

パラメータ

戻り値