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 prendre en charge les comportements côté client du système de chat hérité.

Baie vitrée

La ChatWindow est le module de chat principal du côté client du système de chat de légalité.

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 : null

Obtenez le canal

Obtenez le canal actuel

Actualiser le canal

  • Paramètres : string : channelName
  • Description : Bascule le canal actuel sur le ChatChannelUI avec le channelName donné s'il existe.
  • Retours : null

Devenir visible

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

Rendre visible

  • Paramètres : boule : visible
  • Description : Définit la visibilité de la fenêtre de discussion.
  • Retours : null

FadeOutBackground

  • Paramètres : flotter : duration
  • Description : Disparaît le fond de l'arrière-plan sur la valeur donnée duration dans secondes. Remarque : les appels ultérieurs pour contrôler la dissimulation dans/hors vont écraser les appels précédents.
  • Retours : null

FadeInBackground

  • Paramètres : flotter : duration
  • Description : Fades dans le fond sur la base des données duration dans les secondes. Remarque : les appels ultérieurs pour contrôler le fait de faire pivoter le flotage dans/hors vont écraser les appels précédents.
  • Retours : null

FadeOutText

  • Paramètres : flotter : duration
  • Description : Fades out le texte sur le given duration dans seconds. Note : les appels ultérieurs pour contrôler le fading in/out remplaceront les appels précédents.
  • Retours : null

FadeInText

  • Paramètres : flotter : duration
  • Description : Disparaît dans le texte au-dessus de la valeur donnée duration dans secondes. Remarque : les appels ultérieurs pour contrôler la disparition dans/hors vont écraser les appels précédents.
  • Retours : null

Barre de chat

La Barre de discussion gère l'entrée de texte côté client pour le système de chat Lua. Il existe deux composantes clés de la Barre de discussion :

  • ChatBar , un TextBox , où le joueur entre des messages et des commandes (en surbrillance en orange)
  • MessageMode , un TextLabel , qui peut afficher des informations sur le message envoyé (en surbrillance en vert)

Méthodes

Obtenez Texas

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

Obtenez le texte d'aide au message

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

Est axé

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

Capture de focus

  • 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 GetExecutor.
  • Retours : null

Focus de libération

  • Paramètres : boule : submitted = false
  • Description : Démarque 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 soumettre le message.
  • Retours : null

Réinitialiser texte

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

SettxtText

  • Paramètres : string : text
  • Description : Définit la Text de la barre de chat TextBox à l'aide de laquelle vous avez donné 0> text0> .
  • Retours : null

Obtenez TexasText

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

Définir l'étiquette de texte

  • Paramètres : string : text
  • Description : Définit le Text de la boîte de message TextLabel donné en tant que 0> text0> .
  • Retours : null

Obtenez activé

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

SetEnabled

  • Paramètres : boule : enabled
  • Description : Définit si la barre de chat est Visible.
  • Retours : null

Définir la taille de texte

  • Paramètres : int : textSize
  • Description : Définit la taille TextSize de la barre de chat et du TextBox de MessageMode et 0> TextLabel0>.
  • Retours : null

Taille de réinitialisation

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

Définir la cible de canal

  • Paramètres : string : channelName
  • Description : Définit la cible ChatChannelUI donné son channelName à laquelle la barre de discussion doit soumettre des messages.
  • Retours : null

FadeOutBackground

  • Paramètres : flotter : duration 0> duration0>
  • Description : Disparaît le fond de l'arrière-plan sur la valeur donnée duration dans secondes. Remarque : les appels ultérieurs pour contrôler la dissimulation dans/hors vont écraser les appels précédents.
  • Retours : null

FadeInBackground

  • Paramètres : flotter : duration 0> duration0>
  • Description : Fades dans le fond sur la base des données duration dans les secondes. Remarque : les appels ultérieurs pour contrôler le fait de faire pivoter le flotage dans/hors vont écraser les appels précédents.
  • Retours : null

