Modules de chat côté client

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

Vous pouvez utiliser les modules de chat suivants pour soutenir les comportements côté client du système de chat hérité Legacy chat system.

Fenêtre de discussion

La fenêtre de chat est le principal module de chat du côté client du système de chat hérité.

Méthodes

Ajouter un canal

Supprimer le canal

  • Paramètres : string : channelName
  • Description : Supprime un ChatChannelUI avec le channelName donné de la fenêtre.
  • Retours : void

Obtenir le canal

Obtenir le canal actuel

Changer de canal actuel

  • Paramètres : string : channelName
  • Description : Échange le canal actuel en ChatChannelUI avec le donné channelName s'il existe.
  • Retours : void

Obtenir visible

  • Paramètres : Aucun
  • Description : Retourne si la fenêtre est visible ou non.Remarque : cela se rapporte à l'interface de chat en général ; lorsque la fenêtre de chat disparaît en transparence en raison de l'inactivité, la fenêtre est toujours considérée comme visible.
  • Retours : bool

Définir visible

  • Paramètres : bool : visible
  • Description : Définir la visibilité de la fenêtre de chat.
  • Retours : void

Arrière-plan de disparition

  • Paramètres : flotte : duration
  • Description : Disparaît le fond dans les secondes données duration .Remarque : les appels ultérieurs pour contrôler la dissipation entrée/sortie remplaceront les appels précédents.
  • Retours : void

Disparaître dans le fond

  • Paramètres : flotte : duration
  • Description : Disparaît en arrière-plan au cours des duration secondes données.Remarque : les appels ultérieurs pour contrôler la dissipation entrée/sortie remplaceront les appels précédents.
  • Retours : void

Texte de disparition

  • Paramètres : flotte : duration
  • Description : Fades out le texte sur le donné duration en secondes.Remarque : les appels ultérieurs pour contrôler la dissipation entrée/sortie remplaceront les appels précédents.
  • Retours : void

FadeInTexte

  • Paramètres : flotte : duration
  • Description : Disparaît dans le texte au cours des duration secondes données.Remarque : les appels ultérieurs pour contrôler la dissipation entrée/sortie remplaceront les appels précédents.
  • Retours : void

Bar de chat

La barre de chat gère l'entrée de texte côté client pour le système de chat Lua. Il y a deux composants clés de la barre de chat :

  • Barre de chat , un TextBox , où le joueur saisit des messages et des commandes (mises en évidence en orange)
  • Mode de message , un TextLabel , qui peut afficher des informations sur le message envoyé (mises en évidence en vert)

Méthodes

Obtenir le champ de texte

  • Paramètres : Aucun
  • Description : Retourne le TextBox de la barre de chat.
  • Retours : TextBox

Obtenir le label du mode de message GetMessageModeText

  • Paramètres : Aucun
  • Description : Retourne le MessageMode TextLabel .
  • Retours : TextLabel

Est focalisé

  • Paramètres : Aucun
  • Description : Retourne si la barre de chat TextBox est en focus (le joueur tape dans la boîte de modélisation).Équivalent à l'appel de TextBox:IsFocused sur le résultat de GetTextBox.
  • Retours : bool

CaptureFocus

  • Paramètres : Aucun
  • Description : Force le client à se concentrer sur le TextBox de la barre de chat. Équivalent à l'appel de TextBox:CaptureFocus sur le résultat de GetTextBox.
  • Retours : void

Focalisation de la sortie

  • Paramètres : bool : submitted = false
  • Description : Libère le focus de la barre de chat TextBox .Si submitted est vrai, cela se comportera comme si le joueur a appuyé sur Entrée pour envoyer le message.
  • Retours : void

Réinitialiser le texte

  • Paramètres : Aucun
  • Description : Définir le Text de la barre de chat TextBox sur la chaîne vide.
  • Retours : void

Définir le texte du bouton de texte

  • Paramètres : string : text
  • Description : Définir le Text de la barre de chat TextBox au donné text .
  • Retours : void

Obtenir le texte du bouton GetTextBoxText

  • Paramètres : Aucun
  • Description : Retourne le texte dans la barre de chat TextBox.Text .
  • Retours : string

Définir le texte du label SetTextLabel

  • Paramètres : string : text
  • Description : Définir le Text du MessageMode TextLabel au donné text .
  • Retours : void

Obtenir activé

  • Paramètres : Aucun
  • Description : Retourne si la barre de chat est Visible .
  • Retours : bool

