TextChatService

Veraltete anzeigen

*Dieser Inhalt wurde mit KI (Beta) übersetzt und kann Fehler enthalten. Um diese Seite auf Englisch zu sehen, klicke hier.

Nicht erstellbar
Dienst

Eine Dienstleistung, die In-Experience-Text-Chat-Handling, einschließlich der Verwaltung von Kanälen, Dekoration von Nachrichten, Filtern von Text, Erstellung von Befehlen und Entwicklung benutzerdefinierter Chat-Schnittstellen.

Um mehr zu erfahren, siehe In-Experience Text-Chat.

Zusammenfassung

Eigenschaften

Methoden

Ereignisse

Callbacks

Eigenschaften

ChatTranslationEnabled

Nicht repliziert
Roblox-Skript-Sicherheit
Parallel lesen

ChatVersion

Nicht zugängliche Sicherheit
Parallel lesen

Bestimmt, ob TextChatService vollständig aktiviert werden soll oder auf das Legacy-Chat-System zurückgegriffen werden soll. Wenn Sie diese Eigenschaft auf Enum.ChatVersion.LegacyChatService setzen, deaktivieren Sie effektiv TextChatService.

CreateDefaultCommands

Plugin-Sicherheit
Parallel lesen

Bestimmt, ob TextChatService standardmäßige TextChatCommands erzeugen sollte.

Wenn true, the following TextChatCommands are created and put in a Folder named TextChatCommands inside 1> Class.TextChatService1> :


<tbody>
<tr>
<td><b>RBXClearCommand</b></td>
<td>löschen</td>
<td>cls</td>
<td>Löscht das Chat-Log für den lokalen Benutzer.</td>
<td><code>/cls</code></td>
</tr>
<tr>
<td><b>RBXKonsoleCommande</b></td>
<td>konsole</td>
<td />
<td>Öffnet die Entwicklerkonsole.</td>
<td><code>/console</code></td>
</tr>
<tr>
<td><b>RBXEmoteCommand.</b></td>
<td>emote</td>
<td>e</td>
<td>Spielt ein Avatar-Emote ab.</td>
<td><code>/e tanz</code></td>
</tr>
<tr>
<td><b>RBXHelpCommand</b></td>
<td>helfen</td>
<td>?</td>
<td>Zeigt eine Liste der Chat-Befehle an.</td>
<td><code>/help</code></td>
</tr>
<tr>
<td><b>RBXMuteCommand</b></td>
<td>stummschalten</td>
<td>f</td>
<td>Stummt einen Benutzer durch seine <code>Class.Player.Name|Name</code> oder <code>Class.Player.DisplayName|Name</code> in allen <code>Class.TextChannel|TextChannels</code>.</td>
<td><code>/m Benutzername</code></td>
</tr>
<tr>
<td><b>RBXTeamCommand</b></td>
<td>team</td>
<td>t</td>
<td>Betritt den Team-Chat-Modus, in dem Nachrichten nur für Teamkollegen sichtbar sind.</td>
<td><code>/t</code></td>
</tr>
<tr>
<td><b>RBXUnmuteCommand</b></td>
<td>stummschaltung aufheben</td>
<td>um</td>
<td>Stummt ein Benutzer durch seine <code>Class.Player.Name|Name</code> oder <code>Class.Player.DisplayName|Name</code> in allen <code>Class.TextChannel|TextChannels</code>.</td>
<td><code>/um Benutzername</code></td>
</tr>
<tr>
<td><b>RBXVersionCommand</b></td>
<td>version</td>
<td>v</td>
<td>Zeigt die Chat-Version an.</td>
<td><code>/version</code></td>
</tr>
<tr>
<td><b>RBXWhisperCommand</b></td>
<td>flüstern</td>
<td>w</td>
<td>Betritt den Whisper-Modus mit einem weiteren <code>Class.Player</code>.</td>
<td><code>/w DisplayName</code> oder <code>/w @Username</code></td>
</tr>
</tbody>
NamePrimäre AliasSekundär-AliasBeschreibungBeispiel für die Verwendung

Beachten Sie, dass Sie TextChatCommands bearbeiten, erstellen und entfernen, auch wenn CreateDefaultCommands wahr ist. Beachten Sie auch, dass Stummschalt- und Mute-Befehle auf alle TextChannels angewandt werden.

CreateDefaultTextChannels

Plugin-Sicherheit
Parallel lesen

Bestimmt, ob


