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 potomków.

Aby wysłać wiadomość czatu do TextChannel, zadzwoń TextChannel:SendAsync() z LocalScript.Odpowiedni TextSource użytkownika z TextSource.CanSend = true musi być na tym kanał.

Wiadomości z różnych kanałów tekstowych można oddzielić w różnych zakładkach w oknie czatu za pomocą ChannelTabsConfiguration .

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

Podsumowanie

Właściwości

  • Tylko do odczytu
    Bez replikacji
    Odczyt równoległy

    The TextChannel dostarczy tylko wiadomości do użytkowników, którzy mogą wysyłać bezpośrednie wiadomości do DirectChatRequester.

Metody

Zdarzenia

Wywołania zwrotne

Właściwości

DirectChatRequester

Tylko do odczytu
Bez replikacji
Odczyt równoległy

The TextChannel będzie dostarczać wiadomości tylko użytkownikom, którzy mogą wysyłać bezpośrednie wiadomości do DirectChatRequester. Ta właściwość może być ustawiona tylko za pomocą SetDirectChatRequester().

Metody

DisplaySystemMessage

Wyświetla wiadomość systemową dla użytkownika.Można go używać tylko w LocalScript lub w Script z RunContext z Enum.RunContext.Client.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.

Wartość domyślna: ""
metadata: string

Użyj, aby zidentyfikować typy wiadomości systemowych, takie jak domyślne wiadomości systemowe.

Wartość domyślna: ""

Zwroty

A TextChatMessage z właściwością TextChatMessage.Status wskazującą warunek wiadomość.

SetDirectChatRequester

()

Ustawia DirectChatRequester dla TextChannel. Ta metoda jest dostępna tylko do użytku w skryptach serwerowych.

Użyj tego API, jeśli pracujesz z TextChatService i masz niestandardową implementację czatu bezpośredniego poza kanałami tekstowymi domyślnymi.

Gdy wezwane na TextChannel, które jest powiązane z TextChatService i nie ma istniejącego TextSources, SetDirectChatRequester dodaje wymaganych użytkowników jako TextSource i ustawia właściwość DirectChatRequester dla kanału.

Gdy DirectChatRequester jest ustawiać, dostarczane są tylko wiadomości między użytkownikami, które mogą kierować czatem z DirectChatRequester .


local function createWhisperChannel(fromPlayer, toPlayer)
local whisperChannel = Instance.new("TextChannel")
whisperChannel:SetDirectChatRequester(fromPlayer)
whisperChannel:AddUserAsync(toPlayer.UserId)
-- Instancja TextChannel ma teraz dwie instancje źródła tekstu.
return whisperChannel
end

Parametry

requester: Player
Wartość domyślna: ""

Zwroty

()

AddUserAsync

Wynik

Dodaje TextSource do TextChannel podanego ID użytkownika (z Player.UserId ). Można go używać tylko w Script.

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

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

Jeśli użytkownik ma wyłączoną czat lub nie jest na serwerze, zwraca to tuple nil, false.

Parametry

userId: number

ID użytkownika Player .

Wartość domyślna: ""

Zwroty

Wyświetla i jeśli dla użytkownika zostanie utworzone nowe lub jeśli istnieje istniejący lub jeśli użytkownik ma wyłączoną czat lub nie jest na tym serwerze.

Wynik

Wysyła na serwer. Można go używać tylko w lub w z .

Parametry

message: string

Wiadomość do wysłania do TextChannel.

Wartość domyślna: ""
metadata: string

Niestandardowe metadane do przymocowania do wiadomość.

Wartość domyślna: ""

Zwroty

A TextChatMessage z właściwością TextChatMessage.Status wskazującą warunek wiadomość.

Zdarzenia

MessageReceived

Podobnie jak TextChatService.MessageReceived, zapala się, gdy TextChannel:DisplaySystemMessage() jest wzywany na klientzie, lub gdy klient otrzymuje ważną odpowiedź TextChannel:SendAsync() od serwera.To wydarzenie jest uruchamiane tylko na klientzie.

Jeśli właściwość serwera TextChannel.ShouldDeliverCallback jest wiązana i zwraca false, klient nie uruchomi TextChannel.MessageReceived.

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

Parametr TextChatMessage jest ostatecznym wynikiem każdej funkcji związanej z TextChatService.OnIncomingMessage lub TextChannel.OnIncomingMessage.

Parametry

incomingMessage: TextChatMessage

Otrzymany TextChatMessage .


Wywołania zwrotne

OnIncomingMessage

Wzywany, gdy TextChannel otrzymuje wходяcą wiadomość. Może być wdrożony tylko na klientzie.

Użyj tego, aby udekorować TextChatMessages .Jeśli ten powrót wezwania zwraca TextChatMessageProperties, właściwości te są łączone z parametrem TextChatMessage w celu utworzenia nowej TextChatMessage.

Po wiązaniu z klientem wysyłającym wiadomość ten powrót jest uruchamiany dwa razy; po raz pierwszy, gdy wiadomość jest początkowo wysyłana i odbierana lokalnie, a ponownie, gdy klient otrzymuje wynik filtrowanej wiadomości z serwera.

TextChannel.OnIncomingMessage wezwania zawsze uruchamiają się po wezwaniu TextChatService.OnIncomingMessage.

Powinno to być zdefiniowane tylko raz na TextChannel w kodzie źródłowym.Wiele wiązań do tego samego kanału zastąpi jeden drugiego w sposób niedeterministyczny.

Gdy jest prawdą, domyślne wezwania są przypisywane wewnętrznie, aby wyświetlić specjalne domyślne zachowanie.

Parametry

Otrzymujący TextChatMessage .


Zwroty

Jeśli zostanie zwrócony TextChatMessageProperties, te właściwości zostaną połączone z parametrem TextChatMessage w celu utworzenia nowej TextChatMessage z tymi właściwościami.

ShouldDeliverCallback

Wzywany dla każdego klienta, gdy TextChannel otrzymuje wходяcą wiadomość, aby określić, czy powinna być dostarczona do tego klienta, czy nie.Można go zdefiniować tylko na serwerze.

Po zdefiniowaniu ten powrót musi zwrócić prawdziwą wartość, taką jak true , 1 lub "hello" , aby dostarczyć wiadomość do tego klienta.Jeśli powrót wezwania zwraca coś innego (w tym nil ), wiadomość nie zostanie dostarczona do tego klienta, choć nadawca zobaczy wiadomość niezależnie.

Wysyłający może być odwołany przez TextChatMessage.TextSource, podczas gdy odbiorca jest argumentem textSource.Zauważ, że nadawca i odbiorca mogą być tacy sami, ponieważ powtarzacz odzywa się do wszystkich możliwych odbiorców.W Roblox Studio będziesz jedynym nadawcą i odbiorcą wiadomości w trybie solo Graj .

Parametry

Wiadomość wysyłana, która zawiera również nadawcę wiadomość.

textSource: TextSource

The TextSource użytkownika, który otrzyma wiadomość.


Zwroty