Bạn có thể sử dụng các mô-đun trò chuyện sau đây để hỗ trợ các hành vi bên khách của hệ thống trò chuyện Legacy.
Cửa sổ trò chuyện
Cửa sổ trò chuyện ChatWindow là mô-đun trò chuyện chính của phía khách hàng của Hệ thống trò chuyện Cũ kỹ.
Phương pháp
Thêm kênh
- Trả lại: ChatChannelUI
Xóa kênh
- Trả về: void
Nhận kênh GetChannel
Nhận kênh hiện tại
- Mô tả: Trả về ChatChannelUI hiện tại.
- Trả lại: ChatChannelUI
Chuyển kênh hiện tại
- Trả về: void
Nhận hiển thị
- Tham số: Không có
- Mô tả: Trả về xem có cửa sổ hiển thị hay không.Lưu ý: điều này áp dụng cho giao diện trò chuyện trong tổng phổ quát; khi cửa sổ trò chuyện biến mất thành suốt do không hoạt động, cửa sổ vẫn được coi là hiển thị.
- Trả lại: bool
Bột hiển thị SetVisible
- Mô tả: Đặt hiển thị của cửa sổ trò chuyện.
- Trả về: void
Hoàn thành nền phông
- Mô tả: Nhạt dần nền trong vòng duration vài giây theo như đã cho.Lưu ý: các cuộc gọi sau này để kiểm soát sự biến mất sẽ thay thế các cuộc gọi trước.
- Trả về: void
FadeInBackground ở đằng sau
- Mô tả: Nhạt dần trong nền trong vòng duration giây theo được cung cấp.Lưu ý: các cuộc gọi sau này để kiểm soát sự biến mất sẽ thay thế các cuộc gọi trước.
- Trả về: void
Văn bản biến mất
- Mô tả: Nhạt dần văn bản trên được cho duration trong giây lát.Lưu ý: các cuộc gọi sau này để kiểm soát sự biến mất sẽ thay thế các cuộc gọi trước.
- Trả về: void
Văn bản biến mờ
- Mô tả: Nó biến mất trong văn bản trong vòng duration giây.Lưu ý: các cuộc gọi sau này để kiểm soát sự biến mất sẽ thay thế các cuộc gọi trước.
- Trả về: void
Thanh trò chuyện
The ChatBar điều khiển nhập văn bản bên khách cho hệ thống trò chuyện Lua. Có hai thành phần chính của ChatBar:
- ChatBar , một TextBox , nơi người chơi nhập tin nhắn và lệnh (được tô sáng màu cam)
- MessageMode , một TextLabel , có thể hiển thị thông tin về tin nhắn được gửi (được phát hightlight màu xanh lá)
Phương pháp
Nhận Textbox
- Tham số: Không có
- Mô tả: Trả về TextBox của thanh trò chuyện.
- Trả lại: TextBox
Nhận được MessageModeTextLabel
- Tham số: Không có
- Mô tả: Trả về MessageMode TextLabel .
- Trả lại: TextLabel
Tập trung IsFocused
- Tham số: Không có
- Mô tả: Trả về xem liệu thanh trò chuyện của TextBox có đang ở trong tâm trí (người chơi đang gõ vào hộp) hay không.Tương đương với việc gọi TextBox:IsFocused trên kết quả của GetTextBox.
- Trả lại: bool
Tập trung nắm bắt
- Tham số: Không có
- Mô tả: Buộc khách hàng tập trung vào TextBox của thanh trò chuyện. Tương đương với việc gọi TextBox:CaptureFocus trên kết quả của GetTextBox.
- Trả về: void
Tập trung phát hành
- Mô tả: Phát hành tập trung của thanh trò chuyện TextBox .Nếu submitted là đúng, nó sẽ hành xử như thể người chơi đã nhấn Enter để gửi tin nhắn.
- Trả về: void
Xóa bỏ văn bản
- Tham số: Không có
- Mô tả: Đặt Text của thanh trò chuyện TextBox vào chuỗi trống.
- Trả về: void
Bột văn bản SetTextBoxText
- Mô tả: Đặt Text của thanh trò chuyện TextBox vào text đã cho.
- Trả về: void
Nhận TextboxText
- Tham số: Không có
- Mô tả: Trả về văn bản trong thanh trò chuyện TextBox.Text .
- Trả lại: string
SetTextLabelText Đặt nhãn văn bản
- Mô tả: Đặt Text của MessageMode TextLabel vào text đã cho.
- Trả về: void
Nhận được kích hoạt
- Tham số: Không có
- Mô tả: Trả về xem thanh trò chuyện có phải là Visible hay không.
- Trả lại: bool
Bật được cho phép
- Mô tả: Bộ đặt xem liệu thanh trò chuyện có là Visible .
- Trả về: void
Thiết lập kích thước văn bản
- Mô tả: Đặt của cả thanh trò chuyện và MessageMode .
- Trả về: void
Đặt lại kích thước
- Tham số: Không có
- Mô tả: Tái đặt kích thước của thanh trò chuyện về một dòng văn bản.
- Trả về: void
Bộ mục tiêu kênh SetChannelTarget
- Trả về: void
Hoàn thành nền phông
- Mô tả: Nhạt dần nền trong vòng duration vài giây theo như đã cho.Lưu ý: các cuộc gọi sau này để kiểm soát sự biến mất sẽ thay thế các cuộc gọi trước.
- Trả về: void
FadeInBackground ở đằng sau
- Mô tả: Nhạt dần trong nền trong vòng duration giây theo được cung cấp.Lưu ý: các cuộc gọi sau này để kiểm soát sự biến mất sẽ thay thế các cuộc gọi trước.
- Trả về: void
Văn bản biến mất
- Mô tả: Nhạt dần văn bản trên được cho duration trong giây lát.Lưu ý: các cuộc gọi sau này để kiểm soát sự biến mất sẽ thay thế các cuộc gọi trước.
- Trả về: void
Văn bản biến mờ
- Mô tả: Nó biến mất trong văn bản trong vòng duration giây.Lưu ý: các cuộc gọi sau này để kiểm soát sự biến mất sẽ thay thế các cuộc gọi trước.
- Trả về: void
Kênh trò chuyệnUI
The ChatChannelUI là phiên bản bên khách của ChatChannel.Nó nhận Tin nhắn trò chuyện từ máy chủ và chuyển chúng sang ChatMessageLogDisplay.liên quan đến nó.
Phương pháp
Thêm tin nhắn vào kênh
Tham số: Tin nhắn trò chuyện
Mô tả: Thêm một tin nhắn trò chuyện nhận được từ máy chủ vào ChatMessageLogDisplay.
Trả về: void
Xóa tin nhắn cuối cùng từ kênh
- Tham số: Không có
- Trả về: void
Xóa nhật ký tin nhắn rõ ràng
- Tham số: Không có
- Trả về: void
Log hiển thị tin nhắn trò chuyện
The ChatMessageLogDisplay quản lý việc hiển thị Tin nhắn trò chuyện trong một ChatChannelUI.
Phương pháp
Thêm tin nhắn
- Mô tả: Thêm một message vào bảng hiển thị nhật ký tin nhắn.
- Trả về: void
Xóa tin nhắn cuối cùng
- Tham số: Không có
- Mô tả: Loại bỏ Tin nhắn trò chuyện lâu đời nhất trong log tin nhắn hiển thị.
- Trả về: void
Sắp xếp lại tất cả các tin nhắn
- Tham số: Không có
- Mô tả: Xếp lại tất cả các hiển thị tin nhắn theo thứ tự tăng dần, tương quan với kích thước hiển thị tin nhắn.Nó nên được gọi nếu nhật ký tin nhắn bị thay đổi kích cỡ.
- Trả về: void
Xóa bỏ
- Tham số: Không có
- Mô tả: Loại bỏ tất cả Tin nhắn trò chuyện từ log tin nhắn hiển thị.
- Trả về: void
Văn bản biến mất
- Mô tả: Nhạt dần văn bản trên được cho duration trong giây lát.Lưu ý: các cuộc gọi sau này để kiểm soát sự biến mất sẽ thay thế các cuộc gọi trước.
- Trả về: void
Văn bản biến mờ
- Mô tả: Nó biến mất trong văn bản trong vòng duration giây.Lưu ý: các cuộc gọi sau này để kiểm soát sự biến mất sẽ thay thế các cuộc gọi trước.
- Trả về: void
Trạng thái trò chuyện tùy chỉnh
The ChatCustomState là một giao diện của các cuộc gọi trả lại được sử dụng khi tạo một trạng thái trò chuyện tùy chỉnh trong thanh trò chuyện.
Trò chuyện lén lút và trò chuyện đội sử dụng ChatCustomState để chỉ cho người chơi nơi tin nhắn của họ sẽ được khoản
Các cuộc gọi trở lại
Văn bản được cập nhật
- Tham số: Không có
- Mô tả: Gọi khi văn bản trong thanh trò chuyện được cập nhật.
- Trả về: void
Nhận tin nhắn
- Tham số: Không có
- Mô tả: Gọi để lấy lại văn bản của tin nhắn như nó sẽ được viết như một lệnh duy nhất.Điều này được sử dụng trong trường hợp máy chủ cần xử lý lệnh dưới dạng văn bản, thay vì tình trạng hiển thị của lệnh.
- Trả lại: string
Tin nhắn hoàn thành quá trình
- Tham số: Không có
- Mô tả: Gọi khi người chơi gửi tin nhắn đang được xử lý bởi trạng thái tùy chỉnh.Điều này nên trả về true nếu tin nhắn không nên hiển thị hoặc gửi đến máy chủ.
- Trả lại: bool
Phá hủy
- Tham số: Không có
- Mô tả: Được gọi là ChatBar đang được đặt lại về trạng thái ban đầu trước khi thay đổi trạng thái tùy chỉnh.
- Trả về: void
Cài đặt trò chuyện
Cài đặt ChatSettings là một từ điển các cài đặt cho phía khách của hệ thống trò chuyện Lua.Chúng được lưu trong một ModuleScript có tên Cài đặt trò chuyện , có thể được tìm thấy bên trong dịch vụ trò chơi Chat , dưới cái tên Folder có tên ClientChatModules .Mô-đun có thể được yêu cầu và các thuộc tính của nó có thể được thay đổi trong thời gian chạy.
Để thay đổi một cài đặt, yêu cầu mô-đun này bằng cách sử dụng LocalScript ở cách sau:
-- Yêu cầu mô-đun ChatSettings (chờ đợi nó tải)local Chat = game:GetService("Chat")local ClientChatModules = Chat:WaitForChild("ClientChatModules")local ChatSettings = require(ClientChatModules:WaitForChild("ChatSettings"))-- Thay đổi cài đặt như bạn sẽ với bất kỳ bảng khác.ChatSettings.MaximumMessageLength = 100
Cài đặt hành vi chat
Cửa sổ có thể kéo
- Loại: bool
- Mặc định: false
Cửa sổ có thể thay đổi kích thước
- Loại: bool
- Mặc định: false
- Mô tả: Xác định xem ChatWindow có thể được thay đổi kích cỡ bởi người chơi hay không
Bật chế độ điều hướng Gamepad
- Loại: bool
- Mặc định: false
- Mô tả: Xác định xem gamepad có thể điều hướng giao diện trò chuyện không.
Hiển thị tin nhắn của người dùng bị lọc
- Loại: bool
- Mặc định: true
- Mô tả: Xác định xem người chơi có nên xem phiên bản lọc của tin nhắn trò chuyện của họ hay không, hoặc nội dung ban đầu họ đã gõ vào.
Trò chuyện với thanh trên cùng bị tắt
- Loại: bool
- Mặc định: false
- Mô tả: Xác định xem UI trò chuyện có được bật không ngay cả khi thanh trên cùng bị vô hiệu hóa.
BubbleChatEnabled được bật
- Loại: bool
- Mặc định: game:GetService("Players").BubbleChat
- Mô tả: Xác định xem có bật bong bóng trò chuyện hay không.
Chat classic được bật
- Loại: bool
- Mặc định: game:GetService("Players").ClassicChat
- Mô tả: Xác định xem chat cổ điển được bật hay không.
Cài đặt kích thước văn bản trò chuyện
Kích thước ChatWindowText
- Loại: int
- Mặc định: 18
- Mô tả: Xác định kích thước của văn bản trong ChatWindow.
Kích thước ChatBarText
Kích thước ChatWindowTextSizePhone
- Loại: int
- Mặc định: 14
- Mô tả: Xác định kích thước của văn bản trong ChatWindow cho điện thoại.
Kích thước văn bản trò chuyệnPhone
Cài đặt phông chữ
Phông chữ mặc định
- Loại: Enum.Font
- Mặc định: Enum.Font.SourceSansBold
Phông Chữ Trò Chuyện
- Loại: Enum.Font
- Mặc định: Enum.Font.SourceSansBold
Cài đặt màu
Màu nền sau lưng
- Loại: Color3
- Mặc định: Color3.new(0, 0, 0)
Màu tin nhắn mặc định
- Loại: Color3
- Mặc định: Color3.new(1, 1, 1)
Tên mặc địnhMàu sắc
- Loại: Color3
- Mặc định: Color3.new(1, 1, 1)
- Mô tả: Xác định mặc định TextColor3 của tên người phát của Tin nhắn trò chuyện trong Cửa sổ trò chuyện.
Màu nền ChatBarBackGroundColor
- Loại: Color3
- Mặc định: Color3.new(0, 0, 0)
Hộp màu ChatBarBox
- Loại: Color3
- Mặc định: Color3.new(1, 1, 1)
Màu văn bản ChatBar
- Loại: Color3
- Mặc định: Color3.new(0, 0, 0)
Màu thông báo lỗi
- Loại: Color3
- Mặc định: Color3.fromRGB(245, 50, 50)
- Mô tả: Xác định TextColor3 của các thông điệp lỗi.
Cài đặt cửa sổ
Kích thước cửa sổ tối thiểu
- Loại: UDim2
- Mặc định: UDim2.new(0.3, 0, 0.25, 0)
Kích thước cửa sổ tối đa
- Loại: UDim2
- Mặc định: UDim2.new(1, 0, 1, 0)
- Ghi chú: Nếu điều này được thay đổi để lớn hơn kích thước màn hình đầy đủ, những điều kỳ lạ bắt đầu xảy ra với việc kiểm tra giới hạn kích thước/vị trí.
Vị trí cửa sổ mặc định
- Loại: UDim2
- Mặc định: UDim2.new(0, 0, 0, 0)
- Mô tả: Xác định vị trí mặc định của ChatWindow.
Kích thước cửa sổ mặc địnhPhone
- Loại: UDim2
- Mặc định: UDim2.new(0.5, 0, 0.5, (7 * 2) + (5 * 2))
- Mô tả: Xác định kích thước mặc định của ChatWindow trên điện thoại.
Bảng kích thước cửa sổ mặc địnhTablet
- Loại: UDim2
- Mặc định: UDim2.new(0.4, 0, 0.3, (7 * 2) + (5 * 2))
- Mô tả: Xác định kích thước mặc định của ChatWindow trên các bảng.
Kích thước cửa sổ mặc địnhDesktop
- Loại: UDim2
- Mặc định: UDim2.new(0.3, 0, 0.25, (7 * 2) + (5 * 2))
- Mô tả: Xác định kích thước mặc định của ChatWindow trên máy tính để bàn.
Mờ dần và trong cài đặt
Thời gian chatWindowBackgroundFadeOut
- Loại: float (giây)
- Mặc định: 0.5
- Mô tả: Xác định thời gian mờ dần bền vững của ChatWindow nền phải mất bao lâu.
Thời gian biến mất của ChatWindowText
- Loại: float (giây)
- Mặc định: 30
- Mô tả: Xác định thời gian mờ dần văn bản ChatWindow phải mất bao lâu.
Thời gian biến mất mặc định trò chuyện
- Loại: float (giây)
- Mặc định: 0.8
- Mô tả: Xác định thời gian dành cho các yếu tố UI trò chuyện biến mất.
ChatShouldFadeInTừ Thông tin mới
- Loại: bool
- Mặc định: false
- Mô tả: Xác định xem trò chuyện có nên biến mất khi nhận được tin nhắn mới hay không.
Animations trò chuyện FPS
- Loại: float
- Mặc định: 20.0
- Mô tả: Xác định tốc độ khung hình của các hoạt hình biến mất trong giao diện trò chuyện.
Cài đặt kênh
Tên kênh chung
- Loại: string
- Mặc định: "All"
- Mô tả: Xác định tên kênh mặc định.
Tin nhắn Echo trong General Channel
- Loại: bool
- Mặc định: true
- Mô tả: Xác định xem liệu các tin nhắn đến các kênh khác kênh mặc định có nên được sao chép vào kênh mặc định hay không.
Tên kênh tối đa MaxChannelNameLength
- Loại: int
- Mặc định: 12
- Mô tả: Xác định chiều dài tối đa của tên kênh trước khi nó bị cắt.
Thời gian lịch sử tin nhắn mỗi kênh
- Loại: int
- Mặc định: 50
- Mô tả: Xác định số tối đa của Tin nhắn trò chuyện có thể được hiển thị trong kênh trò chuyện.
Hiển thị JoinAndLeaveHelpText
- Loại: bool
- Mặc định: false
- Mô tả: Xác định xem có hiển thị lời trợ giúp cho việc tham gia/rời khỏi kênh hay không.
Cài đặt tin nhắn
Chiều dài tin nhắn tối đa
- Loại: int
- Mặc định: 200
- Mô tả: Xác định chiều dài tối đa của Tin nhắn trò chuyện .
Không cho phép không gian trắng
- Loại: array< string >
- Mặc định: {"\n", "\r", "\t", "\v", "\f"}
- Mô tả: Xác định các ký tự trắng không được phép.
Nhấp vào Tên người chơi để thì thầm
- Loại: bool
- Mặc định: true
- Mô tả: Xác định xem người chơi có thể nhấp vào tên của người chơi khác để tham gia vào cuộc trò chuyện thì thầm với họ.
Nhấp vào tên kênh để thiết lập kênh chính
- Loại: bool
- Mặc định: true
- Mô tả: Xác định xem người chơi có thể nhấp vào tab của kênh để đặt nó làm kênh chính của họ hay không.
Cài đặt khác
Tên người chơi hoàn thành tự động WhisperCommandAutoCompletePlayerNames
- Loại: bool
- Mặc định: true
- Mô tả: Xác định xem lệnh trò chuyện có nên tự động hoàn thành tên người chơi hay không.
Sự kiện
Cài đặt thay đổi
- Tham số: Library.string``settingName , Biến thể newValue
- Mô tả: Bắt lửa khi một cài đặt với settingName được thay đổi thành newValue .