TextChannel

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.

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

  • Lecture uniquement
    Non répliqué
    Lecture parallèle

    Le TextChannel ne livrera des messages qu'aux utilisateurs qui peuvent envoyer des messages directs au DirectChatRequester.

Méthodes

Évènements

Rappels

Propriétés

DirectChatRequester

Lecture uniquement
Non répliqué
Lecture parallèle

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

systemMessage: string

Le message du système envoyé au TextChannel.

Valeur par défaut : ""
metadata: string

Utilisez pour identifier les types de message du système, tels que les messages système par défaut.

Valeur 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

requester: Player
Valeur par défaut : ""

Retours

()

AddUserAsync

Rendement

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

userId: number

L'ID du Player .

Valeur par défaut : ""

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.

Rendement

Envoie un TextChatMessage au serveur. Ne peut être utilisé qu'en LocalScript ou en Script avec RunContext de Enum.RunContext.Client .

Paramètres

message: string

Le message à envoyer au TextChannel.

Valeur par défaut : ""
metadata: string

Métadonnées personnalisées à attacher au message.

Valeur par défaut : ""

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

incomingMessage: TextChatMessage

Rappels

OnIncomingMessage

Appelé lorsque TextChannel reçoit un message entrant. Ne peut être implémenté que sur le client.

Utilisez ceci pour décorer TextChatMessages .Si ce rappel renvoie un TextChatMessageProperties , ces propriétés sont fusionnées avec le paramètre TextChatMessage pour créer un nouveau TextChatMessage .

Lorsqu'il est lié au client qui envoie un message, ce rappel est exécuté deux fois ; d'abord lorsque le message est initialement envoyé et reçu localement, puis lorsque le client reçoit le résultat du message filtré du serveur.

TextChannel.OnIncomingMessage les appels de rappel s'exécutent toujours après l'appel de rappel TextChatService.OnIncomingMessage.

Cela devrait être défini qu'une seule fois par TextChannel dans le code source.Plusieurs liens à la même chaîne annuleront l'un l'autre d'une manière non déterministe.

Lorsque est vrai, ces appels par défaut sont attribués internement afin d'exposer un comportement par défaut spécial.

Paramètres

L'entrante TextChatMessage .


Retours

Si un TextChatMessageProperties est renvoyé, ces propriétés sont fusionnées avec le paramètre TextChatMessage pour créer un nouveau TextChatMessage avec ces propriétés.

ShouldDeliverCallback

Appelé pour chaque client lorsque TextChannel reçoit un message entrant pour déterminer s'il doit ou non être livré à ce client.Ne peut être défini que sur le serveur.

Une fois défini, ce rappel doit retourner une valeur véritable telle que true , 1 ou "hello" pour envoyer le message au client dit.Si le rappel renvoie autre chose (y compris nil ), le message ne sera pas livré à ce client, bien que l'expéditeur voie le message indépendamment.

L'expéditeur peut être référencé par TextChatMessage.TextSource , tandis que le destinataire est l'argument textSource.Notez que l'expéditeur et le destinataire peuvent être les mêmes, car le rappel itère à travers tous les récepteurs possibles.Dans Roblox Studio, vous serez le seul expéditeur et le seul destinataire d'un message en mode solo Jouer .

Paramètres

Le message envoyé, qui contient également l'expéditeur du message.

textSource: TextSource

Le TextSource de l'utilisateur qui recevra le message.


Retours