FadeOutText

  • Paramètres : flotter : duration 0> duration0>
  • Description : Fades out le texte sur le given duration dans seconds. Note : les appels ultérieurs pour contrôler le fading in/out remplaceront les appels précédents.
  • Retours : null

FadeInText

  • Paramètres : flotter : duration 0> duration0>
  • Description : Disparaît dans le texte au-dessus de la valeur donnée duration dans secondes. Remarque : les appels ultérieurs pour contrôler la disparition dans/hors vont écraser les appels précédents.
  • Retours : null

ChatChannelUI

Le ChatChannelUI est la version client de ChatChannel. Il reçoit ChatMessages du serveur et les transmet à l'1>affiche-mensages de chat1>. associé.

Méthodes

Ajouter un message au canal

Supprimer le dernier message du canal

Effacer le journal des messages

Afficher le chat

Le ChatMessageLogDisplay gère le rendu de ChatMessages dans un ChatChannelUI.

Méthodes

Ajouter un message

  • Paramètres : Message de chatmessage
  • Description : Ajoute un message à l'afficheur de journal des messages.
  • Retours : null

Supprimer le dernier message

  • Paramètres : Aucun
  • Description : Supprime le plus ancien Message de chat dans l'afficheur de messages.
  • Retours : null

Réorganiser tous les messages

  • Paramètres : Aucun
  • Description : Réorganise tous les messages affichés dans l'ordre, en fonction de la taille de l'afficheur de message. Ceci devrait être appelé si le message log est réorganisé.
  • Retours : null

Effacer

  • Paramètres : Aucun
  • Description : Supprime tous les ChatMessages du message log display.
  • Retours : null

FadeOutText

  • Paramètres : flotterduration
  • Description : Fades out le texte sur le given duration dans seconds. Note : les appels ultérieurs pour contrôler le fading in/out remplaceront les appels précédents.
  • Retours : null

FadeInText

  • Paramètres : flotterduration
  • Description : Disparaît dans le texte au-dessus de la valeur donnée duration dans secondes. Remarque : les appels ultérieurs pour contrôler la disparition dans/hors vont écraser les appels précédents.
  • Retours : null

État de chat personnalisé

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

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

Appels

Mise à jour du texte

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

Obtenir le message

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

Message de fin du processus

  • Paramètres : Aucun
  • Description : Appelé lorsque le joueur soumet le message qui est en cours de traitement par l'état personnalisé. Cela devrait retourner vrai si le message ne devrait pas être affiché ou envoyé au serveur.
  • Retours : boule

Détruire

  • Paramètres : Aucun
  • Description : Appelé comme le ChatBar est réinitialisé en son état d'origine avant la modification d'état personnalisée.
  • Retours : null

Paramètres du chat

Le ChatSettings 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 1> Chat 1>, sous le 4> Folder4> nommé 7> ClientChatModule

Pour modifier un paramètre, exigez ce module en utilisant un LocalScript dans les façons suivantes :

-- Requiert 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

Glisser la fenêtre

Redimensionner la fenêtre

GamepadRotation activée

  • Type : boule
  • Par défaut: false
  • Description : Détermine si les gamepads peuvent naviguer dans l'interface de discussion.

Afficher le message filtré par l'utilisateur

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

ChatOnWithTopBarOff

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

BubbleChatActivé

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

Chat classique activé

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

Paramètres de taille du texte de chat

Taille de chat

Taille de chatBar

  • Type : int
  • Par défaut: 18
  • Description : Détermine la taille du texte dans le ChatBar .

Taille de chatWindowTextSizePhone

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

Taille du chatBarText

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

Paramètres de police

Police par défaut

Barre de chat

Paramètres de couleur

Couleur arrière-plan

  • Type : Color3
  • Par défaut : Color3.new(0, 0, 0)
  • Description : Détermine la couleur de l'arrière-plan BackgroundColor3 de la fenêtre de discussion.

