TextChannel

Pokaż przestarzałe

*Ta zawartość została przetłumaczona przy użyciu narzędzi AI (w wersji beta) i może zawierać błędy. Aby wyświetlić tę stronę w języku angielskim, kliknij tutaj.

Reprezentuje kanał czatu tekstowego. Zawiera TextSources jako potomnych.

Aby wysłać wiadomość czatu na TextChannel, wezwij TextChannel:SendAsync() z LocalScript . Odpowiedni 1> Class.TextSource1> użytkownika z 4> TextSource.CanSend = true4> musi być w tym kanał.

Wiadomości z różnych kanałów tekstowych można podzielić na różne zakładki w oknie czatu używając ChannelTabsConfiguration .

Aby dowiedzieć się więcej, zobacz czat tekstowy w doświadczeniu.

Podsumowanie

Metody

Wywołania zwrotne

Właściwości

DirectChatRequester

Tylko do odczytu
Bez replikacji
Odczyt równoległy

Metody

DisplaySystemMessage

Pokazuje użytkownikowi wiadomość systemową. Można go używać tylko w LocalScript lub Script z RunContext . Wiadomości są widoczne tylko dla tego użytkownika i nie są automatycznie filtrowane ani lokalizowane.

Parametry

systemMessage: string

Wiadomość systemowa wysłana do TextChannel .

metadata: string

Użyj do identyfikacji typów wiadomości systemowych, takich jak wiadomości systemowe domyślne.

Wartość domyślna: ""

Zwroty

A TextChatMessage z TextChatMessage.Status właściwością, która wskazuje na stan wiadomość.

SetDirectChatRequester

void

Parametry

requester: Player

Zwroty

void

AddUserAsync

Wynik

Doduje TextSource do TextChannel użytkownika (z Player.UserId ) z możliwością użycia tylko w 2>Class.Script2> .

Jeśli TextSource reprezentujący użytkownika nie istnieje, to dodaje się TextSource .

Jeśli istnieje TextSource reprezentujący użytkownika, to zwraca TextSource.

Jeśli użytkownik ma wyłączoną opcję czatu lub nie jest na serwerze, to zwraca się tupe nil , false .

Parametry

userId: number

Class.Player .


Zwroty

Zwraca TextSource i true jeśli użytkownik utworzy nowy TextSource dla użytkownika, 1> Class.TextSource1> i 4> false4> jeśli istnie

Wynik

Wyświetla TextChatMessage na serwer. Może być używany tylko w LocalScript lub Script z 2> Class.Script.RunContext|RunContext2> z 5> Ennum.RunContext.Client5> .

Parametry

message: string

Wiadomość do wysłania na TextChannel .

metadata: string

Niestandardowe metadane do przyłączenia do wiadomość.

Wartość domyślna: ""

Zwroty

A TextChatMessage z TextChatMessage.Status właściwością, która wskazuje na stan wiadomość.

Zdarzenia

MessageReceived

Podobnie jak TextChannel:DisplaySystemMessage(), działa, gdy TextChannel:SendAsync() jest wzywany na klientu lub gdy klient otrzymuje ważną 1> Class.TextChannel:SendAsync() od serwera. Ten wąż jest uruchomiony tylko na klientu.

Jeśli właściwość TextChannel.ShouldDeliverCallback serwera jest związana i zwraca false, kliент nie będzie wysyłał TextChannel.MessageReceived .

Użyj parametru TextChatMessage, aby uzyskać TextSource i tekst wiadomości (z TextChatMessage.Text).

Parametr TextChatMessage jest wynikiem końcowym dowolnych funkcji związanych z TextChatService.OnIncomingMessage lub TextChannel.OnIncomingMessage .

Parametry

incomingMessage: TextChatMessage

Otrzymano TextChatMessage .


Wywołania zwrotne

OnIncomingMessage

Wyzwany, gdy TextChannel otrzymuje wiadomość. Można to zaimplementować tylko na klientach.

Użyj tego, aby ozdobić TextChatMessages . Jeśli ten zwrotny kalendarz zwraca TextChatMessageProperties, te właściwości są połączone z parametrem TextChatMessage, aby stworzyć nowy 1> Class.TextChatMessage1> .

Gdy wiązany z wysyłaniem wiadomości na klienta, ten zwrotny callback jest wykonany dwa razy; pierwszy, gdy wiadomość zostanie najpierw wysłana i otrzymana lokalnie, a ponownie, gdy klient otrzyma wynik filtrowanej wiadomości z serwera.

TextChannel.OnIncomingMessage wiadomości zawsze będą wykonane po wiadomości z wiadomości z wiadomości z wiadomości z wiadomości z wiadomości z wiadomości z wiadomości z wiadomości z wiadomości z wiadomości z wiadomości z wiadomości z wiadomości z wiadomości z wiadomości z wiadomości z wiadomości z wiadomości z wiadomości z wiadomości z wiadomości z wiadomości z w

To powinno być zdefiniowane tylko raz w TextChannel w kodzie źródłowym. Wieloma wiązaniami do tego samego kanału będzie się nakładać niedeterministyczny sposób.

Gdy TextChatService:CreateDefaultTextChannels() jest prawdą, te domyślne TextChannels mają swoje wewnętrznie przydzielone TextChannel.OnIncomingMessage w celu wykonania specjalnego zachowania domyślnego.

Parametry

Przychodzące TextChatMessage .


Zwroty

Jeśli TextChatMessageProperties zostanie zwrócony, te właściwości są łączone z parametrem TextChatMessage, aby stworzyć nowy TextChatMessage z tymi właściwościami.

ShouldDeliverCallback

Wywołany dla każdego klienta, gdy TextChannel otrzymuje wходяce wiadomość, aby określić, czy powinna być dostarczona do tego klienta. Można ustawić tylko na serwerze.

Po zdefiniowaniu tego zwrotu, ten zwrot musi zwrócić prawdziwą wartość, taką jak true , 1 lub "hello", aby dostarczić wiadomość do powyższego klienta. Jeśli zwrot zwraca jakikolwiek inny wynik (w tym 1> nil1> ) lub wiadomość nie zostanie dostarczona do

Wyślij można zacytować przez TextChatMessage.TextSource .

Parametry

textSource: TextSource

Zwroty