TextChannel
*Dieser Inhalt wurde mit KI (Beta) übersetzt und kann Fehler enthalten. Um diese Seite auf Englisch zu sehen, klicke hier.
Repäsentiert einen Text-Chat-Kanal. Enthält TextSources als Nachkommen.
Um eine Chat-Nachricht an den TextChannel zu senden, rufe TextChannel:SendAsync() von einem LocalScript . Die entsprechende 1> Class.TextSource1> des Benutzers mit 4> TextSource.CanSend = true4> muss in diesem Kanal sein.
Nachrichten von verschiedenen Textkanälen können in der Chat-Fenster mit ChannelTabsConfiguration getrennt werden.
Um mehr zu erfahren, siehe In-Experience Text-Chat.
Zusammenfassung
Methoden
Zeigt dem Benutzer eine Systemnachricht an.
Fügt eine TextSource zu dem TextChannel , der dem Benutzer-ID eines Player gegeben wird.
Sendet eine TextChatMessage an den Server.
Ereignisse
Feuert, wenn TextChannel:DisplaySystemMessage() auf dem Client aufgerufen wird, oder wenn der Client eine gültige TextChannel:SendAsync() Antwort vom Server erhält.
Callbacks
Ausgerufen, wenn TextChannel eine eingehende Nachricht erhält.
Ausgerufen für jeden Client, wenn TextChannel eine einkommende Nachricht erhält, um zu bestimmen, ob sie an diesen Client geliefert werden sollen.
Eigenschaften
Methoden
DisplaySystemMessage
Zeigt eine Systemnachricht an den Benutzer an. Kann nur in einem LocalScript oder in einem Script mit RunContext von 2>Ennum.RunContext.Client2> angezeigt werden. Nachrichten sind nur für diesen Benutzer sichtbar und werden nicht automatisch gefiltert oder lokalisiert.
Parameter
Die Systemnachricht, die an den TextChannel gesendet wird.
Verwenden, um Systemnachrichtenarten zu identifizieren, wie die Standardnachrichten.
Rückgaben
Ein TextChatMessage mit TextChatMessage.Status Eigenschaft, die die Zustand der Nachricht anzeigt.
AddUserAsync
Fügt eine TextSource zu dem TextChannel des Benutzers hinzu, der angegebene User-ID (mit Player.UserId ) ist. Kann nur in einem 2>Class.Script2> verwendet werden.
Wenn ein TextSource , das den Benutzer repräsentiert, nicht existiert, fügt dies einen TextSource hinzu.
Wenn ein TextSource , das den Benutzer repräsentiert, existiert, gibt dies die TextSource zurück.
Wenn der Benutzer den Chat aus oder nicht in dem Server ist, gibt dies eine Liste zurück nil , false .
Parameter
Die UserId des Class.Player .
Rückgaben
Kehrt TextSource und true zurück, wenn ein neuer TextSource für den Benutzer erstellt wird, 1> Class.TextSource1> und 4> false4> , wenn es ein bestehend
SendAsync
Sendet eine TextChatMessage an den Server. Kann nur in einem LocalScript oder in einem Script mit 1> Class.Script.RunContext|RunContext1> von 4> Ennum.RunContext.Client4> verwendet werden.
Parameter
Die Nachricht an die TextChannel.
Benutzerdefinierte Metadaten, die an die Nachricht angehängt werden.
Rückgaben
Ein TextChatMessage mit TextChatMessage.Status Eigenschaft, die die Zustand der Nachricht anzeigt.
Ereignisse
MessageReceived
Wie TextChatService.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 TextChannel.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
Der erhaltene TextChatMessage .
Callbacks
OnIncomingMessage
Ausgerufen, wenn TextChannel 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.
TextChannel.OnIncomingMessage -Rückrufe immer nach dem Class.TextChatService.OnIncomingMessageCallback.
Dies sollte nur einmal pro TextChannel im Codesdefiniert sein. Mehrere Bindungen an dieselbe Kanalüberschreiben sich gegenseitig in einer nicht deterministischen Weise.
Wenn TextChatService:CreateDefaultTextChannels() wahr ist, haben diese Standard- TextChannels ihre internen TextChannel.OnIncomingMessage -Rückrufe, um ein spezielles Standardverhalten anzuzeigen.
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.
ShouldDeliverCallback
Ausgerufen für jeden Client, wenn TextChannel eine einkommende Nachricht erhält, um zu bestimmen, ob sie an diesen Client geliefert werden sollen. Kann nur auf dem Server definiert werden.
Nach der Festlegung muss dieser Rückruf eine wahre Werte wie true , 1 oder "hello" zurückgeben, um die Nachricht an den angegebenen Client zu liefern. Wenn der Rückruf irgendwelche anderen Werte zurückgibt (einschließlich 1> nil1> ) , wird die Nachricht nicht an diesen Client geliefert, obwohl der Sender die Nachricht trotzdem sehen wird.
Der Absender kann durch TextChatMessage.TextSource verwendet werden.