Couleur de message par défaut

  • Type : Color3
  • Par défaut: Color3.new(1, 1, 1)
  • Description : Détermine la couleur par défaut TextColor3 de Message de chat dans la 0> fenêtre de chat0>.

Couleur nom par défaut

  • Type : Color3
  • Par défaut: Color3.new(1, 1, 1)
  • Description : Détermine la valeur par défaut de TextColor3 des noms des ChatMessages dans la 0> fenêtre de chat0>.

Couleur de l'arrière-plan de chat

  • Type : Color3
  • Par défaut : Color3.new(0, 0, 0)
  • Description : Détermine la couleur de l'arrière-plan BackgroundColor3 de la barre de discussion.

Couleur de la barre de chat

  • Type : Color3
  • Par défaut: Color3.new(1, 1, 1)
  • Description : Détermine la couleur de l'arrière-plan BackgroundColor3 de la barre de discussion ChatBar.

Couleur de texte de chat

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

Couleur de texte de message d'erreur

  • Type : Color3
  • Par défaut: Color3.fromRGB(245, 50, 50)
  • Description : Détermine la couleur de l'erreur.

Paramètres de fenêtre

Taille de fenêtre minimale

  • Type : UDim2
  • Par défaut: UDim2.new(0.3, 0, 0.25, 0)
  • Description : Détermine la taille la plus petite possible de la brouillière de discussion (généré le WindowResizable ).

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 brouillière de discussion (généré lorsque WindowResizable est activé).
  • Notes : Si ceci est modifié pour être plus grand que la taille de l'écran complet, des choses étranges commencent à se produire avec les limites de taille/position en vérifiant.

Position de fenêtre par défaut

Taille de fenêtre par défaut

  • 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 discussion 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 discussion sur les tables.

Taille de fenêtre par défaut

  • 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 discussion sur le bureau.

Fade Out et In Settings

Temps de fondu de la fenêtre de chat

  • Type : flotter (secondes)
  • Par défaut: 0.5
  • Description : Détermine la durée de la dissolution de l'arrière-plan de la fenêtre de discussion.

ChatWindowTextFadeOutTime

  • Type : flotter (secondes)
  • Par défaut: 30
  • Description : Détermine la durée de la disparaissance du texte dans la fenêtre de discussion.

Durée de chat par défaut

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

ChatShouldFadeInFromNewInformation

  • Type : boule
  • Par défaut: false
  • Description : Détermine si le chat devrait disparaître lorsque vous recevez de nouveaux messages.

Animer le chat FPS

  • Type : flotter
  • Par défaut: 20.0
  • Description : Détermine la framerate des animations de dégradé dans l'interface de chat.

Paramètres du canal

Nom général du canal

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

EchoMessagesInGeneralChannel

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

Nom de MaxChannelName

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

Longueur du message par canal

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

Afficher le texte de l'invitation et des informations de départ

  • Type : boule
  • 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 Message de chat.

Espace blanc non autorisé

  • Type : tableau< string >
  • Par défaut: {"\n", "\r", "\t", "\v", "\f"}
  • Description : Détermine les caractères de police qui ne sont pas autorisés.

Cliquez sur le nom du joueur pour lui souffler

  • Type : boule
  • Par défaut: true
  • Description : Détermine si le joueur peut cliquer sur le nom d'un autre joueur pour discuter en privé avec eux.

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

  • Type : boule
  • 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 leur chat (chat privé)principal.

Paramètres divers

Noms de commande WhisperCommandAutoCompletePlayer

  • Type : boule
  • Par défaut: true
  • Description : Détermine si la commande Whisper devrait automatiquement compléter les noms des joueurs.

Événements

Paramètres modifiés

  • Paramètres : Library.string``settingName , variante 0> newValue0>
  • Description : Feux quand un paramètre avec le settingName donné est changé en newValue .