TextChannel
*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.
Représente un chat (chat privé)de chat texte. Contient TextSources en tant que descendants.
Pour envoyer un message de chat à la TextChannel, appelez TextChannel:SendAsync() à partir d'un LocalScript .Le correspondant TextSource de l'utilisateur avec TextSource.CanSend = true doit être dans ce chat (chat privé).
Les messages de différents canaux de texte peuvent être séparés en différentes sections dans la fenêtre de chat en utilisant ChannelTabsConfiguration .
Pour en savoir plus, voir discussion de texte en expérience.
Résumé
Propriétés
Le TextChannel ne livrera des messages qu'aux utilisateurs qui peuvent envoyer des messages directs au DirectChatRequester.
Méthodes
Affiche un message système à l'utilisateur.
Définit le DirectChatRequester pour le TextChannel. Le TextChannel ne livrera que des messages aux utilisateurs qui peuvent envoyer des messages directs au DirectChatRequester.
Ajoute un TextSource à l'identifiant de donateur donné de TextChannel d'un Player .
Envoie un TextChatMessage au serveur.
Évènements
S'enflamme lorsque TextChannel:DisplaySystemMessage() est invoqué sur le client, ou lorsque le client reçoit une réponse valide TextChannel:SendAsync() du serveur.
Rappels
Propriétés
DirectChatRequester
Le TextChannel ne livrera que des messages aux utilisateurs qui peuvent envoyer des messages directs au DirectChatRequester. Cette propriété ne peut être définie qu'en utilisant SetDirectChatRequester().
Méthodes
DisplaySystemMessage
Affiche un message système à l'utilisateur.Ne peut être utilisé qu'en LocalScript , ou en Script avec RunContext de Enum.RunContext.Client .Les messages ne sont visibles que par cet utilisateur et ne sont pas automatiquement filtrés ou localisés.
Paramètres
Le message du système envoyé au TextChannel.
Utilisez pour identifier les types de message du système, tels que les messages système par défaut.
Retours
Un TextChatMessage avec la propriété TextChatMessage.Status indiquant la condition du message.
SetDirectChatRequester
Définit le DirectChatRequester pour le TextChannel. Cette méthode n'est disponible que pour l'utilisation dans les scripts du serveur.
Utilisez cette API si vous travaillez avec TextChatService et disposez d'une implémentation personnalisée de chat direct en dehors des canaux de texte par défaut.
Lorsqu'il est appelé sur un TextChannel qui est parenté à TextChatService et n'a pas d'existant TextSources , SetDirectChatRequester ajoute les utilisateurs demandés en tant que TextSource et définir la propriété DirectChatRequester pour le chat (chat privé).
Lorsque DirectChatRequester est configurer, seuls les messages entre les utilisateurs qui peuvent diriger le chat avec le DirectChatRequester sont livrés.
local function createWhisperChannel(fromPlayer, toPlayer)
local whisperChannel = Instance.new("TextChannel")
whisperChannel:SetDirectChatRequester(fromPlayer)
whisperChannel:AddUserAsync(toPlayer.UserId)
-- L'instance TextChannel a maintenant deux instances de TextSource.
return whisperChannel
end
Paramètres
Retours
AddUserAsync
Ajoute un à l'identifiant de l'utilisateur donné (avec ). Ne peut être utilisé qu'en .
Si un TextSource représentant l'utilisateur n'existe pas, cela ajoute un TextSource .
Si un TextSource représentant l'utilisateur existe, cela renvoie le TextSource .
Si l'utilisateur a le chat désactivé ou n'est pas sur le serveur, cela renvoie une tuple nil, false.
Paramètres
Retours
Retourne TextSource et true si une nouvelle TextSource est créée pour l'utilisateur, TextSource et false si il existe une existence TextSource , ou nil et false si l'utilisateur a le chat désactivé ou n'est pas sur ce serveur.
SendAsync
Envoie un TextChatMessage au serveur. Ne peut être utilisé qu'en LocalScript ou en Script avec RunContext de Enum.RunContext.Client .
L'argument metadata a une limite de 200 caractères.Si cela est appelé avec un argument metadata qui a plus de 200 caractères, le message ne sera pas envoyé à d'autres utilisateurs.Au lieu de cela, l'expéditeur recevra un TextChatMessage avec les propriétés TextChatMessage.Metadata et TextChatMessage.Text définies sur des chaînes vides.
Paramètres
Le message à envoyer au TextChannel.
Métadonnées personnalisées à attacher au message.
Retours
Un TextChatMessage avec la propriété TextChatMessage.Status indiquant la condition du message.
Évènements
MessageReceived
Comme TextChatService.MessageReceived , se déclenche lorsque TextChannel:DisplaySystemMessage() est invoqué sur le client, ou lorsque le client reçoit une réponse valide TextChannel:SendAsync() du serveur.Cet événement ne se déclenche que sur le client.
Si la propriété TextChannel.ShouldDeliverCallback du serveur est liée et renvoie false, le client ne déclenchera pas TextChannel.MessageReceived .
Utilisez le paramètre TextChatMessage pour obtenir le TextSource et le texte du message (avec TextChatMessage.Text).
Le paramètre TextChatMessage est le résultat final de toutes les fonctions liées à TextChatService.OnIncomingMessage ou TextChannel.OnIncomingMessage.
Paramètres
Le TextChatMessage.