Módulos de Chat do Lado do Cliente

*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.

Você pode usar os seguintes módulos de chat para suportar comportamentos do lado do cliente do Sistema de Chat Legado.

Janela de Bate-papo

A Janela de Bate-papo é o módulo de chat principal do lado do cliente do Legacy Chat System.

Métodos

Adicionar canal

Remover Canal

  • Parâmetros: string : channelName
  • Descrição: Remova um ChatChannelUI com o channelName dado da janela.
  • Retornos: void

Obter canal

Obter o Canal Atual

SwitchCurrentChannel

  • Parâmetros: string : channelName
  • Descrição: Alterna o canal atual para o ChatChannelUI com o channelName se ele existir.
  • Retornos: void

Ficar Visível

  • Parâmetros: Nenhum
  • Descrição: Retorna se a janela é visível ou não. Nota: isso se refere à interface do usuário de chat em geral; quando a janela de chat desvanecer para transparente devido a inatividade, a janela ainda é considerada visível.
  • Retornos: boolo

Visível

  • Parâmetros: Booleano : visible
  • Descrição: Defines a visibilidade da janela de chat.
  • Retornos: void

Fundo de Ajuste

  • Parâmetros: flutuar : duration
  • Descrição: Fades para trás o fundo sobre o dado duration em segundos. Nota: Chamadas posteriores para controlar a fuga em/fora substituirão as chamadas anteriores.
  • Retornos: void

FadeInBackground

  • Parâmetros: flutuar : duration
  • Descrição: Fades no background over the given duration em segundos. Nota: chamadas posteriores para controlar o fading in/out substituirão as chamadas anteriores.
  • Retornos: void

Texto de Desvanecimento

  • Parâmetros: flutuar : duration
  • Descrição: Fades out the text over the given duration in seconds. Note: later calls to control fading in/out will override earlier calls.
  • Retornos: void

FadeInTexto

  • Parâmetros: flutuar : duration
  • Descrição: Fades no texto sobre o dado duration em segundos. Nota: Chamadas posteriores para controlar a fuga de texto substituirão as chamadas anteriores.
  • Retornos: void

Barra de Chat

O ChatBar lida com a entrada de texto do lado do cliente para o sistema de chat Lua. Existem duas componentes-chave do ChatBar:

  • ChatBar , um TextBox, onde o jogador insere mensagens e comandos ( destacados em laranja)
  • MessageMode , um TextLabel, que pode exibir informações sobre a mensagem sendo enviada (destacado em verde)

Métodos

Obtenha o nome do espaço

  • Parâmetros: Nenhum
  • Descrição: Retorna o TextBox da barra de chat.
  • Retornos: TextBox

Obtenha a etiqueta de texto GetMessageMode

  • Parâmetros: Nenhum
  • Descrição: Retorna o MessageMode TextLabel .
  • Retornos: TextLabel

Está Focado

  • Parâmetros: Nenhum
  • Descrição: Retorna se a barra de chat's TextBox está em foco (o jogador está digitando na caixa). Equivalente ao chamado de TextBox:IsFocused no resultado de GetExecutor.
  • Retornos: boolo

CapturarFoco

  • Parâmetros: Nenhum
  • Descrição: Força o cliente a focar no TextBox da barra de chat. Equivalente a chamar TextBox:CaptureFocus no resultado de GetExecutor.
  • Retornos: void

Foco de lançamento

  • Parâmetros: bool : submitted = false
  • Descrição: Relembra o foco da barra de chat TextBox. Se submitted for verdadeiro, isso se comportará como se o jogador pressionasse Enter para enviar a mensagem.
  • Retornos: void

Texto de redefinição

  • Parâmetros: Nenhum
  • Descrição: Defines the Text of the chat bar TextBox to the empty string / cadeia / texto.
  • Retornos: void

Definir Texto de Título

  • Parâmetros: string : text
  • Descrição: Defines the Text of the chat bar TextBox to the given 0> text0>.
  • Retornos: void

Obtenha o Texto do DSpace

  • Parâmetros: Nenhum
  • Descrição: Retorna o texto na barra de chat TextBox.Text .
  • Retornos: string

DefinirTextoLabelTexto

  • Parâmetros: string : text
  • Descrição: Defines the Text of the MessageMode TextLabel to the given 0> text0> .
  • Retornos: void

GetEnabled

  • Parâmetros: Nenhum
  • Descrição: Retorna se a barra de bate-papo é Visible .
  • Retornos: boolo

