TeleportService

Methoden

GetArrivingTeleportGui():Instance
Returns the customLoadingScreen the LocalPlayer arrived into the place with.
GetLocalPlayerTeleportData():Variant
Returns the teleportData the Players.LocalPlayer arrived into the place with.
GetPlayerPlaceInstanceAsync(userId : number):Tuple
Angehalten
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.
GetTeleportSetting(setting : string):Variant
Retrieves a teleport setting saved using TeleportService:SetTeleportSetting() using the given key.
ReserveServer(placeId : number):Tuple
Angehalten
Returns an access code that can be used to teleport players to a reserved server, along with the DataModel.PrivateServerId for it.
SetTeleportGui(gui : Instance):()
Sets the custom teleport GUI that will be shown to the local user during teleportation, prior to the teleport being invoked.
SetTeleportSetting(setting : string,value : Variant):()
Stores a value under a given key that persists across all teleportations in the same game.
Teleport(placeId : number,player : Instance,teleportData : Variant,customLoadingScreen : Instance):()
Teleports a Player to the place associated with the given placeId.
TeleportAsync(placeId : number,players : Instances,teleportOptions : Instance):Instance
Angehalten
The all-encompassing method to teleport a player or group of players from one server to another.
TeleportPartyAsync(placeId : number,players : Instances,teleportData : Variant,customLoadingScreen : Instance):string
Angehalten
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.
TeleportToPlaceInstance(placeId : number,instanceId : string,player : Instance,spawnName : string,teleportData : Variant,customLoadingScreen : Instance):()
Teleports a Player to the server instance associated with the given placeId and instanceId.
TeleportToPrivateServer(placeId : number,reservedServerAccessCode : string,players : Instances,spawnName : string,teleportData : Variant,customLoadingScreen : Instance):()
Teleport a group of Players to a reserved server created using TeleportService:ReserveServer().
TeleportToSpawnByName(placeId : number,spawnName : string,player : Instance,teleportData : Variant,customLoadingScreen : Instance):()
A variant of TeleportService:Teleport() that causes the Player to spawn at a SpawnLocation of the given name at the destination place.

Events

LocalPlayerArrivedFromTeleport(loadingGui : Instance,dataTable : Variant):RBXScriptSignal
Fires when the LocalPlayer enters the place following a teleport.
TeleportInitFailed(player : Instance,teleportResult : Enum.TeleportResult,errorMessage : string,placeId : number,teleportOptions : Instance):RBXScriptSignal
Fires when a teleport fails to start, leaving the player in their current server.

Eigenschaften

Methoden

GetArrivingTeleportGui

Rückgaben

Code-Beispiele

Teleport-Lade-GUI verwalten

local TeleportService = game:GetService("TeleportService")
local Players = game:GetService("Players")
local ReplicatedFirst = game:GetService("ReplicatedFirst")

local customLoadingScreen = TeleportService:GetArrivingTeleportGui()
if customLoadingScreen then
	local playerGui = Players.LocalPlayer:WaitForChild("PlayerGui")
	ReplicatedFirst:RemoveDefaultLoadingScreen()
	customLoadingScreen.Parent = playerGui
	task.wait(5)
	customLoadingScreen:Destroy()
end

GetLocalPlayerTeleportData

Variant

Rückgaben

Variant

Code-Beispiele

Getting LocalPlayer Teleport Data

local TeleportService = game:GetService("TeleportService")

local teleportData = TeleportService:GetLocalPlayerTeleportData()

print("Local player arrived with this data:", teleportData)

GetPlayerPlaceInstanceAsync

Angehalten

Parameter

userId: number

Rückgaben

Code-Beispiele

Following Another Player

local TeleportService = game:GetService("TeleportService")
local Players = game:GetService("Players")

