Du kannst die folgenden Chat-Module verwenden, um die Client-seitigen Verhaltensweisen des Legacy-Chat-Systems zu unterstützen.
Chatfenster
Das Chat-Fenster ist das Hauptchat-Modul der Clientseite des Legacy-Chat-Systems.
Methoden
Kanal hinzufügen
- Rückgaben: ChatChannelUI
Kanal entfernen
- Rückgaben: void
Channel erhalten
Erhalten Sie den aktuellen Kanal
- Beschreibung: Gibt die aktuelle ChatChannelUI zurück.
- Rückgaben: ChatChannelUI
Wechselkanal aktivieren
- Rückgaben: void
Sichtbar werden
- Parameter: Keine
- Beschreibung: Gibt zurück, ob das Fenster sichtbar ist oder nicht.Hinweis: Dies bezieht sich auf die Chat-UI im Allgemeinen; wenn das Chat-Fenster aufgrund der Inaktivität transparent wird, wird das Fenster immer noch als sichtbar angesehen.
- Rückgaben: bool
Sichtbar machen
- Beschreibung: Legt die Sichtbarkeit des Chat-Fensters fest.
- Rückgaben: void
FadeOutHintergrund
- Beschreibung: Verbleicht den Hintergrund über die angegebene duration in Sekunden aus.Hinweis: Spätere Anrufe zur Kontrolle des Verbleibens von In/Aus werden frühere Anrufe überschreiben.
- Rückgaben: void
FadeInBackground
- Beschreibung: Verschwindet im Hintergrund über die angegebene duration in Sekunden.Hinweis: Spätere Anrufe zur Kontrolle des Verbleibens von In/Aus werden frühere Anrufe überschreiben.
- Rückgaben: void
Ausblendentext
- Beschreibung: Löscht den Text über die angegebene duration in Sekunden aus.Hinweis: Spätere Anrufe zur Kontrolle des Verbleibens von In/Aus werden frühere Anrufe überschreiben.
- Rückgaben: void
FadeInText
- Beschreibung: Verschwindet im Text über die angegebene duration in Sekunden.Hinweis: Spätere Anrufe zur Kontrolle des Verbleibens von In/Aus werden frühere Anrufe überschreiben.
- Rückgaben: void
Chatbar
Die Chatbar verarbeitet die Texteingabe auf clientseitige für das Lua-Chat-System. Es gibt zwei wichtige Komponenten der Chatbar:
- Chatbar , eine TextBox , wo der Spieler Nachrichten und Befehle eingibt (hervorgehoben in orange)
- Nachrichtenmodus , ein TextLabel , das Informationen über die gesendete Nachricht anzeigen kann (hervorgehoben in grün)
Methoden
Erhalten Sie Textbox
- Parameter: Keine
- Beschreibung: Gibt die TextBox der Chatleiste zurück.
- Rückgaben: TextBox
GetMessageModeTextLabel erhalten
- Parameter: Keine
- Beschreibung: Gibt die Nachrichtenmodus zurück TextLabel .
- Rückgaben: TextLabel
Ist fokussiert
- Parameter: Keine
- Beschreibung: Gibt zurück, ob die Chat-Leiste TextBox im Fokus ist (Spieler tippt in die Auswahlbox).Äquivalent zu Aufrufen von TextBox:IsFocused auf dem Ergebnis von GetTextBox.
- Rückgaben: bool
Fokus aufnehmen
- Parameter: Keine
- Beschreibung: Erzwingt, dass der Client sich auf die TextBox des Chat-Balkens konzentriert. Äquivalent zu Aufrufen von TextBox:CaptureFocus auf das Ergebnis von GetTextBox.
- Rückgaben: void
Fokus auf Freigabe
- Beschreibung: Löst den Fokus der Chat-Leiste frei TextBox .Wenn submitted wahr ist, verhält sich dies, als ob der Spieler Enter drückt, um die Nachricht einzureichen.
- Rückgaben: void
Text zurücksetzen
- Parameter: Keine
- Beschreibung: Legt das Text der Chat-Leiste TextBox auf die leere Stringfest.
- Rückgaben: void
Textfeldtext einstellen
- Beschreibung: Legt das Text der Chatleiste TextBox auf die angegebene text fest.
- Rückgaben: void
Erhalten Sie Textbox-Text
- Parameter: Keine
- Beschreibung: Gibt den Text in der Chat-Leiste zurück TextBox.Text .
- Rückgaben: string
SetTextLabelText einstellen
- Beschreibung: Legt das Text des MessageModes TextLabel auf den angegebenen text fest.
- Rückgaben: void
AktivierenGetEnabled
- Parameter: Keine
- Beschreibung: Gibt zurück, ob die Chatleiste Visible ist.
- Rückgaben: bool
Aktiviert festlegen
- Beschreibung: Legt fest, ob die Chatleiste Visible ist.
- Rückgaben: void
Textgröße festlegen
- Beschreibung: Legt das TextSize von both the chat bar's TextBox und MessageMode TextLabel fest.
- Rückgaben: void
Größe zurücksetzen
- Parameter: Keine
- Beschreibung: Setzt die Größe der Chatleiste auf eine Zeile Text zurück.
- Rückgaben: void
Channelziel festlegen
- Beschreibung: Legt das Ziel ChatChannelUI fest, das seinem channelName entspricht, auf das die Chatleiste Nachrichten senden soll.
- Rückgaben: void
FadeOutHintergrund
- Beschreibung: Verbleicht den Hintergrund über die angegebene duration in Sekunden aus.Hinweis: Spätere Anrufe zur Kontrolle des Verbleibens von In/Aus werden frühere Anrufe überschreiben.
- Rückgaben: void
FadeInBackground
- Beschreibung: Verschwindet im Hintergrund über die angegebene duration in Sekunden.Hinweis: Spätere Anrufe zur Kontrolle des Verbleibens von In/Aus werden frühere Anrufe überschreiben.
- Rückgaben: void
Ausblendentext
- Beschreibung: Löscht den Text über die angegebene duration in Sekunden aus.Hinweis: Spätere Anrufe zur Kontrolle des Verbleibens von In/Aus werden frühere Anrufe überschreiben.
- Rückgaben: void
FadeInText
- Beschreibung: Verschwindet im Text über die angegebene duration in Sekunden.Hinweis: Spätere Anrufe zur Kontrolle des Verbleibens von In/Aus werden frühere Anrufe überschreiben.
- Rückgaben: void
ChatChannelUI
Die ChatChannelUI ist die Client-Seite-Version von ChatChannel.Es empfängt Chatnachrichten vom Server und leitet sie an den ChatMessageLogDisplay weiter.die damit verbunden sind.
Methoden
Nachrichten zum Kanal hinzufügen
Parameter: ChatMessage
Beschreibung: Fügt eine Chatnachricht, die vom Server empfangen wurde, zum ChatMessageLogDisplay hinzu.
Rückgaben: void
Letzte Nachricht vom Kanal entfernen
- Parameter: Keine
- Rückgaben: void
Klarer Nachrichtenlog
- Parameter: Keine
- Rückgaben: void
ChatMessageLogAnzeige
Die ChatMessageLogDisplay verwaltet die Rendering von Chatnachrichten in einer ChatChannelUI.
Methoden
Nachricht hinzufügen
- Beschreibung: Fügt ein message zum Nachrichtenlog-Anzeige hinzu.
- Rückgaben: void
Letzte Nachricht entfernen
- Parameter: Keine
- Beschreibung: Entfernt die älteste Chatnachricht im Nachrichtenlog-Anzeigebild.
- Rückgaben: void
Alle Nachrichten neu ordnen
- Parameter: Keine
- Beschreibung: Sortiert alle Nachrichtendisplays in aufsteigender Reihenfolge, relativ zur Größe des Nachrichtendisplays.Dies sollte aufgerufen werden, wenn das Nachrichtenlog-Anzeigefenster skaliert wird.
- Rückgaben: void
Löschen
- Parameter: Keine
- Beschreibung: Entfernt alle Chatnachrichten aus dem Nachrichtenlog-Anzeige.
- Rückgaben: void
Ausblendentext
- Beschreibung: Löscht den Text über die angegebene duration in Sekunden aus.Hinweis: Spätere Anrufe zur Kontrolle des Verbleibens von In/Aus werden frühere Anrufe überschreiben.
- Rückgaben: void
FadeInText
- Beschreibung: Verschwindet im Text über die angegebene duration in Sekunden.Hinweis: Spätere Anrufe zur Kontrolle des Verbleibens von In/Aus werden frühere Anrufe überschreiben.
- Rückgaben: void
ChatCustomState
Die ChatCustomState ist ein Interface von Rückrufen, die verwendet werden, wenn ein benutzerdefinierter Chat-Status in der Chat-Leiste erstellt wird.
Flüstern-Chat und Team-Chat verwenden ChatCustomState, um dem Spieler anzuzeigen, wo seine Nachricht gesendet wird.
Rückrufe
Text aktualisiert
- Parameter: Keine
- Beschreibung: Aufgerufen, wenn der Text in der Chat-Leiste aktualisiert wird.
- Rückgaben: void
ErhalteNachricht
- Parameter: Keine
- Beschreibung: Aufgerufen, um den Text der Nachricht abzurufen, wie er als einzelner Befehl geschrieben würde.Dies wird verwendet, wenn der Server die Befehle als Text verarbeiten muss, anstatt den visuellen Zustand des Befehls.
- Rückgaben: string
Prozessabgeschlossene Nachricht
- Parameter: Keine
- Beschreibung: Aufgerufen, wenn der Spieler die Nachricht abschickt, die vom benutzerdefinierten Zustand verarbeitet wird.Dies sollte wahr zurückgeben, wenn die Nachricht nicht angezeigt oder an den Server gesendet werden sollte.
- Rückgaben: bool
Zerstören
- Parameter: Keine
- Beschreibung: Aufgerufen, wenn die ChatBar auf ihren ursprünglichen Zustand zurückgesetzt wird, bevor die benutzerdefinierte Zustandsänderung durchgeführt wird.
- Rückgaben: void
Chat-Einstellungen
Die ChatSettings ist ein Wörterbuch von Einstellungen für die Clientseite des Lua-Chat-Systems.Sie werden in einem ModuleScript benannten ChatSettings gespeichert, das innerhalb des Chat Spieldienstes gefunden werden kann, unter dem Folder benannten ClientChatModule .Das Modul kann erforderlich sein und seine Eigenschaften können während der Laufzeit geändert werden.
Um eine Einstellung zu ändern, erfordern Sie dieses Modul mit einem LocalScript in der folgenden Weise:
-- Fordere das ChatSettings-Modul an (warte, bis es geladen ist)local Chat = game:GetService("Chat")local ClientChatModules = Chat:WaitForChild("ClientChatModules")local ChatSettings = require(ClientChatModules:WaitForChild("ChatSettings"))-- Ändere Einstellungen wie bei jedem anderen Tisch.ChatSettings.MaximumMessageLength = 100
Chat-Verhaltenseinstellungen
FensterZiehbaar
- Typ: bool
- Standard: false
Fenstergrößenanpassbar
- Typ: bool
- Standard: false
- Beschreibung: Legt fest, ob das Chatfenster vom Spieler:invergrößert werden kann
GamepadNavigationEnabled
- Typ: bool
- Standard: false
- Beschreibung: Legt fest, ob Gamepads die Chat-Benutzeroberfläche navigieren können.
ZeigeBenutzerOwnFilteredMessage
- Typ: bool
- Standard: true
- Beschreibung: Legt fest, ob Spieler die gefilterte Version ihrer Chatnachrichten oder den ursprünglichen Inhalt sehen sollen, den sie eingegeben haben.
Chatten mit der oberen Leiste aus
- Typ: bool
- Standard: false
- Beschreibung: Legt fest, ob die Chat-UI aktiviert ist, auch wenn die oberste Leiste deaktiviert ist.
Blasenchat aktiviert
- Typ: bool
- Standard: game:GetService("Players").BubbleChat
- Beschreibung: Legt fest, ob Blasenchat aktiviert ist.
Klassischer Chat aktiviert
- Typ: bool
- Standard: game:GetService("Players").ClassicChat
- Beschreibung: Legt fest, ob der klassische Chat aktiviert ist.
Chat-Textgrößen-Einstellungen
ChatWindowTextgröße
- Typ: int
- Standard: 18
- Beschreibung: Legt die Größe des Textes im Chat-Fenster fest.
ChatBarTextGröße
ChatWindowTextGrößeTelefon
- Typ: int
- Standard: 14
- Beschreibung: Legt die Größe des Textes im Chat-Fenster für Telefone fest.
ChatBarTextGrößePhone
- Typ: int
- Standard: 14
- Beschreibung: Legt die Größe des Textes in der Chatleiste für Telefone fest.
Schriftarten-Einstellungen
Standardschriftart
- Typ: Enum.Font
- Standard: Enum.Font.SourceSansBold
ChatBarFont
- Typ: Enum.Font
- Standard: Enum.Font.SourceSansBold
- Beschreibung: Legt das Standard der ChatBar fest.
Farb-Einstellungen
Hintergrundfarbe
- Typ: Color3
- Standard: Color3.new(0, 0, 0)
Standardmäßige Nachrichtenfarbe
- Typ: Color3
- Standard: Color3.new(1, 1, 1)
Standardnamefarbe
- Typ: Color3
- Standard: Color3.new(1, 1, 1)
ChatbarHintergrundfarbe
- Typ: Color3
- Standard: Color3.new(0, 0, 0)
ChatBarBoxFarbe
- Typ: Color3
- Standard: Color3.new(1, 1, 1)
ChatBarTextfarbe
- Typ: Color3
- Standard: Color3.new(0, 0, 0)
Fehlertextfarbe
- Typ: Color3
- Standard: Color3.fromRGB(245, 50, 50)
- Beschreibung: Legt das TextColor3 von Fehlermeldungen fest.
Fenster-Einstellungen
Mindestfenstergröße
- Typ: UDim2
- Standard: UDim2.new(0.3, 0, 0.25, 0)
- Beschreibung: Legt die kleinste mögliche Größe des ChatWindows (geben, dass WindowResizable aktiviert ist) fest.
Maximale Fenstergröße
- Typ: UDim2
- Standard: UDim2.new(1, 0, 1, 0)
- Anmerkungen: Wenn dies geändert wird, größer als die volle Bildschirmgröße zu sein, beginnen seltsame Dinge mit der Größen-/Position-Prüfung zu passieren.
Standardfensterposition
- Typ: UDim2
- Standard: UDim2.new(0, 0, 0, 0)
- Beschreibung: Legt die Standardposition des ChatWindows fest.
Standardfenstergröße Telefon
- Typ: UDim2
- Standard: UDim2.new(0.5, 0, 0.5, (7 * 2) + (5 * 2))
- Beschreibung: Legt die Standardgröße des ChatWindows auf Telefonen fest.
Standardfenstergröße-Tablet
- Typ: UDim2
- Standard: UDim2.new(0.4, 0, 0.3, (7 * 2) + (5 * 2))
- Beschreibung: Legt die Standardgröße des ChatWindows auf Tabellen fest.
Standardfenstergröße Desktop
- Typ: UDim2
- Standard: UDim2.new(0.3, 0, 0.25, (7 * 2) + (5 * 2))
- Beschreibung: Legt die Standardgröße des ChatWindows auf dem Desktop fest.
Aus- und Einstellungen verbleicht
ChatWindowBackgroundFadeOutZeit
- Typ: schwimmend (Sekunden)
- Standard: 0.5
- Beschreibung: Legt fest, wie lange der Hintergrund des ChatWindows ausblenden sollte.
ChatWindowTextFadeOutZeit
- Typ: schwimmend (Sekunden)
- Standard: 30
- Beschreibung: Legt fest, wie lange der Chat-Fenster-Text verschwinden sollte.
ChatDefaultFadeDauer
- Typ: schwimmend (Sekunden)
- Standard: 0.8
- Beschreibung: Legt fest, wie lange die Verblassung von Chat-UI-Elementen dauern sollte.
ChatShouldFadeInAusNeuerInformation
- Typ: bool
- Standard: false
- Beschreibung: Legt fest, ob der Chat verschwinden soll, wenn neue Nachrichten empfangen werden.
ChatanimationFPS
- Typ: schwimmend
- Standard: 20.0
- Beschreibung: Legt die Framerate von Verbleichungsanimationen in der Chat-UI fest.
Kanal-Einstellungen
Allgemeiner Kanalname
- Typ: string
- Standard: "All"
- Beschreibung: Legt den Namen des Kanalfest.
EchoNachrichtenImAllgemeinenKanal
- Typ: bool
- Standard: true
- Beschreibung: Legt fest, ob Nachrichten an Kanäle außer dem Standardkanal in den Kanaleingeleitet werden sollen.
MaxChannelNameLänge
- Typ: int
- Standard: 12
- Beschreibung: Legt die maximale Länge eines Kanalnamens fest, bevor er gekürzt wird.
Nachrichtenhistorielänge pro Kanal
- Typ: int
- Standard: 50
- Beschreibung: Legt die maximale Anzahl von Chatnachrichten fest, die in einem Chat-Kanal angezeigt werden können.
ZeigeJoinAndLeaveHelpText
- Typ: bool
- Standard: false
- Beschreibung: Legt fest, ob der Hilfetext für das Beitreten/Verlassen von Kanälen angezeigt wird.
Nachrichteneinstellungen
Maximale Nachrichtenlänge
- Typ: int
- Standard: 200
- Beschreibung: Legt die maximale Länge von Chatnachrichten fest.
Verbotener Weißer Raum
- Typ: Array< string >
- Standard: {"\n", "\r", "\t", "\v", "\f"}
- Beschreibung: Legt die Leerzeichencharaktere fest, die nicht erlaubt sind.
Klicken Sie auf Spielername, um zu flüstern
- Typ: bool
- Standard: true
- Beschreibung: Legt fest, ob der Spieler auf den Namen eines anderen Spieler:inklicken kann, um mit ihm in einen Whisper-Chat zu treten.
Klicken Sie auf ChannelName, um den Hauptkanal einzustellen
- Typ: bool
- Standard: true
- Beschreibung: Legt fest, ob der Spieler auf die Registerkarte eines Kanals klicken kann, um sie als Hauptkanal festzulegen.
Sonstige Einstellungen
Flüsterbefehl-Autocomplete-Spieler-Namen
- Typ: bool
- Standard: true
- Beschreibung: Legt fest, ob der Whisper-Befehl Spielernamen automatisch abschließen sollte.
Ereignisse
Einstellungen geändert
- Parameter: Library.string``settingName , Variante newValue
- Beschreibung: Feuert, wenn eine Einstellung mit dem angegebenen settingName geändert wird zu newValue.