Moduły czatu strony klienta

Ten przewodnik obejmuje moduły czatu strony klienta z systemu czatu dziedzicznego, który został wycofany i nie jest już wdrażany w nowych użytkownikach na rzecz TextChatService z łatwiejszymi i bardziej nowoczesnymi ustawieniami czatu.Jeśli używasz domyślnego systemu czatu zasilanego przez TextChatService, zobacz czat tekstowy w doświadczeniu.

Możesz użyć następujących modułów czatu, aby wspierać zachowania strony klienta w systemie czatu Legacy.

Okienko czatu

Okienko czatu jest głównym modułem czatu ze strony klienta systemu Legacy Chat .

Metody

Dodaj kanał

Parametry: string : channelName
Opis: Dodaje ChatChannelUI z danym channelName do okna.
Powroty: ChatChannelUI

Usuń kanał

Parametry: string : channelName
Opis: Usuwa ChatChannelUI z danym channelName z okna.
Powroty: puste

Zdobądź kanał

Parametry: string : channelName
Opis: Zdobądź ChatChannelUI z podanym channelName jeśli istnieje.
Powroty: ChatChannelUI lub nil

Zdobądź obecny kanał

Parametry: string : channelName
Opis: Powraca obecny ChatChannelUI.
Powroty: ChatChannelUI

Przełącz kanał obecny

Parametry: string : channelName
Opis: Przełącza obecny kanał na kanał ChatChannelUI z podanym channelName, jeśli istnieje.
Powroty: puste

Zostań widoczny

Parametry: Żadne
Opis: Powraca, czy okno jest widoczne, czy nie.Uwaga: odnosi się to do interfejsu czatu w ogólne; gdy okno czatu zanika do przeźroczystości z powodu braku aktywności, okno nadal jest uważane za widoczne.
Powroty: bool

Ustaw widoczne

Parametry: bool : visible
Opis: Ustawia widoczność okna czatu.
Powroty: puste

Wyblakły tłok tła

Parametry: pływanie : duration
Opis: Zanika tło w ciągu kilku sekund nad danym duration .Uwaga: późniejsze wezwania do kontroli zanikania w/w będą zastępować wcześniejsze wezwania.
Powroty: puste

Rozpłynięcie w tle

Parametry: pływanie : duration
Opis: Zanika w tle za określone duration.Uwaga: późniejsze wezwania do kontroli zanikania w/w będą zastępować wcześniejsze wezwania.
Powroty: puste

Wyblakły tekst

Parametry: pływanie : duration
Opis: Zanika tekst nad podanym w ciągu kilku sekund.Uwaga: późniejsze wezwania do kontroli zanikania w/w będą zastępować wcześniejsze wezwania.
Powroty: puste

Wyblaknący tekst

Parametry: pływanie : duration
Opis: Zanika w tekście w ciągu duration sekund.Uwaga: późniejsze wezwania do kontroli zanikania w/w będą zastępować wcześniejsze wezwania.
Powroty: puste

Pasek czatu

Pasek czatu obsługuje wejście tekstowe po stronie klienta dla systemu czatu Lua. Istnieją dwa kluczowe komponenty paska czatu:

Pasek czatu , gdzie gracz wpisuje wiadomości i komendy (podświetlone w pomarańczu)
Tryb wiadomości , który może wyświetlać informacje o wysyłanej wiadomości (podświetlone w zieleni)

Metody

Zdobądź edytor tekstu

Parametry: Żadne
Opis: Zwraca TextBox z paska czatu.
Powroty: TextBox

Otrzymaj etykietę tekstu trybu wiadomości

Parametry: Żadne
Opis: Powraca wiadomość Mode TextLabel .
Powroty: TextLabel

Jest skupiony

Parametry: Żadne
Opis: Powraca, czy pasek czatu TextBox jest w fokusie (gracz pisze w pudełku).Równoznaczne z wezwaniem TextBox:IsFocused na wynik GetTextBox.
Powroty: bool

