TeleportService | Documentation - Hub Création Roblox

Classe de moteur

TeleportService

Création impossible

Service

*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.

Résumé

Propriétés

CustomizedTeleportUI:boolean

Déprécié

Méthodes

GetArrivingTeleportGui():Instance

GetLocalPlayerTeleportData():Variant

GetPlayerPlaceInstanceAsync(userId: User):Tuple

GetTeleportSetting(setting: string):Variant

PromptExperienceDetailsAsync(player: Player,universeId: number):Enum.PromptExperienceDetailsResult

ReserveServer(placeId: number):Tuple

Déprécié

ReserveServerAsync(placeId: number):Tuple

SetTeleportGui(gui: Instance):()

SetTeleportSetting(setting: string,value: Variant):()

Teleport(placeId: number,player: Instance,teleportData: Variant,customLoadingScreen: Instance):()

TeleportAsync(placeId: number,players: Instances,teleportOptions: Instance):Instance

TeleportPartyAsync(placeId: number,players: Instances,teleportData: Variant,customLoadingScreen: Instance):string

TeleportToPlaceInstance(placeId: number,instanceId: string,player: Instance,spawnName: string,teleportData: Variant,customLoadingScreen: Instance):()

TeleportToPrivateServer(placeId: number,reservedServerAccessCode: string,players: Instances,spawnName: string,teleportData: Variant,customLoadingScreen: Instance):()

TeleportToSpawnByName(placeId: number,spawnName: string,player: Instance,teleportData: Variant,customLoadingScreen: Instance):()

Événements

LocalPlayerArrivedFromTeleport(loadingGui: Instance,dataTable: Variant):RBXScriptSignal

TeleportInitFailed(player: Instance,teleportResult: Enum.TeleportResult,errorMessage: string,placeId: number,teleportOptions: Instance):RBXScriptSignal

Membres hérités

57 hérité du Instance

6 hérité du Object

Référence API

Propriétés

CustomizedTeleportUI

Déprécié

Méthodes

GetArrivingTeleportGui

Capacités : UI, Teleport

TeleportService:GetArrivingTeleportGui():Instance

Retours

Instance

Échantillons de code

Gestion d'une interface de chargement de téléportation

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

Capacités : Teleport

TeleportService:GetLocalPlayerTeleportData():Variant

Retours

Variant

Échantillons de code

Obtention des données de téléportation de LocalPlayer

local TeleportService = game:GetService("TeleportService")

local teleportData = TeleportService:GetLocalPlayerTeleportData()

print("Le joueur local est arrivé avec ces données :", teleportData)

GetPlayerPlaceInstanceAsync

Rendement

Capacités : Teleport

TeleportService:GetPlayerPlaceInstanceAsync(userId:User):Tuple

Paramètres

userId:User

Retours

Tuple

Échantillons de code

Suivre un autre joueur

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

Players.PlayerAdded:Connect(function(player)
	local followId = player.FollowUserId

	if followId and followId ~= 0 then
		-- Ce joueur suit-il quelqu'un ? Si oui, trouvez où il est
		local success, currentInstance, error, placeId, jobIdOrErr = pcall(function()
			return TeleportService:GetPlayerPlaceInstanceAsync(followId)
		end)
			-- followId est l'ID utilisateur du joueur dont vous souhaitez récupérer l'ID de lieu et d'emploi
		if success then
			-- Téléporte le joueur en cas de succès basé sur jobId
			TeleportService:TeleportToPlaceInstance(placeId, jobIdOrErr, player)
		else
			-- Envoie un avertissement basé sur l'erreur retournée
			warn(jobIdOrErr)
		end
	else
		warn(("Le joueur %d ne suit pas un autre joueur !"):format(player.UserId))
	end
end)

GetTeleportSetting

Capacités : Teleport

TeleportService:GetTeleportSetting(setting:string):Variant

Paramètres

setting:string

Retours

Variant

PromptExperienceDetailsAsync

Rendement

Capacités : Teleport

TeleportService:PromptExperienceDetailsAsync(

player:Player, universeId:number

):Enum.PromptExperienceDetailsResult

Paramètres

player:Player

universeId:number

Retours

Enum.PromptExperienceDetailsResult

