Moduły czatu strony klienta | Dokumentacja

Ta przewodnik dotyczy modułów czatu strony klienta z systemu czatu dziedzicznego, który jest przestarzały i nie jest już wdrożeniem nowych użytkowników na rzecz łatwiejszych i bardziej nowoczesnych ustawień czatu. Jeśli używasz domyślnego systemu czatu zasilanego przez TextChatService, zobacz TextChatService

Możesz użyć następujący moduły czatu, aby wspierać stronę klienta zachowań Legacy Chat System.

Okienko czatu

ChatWindow jest głównym modułem czatu strony klienta systemu czatu dziedzictwa.

Metody

Dodaj kanał

Parametry: string : channelName
Opis: Dodaje ChatChannelUI z podanym channelName do okna.
Wrócić: ChatChannelUI

Usuń kanał

Parametry: string : channelName
Opis: Usunie ChatChannelUI z okienka.
Wynik: void

Zdobądź kanał

Parametry: string : channelName
Opis: Zdobądź ChatChannelUI z podanym channelName jeśli istnieje.
Wróщает: ChatChannelUI lub nil

Zdobądź bieżący kanał

Parametry: string : channelName
Opis: Wróci bieżący ChatChannelUI .
Wrócić: ChatChannelUI

Przełącz kanał

Parametry: string : channelName
Opis: Przełącza bieżący kanał na ChatChannelUI z podanym channelName jeśli istnieje.
Wynik: void

Ukryj

Parametry: Brak
Opis: Wrócić, czy okno jest widoczne lub nie. Uwaga: to odnosi się do ogólnego interfejsu czatu; gdy okno czatu zanika z powodu nieskończoności, okno jest nadal uważane za widoczne.
Wyniki: bułka

Pokaż

Parametry: bool : visible
Opis: Ustawia widoczność okna czatu.
Wynik: void

Tło FadeOut

Parametry: float : duration
Opis: Przejściowe wyłączenie tła nad danym duration w sekundach. Uwaga: późniejsze wezwania do kontroli przejściowych wyłączeń będą wyłączać wcześniejsze wezwania.
Wynik: void

FadeInTłoń

Parametry: float : duration
Opis: Zniknie na tle zgodnie z podanym duration w sekundach. Uwaga: późniejsze wezwania do kontroli zanikania będą nadpisywać wcześniejsze wezwania.
Wynik: void

Wyłącz tekst

Parametry: float : duration
Opis: Zniknie tekst nadany duration w sekundach. Uwaga: późniejsze wezwania do kontroli zanikania będą nadrukować wcześniejsze wezwania.
Wynik: void

FadeInText

Parametry: float : duration
Opis:: Zniknie w tekście nadany duration w sekundach. Uwaga: późniejsze wezwania do kontroli zanikania będą nadrukować wcześniejsze wezwania.
Wynik: void

Czat

ChatBar zarządza wpisami tekstowymi strony klienta dla systemu czatu Lua. Jest to jeden z dwóch kluczowych składników ChatBar:

ChatBar , a TextBox , gdzie gracz wpisuje wiadomości i komendy (zaznaczone pomarańczowym)
MessageMode , a TextLabel , które może wyświetlać informacje o wysyłanej wiadomości (zaznaczony na zielonym)

Metody

Zdobądź zmianę

Parametry: Brak
Opis: Wrócić TextBox z baru czatu.
Wyniki: TextBox

Zdobądź etykietę wiadomości

Parametry: Brak
Opis: Wróщает Mode wiadomości TextLabel .
Wróć: TextLabel

Jest skupiony

Parametry: Brak
Opis: Wrócić, czy TextBox bary czatu jest w skupieniu (gracz wpisuje w pudełko). Równoznaczne z wezwanie TextBox:IsFocused na wyniku Get:`Box`a.
Wyniki: bułka

Zdobądź koncentrację