Skupienie na nagraniu

Parametry: Żadne
Opis: Zmusza klienta do skupienia się na TextBox pasku czatu. Równoznaczne z wezwaniem TextBox:CaptureFocus na wynik GetTextBox.
Powroty: puste

Fuzja uwagi uwolnienia

Parametry: bool : submitted = false
Opis: Uwalnia uwagę paska czatu TextBox .Jeśli submitted jest prawdą, zachowa się tak, jakby gracz naciśnięty Enter, aby wysłać wiadomość.
Powroty: puste

Zresetuj tekst

Parametry: Żadne
Opis: Ustawia Text pasek czatu TextBox na pustą ciąg.
Powroty: puste

Ustaw tekst w polu tekstowym

Parametry: string : text
Opis: Ustawia Text pasek czatu TextBox do podanego text.
Powroty: puste

Zdobądź tekst okienka

Parametry: Żadne
Opis: Powraca tekst w pasku czatu TextBox.Text .
Powroty: string

Ustaw tekst etykiety tekstu

Parametry: string : text
Opis: Ustawia Text z MessageMode TextLabel do podanego text.
Powroty: puste

Zostań aktywowany

Parametry: Żadne
Opis: Powraca, czy pasek czatu jest Visible .
Powroty: bool

Włączone ustawienie

Parametry: bool : enabled
Opis: Ustawia, czy pasek czatu jest Visible.
Powroty: puste

Ustaw rozmiar tekstu

Parametry: int : textSize
Opis: Ustawia TextSize zarówno TextBox pasek czatu, jak i MessageMode TextLabel.
Powroty: puste

Zresetuj rozmiar

Parametry: Żadne
Opis: Zmienia rozmiar paska czatu do jednej linii tekstu.
Powroty: puste

Ustaw cel kanału

Parametry: string : channelName
Opis: Ustawia cel ChatChannelUI podany jego channelName do którego pasek czatu powinien przesyłać wiadomości.
Powroty: puste

Wyblakły tłok tła

Parametry: pływanie : duration``duration
Opis: Zanika tło w ciągu kilku sekund nad danym duration .Uwaga: późniejsze wezwania do kontroli zanikania w/w będą zastępować wcześniejsze wezwania.
Powroty: puste

Rozpłynięcie w tle

Parametry: pływanie : duration``duration
Opis: Zanika w tle za określone duration.Uwaga: późniejsze wezwania do kontroli zanikania w/w będą zastępować wcześniejsze wezwania.
Powroty: puste

Wyblakły tekst

Parametry: pływanie : duration``duration
Opis: Zanika tekst nad podanym w ciągu kilku sekund.Uwaga: późniejsze wezwania do kontroli zanikania w/w będą zastępować wcześniejsze wezwania.
Powroty: puste

Wyblaknący tekst

Parametry: pływanie : duration``duration
Opis: Zanika w tekście w ciągu duration sekund.Uwaga: późniejsze wezwania do kontroli zanikania w/w będą zastępować wcześniejsze wezwania.
Powroty: puste

Kanał czatu UI

The ChatChannelUI jest wersją klienta ChatChannel.Otrzymuje wiadomości z czatu od serwera i przekazuje je dalej do logu wiadomości czatu.związane z nim.

Metody

Dodaj Wiadomość do Kanału

Parametry: Wiadomość czatu
Opis: Dodaje wiadomość czatu otrzymaną z serwera do ChatMessageLogDisplay.
Powroty: puste

Usuń ostatnią wiadomość z kanału

Parametry: Żadne
Opis: Usuwa najstarszą wiadomość czatu znalezioną w logu czatu.
Powroty: puste

Wyczyść dziennik wiadomości

Parametry: Żadne
Opis: Usuwa wszystkie wiadomości czatu w logu czatu.
Powroty: puste

Log wyświetlania wiadomości czatu

Funkcja ChatMessageLogDisplay zarządza renderowaniem Wiadomości czatu w ChatChannelUI.

Metody