Players.PlayerAdded:Connect(function(player)
	-- Is this player following anyone?
	local followId = player.FollowUserId
	-- If so, find out where they are
	if followId and followId ~= 0 then
		local _currentInstance, placeId, jobId
		local success, errorMessage, _currentInstance, placeId, jobId = pcall(function()
			-- followId is the user ID of the player that you want to retrieve the place and job ID for
			return TeleportService:GetPlayerPlaceInstanceAsync(followId)
		end)
		if success then
			-- Teleport player
			TeleportService:TeleportToPlaceInstance(placeId, jobId, player)
		else
			warn(errorMessage)
		end
	else
		warn("Player " .. player.UserId .. " is not following another player!")
	end
end)

GetTeleportSetting

Variant

Parameter

setting: string

Rückgaben

Variant

ReserveServer

Angehalten

Parameter

placeId: number

Rückgaben

Code-Beispiele

TeleportService: Teleport to a Reserved Server

local TeleportService = game:GetService("TeleportService")
local Players = game:GetService("Players")

local code = TeleportService:ReserveServer(game.PlaceId)

local players = Players:GetPlayers()

TeleportService:TeleportToPrivateServer(game.PlaceId, code, players)
-- You could add extra arguments to this function: spawnName, teleportData and customLoadingScreen

TeleportService: Teleport to a Reserved Server via Chat

local TeleportService = game:GetService("TeleportService")
local Players = game:GetService("Players")
local DataStoreService = game:GetService("DataStoreService")

local dataStore = DataStoreService:GetGlobalDataStore()

-- Get the saved code
local code = dataStore:GetAsync("ReservedServer")
if typeof(code) ~= "string" then -- None saved, create one
	code = TeleportService:ReserveServer(game.PlaceId)
	dataStore:SetAsync("ReservedServer", code)
end

local function joined(player)
	player.Chatted:Connect(function(message)
		if message == "reserved" then
			TeleportService:TeleportToPrivateServer(game.PlaceId, code, { player })
		end
	end)
end

Players.PlayerAdded:Connect(joined)

SetTeleportGui

()

Parameter

gui: Instance

Rückgaben

()

Code-Beispiele

Teleportieren des lokalen Spielers

local TeleportService = game:GetService("TeleportService")
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local Players = game:GetService("Players")

local playerGui = Players.LocalPlayer:WaitForChild("PlayerGui")

local PLACE_ID = 0 -- ersetzen hier
local loadingGui = ReplicatedStorage:FindFirstChild("LoadingGui")

-- eltern das lade-gui für diesen ort
loadingGui.Parent = playerGui

-- legen sie das lade-gui für den zielort fest
TeleportService:SetTeleportGui(loadingGui)

TeleportService:Teleport(PLACE_ID)

SetTeleportSetting

()

Parameter

setting: string

value: Variant

Rückgaben

()

Teleport

()

Parameter

placeId: number

player: Instance

Standardwert: "nil"

teleportData: Variant

customLoadingScreen: Instance

Standardwert: "nil"

Rückgaben

()

Code-Beispiele

Teleportieren des lokalen Spielers

local TeleportService = game:GetService("TeleportService")
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local Players = game:GetService("Players")

local playerGui = Players.LocalPlayer:WaitForChild("PlayerGui")

local PLACE_ID = 0 -- ersetzen hier
local loadingGui = ReplicatedStorage:FindFirstChild("LoadingGui")

-- eltern das lade-gui für diesen ort
loadingGui.Parent = playerGui

-- legen sie das lade-gui für den zielort fest
TeleportService:SetTeleportGui(loadingGui)

TeleportService:Teleport(PLACE_ID)

Teleporting from the server

local Players = game:GetService("Players")
local TeleportService = game:GetService("TeleportService")

local PLACE_ID = 0 -- replace here
local USER_ID = 1 -- replace with player's UserId

local player = Players:GetPlayerByUserId(USER_ID)

TeleportService:Teleport(PLACE_ID, player)

TeleportAsync

Angehalten

Parameter

placeId: number

players: Instances

