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 textuel. Contient TextSources comme descendants.

Pour envoyer un message de chat à l' TextChannel, appelez Class.TextChannel:SendAsync() Class.LocalScript . Le correspondant 2>Class.TextSource2> de l'utilisateur avec 5>TextSource.CanSend = true5> doit être dans ce chat (chat privé).

Les messages des différents canaux de texte peuvent être séparés en différentes onglets dans la fenêtre de chat en utilisant ChannelTabsConfiguration.

Pour en savoir plus, voir Chat textuel dans l'expérience.

Résumé

Méthodes

Évènements

Propriétés

Méthodes

DisplaySystemMessage

Affiche un message du système à l'utilisateur. Ne peut être utilisé que dans un LocalScript , ou dans un Script avec RunContext de 2> Class.Script2>. Les messages ne sont visibles que à cet utilisateur et ne sont pas automatiquement filtrés ou localisés.

Paramètres

systemMessage: string

Le message du système envoyé au TextChannel .

metadata: string

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

Valeur par défaut : ""

Retours

Un TextChatMessage avec TextChatMessage.Status propriété qui indique le statut du message.

AddUserAsync

Rendement

Ajoute un TextSource à la TextChannel donné à l'utilisateur (avec Player.UserId ). Ne peut être utilisé que dans un 2>Class.Script2>.

Si une TextSource représentant l'utilisateur n'existe pas, cela ajoute un TextSource .

Si une TextSource représentant l'utilisateur existe, ceci renvoie le TextSource.

Si l'utilisateur a le chat désactivé ou n'est pas dans le serveur, cela renvoie un tableau nil , false .

Paramètres

userId: number

L'identifiant de l'utilisateur du Player.


Retours

Retourne TextSource et true si un nouveau TextSource est créé pour l'utilisateur, 1> Class.TextSource1> et 4> false4> s'il y a un

Rendement

Envoye un TextChatMessage au serveur. Ne peut être utilisé que dans un LocalScript ou dans un Script avec 1> Class.Script.RunContext|RunContext1> de 4> Ennum.RunContext.Client4>.

Paramètres

message: string

Le message à envoyer à TextChannel .

metadata: string

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

Valeur par défaut : ""

Retours

Un TextChatMessage avec TextChatMessage.Status propriété qui indique le statut 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 n'est déclenché que sur le client.

Si la propriété TextChannel.ShouldDeliverCallback du serveur est liée et renvoie false, le client ne tirera pas sur TextChannel.MessageReceived.

Utilisez le paramètre TextChatMessage pour obtenir le TextSource et le texte du message (avec TextChatMessage.Text).

Le TextChatMessage paramètre est le résultat final de toutes les fonctions liées à TextChatService.OnIncomingMessage ou TextChannel.OnIncomingMessage.

Paramètres

incomingMessage: TextChatMessage

Le TextChatMessage reçu.


Rappels

OnIncomingMessage

Paramètres


Retours

ShouldDeliverCallback

Paramètres

textSource: TextSource

Retours