Configurado

  • Parâmetros: Booleano : enabled
  • Descrição: Defines se a barra de chat é Visible .
  • Retornos: void

Definir o Tamanho do Texto

  • Parâmetros: int : textSize
  • Descrição: Defines o TextSize of both the chat bar's TextBox and MessageMode 0> TextLabel0> .
  • Retornos: void

RedimensionarTamanho

  • Parâmetros: Nenhum
  • Descrição: Redefine o tamanho da barra de chat para uma linha de texto.
  • Retornos: void

Definir o alvo de canal

  • Parâmetros: string : channelName
  • Descrição: Defines o target ChatChannelUI dado seu channelName para que a barra de chat envie mensagens.
  • Retornos: void

Fundo de Ajuste

  • Parâmetros: flutuar : duration 0> duration0>
  • Descrição: Fades para trás o fundo sobre o dado duration em segundos. Nota: Chamadas posteriores para controlar a fuga em/fora substituirão as chamadas anteriores.
  • Retornos: void

FadeInBackground

  • Parâmetros: flutuar : duration 0> duration0>
  • Descrição: Fades no background over the given duration em segundos. Nota: chamadas posteriores para controlar o fading in/out substituirão as chamadas anteriores.
  • Retornos: void

Texto de Desvanecimento

  • Parâmetros: flutuar : duration 0> duration0>
  • Descrição: Fades out the text over the given duration in seconds. Note: later calls to control fading in/out will override earlier calls.
  • Retornos: void

FadeInTexto

  • Parâmetros: flutuar : duration 0> duration0>
  • Descrição: Fades no texto sobre o dado duration em segundos. Nota: Chamadas posteriores para controlar a fuga de texto substituirão as chamadas anteriores.
  • Retornos: void

Chat ChannelUI

O ChatChannelUI é a versão do lado do cliente de ChatChannel. Ele recebe ChatMessages do servidor e os傳a para o 1>ChatMessageLogDisplay1> associado.

Métodos

Adicionar Mensagem ao Canal

Remover a Última Mensagem do Canal

Limpar registro de mensagens

Exibir ChatMessageLog

O ChatMessageLogDisplay gerencia a renderização de ChatMessages em um ChatChannelUI.

Métodos

AdicionarMensagem

  • Parâmetros: ChatMessagemessage
  • Descrição: Adiciona um message ao display de log de mensagem.
  • Retornos: void

Remover última mensagem

  • Parâmetros: Nenhum
  • Descrição: Remova o mais antigo ChatMessage na exibição de log de mensagem.
  • Retornos: void

Reorganizar todos os mensagens

  • Parâmetros: Nenhum
  • Descrição: Re-organiza todos os display de mensagem em ordem crescente, relativamente ao tamanho do display de mensagem. Isso deve ser chamado se o log de mensagem for reorganizado.
  • Retornos: void

Limpar

  • Parâmetros: Nenhum
  • Descrição: Remova todos os ChatMessages do display de log de mensagens.
  • Retornos: void

Texto de Desvanecimento

  • Parâmetros: flutuarduration
  • Descrição: Fades out the text over the given duration in seconds. Note: later calls to control fading in/out will override earlier calls.
  • Retornos: void

FadeInTexto

  • Parâmetros: flutuarduration
  • Descrição: Fades no texto sobre o dado duration em segundos. Nota: Chamadas posteriores para controlar a fuga de texto substituirão as chamadas anteriores.
  • Retornos: void

Estado do ChatCustom

O ChatCustomState é uma interface de chamadas usada ao criar um estado de chat personalizado na barra de chat.

O chat de brinquedos e o chat de equipe usam o ChatCustomState para indicar para o jogador onde sua mensagem será sentença / frase

Chamadas

TextoAtualizado

  • Parâmetros: Nenhum
  • Descrição: Chamado quando o texto na barra de chat é atualizado.
  • Retornos: void

Obter Mensagem

  • Parâmetros: Nenhum
  • Descrição: Chamado para recuperar o texto da mensagem como seria escrito como um único comando. Isso é usado no caso em que o servidor precisa processar o comando como texto, em vez do estado visualizado do comando.
  • Retornos: string

Mensagem de Processo Concluído

  • Parâmetros: Nenhum
  • Descrição: Chamado quando o jogador envia a mensagem que está sendo processada pelo estado personalizado. Isso deve retornar verdadeiro se a mensagem não deve ser exibida ou enviada para o servidor.
  • Retornos: boolo