<tbody>
<tr>
<td><b>RBXGeneral</b></td>
<td><code>Class.TextChannel</code> für Spieler-Nachrichtungen. Im Chat-Fenster werden Nachrichten modifiziert, sodass <code>Class.TextChatMessage.PrefixText|PrefixText</code> eine <a href="../../../ui/rich-text.md">reiche Textfarbe-Namensschrift</a> erhalten, um den Chat-Spielern ihren einzigartigen Namenfarben zu geben. Wenn 0> Class.Player.Team0> existiert, wird stattdessen die Standard-</td>
</tr>
<tr>
<td><b>RBXSystem</b></td>
<td><code>Class.TextChannel</code> für Systemnachrichten. Im Chat-Fenster werden Nachrichten modifiziert, sodass <code>Class.TextChatMessage.Text</code> standardmäßig hellgrau ist, oder ein roter Farb-Tag, wenn <code>Class.TextChatMessage.Metric</code> das Wort 0>„Error“0> enthält.</td>
</tr>
<tr>
<td><b>RBXTeam\[BrickColor]</b></td>
<td> Class.TextChannel</td>
</tr>
<tr>
<td><b>RBXWhisper:\[userId1]\_\[userId2]</b></td>
<td><code>Class.TextChannel</code> für WhatsApp-Nachrichten zwischen zwei Spieler:in, die erstellt werden, wenn ein Spieler die /whisper</td>
</tr>
</tbody>
KanalBeschreibung

Beachten Sie, dass die Standard- TextChannel.OnIncomingMessage -Rückrufe überschrieben werden können. Beachten Sie auch, dass Sie TextChannels bearbeiten, erstellen und entfernen, auch wenn CreateDefaultTextChannels wahr ist.

Nachrichten von verschiedenen Textkanälen können in der Chat-Fenster mit ChannelTabsConfiguration getrennt werden.

Methoden

DisplayBubble

void

Zeigt eine Chat-Blase über der angezeigten Teil oder dem benutzereingebrachten Charakter an und feuert das Ereignis BubbleDisplayed mit den angegebenen Parametern mit diesem Methoden an. Kann Blasen für nicht-Spieler-Charaktere (NPCs) anzeigen, wenn Sie ein Teil innerhalb des Charakters, wie sein Kopf, spezifizieren.

Beachten Sie, dass diese Methode nur für die Verwendung in LocalScript oder in einem Script mit RunContext von 1>Ennum.RunContext.Client1> verfügbar ist.

Parameter

partOrCharacter: Instance

Der Teil oder Charakter, der die Blase oben angezeigt wird.

message: string

Der Text, der in der Chat-Blase angezeigt wird.


Rückgaben

void

CanUserChatAsync

Angehalten

Parameter

userId: number

Rückgaben

CanUsersChatAsync

Angehalten

Parameter

userIdFrom: number
userIdTo: number

Rückgaben

CanUsersDirectChatAsync

Angehalten

Bestimmt, ob ein Benutzer die Erlaubnis hat, direkt mit anderen Benutzern in Erlebnissen basierend auf seinen elterlichen Kontroll-Einstellungen, zu chatten. Wird verwendet, wenn:

  • Die Kommunikationslinie wird von Benutzern initiiert (nicht von Entwicklern oder Spielen begonnen)
  • Der Zugriff auf die Kommunikation ist geschlossen und begrenzt

Parameter

requesterUserId: number
userIds: Array

Rückgaben

Code-Beispiele

This example checks if two users can chat, creates a new TextChannel, and adds them to it.

CanUsersDirectChatAsync

local TextChatService = game:GetService("TextChatService")
local directChatParticipants = TextChatService:CanUsersDirectChatAsync(userId1, { userId2 })
-- Check for eligible participants
if #directChatParticipants > 0 then
local directChannel = Instance.new("TextChannel")
directChannel.Parent = TextChatService
for _, participant in directChatParticipants do
directChannel:AddUserAsync(participant)
end
return directChannel
end
warn("Could not create TextChannel. Not enough eligible users.")
return nil

Ereignisse

BubbleDisplayed

Feuert ab, wenn TextChatService:DisplayBubble() aufgerufen wird.

Parameter

partOrCharacter: Instance
textChatMessage: TextChatMessage

MessageReceived

Wie TextChannel.MessageReceived , wird ausgelöst, wenn TextChannel:DisplaySystemMessage() auf dem Client ausgeführt wird, oder wenn der Client eine gültige TextChannel:SendAsync() -Antwort vom Server erhält. Dieses Ereignis wird nur auf dem Client ausgelöst.