teleportOptions: Instance

Standardwert: "nil"

Rückgaben

TeleportPartyAsync

string

Angehalten

Parameter

placeId: number

players: Instances

teleportData: Variant

customLoadingScreen: Instance

Standardwert: "nil"

Rückgaben

string

Code-Beispiele

Teleport all players in the server

local Players = game:GetService("Players")
local TeleportService = game:GetService("TeleportService")

local PLACE_ID = 0 -- replace
local playerList = Players:GetPlayers()

local success, result = pcall(function()
	return TeleportService:TeleportPartyAsync(PLACE_ID, playerList)
end)

if success then
	local jobId = result
	print("Players teleported to", jobId)
else
	warn(result)
end

TeleportToPlaceInstance

()

Parameter

placeId: number

instanceId: string

player: Instance

Standardwert: "nil"

spawnName: string

teleportData: Variant

customLoadingScreen: Instance

Standardwert: "nil"

Rückgaben

()

Code-Beispiele

Following Another Player

local TeleportService = game:GetService("TeleportService")
local Players = game:GetService("Players")

Players.PlayerAdded:Connect(function(player)
	-- Is this player following anyone?
	local followId = player.FollowUserId
	-- If so, find out where they are
	if followId and followId ~= 0 then
		local _currentInstance, placeId, jobId
		local success, errorMessage, _currentInstance, placeId, jobId = pcall(function()
			-- followId is the user ID of the player that you want to retrieve the place and job ID for
			return TeleportService:GetPlayerPlaceInstanceAsync(followId)
		end)
		if success then
			-- Teleport player
			TeleportService:TeleportToPlaceInstance(placeId, jobId, player)
		else
			warn(errorMessage)
		end
	else
		warn("Player " .. player.UserId .. " is not following another player!")
	end
end)

TeleportToPrivateServer

()

Parameter

placeId: number

reservedServerAccessCode: string

players: Instances

spawnName: string

teleportData: Variant

customLoadingScreen: Instance

Standardwert: "nil"

Rückgaben

()

Code-Beispiele

TeleportService: Teleport to a Reserved Server via Chat

local TeleportService = game:GetService("TeleportService")
local Players = game:GetService("Players")
local DataStoreService = game:GetService("DataStoreService")

local dataStore = DataStoreService:GetGlobalDataStore()

-- Get the saved code
local code = dataStore:GetAsync("ReservedServer")
if typeof(code) ~= "string" then -- None saved, create one
	code = TeleportService:ReserveServer(game.PlaceId)
	dataStore:SetAsync("ReservedServer", code)
end

local function joined(player)
	player.Chatted:Connect(function(message)
		if message == "reserved" then
			TeleportService:TeleportToPrivateServer(game.PlaceId, code, { player })
		end
	end)
end

Players.PlayerAdded:Connect(joined)

TeleportService: Teleport to a Reserved Server

local TeleportService = game:GetService("TeleportService")
local Players = game:GetService("Players")

local code = TeleportService:ReserveServer(game.PlaceId)

local players = Players:GetPlayers()

TeleportService:TeleportToPrivateServer(game.PlaceId, code, players)
-- You could add extra arguments to this function: spawnName, teleportData and customLoadingScreen

TeleportToSpawnByName

()

Parameter

placeId: number

spawnName: string

player: Instance

Standardwert: "nil"

teleportData: Variant

customLoadingScreen: Instance

Standardwert: "nil"

Rückgaben

()

Code-Beispiele

TeleportService: Teleportieren zu SpawnName

local TeleportService = game:GetService("TeleportService")

TeleportService:TeleportToSpawnByName(1818, "TeleportSpawn")

Events

LocalPlayerArrivedFromTeleport

Parameter

loadingGui: Instance

dataTable: Variant

TeleportInitFailed

Parameter

player: Instance

teleportResult: Enum.TeleportResult

errorMessage: string

placeId: number

teleportOptions: Instance