Définir activé

  • Paramètres : bool : enabled
  • Description : Défini si la barre de chat est Visible .
  • Retours : void

Définir la taille du texte

  • Paramètres : int : textSize :
  • Description : Définir le de la barre de chat et du MessageMode .
  • Retours : void

Taille de réinitialisation

  • Paramètres : Aucun
  • Description : Réinitialise la taille de la barre de chat à une ligne de texte.
  • Retours : void

Définir la cible du canal

  • Paramètres : string : channelName
  • Description : Définir le cible ChatChannelUI donné son channelName auquel la barre de chat devrait soumettre des messages.
  • Retours : void

Arrière-plan de disparition

  • Paramètres : flotte : duration``duration
  • Description : Disparaît le fond dans les secondes données duration .Remarque : les appels ultérieurs pour contrôler la dissipation entrée/sortie remplaceront les appels précédents.
  • Retours : void

Disparaître dans le fond

  • Paramètres : flotte : duration``duration
  • Description : Disparaît en arrière-plan au cours des duration secondes données.Remarque : les appels ultérieurs pour contrôler la dissipation entrée/sortie remplaceront les appels précédents.
  • Retours : void

Texte de disparition

  • Paramètres : flotte : duration``duration
  • Description : Fades out le texte sur le donné duration en secondes.Remarque : les appels ultérieurs pour contrôler la dissipation entrée/sortie remplaceront les appels précédents.
  • Retours : void

FadeInTexte

  • Paramètres : flotte : duration``duration
  • Description : Disparaît dans le texte au cours des duration secondes données.Remarque : les appels ultérieurs pour contrôler la dissipation entrée/sortie remplaceront les appels précédents.
  • Retours : void

ChатChannelUI

Le ChatChannelUI est la version cliente de ChatChannel.Il reçoit messages de chat du serveur et les transmet au journal des messages de chat. associé à elle.

Méthodes

Ajouter un message au canal

Supprimer le dernier message du canal

Effacer le journal des messages

Affichage des journaux de message de chat

Le ChatMessageLogDisplay gère la rendu de messages de chat dans un ChatChannelUI.

Méthodes

Ajouter un message

  • Paramètres : Message de chatmessage
  • Description : Ajoute un message au log de message d'affichage.
  • Retours : void

Supprimer le dernier message

  • Paramètres : Aucun
  • Description : Supprime le plus ancien message de chat dans l'affichage du journal des messages.
  • Retours : void

Reorganiser tous les messages

  • Paramètres : Aucun
  • Description : Réorganise toutes les affichages de messages dans l'ordre croissant, par rapport à la taille de l'affichage de message.Cela devrait être appelé si l'affichage du journal des messages est redimensionné.
  • Retours : void

Effacer

  • Paramètres : Aucun
  • Description : Supprime tous les messages de chat de l'affichage du journal des messages.
  • Retours : void

Texte de disparition

  • Paramètres : flottementduration
  • Description : Fades out le texte sur le donné duration en secondes.Remarque : les appels ultérieurs pour contrôler la dissipation entrée/sortie remplaceront les appels précédents.
  • Retours : void

FadeInTexte

  • Paramètres : flottementduration
  • Description : Disparaît dans le texte au cours des duration secondes données.Remarque : les appels ultérieurs pour contrôler la dissipation entrée/sortie remplaceront les appels précédents.
  • Retours : void

Statut personnalisé de chat

Le ChatCustomState est une interface de rappels utilisés lors de la création d'un état de chat personnalisé dans la barre de chat.

Le chat whisper et le chat d'équipe utilisent ChatCustomState pour indiquer au joueur où sa message sera envoyé.

Appels de rappel

Texte mis à jour

  • Paramètres : Aucun
  • Description : Appelé lorsque le texte dans la barre de chat est mis à jour.
  • Retours : void

Obtenir un message

  • Paramètres : Aucun
  • Description : Appelé pour récupérer le texte du message tel qu'il serait écrit comme une seule commande.Cela est utilisé dans le cas où le serveur doit traiter la commande en tant que texte, plutôt que l'état visuelisé de la commande.
  • Retours : string

Message de processus terminé

  • Paramètres : Aucun
  • Description : Appelé lorsque le joueur envoie le message qui est traité par l'état personnalisé.Cela devrait retourner vrai si le message ne doit pas être affiché ou envoyé au serveur.
  • Retours : bool