Wenn die Eigenschaft TextChannel.ShouldDeliverCallback des Servers gebunden ist und false zurückgibt, wird der Client keine TextChatService.MessageReceived feuern.

Verwenden Sie den TextChatMessage-Parameter, um die TextSource und den Text der Nachricht zu erhalten (mit TextChatMessage.Text).

Der TextChatMessage -Parameter ist das endgültige Ergebnis jeder Funktionen, die an TextChatService.OnIncomingMessage oder TextChannel.OnIncomingMessage gebunden sind.

Parameter

textChatMessage: TextChatMessage

Der erhaltene TextChatMessage .


SendingMessage

Feuert, wenn TextChannel:SendAsync() vom Sender-Client aufgerufen wird. Verwenden Sie dies, um Platzhalter-Nachrichten anzuzeigen, während Sie auf die Antwort des Servers warten, um TextChannel:SendAsync() .

Parameter

textChatMessage: TextChatMessage

Callbacks

OnBubbleAdded

Ausgerufen, wenn ein Blasen-Chat kurz davor ist, angezeigt zu werden. Dies kann nur auf dem Client implementiert werden.

Verwenden Sie dies, um einzelne Bubble-Chat-Nachrichten anzupassen. Wenn dieser Rückruf ein BubbleChatMessageProperties zurückgibt, werden diese Eigenschaften auf das zugeordnete Bubble an

Wenn die Chat-Nachricht von einem Spieler:ingesendet wird, message.TextSource wird mit diesem Spieler:inübereinstimmen, und adornee wird mit nil sein.

Wenn die Chat-Nachricht über TextChatService:DisplayBubble() gesendet wird, wird adornee der partOrCharacter bereitgestellt, und 1> message.TextSource1> wird der 4> nil4> sein.

Parameter

Der einkommende TextChatMessage .

adornee: Instance

Der Teil oder Charakter, dem sich die Blasen-Chat-Nachricht anhängt.


Rückgaben

Wenn ein TextChatMessage zurückgegeben wird, werden diese Eigenschaften auf die zugeordnete Blase angewendet, wodurch BubbleChatConfiguration Eigenschaften überschrieben werden.

OnChatWindowAdded

Ausgerufen, wenn eine neue Nachricht im Chat-Fenster angezeigt wird. Dies kann nur auf dem Client implementiert werden.

Verwenden Sie dies, um einzelne Nachrichten anzuzeigen, die im Chat-Fenster erscheinen. Wenn dieser Rückruf ein ChatWindowMessageProperties zurückgibt, werden diese Eigenschaften auf das zugeordnete Nachricht angewendet, wobei

Parameter

Der einkommende TextChatMessage .


Rückgaben

Wenn ein TextChatMessage zurückgegeben wird, werden diese Eigenschaften auf das zugeordnete Nachricht angewendet, wodurch ChatWindowConfiguration Eigenschaften überschrieben werden.

OnIncomingMessage

Ausgerufen, wenn TextChatService eine eingehende Nachricht erhält. Kann nur auf dem Client implementiert werden.

Verwenden Sie dies, um TextChatMessages zu dekorieren. Wenn dieser Rückruf ein TextChatMessageProperties zurückgibt, werden diese Eigenschaften mit dem TextChatMessage -Parameter zusammengeführt, um ein neues 2>Class.TextChatMessage2> zu erstellen.

Wenn Sie an den Client gebunden sind, der eine Nachricht sendet, wird diese Rückruf zweimal ausgeführt; zuerst, wenn die Nachricht ursprünglich lokal gesendet und erhalten wird, und erneut, wenn der Client das Ergebnis der gefilterten Nachricht vom Server erhält.

Beachten Sie, dass dieser TextChatService.OnIncomingMessage-Callback vor vor jeder TextChannel.OnIncomingMessage-Calls ausgeführt wird.

Dies sollte im Codesnur einmal definiert werden. Mehrere Bindungen überschreiben sich gegenseitig in einer nicht deterministischen Weise.

Parameter

Der einkommende TextChatMessage .


Rückgaben

Wenn ein TextChatMessageProperties zurückgegeben wird, werden diese Eigenschaften mit dem TextChatMessage -Parameter zusammengeführt, um ein neues TextChatMessage mit diesen Eigenschaften zu erstellen, ansonsten wird 1> nil1> zurückgegeben, dann 4> Class.TextChatMessage4> wird nicht geändert.