Destruir

  • Parâmetros: Nenhum
  • Descrição: Chamado como o ChatBar está sendo redefinido de volta ao seu estado original antes da modificação de estado personalizado.
  • Retornos: void

Configurações do Chat

O ChatSettings é um dicionário de configurações para o lado do cliente do sistema de chat Lua. Eles são armazenados em um ModuleScript chamado ChatSettings, que pode ser encontrado dentro do serviço de jogos 1> chat/conversa1> sob o nome de 4>ClientChatModule4>. O módulo pode ser

Para alterar uma configuração, exija este módulo usando um LocalScript na seguinte maneira:

-- Requer o módulo ChatSettings (aguarde até que carregar)

local Chat = game:GetService("Chat")

local ClientChatModules = Chat:WaitForChild("ClientChatModules")

local ChatSettings = require(ClientChatModules:WaitForChild("ChatSettings"))

-- Altere as configurações como você faria com qualquer outra tabela.

ChatSettings.MaximumMessageLength = 100

Configurações de Comportamento do Chat

Janela拖动

JanelaResizable

GamepadRotationEnabled

  • Tipo: bool
  • Padrão: false
  • Descrição: Determina se os gamepads podem navegar pela interface do usuário de chat.

Mostrar Usuário OwnFilteredMessage

  • Tipo: bool
  • Padrão: true
  • Descrição: Determina se os jogadores devem ver a versão filtrada de suas mensagens de chat ou o conteúdo original que eles digitaram.

ChatOnWithTopBarOff

  • Tipo: bool
  • Padrão: false
  • Descrição: Determina se a interface do usuário de chat está ativada, mesmo que a barra superior esteja desativada.

BubbleChatAtivado

  • Tipo: bool
  • Padrão: game:GetService("Players").BubbleChat
  • Descrição: Determina se o bate-papo de bolha está ativado.

ClassicChatAtivado

  • Tipo: bool
  • Padrão: game:GetService("Players").ClassicChat
  • Descrição: Determina se o chat clássico está ativado.

Configurações do Tamanho do Texto do Chat

Tamanho do ChatWindow

Tamanho do ChatBar

  • Tipo: int
  • Padrão: 18
  • Descrição: Determina o tamanho do texto na Barra de Chat.

Tamanho do ChatWindowTextSizePhone

Tamanho do ChatBarTextSizePhone

  • Tipo: int
  • Padrão: 14
  • Descrição: Determina o tamanho do texto na Barra de Chat para telefones.

Configurações de Fonte

Fonte Padrão

ChatBarFont

Configurações de Cor

Cor de fundo

  • Tipo: Color3
  • Padrão: Color3.new(0, 0, 0)
  • Descrição: Determina o BackgroundColor3 do ChatWindow.

Cor padrão da mensagem

  • Tipo: Color3
  • Padrão: Color3.new(1, 1, 1)
  • Descrição: Determina o padrão TextColor3 de ChatMessages na 0>Janela de Bate-papo0>.

Cor de nome padrão

  • Tipo: Color3
  • Padrão: Color3.new(1, 1, 1)
  • Descrição: Determina o padrão TextColor3 de nomes de ChatMessages na 0>Janela de Chat0>.

Cor de fundo do chat

  • Tipo: Color3
  • Padrão: Color3.new(0, 0, 0)
  • Descrição: Determina o BackgroundColor3 do ChatBar.

Cor da Caixa de Bate-papo

  • Tipo: Color3
  • Padrão: Color3.new(1, 1, 1)
  • Descrição: Determina o BackgroundColor3 do ChatBar .

Cor de ChatBar

  • Tipo: Color3
  • Padrão: Color3.new(0, 0, 0)
  • Descrição: Determina o TextColor3 do ChatBar.

Cor do Texto de Mensagem de Erro

  • Tipo: Color3
  • Padrão: Color3.fromRGB(245, 50, 50)
  • Descrição: Determina o TextColor3 de mensagens de erro.

Configurações da Janela

Tamanho Mínimo da Janela

  • Tipo: UDim2
  • Padrão: UDim2.new(0.3, 0, 0.25, 0)
  • Descrição: Determina o tamanho mais pequeno possível da Janela de Bate-papo (já que JanelaResizable está habilitado).