Dodaj wiadomość

Parametry: Wiadomość czatumessage
Opis: Dodaje message do wyświetlania dziennika wiadomości.
Powroty: puste

Usuń ostatnią wiadomość

Parametry: Żadne
Opis: Usuwa najstarszą Wiadomość czatu w logu wiadomości.
Powroty: puste

Przegrupuj wszystkie wiadomości

Parametry: Żadne
Opis: Przesortuje wszystkie wyświetlenia wiadomości w kolejności rosnącej, względem rozmiaru wyświetlania wiadomości.Należy to wezwać, jeśli wyświetlanie dziennika wiadomości zostanie zmienione.
Powroty: puste

Wyczyść

Parametry: Żadne
Opis: Usuwa wszystkie wiadomości czatu z wyświetlenia dziennika wiadomości.
Powroty: puste

Wyblakły tekst

Parametry: pływanieduration
Opis: Zanika tekst nad podanym w ciągu kilku sekund.Uwaga: późniejsze wezwania do kontroli zanikania w/w będą zastępować wcześniejsze wezwania.
Powroty: puste

Wyblaknący tekst

Parametry: pływanieduration
Opis: Zanika w tekście w ciągu duration sekund.Uwaga: późniejsze wezwania do kontroli zanikania w/w będą zastępować wcześniejsze wezwania.
Powroty: puste

Status niestandardowy czatu

The ChatCustomState jest interfejsem interfejsu wezwań używanych podczas tworzenia niestandardowego stanu czatu w pasku czatu.

Cichy czat i czat zespołu wykorzystują ChatCustomState, aby wskazać graczowi, gdzie jego wiadomość zostanie zd.

Wezwania powrotne

Tekst zaktualizowany

Parametry: Żadne
Opis: Wezwany, gdy tekst w pasku czatu zostanie zaktualizowany.
Powroty: puste

Otrzymaj wiadomość

Parametry: Żadne
Opis: Wezwano w celu odzyskania tekstu wiadomości, ponieważ zostanie on napisany jako pojedyncze polecenie.Wykorzystuje się to w przypadku, gdy serwer musi przetworzyć polecenie jako tekst, a nie wizualny stan polecenia.
Powroty: string

Wiadomość o zakończonym procesie

Parametry: Żadne
Opis: Wezwany, gdy gracz wysyła wiadomość, która jest przetwarzana przez niestandardowy stan.Powinno to zwrócić prawdę, jeśli wiadomość nie powinna być wyświetlana lub wysyłana na serwer.
Powroty: bool

Zniszcz

Parametry: Żadne
Opis: Wezwano jako pasek czatu zostaje zresetowany do pierwotnego stanu przed zmianą stanu niestandardowego.
Powroty: puste

Ustawienia czatu

The Ustawienia czatu jest słownikiem ustawień dla strony klienta systemu czatu Lua.Są przechowywane w ModuleScript nazywanym ChatSettings, który można znaleźć w środku usługi gry Chat, pod nazwą Folder o nazwie ClientChatModule.Moduł może być wymagany, a jego właściwości mogą być zmieniane podczas czasu wykonania.

Aby zmienić ustawienie, wymagaj tego modułu za pomocą LocalScript w następujący sposób:


-- Wymagaj modułu ChatSettings (poczekaj, aż się wczytywać)
local Chat = game:GetService("Chat")
local ClientChatModules = Chat:WaitForChild("ClientChatModules")
local ChatSettings = require(ClientChatModules:WaitForChild("ChatSettings"))
-- Zmień ustawienia tak, jak zrobiłbyś to z każdym innym stołem.
ChatSettings.MaximumMessageLength = 100

Ustawienia zachowania czatu

Przesuwalne okno

Typ: bool
Domyślnie: false
Opis: Określa, czy okno czatu jest Draggable.

Okno dostosowywalne

Typ: bool
Domyślnie: false
Opis: Określa, czy okno czatu może zostać zmienione przez gracza

Włączona nawigacja gamepada