Parametry: Brak
Opis: Zmusza klienta do skupienia się na TextBox balku czatu. Równoznaczne z wzywaniem TextBox:CaptureFocus na wyniku Get:` Texas.
Wynik: void

Zwolnij

Parametry: bułka : submitted = false
Opis: Releases the focus of the chat bar TextBox . If submitted is true, this will behave as if the player pressed Enter to submit the wiadomość.
Wynik: void

Zresetuj tekst

Parametry: Brak
Opis: Ustawia Text bary czatu TextBox na pustą ciąg.
Wynik: void

Ustaw tekst

Parametry: string : text
Opis: Ustawia Text bary czatu TextBox na 0> text0> danych.
Wynik: void

Zdobądź tekst Box

Parametry: Brak
Opis: Wróщает tekst w oknie czatu TextBox.Text .
Wyniki: string

Ustaw tekstowy label tekstu

Parametry: string : text
Opis: Ustawia Text MessageMode TextLabel na dany 0> text0> .
Wynik: void

Uruchom

Parametry: Brak
Opis: Wrócić, czy bar czatu jest Visible .
Wyniki: bułka

ZmieńUstawienia

Parametry: bool : enabled
Opis: Ustawia, czy Visible.
Wynik: void

Ustaw rozmiar tekstu

Parametry: int : textSize
Opis: Ustawia TextSize obu barw czatu TextBox i MenuMode 0> TextLabel0> .
Wynik: void

Zresetuj rozmiar

Parametry: Brak
Opis: Zresetuje rozmiar czatu do jednej linii tekstu.
Wynik: void

Ustaw cel kanału

Parametry: string : channelName
Opis: Ustawia cel ChatChannelUI zadanym jego channelName, do którego kanał czatu powinien wysyłać wiadomości.
Wynik: void

Tło FadeOut

Parametry: float : duration 0> duration0>
Opis: Przejściowe wyłączenie tła nad danym duration w sekundach. Uwaga: późniejsze wezwania do kontroli przejściowych wyłączeń będą wyłączać wcześniejsze wezwania.
Wynik: void

FadeInTłoń

Parametry: float : duration 0> duration0>
Opis: Zniknie na tle zgodnie z podanym duration w sekundach. Uwaga: późniejsze wezwania do kontroli zanikania będą nadpisywać wcześniejsze wezwania.
Wynik: void

Wyłącz tekst

Parametry: float : duration 0> duration0>
Opis: Zniknie tekst nadany duration w sekundach. Uwaga: późniejsze wezwania do kontroli zanikania będą nadrukować wcześniejsze wezwania.
Wynik: void

FadeInText

Parametry: float : duration 0> duration0>
Opis:: Zniknie w tekście nadany duration w sekundach. Uwaga: późniejsze wezwania do kontroli zanikania będą nadrukować wcześniejsze wezwania.
Wynik: void

Interfejs czatu

ChatChannelUI jest klient-stroną wersji ChatChannel. Otrzymuje ChatMessages z serwera i przekazuje je na 1>ChatMessageLogDisplay1> związany z nim.

Metody

Dodaj wiadomość do kanału

Parametry: ChatMessage
Opis: Dodaje wiadomość o czacie otrzymaną z serwera do ChatMessageLogDisplay .
Wynik: void

Usuń ostatnią wiadomość z kanału

Parametry: Brak
Opis: Usuwa najstarszy znaleziony w ChatMessageLogDisplay .
Wynik: void

WyczyśćDziennik

Parametry: Brak
Opis: Usuwa wszystkie ChatMessages w ChatMessageLogDisplay.
Wynik: void

Wyświetlacz znaków czatu

ChatMessageLogDisplay zarządza renderowaniem ChatMessages w ChatChannelUI.

Metody

DodajMesyż

Parametry: CzatMessagemessage
Opis: Dodaje message do wyświetlenia ekranu z wiadomościami.
Wynik: void

Usuń ostatnią wiadomość

Parametry: Brak
Opis: Usuwa najstarszy ChatMessage w dyskach logach.
Wynik: void

Zresetuj wszystkie wiadomości

Parametry: Brak
Opis: Zwraca wszystkie wyświetlanie wiadomości w rosnącym porządku, względem rozmiaru wyświetlania wiadomości. To powinno być nazywane, jeśli wyświetlanie dziennika wiadomości jest zmieniane.
Wynik: void

Wyczyść

Parametry: Brak
Opis: Usunie wszystkie ChatMessages z ekranu logu wiadomości.
Wynik: void

Wyłącz tekst

Parametry: floatduration
Opis: Zniknie tekst nadany duration w sekundach. Uwaga: późniejsze wezwania do kontroli zanikania będą nadrukować wcześniejsze wezwania.
Wynik: void

FadeInText

Parametry: floatduration
Opis:: Zniknie w tekście nadany duration w sekundach. Uwaga: późniejsze wezwania do kontroli zanikania będą nadrukować wcześniejsze wezwania.
Wynik: void

Stan bicia

ChatCustomState to interfejs wezwania używany do tworzenia niestandardowego stanu czatu w oknie czatu.

Cicho czat i czat zespołu używają ChatCustomState, aby zindykowacj miejsce, w którym ich wiadomość zostanie zd.

Wezwania

Aktualizowano tekst

Parametry: Brak
Opis: Zadzwoniono, gdy tekst w oknie czatu jest aktualizowany.
Wynik: void

Zdobądź wiadomość

Parametry: Brak
Opis: Wezwano, aby odzyskać tekst wiadomości, ponieważ będzie ona zapisana jako jeden komunikat. Jest to używane w przypadku, gdy serwer musi przetworzyć komunikat jako tekst, a nie wizualny stan komunikatu.
Wyniki: string

Ukończono przetwarzanie wiadomości

Parametry: Brak
Opis: Zadzwonił, gdy gracz wysyłał wiadomość, która jest przetwarzana przez niestandardowy stan. To powinno zwrócić prawdę, jeśli wiadomość nie powinna być wyświetlana lub wysłana na serwer.
Wyniki: bułka

Zniszcz

Parametry: Brak
Opis: Zadzwoniono jako ChatBar jest resetowane do swojego pierwotnego stanu przed modyfikacją stanu niestandardowego.
Wynik: void

Ustawienia czatu

ChatSettings to słownik ustawień dla strony klienta systemu Lua Chat. Są one zapisane w ModuleScript o nazwie ChatSettings, które można znaleźć w grze 1> Czat1> pod adresem 4> Folder4> nazyającym się 7>ClientChatModule

Aby zmienić ustawienie, wymagaj tego modułu używając LocalScript następującego sposób:


-- Wymaga 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, jak w przypadku dowolnej innej tabeli.
ChatSettings.MaximumMessageLength = 100

Ustawienia zachowania czatu

OkienkoDraggable

Typ: bułka
Domyślnie: false
Opis: Determines, czy Okienko czatu jest Draggable .

Zmiana rozmiaru okna

Typ: bułka
Domyślnie: false
Opis: Determines, czy Okienko czatu może być zmniejszone przez gracza

WłączoneGamepadRotation

Typ: bułka
Domyślnie: false
Opis: Determines, czy gamepady mogą przeglądać interfejs czatu.

PokażUżytkownikOwnFilteredMessage

Typ: bułka
Domyślnie: true
Opis: Determines, czy gracze powinni widzieć filtrowaną wersję wiadomości czatu lub oryginalny treści, którą wpisali.

ChatOnWithTopBarOff

Typ: bułka
Domyślnie: false
Opis: Determines, czy interfejs czatu jest włączony, nawet jeśli topbar jest wyłączony.

Włączony do BubbleChat

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

KlasycznyCzatWłączony

Typ: bułka
Domyślny: game:GetService("Players").ClassicChat
Opis: Determines, czy klasyczny czat jest włączony.

Ustawienia rozmiaru tekstu czatu

Rozmiar tekstu czatu

Typ: int
Domyślny:: 18
Opis: Determines the size of the text in the Okienku czatu .

Rozmiar tekstu czatu

Typ: int
Domyślny:: 18
Opis: Determines rozmiar tekstu w ChatBar .

Wielkość tekstu czatu

Typ: int
Domyślny:: 14
Opis: Determines rozmiar tekstu w ChatWindow dla telefonów.

Wielkość tekstu czatu

Typ: int
Domyślny:: 14
Opis: Determines rozmiar tekstu w ChatBar dla telefonów.

Ustawienia czcionki

Domyślny czcionki

Typ: Enum.Font
Domyślny: Enum.Font.SourceSansBold
Opis: Determines the default Font of the Czat okienko .

CzatBarFont

Typ: Enum.Font
Domyślny: Enum.Font.SourceSansBold
Opis:: Określa domyślną Font dla Baru czatu 0> Executor0> .

Ustawienia kolorów

Kolor tła

Typ: Color3
Domyślny: Color3.new(0, 0, 0)
Opis: Determines the BackgroundColor3 of the Okienko czatu.

Domyślny kolor wiadomości

Typ: Color3
Domyślny: Color3.new(1, 1, 1)
Opis: Determines the default TextColor3 of ChatMessages in the 0> ChatWindow0> .

Domyślny kolor nazwy

Typ: Color3
Domyślny: Color3.new(1, 1, 1)
Opis: Determines the default TextColor3 of nazwiskaw przestawowych ChatMessages w 0>ChatWindow0> .

Kolor tła chatu

Typ: Color3
Domyślny: Color3.new(0, 0, 0)
Opis: Determines the BackgroundColor3 of the ChatBar .

Kolor ChatBarBox

Typ: Color3
Domyślny: Color3.new(1, 1, 1)
Opis: Determines the BackgroundColor3 of the ChatBar 0> Executor0> .

Kolor tekstu czatu

Typ: Color3
Domyślny: Color3.new(0, 0, 0)
Opis: Determines the TextColor3 of the ChatBar .

KolorNapisuBłędu

Typ: Color3
Domyślny: Color3.fromRGB(245, 50, 50)
Opis: Określa TextColor3 błędnych wiadomości.

Ustawienia Okien

Maksymalny rozmiar okna

Typ: UDim2
Domyślnie: UDim2.new(0.3, 0, 0.25, 0)
Opis: Determines najmniejszy rozmiar możliwego Okienka czatu (given that WindowResizable is enabled).

Maksymalna wielkość okna

Typ: UDim2
Domyślnie: UDim2.new(1, 0, 1, 0)
Opis: Determines the largest possible size of the Okienko czatu (given that Zmiana rozmiaru okien is enabled).
Notatki: Jeśli ta opcja jest zmieniona na większą niż rozmiar ekranu pełnego, dziwne rzeczy zaczynają się dziać z kontrolą granic rozmiarów/pozycji.