Tamanho Máximo da Janela

  • Tipo: UDim2
  • Padrão: UDim2.new(1, 0, 1, 0)
  • Descrição: Determina o tamanho maior possível do ChatWindow (desde que WindowResizable está ativado).
  • Notas: Se isso for alterado para ser maior do que o tamanho total da tela, coisas estranhas começam a acontecer com limites de tamanho/posição verificando.

Posição da Janela Padrão

  • Tipo: UDim2
  • Padrão: UDim2.new(0, 0, 0, 0)
  • Descrição: Determina a posição padrão do ChatWindow.

Tamanho da janela padrão

  • Tipo: UDim2
  • Padrão: UDim2.new(0.5, 0, 0.5, (7 * 2) + (5 * 2))
  • Descrição: Determina o tamanho padrão do ChatWindow em telefones.

Tabela de Tamanho da Janela Padrão

  • Tipo: UDim2
  • Padrão: UDim2.new(0.4, 0, 0.3, (7 * 2) + (5 * 2))
  • Descrição: Determina o tamanho padrão do ChatWindow em mesas.

Tamanho da Janela PadrãoDesktop

  • Tipo: UDim2
  • Padrão: UDim2.new(0.3, 0, 0.25, (7 * 2) + (5 * 2))
  • Descrição: Determina o tamanho padrão do ChatWindow no Área de trabalho.

Desvanecer e Configurar

Tempo de Desvanecimento de Janela de Bate-papo

  • Tipo: flutuar (segundos)
  • Padrão: 0.5
  • Descrição: Determina o tempo de fundo que a janela de chat deve levar.

Tempo de Desvanecimento de ChatWindowText

  • Tipo: flutuar (segundos)
  • Padrão: 30
  • Descrição: Determina o tempo que o texto ChatWindow deve levar para desaparecer.

Duração de Chat Padrão

  • Tipo: flutuar (segundos)
  • Padrão: 0.8
  • Descrição: Determina o tempo que os elementos da interface de chat piscando devem levar.

ChatShouldFadeInFromNewInformation

  • Tipo: bool
  • Padrão: false
  • Descrição: Determina se o chat deve desaparecer quando receber novas mensagens.

Animação de ChatFPS

  • Tipo: flutuar
  • Padrão: 20.0
  • Descrição: Determina a taxa de quadros de animações de fading na interface do chat.

Configurações de Canal

NomeGeneralChannelName

  • Tipo: string
  • Padrão: "All"
  • Descrição: Determina o nome do canal padrão.

EchoMessagesInGeneralChannel

  • Tipo: bool
  • Padrão: true
  • Descrição: Determina se as mensagens para canais que não sejam o canal padrão devem ser ecoadas no canal padrão.

Nome de Máximo de Canais

  • Tipo: int
  • Padrão: 12
  • Descrição: Determina a comprimento máximo de um nome de canal antes de ser cortado.

Histórico de Mensagens por Canal

  • Tipo: int
  • Padrão: 50
  • Descrição: Determina o número máximo de ChatMessage que pode ser exibido em um canal de chat.

MostrarJoinAndLeaveHelpText

  • Tipo: bool
  • Padrão: false
  • Descrição: Determina se o texto de ajuda para entrar/sair de canais é mostrado.

Configurações de Mensagem

Limite de Comprimento de Mensagem

  • Tipo: int
  • Padrão: 200
  • Descrição: Determina a comprimento máximo de ChatMessages.

Espaço Disponível Restrito

  • Tipo: array< string >
  • Padrão: {"\n", "\r", "\t", "\v", "\f"}
  • Descrição: Determina os caracteres de espaço branco que não são permitidos.

Clique em PlayerName para Whisper

  • Tipo: bool
  • Padrão: true
  • Descrição: Determina se o jogador pode clicar no nome de outro jogador para engajar-se em uma conversa de suspiro com eles.

Clique no canal de nome para definir o canal principal

  • Tipo: bool
  • Padrão: true
  • Descrição: Determina se o jogador pode clicar em uma guia de canal para configurá-lo como seu canal principal.

Configurações Diversas

Nomes de Jogadores que Auto-Completam

  • Tipo: bool
  • Padrão: true
  • Descrição: Determina se o comando de sopro deve auto-completar nomes de jogadores.

Eventos

Configurações alteradas

  • Parâmetros: Library.string``settingName , Variante 0> newValue0>
  • Descrição: Fires when a setting with the given settingName is changed to newValue .