Typ: bool
Domyślnie: false
Opis: Określa, czy pady mogą nawigować po interfejsie czatu.

Pokaż wiadomość przefiltrowaną przez użytkownika

Typ: bool
Domyślnie: true
Opis: Określa, czy gracze powinni zobaczyć filtrowaną wersję swoich wiadomości czatu, czy oryginalną treść, którą wpisali.

Rozmowa z paskiem górnym wyłączona

Typ: bool
Domyślnie: false
Opis: Określa, czy interfejs czatu jest włączony, nawet jeśli pasek górny jest wyłączony.

BubbleChatWłączone

Typ: bool
Domyślnie: game:GetService("Players").BubbleChat
Opis: Określa, czy czat bąbelkowy jest włączony.

KlasycznyChatWłączony

Typ: bool
Domyślnie: game:GetService("Players").ClassicChat
Opis: Określa, czy włączono klasyczny czat.

Ustawienia rozmiaru tekstu czatu

Rozmiar okna czatu

Typ: int
Domyślnie: 18
Opis: Określa rozmiar tekstu w oknie czatu.

Rozmiar tekstu w czacie

Typ: int
Domyślnie: 18
Opis: Określa rozmiar tekstu w pasku czatu.

Rozmiar tekstu okna czatuPhone

Typ: int
Domyślnie: 14
Opis: Określa rozmiar tekstu w oknie czatu na telefony.

Rozmiar tekstu czatuBarPhone

Typ: int
Domyślnie: 14
Opis: Określa rozmiar tekstu w pasku czatu dla telefonów.

Ustawienia czcionki

Domyślna czcionka

Typ: Enum.Font
Domyślnie: Enum.Font.SourceSansBold
Opis: Określa domyślną Font z ChatWindow.

Font czatu

Typ: Enum.Font
Domyślnie: Enum.Font.SourceSansBold
Opis: Określa domyślną z paska czatu .

Ustawienia kolorów

Kolor tła

Typ: Color3
Domyślnie: Color3.new(0, 0, 0)
Opis: Określa BackgroundColor3 z ChatWindow.

Domyślny kolor wiadomości

Typ: Color3
Domyślnie: Color3.new(1, 1, 1)
Opis: Określa domyślną TextColor3 wartość wiadomości czatu w oknie czatu.

Domyślna nazwa koloru

Typ: Color3
Domyślnie: Color3.new(1, 1, 1)
Opis: Określa domyślną TextColor3 nazwę mówcy wiadomości czatu w oknie czatu.

Kolor tła czatu BarBackGroundColor

Typ: Color3
Domyślnie: Color3.new(0, 0, 0)
Opis: Określa BackgroundColor3 z paska czatu.

Kolor pudełka czatu

Typ: Color3
Domyślnie: Color3.new(1, 1, 1)
Opis: Określa BackgroundColor3ChatBarTextBox .

Kolor tekstu w pasku czatu

Typ: Color3
Domyślnie: Color3.new(0, 0, 0)
Opis: Określa TextColor3 z paska czatu.

Kolor wiadomości o błędzie

Typ: Color3
Domyślnie: Color3.fromRGB(245, 50, 50)
Opis: Określa TextColor3 błędów wiadomości.

Ustawienia okna

Minimalny rozmiar okna

Typ: UDim2
Domyślnie: UDim2.new(0.3, 0, 0.25, 0)
Opis: Określa najmniejszy możliwy rozmiar okna ChatWindow (biorąc pod uwagę, że WindowResizable jest włączone).

Maksymalny rozmiar okna

Typ: UDim2
Domyślnie: UDim2.new(1, 0, 1, 0)
Opis: Określa największy możliwy rozmiar okna ChatWindow (biorąc pod uwagę, że WindowResizable jest włączone).
Notatki: Jeśli to zostanie zmienione, aby być większe niż rozmiar pełnego ekranu, zaczynają się dziać dziwne rzeczy z kontrolą granic rozmiaru/pozycji.