Échantillons de code

Afficher les détails de l'expérience au joueur

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

local player = Players.LocalPlayer

local success, result = pcall(function()
	TeleportService:PromptExperienceDetailsAsync(player, 8357232245)
end)
if not success then
	warn("Erreur lors de la demande des détails de l'expérience : " .. tostring(result))
end

if result == Enum.PromptExperienceDetailsResult.PromptClosed then
	print("Le joueur a fermé l'invitation aux détails de l'expérience")
elseif result == Enum.PromptExperienceDetailsResult.TeleportAttempted then
	print("Le joueur a choisi de se téléporter vers l'expérience")
end

ReserveServer

Déprécié

ReserveServerAsync

Rendement

Capacités : Teleport

TeleportService:ReserveServerAsync(placeId:number):Tuple

Paramètres

placeId:number

Retours

Tuple

Échantillons de code

TeleportService : Télporter vers un serveur réservé

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

local code = TeleportService:ReserveServerAsync(game.PlaceId)

local players = Players:GetPlayers()

TeleportService:TeleportToPrivateServer(game.PlaceId, code, players)
-- Vous pouvez ajouter des arguments supplémentaires à cette fonction : spawnName, teleportData et customLoadingScreen

TeleportService : Téléportez-vous vers un serveur réservé via le chat

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

local dataStore = DataStoreService:GetGlobalDataStore()

-- Obtenez le code enregistré
local code = dataStore:GetAsync("ReservedServer")
if typeof(code) ~= "string" then -- Aucun enregistré, en créez un
	code = TeleportService:ReserveServerAsync(game.PlaceId)
	dataStore:SetAsync("ReservedServer", code)
end

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

Players.PlayerAdded:Connect(joined)

SetTeleportGui

Capacités : UI, Teleport

TeleportService:SetTeleportGui(gui:Instance):()

Paramètres

gui:Instance

Retours

()

Échantillons de code

Téléporter le joueur local

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 -- remplacez ici
local loadingGui = ReplicatedStorage:FindFirstChild("LoadingGui")

-- parent le gui de chargement pour cet endroit
loadingGui.Parent = playerGui

-- définissez le gui de chargement pour l'endroit de destination
TeleportService:SetTeleportGui(loadingGui)

TeleportService:Teleport(PLACE_ID)

SetTeleportSetting

Capacités : Teleport

TeleportService:SetTeleportSetting(

setting:string, value:Variant

):()

Paramètres

setting:string

value:Variant

Retours

()

Teleport

Capacités : UI, Teleport

TeleportService:Teleport(

placeId:number, player:Instance, teleportData:Variant, customLoadingScreen:Instance

):()

Paramètres

placeId:number

player:Instance

Valeur par défaut : "nil"

teleportData:Variant

customLoadingScreen:Instance

Valeur par défaut : "nil"

Retours

()

Échantillons de code

Téléporter le joueur local

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 -- remplacez ici
local loadingGui = ReplicatedStorage:FindFirstChild("LoadingGui")

-- parent le gui de chargement pour cet endroit
loadingGui.Parent = playerGui

-- définissez le gui de chargement pour l'endroit de destination
TeleportService:SetTeleportGui(loadingGui)

TeleportService:Teleport(PLACE_ID)

Téléportation depuis le serveur

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

local PLACE_ID = 0 -- remplacez ici
local USER_ID = 1 -- remplacez par l'UserId du joueur

local player = Players:GetPlayerByUserId(USER_ID)

TeleportService:Teleport(PLACE_ID, player)

TeleportAsync

Rendement

Capacités : UI, Teleport

TeleportService:TeleportAsync(

placeId:number, players:Instances, teleportOptions:Instance

):Instance

Paramètres

placeId:number

players:Instances

teleportOptions:Instance

Valeur par défaut : "nil"

Retours

Instance

TeleportPartyAsync

Rendement

Capacités : UI, Teleport

TeleportService:TeleportPartyAsync(

placeId:number, players:Instances, teleportData:Variant, customLoadingScreen:Instance

):string

Paramètres

placeId:number

players:Instances

teleportData:Variant

customLoadingScreen:Instance

Valeur par défaut : "nil"

Retours

string

Échantillons de code

