TeleportOptions

Afficher les obsolètes

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

Cette classe est un paramètre facultatif de la fonction TeleportService:TeleportAsync() qui permet aux développeurs de fournir des arguments pour l'appel de téléportation.

Certains arguments de cette classe ne sont pas compatibles les uns avec les autres et provoquent une erreur lorsqu'ils sont passés à TeleportService:TeleportAsync() :

  • Code d'accès au serveur réservé + ID de serveur instance
  • DevraitReserveServer + ServerInstanceId
  • ShouldReserveServer + RéservéServerAccessCode

Pour plus d'informations sur la façon de téléporter les joueurs entre les serveurs, voir Téléportation entre lieux.

Résumé

Propriétés

Méthodes

Propriétés

ReservedServerAccessCode

Lecture parallèle

Cette propriété indique le code d'accès au serveur réservé pour le serveur réservé auquel l'utilisateur(s) doit être téléporté.

Pour plus d'informations sur la façon de téléporter les joueurs entre les serveurs, voir Téléportation entre lieux.

ServerInstanceId

Lecture parallèle

Cette propriété indique la DataModel.JobId de l'instance du serveur vers laquelle l'utilisateur(s) devrait être téléporté.

Pour plus d'informations sur la façon de téléporter les joueurs entre les serveurs, voir Téléportation entre lieux.

ShouldReserveServer

Lecture parallèle

Cette propriété indique si l'appel de téléportation doit créer un nouveau serveur réservé.Lorsqu'il est défini sur vrai, un serveur réservé sera créé et le(s) joueur(s) sera(ont) téléporté(s) sur le nouveau serveur.

Si la valeur est définie sur false, le(s) joueur(s) sera(ont) téléporté(s) sur le serveur public avec le TeleportOptions.ServerInstanceId spécifié s'il est fourni.Lorsque TeleportOptions.ServerInstanceId est vide ou qu'aucun serveur correspondant n'est trouvé, un nouveau serveur public sera créé pour téléporter le(s) joueur(s).

Pour plus d'informations sur la façon de téléporter les joueurs entre les serveurs, voir Téléportation entre lieux.

Méthodes

GetTeleportData

Variant

Cette fonction renvoie les données de téléportation stockées dans l'instance TeleportOptions par TeleportOptions:SetTeleportData().

Une fois qu'un joueur a téléporté, les données de téléportation peuvent être récupérées en utilisant les fonctions Player:GetJoinData() et TeleportService:GetLocalPlayerTeleportData().

Pour plus d'informations sur la façon de téléporter les joueurs entre les serveurs, voir Téléportation entre lieux.


Retours

Variant

SetTeleportData

()

C'est une fonction de définition pour les données à transmettre à l'emplacementde destination.Sur le emplacementde destination, ces données peuvent être récupérées en utilisant Player:GetJoinData() ou TeleportService:GetLocalPlayerTeleportData().

Par exemple, le fragment suivant enverrait le DataModel.PlaceId et le DataModel.JobId dans un dictionnaire qui transmet les données de téléportation dans une instance TeleportOptions en utilisant TeleportOptions:SetTeleportData() :


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

Ces données pourraient ensuite être récupérées à l'arrivée en utilisant la fonction GetLocalPlayerTeleportData() comme suit :


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

Si aucun teleportData n'a été défini dans la fonction de téléportation, cette GetLocalPlayerTeleportData() retournera nil .

Pour plus d'informations sur la façon d'envoyer et de recevoir des données d'utilisateur avec des téléportations, voir téléportation entre lieux.

Paramètres

teleportData: Variant

Données à transmettre à l'emplacementdestination.

Valeur par défaut : ""

Retours

()

Évènements