Déposer

  • Paramètres : Aucun
  • Description : Appelé comme le bar de chat est réinitialisé à son état d'origine avant la modification d'état personnalisée.
  • Retours : void

Paramètres de chat

Le paramètre de chat est un dictionnaire de paramètres pour le côté client du système de chat Lua.Ils sont stockés dans un ModuleScript nommé ChatSettings , qui peut être trouvé à l'intérieur du service de jeu Chat , sous le Folder nommé ClientChatModules .Le module peut être requis et ses propriétés peuvent être modifiées au moment de l'exécution.

Pour modifier un paramètre, exigez ce module en utilisant un LocalScript de la manière suivante :

-- Exigez le module ChatSettings (attendez qu'il se charger)

local Chat = game:GetService("Chat")

local ClientChatModules = Chat:WaitForChild("ClientChatModules")

local ChatSettings = require(ClientChatModules:WaitForChild("ChatSettings"))

-- Changez les paramètres comme vous le feriez avec n'importe quelle autre table.

ChatSettings.MaximumMessageLength = 100

Paramètres du comportement du chat

Fenêtre glissable

  • Type : bool
  • Par défaut : false
  • Description : Détermine si la fenêtre de chat est .

Fenêtre rétractable

  • Type : bool
  • Par défaut : false
  • Description : Détermine si la fenêtre de chat peut être redimensionnée par le joueur
  • Type : bool
  • Par défaut : false
  • Description : Détermine si les manettes de jeu peuvent naviguer dans l'interface de chat.

Afficher le message filtré de l'utilisateur

  • Type : bool
  • Par défaut : true
  • Description : Détermine si les joueurs doivent voir la version filtrée de leurs messages de chat ou le contenu original qu'ils ont saisi.

ChatOnWithTopBarOff

  • Type : bool
  • Par défaut : false
  • Description : Détermine si l'interface de chat est activée même si la barre supérieure est désactivée.

BubbleChatEnabled

  • Type : bool
  • Par défaut : game:GetService("Players").BubbleChat
  • Description : Détermine si le chat à bulles est activé.

ClassicChatEnabled

  • Type : bool
  • Par défaut : game:GetService("Players").ClassicChat
  • Description : Détermine si le chat classique est activé.

Paramètres de la taille du texte de chat

Taille du texte de la fenêtre de chat

  • Type : int
  • Par défaut : 18
  • Description : Détermine la taille du texte dans la fenêtre de chat.

Taille du texte de la barre de discussion

  • Type : int
  • Par défaut : 18
  • Description : Détermine la taille du texte dans la barre de chat.

Taille du texte de la fenêtre de chatPhone

  • Type : int
  • Par défaut : 14
  • Description : Détermine la taille du texte dans la fenêtre de chat pour les téléphones.

Taille du texte de la barre de discussionPhone

  • Type : int
  • Par défaut : 14
  • Description : Détermine la taille du texte dans la barre de chat pour les téléphones.

Paramètres de police

Police par défaut

Police de bar de chat

Paramètres de couleur

Couleur de fond arrière

  • Type : Color3
  • Par défaut : Color3.new(0, 0, 0)
  • Description : Détermine le BackgroundColor3 de la fenêtre de chat.

Couleur de message par défaut

Nom par défaut de la couleur

Couleur d'arrière-plan de la barre de chat

  • Type : Color3
  • Par défaut : Color3.new(0, 0, 0)
  • Description : Détermine le BackgroundColor3 de la barre de chat.

Couleur de la boîte de discussion

  • Type : Color3
  • Par défaut : Color3.new(1, 1, 1)
  • Description : Détermine le de la barre de chat .

Couleur du texte de la barre de discussion

  • Type : Color3
  • Par défaut : Color3.new(0, 0, 0)
  • Description : Détermine le TextColor3 de la barre de chat.

Couleur du message d'erreur

  • Type : Color3
  • Par défaut : Color3.fromRGB(245, 50, 50)
  • Description : Détermine le TextColor3 des messages d'erreur.

Paramètres de la fenêtre

Taille de fenêtre minimale

  • Type : UDim2
  • Par défaut : UDim2.new(0.3, 0, 0.25, 0)
  • Description : Détermine la plus petite taille possible de la fenêtre de chat (étant donné que WindowResizable est activé).

Taille maximale de la fenêtre

  • Type : UDim2
  • Par défaut : UDim2.new(1, 0, 1, 0)
  • Description : Détermine la plus grande taille possible de la fenêtre de chat (étant donné que WindowResizable est activé).
  • Notes : Si cela est modifié pour être supérieur à la taille complète de l'écran, des choses étranges commencent à se produire avec la vérification des limites de taille/position.

Position de la fenêtre par défaut

  • Type : UDim2
  • Par défaut : UDim2.new(0, 0, 0, 0)
  • Description : Détermine la position par défaut de la fenêtre de chat.

Taille de la fenêtre par défautPhone

  • Type : UDim2
  • Par défaut : UDim2.new(0.5, 0, 0.5, (7 * 2) + (5 * 2))
  • Description : Détermine la taille par défaut de la fenêtre de chat sur les téléphones.

Tablette de taille de fenêtre par défaut

  • Type : UDim2
  • Par défaut : UDim2.new(0.4, 0, 0.3, (7 * 2) + (5 * 2))
  • Description : Détermine la taille par défaut de la fenêtre de chat sur les tables.

Taille de la fenêtre par défaut du bureau

  • Type : UDim2
  • Par défaut : UDim2.new(0.3, 0, 0.25, (7 * 2) + (5 * 2))
  • Description : Détermine la taille par défaut de la fenêtre de chat sur bureau.

Disparaître et dans les paramètres

Temps de fondu de l'arrière-plan de la fenêtre de chat

  • Type : flotte (secondes)
  • Par défaut : 0.5
  • Description : Détermine la durée de l'éclipse du fond de la fenêtre de discussion ChatWindow.

Temps de fondu de la fenêtre de chat

  • Type : flotte (secondes)
  • Par défaut : 30
  • Description : Détermine la durée de disparition du texte de la fenêtre de chat.

Durée de fondu de chat par défaut

  • Type : flotte (secondes)
  • Par défaut : 0.8
  • Description : Détermine la durée des éléments de l'interface de chat qui disparaissent.

ChatShouldFadeInFromNouvelle information

  • Type : bool
  • Par défaut : false
  • Description : Détermine si le chat doit disparaître lors de la réception de nouveaux messages.

ChatAnimationFPS

  • Type : flottement
  • Par défaut : 20.0
  • Description : Détermine le taux de rafraîchissement des animations de disparition dans l'interface de chat.

Paramètres du canal

Nom du canal général

  • Type : string
  • Par défaut : "All"
  • Description : Détermine le nom du chat (chat privé)par défaut.

Message d'écho dans le canal général

  • Type : bool
  • Par défaut : true
  • Description : Détermine si les messages vers des canaux autres que le canal par défaut doivent être échés dans le chat (chat privé)par défaut.

Nom du canal maximum de longueur

  • Type : int
  • Par défaut : 12
  • Description : Détermine la longueur maximale d'un nom de canal avant qu'il soit tronqué.

Longueur de l'histoire des messages par canal

  • Type : int
  • Par défaut : 50
  • Description : Détermine le nombre maximum de message de chat qui peut être affiché dans un chat (chat privé)de chat.

Afficher le texte d'aide JoinAndLeave

  • Type : bool
  • Par défaut : false
  • Description : Détermine si le texte d'aide pour rejoindre/quitter les canaux est affiché.

Paramètres de message

Longueur maximale du message

  • Type : int
  • Par défaut : 200
  • Description : Détermine la longueur maximale de messages de chat.

Espace blanc non autorisé

  • Type : array< string >
  • Par défaut : {"\n", "\r", "\t", "\v", "\f"}
  • Description : Détermine les caractères d'espace blancs qui sont interdits.

Cliquez sur le nom du joueur pour chuchoter

  • Type : bool
  • Par défaut : true
  • Description : Détermine si le joueur peut cliquer sur le nom d'un autre joueur pour engager une conversation confidentielle avec eux.

Cliquez sur le nom du canal pour définir le canal principal

  • Type : bool
  • Par défaut : true
  • Description : Détermine si le joueur peut cliquer sur l'onglet d'un chat (chat privé)pour le définir comme son chat (chat privé)principal.

Paramètres divers

Noms de joueurs de commande WhisperCommandAutoCompletePlayerNames

  • Type : bool
  • Par défaut : true
  • Description : Détermine si la commande chuchotement doit automatiquement compléter les noms des joueurs.

Événements

Paramètres modifiés

  • Paramètres : Library.string``settingName , Variante newValue
  • Description : Se déclenche lorsqu'un paramètre avec le donné settingName est modifié en newValue .

Sur cette page