Téléporter tous les joueurs dans le serveur

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

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

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

if success then
	local jobId = result
	print("Joueurs téléportés vers", jobId)
else
	warn(result)
end

TeleportToPlaceInstance

Capacités : UI, Teleport

TeleportService:TeleportToPlaceInstance(

placeId:number, instanceId:string, player:Instance, spawnName:string, teleportData:Variant, customLoadingScreen:Instance

):()

Paramètres

placeId:number

instanceId:string

player:Instance

Valeur par défaut : "nil"

spawnName:string

teleportData:Variant

customLoadingScreen:Instance

Valeur par défaut : "nil"

Retours

()

Échantillons de code

Suivre un autre joueur

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

Players.PlayerAdded:Connect(function(player)
	local followId = player.FollowUserId

	if followId and followId ~= 0 then
		-- Ce joueur suit-il quelqu'un ? Si oui, trouvez où il est
		local success, currentInstance, error, placeId, jobIdOrErr = pcall(function()
			return TeleportService:GetPlayerPlaceInstanceAsync(followId)
		end)
			-- followId est l'ID utilisateur du joueur dont vous souhaitez récupérer l'ID de lieu et d'emploi
		if success then
			-- Téléporte le joueur en cas de succès basé sur jobId
			TeleportService:TeleportToPlaceInstance(placeId, jobIdOrErr, player)
		else
			-- Envoie un avertissement basé sur l'erreur retournée
			warn(jobIdOrErr)
		end
	else
		warn(("Le joueur %d ne suit pas un autre joueur !"):format(player.UserId))
	end
end)

TeleportToPrivateServer

Capacités : UI, Teleport

TeleportService:TeleportToPrivateServer(

placeId:number, reservedServerAccessCode:string, players:Instances, spawnName:string, teleportData:Variant, customLoadingScreen:Instance

):()

Paramètres

placeId:number

reservedServerAccessCode:string

players:Instances

spawnName:string

teleportData:Variant

customLoadingScreen:Instance

Valeur par défaut : "nil"

Retours

()

Échantillons de code

TeleportService : Téléportez-vous vers un serveur réservé via le chat

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

local dataStore = DataStoreService:GetGlobalDataStore()

-- Obtenez le code enregistré
local code = dataStore:GetAsync("ReservedServer")
if typeof(code) ~= "string" then -- Aucun enregistré, en créez un
	code = TeleportService:ReserveServerAsync(game.PlaceId)
	dataStore:SetAsync("ReservedServer", code)
end

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

Players.PlayerAdded:Connect(joined)

TeleportService : Télporter vers un serveur réservé

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

local code = TeleportService:ReserveServerAsync(game.PlaceId)

local players = Players:GetPlayers()

TeleportService:TeleportToPrivateServer(game.PlaceId, code, players)
-- Vous pouvez ajouter des arguments supplémentaires à cette fonction : spawnName, teleportData et customLoadingScreen

TeleportToSpawnByName

Capacités : UI, Teleport

TeleportService:TeleportToSpawnByName(

placeId:number, spawnName:string, player:Instance, teleportData:Variant, customLoadingScreen:Instance

):()

Paramètres

placeId:number

spawnName:string

player:Instance

Valeur par défaut : "nil"

teleportData:Variant

customLoadingScreen:Instance

Valeur par défaut : "nil"

Retours

()

Échantillons de code

TéléportationService:TéléporterAuPointDEspawnParNom

local TeleportService = game:GetService("TeleportService")

TeleportService:TeleportToSpawnByName(1818, "TeleportSpawn")

Événements

LocalPlayerArrivedFromTeleport

Capacités : Teleport

TeleportService.LocalPlayerArrivedFromTeleport(

loadingGui:Instance, dataTable:Variant

):RBXScriptSignal

Paramètres

loadingGui:Instance

dataTable:Variant

TeleportInitFailed

Capacités : Teleport

TeleportService.TeleportInitFailed(

player:Instance, teleportResult:Enum.TeleportResult, errorMessage:string, placeId:number, teleportOptions:Instance

):RBXScriptSignal

Paramètres

player:Instance

teleportResult:Enum.TeleportResult

errorMessage:string

placeId:number

teleportOptions:Instance