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 os comportamentos do lado do cliente do sistema de chat Legado.

Janela de Bate-papo

A janela de bate-papo é o principal módulo de bate-papo do lado do cliente do Sistema de Chat Legado .

Métodos

Adicionar Canal

Remover Canal

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

Obter Canal

Obter Canal Atual

Mudar o Canal Atual

  • Parâmetros: string : channelName
  • Descrição: Muda o canal atual para o ChatChannelUI com o dado channelName.
  • Retornos: vazio

Ficar Visível

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

Definir Visível

  • Parâmetros: bool : visible
  • Descrição: Define a visibilidade da janela de chat.
  • Retornos: vazio

Fundo Desaparecendo

  • Parâmetros: flutuação : duration
  • Descrição: Fade fora o plano de fundo sobre o dado em segundos.Nota: chamadas posteriores para controlar o desaparecimento em/fora substituirão chamadas anteriores.
  • Retornos: vazio

Desaparecer no Fundo

  • Parâmetros: flutuação : duration
  • Descrição: Desaparece no plano de fundo em segundos sobre o dado duration em segundos.Nota: chamadas posteriores para controlar o desaparecimento em/fora substituirão chamadas anteriores.
  • Retornos: vazio

Texto Desaparecendo

  • Parâmetros: flutuação : duration
  • Descrição: Fade fora o texto sobre o dado em segundos.Nota: chamadas posteriores para controlar o desaparecimento em/fora substituirão chamadas anteriores.
  • Retornos: vazio

Desaparecer em Texto

  • Parâmetros: flutuação : duration
  • Descrição: Desaparece no texto em segundos após o dado duration.Nota: chamadas posteriores para controlar o desaparecimento em/fora substituirão chamadas anteriores.
  • Retornos: vazio

Barra de Chat

A Barra de Chat lida com a entrada de texto do lado do cliente para o sistema de chat Lua. Existem dois componentes-chave da Barra de Chat:

  • Barra de Chat , um TextBox , onde o jogador insere mensagens e comandos (destacados em laranja)
  • Modo de Mensagem , um TextLabel , que pode exibir informações sobre a mensagem que está sendo enviada (destacada em verde)

Métodos

Obter Caixa de Texto

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

Obter rótulo do modo de mensagem GetMessageModeText

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

Está Focado

  • Parâmetros:: Nenhum
  • Descrição: Retorna se a barra de chat TextBox está em foco (o jogador está digitando na caixa).Equivalente a chamar TextBox:IsFocused no resultado de GetTextBox.
  • Retornos: bool

Foco de Captura

  • Parâmetros:: Nenhum
  • Descrição: Força o cliente a se concentrar no TextBox da barra de chat. Equivalente a chamar TextBox:CaptureFocus no resultado de GetTextBox.
  • Retornos: vazio

Foco de lançamento

  • Parâmetros: bool : submitted = false
  • Descrição: Libera 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: vazio

Reiniciar Texto

  • Parâmetros:: Nenhum
  • Descrição: Defines o Text da barra de chat TextBox para a string / cadeia / textovazia.
  • Retornos: vazio

Definir Texto da Caixa de Texto

  • Parâmetros: string : text
  • Descrição: Define o Text da barra de chat TextBox para o dado text.
  • Retornos: vazio

Obter Texto do TextBox

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

Definir texto de rótulo de texto

  • Parâmetros: string : text
  • Descrição: Define o Text do MessageMode TextLabel para o dado text.
  • Retornos: vazio

Obter Ativado

  • Parâmetros:: Nenhum
  • Descrição: Retorna se a barra de chat é Visible .
  • Retornos: bool

DefinirAtivado

  • Parâmetros: bool : enabled
  • Descrição: Define se a barra de chat é Visible .
  • Retornos: vazio

Definir tamanho de texto

  • Parâmetros: int : textSize
  • Descrição: Define o TextSize de ambos o TextBox da barra de chat e o MessageMode TextLabel.
  • Retornos: vazio

Redefinir Tamanho

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

Definir Alvo de Canal

  • Parâmetros: string : channelName
  • Descrição: Defines o alvo ChatChannelUI dado seu channelName para o qual a barra de chat deve enviar mensagens.
  • Retornos: vazio

Fundo Desaparecendo

  • Parâmetros: flutuação : duration``duration
  • Descrição: Fade fora o plano de fundo sobre o dado em segundos.Nota: chamadas posteriores para controlar o desaparecimento em/fora substituirão chamadas anteriores.
  • Retornos: vazio

Desaparecer no Fundo

  • Parâmetros: flutuação : duration``duration
  • Descrição: Desaparece no plano de fundo em segundos sobre o dado duration em segundos.Nota: chamadas posteriores para controlar o desaparecimento em/fora substituirão chamadas anteriores.
  • Retornos: vazio

Texto Desaparecendo

  • Parâmetros: flutuação : duration``duration
  • Descrição: Fade fora o texto sobre o dado em segundos.Nota: chamadas posteriores para controlar o desaparecimento em/fora substituirão chamadas anteriores.
  • Retornos: vazio

Desaparecer em Texto

  • Parâmetros: flutuação : duration``duration
  • Descrição: Desaparece no texto em segundos após o dado duration.Nota: chamadas posteriores para controlar o desaparecimento em/fora substituirão chamadas anteriores.
  • Retornos: vazio

Bate-papoChannelUI

O ChatChannelUI é a versão do lado do cliente de ChatChannel.Ele recebe Mensagens de Chat do servidor e as passa para o Log de Mensagens de Chat. associado a ele.

Métodos

Adicionar Mensagem ao Canal

Remover a última mensagem do canal

LimparRegistro de Mensagens

Exibição de registro de mensagens de chat

O Log de Mensagens de Chat gerencia o renderizamento de Mensagens de Chat em um ChatChannelUI.

Métodos

Adicionar Mensagem

  • Parâmetros: Mensagem de Chatmessage
  • Descrição: Adiciona um message ao exibição do registro de mensagens.
  • Retornos: vazio

Remover a última mensagem

  • Parâmetros:: Nenhum
  • Descrição: Remove o mais antigo Mensagem de Chat na exibição do registro de mensagens.
  • Retornos: vazio

Reorganizar todas as mensagens

  • Parâmetros:: Nenhum
  • Descrição: Reorganiza todos os displays de mensagens em ordem crescente, em relação ao tamanho do display de mensagem.Isso deve ser chamado se o log de mensagens for redimensionado.
  • Retornos: vazio

Limpar

  • Parâmetros:: Nenhum
  • Descrição: Remove todos os Mensagens de Chat da exibição do registro de mensagens.
  • Retornos: vazio

Texto Desaparecendo

  • Parâmetros: flutuarduration
  • Descrição: Fade fora o texto sobre o dado em segundos.Nota: chamadas posteriores para controlar o desaparecimento em/fora substituirão chamadas anteriores.
  • Retornos: vazio

Desaparecer em Texto

  • Parâmetros: flutuarduration
  • Descrição: Desaparece no texto em segundos após o dado duration.Nota: chamadas posteriores para controlar o desaparecimento em/fora substituirão chamadas anteriores.
  • Retornos: vazio

Estado de Bate-papo Personalizado

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

O bate-papo sussurrado e o bate-papo em equipe usam o ChatCustomState para indicar ao jogador onde sua mensagem será sentença / frase

Chamadas de volta

Texto Atualizado

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

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 de o servidor precisar processar o comando como texto, em vez do estado visualizado do comando.
  • Retornos: string

Mensagem de Processamento 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 ao servidor.
  • Retornos: bool

Destroiar

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

Configurações de Chat

O Configurações de Chat é um dicionário de configurações para o lado do cliente do sistema de chat Lua.Eles são armazenados em um ModuleScript chamado Configurações de Chat, que pode ser encontrado dentro do serviço de jogo Chat, sob o Folder chamado ClientChatModules.O módulo pode ser necessário e suas propriedades podem ser alteradas durante o tempo de execução.

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

-- Exija o módulo ChatSettings (espere que ele carregar)

local Chat = game:GetService("Chat")

local ClientChatModules = Chat:WaitForChild("ClientChatModules")

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

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

ChatSettings.MaximumMessageLength = 100

Configurações de comportamento de chat

JanelaDragável

  • Tipo: bool
  • Padrão: false
  • Descrição: Determina se o ChatWindow é Draggable .

JanelaRedimensionável

  • Tipo: bool
  • Padrão: false
  • Descrição: Determina se o Janela de Chat pode ser redimensionado pelo jogador
  • Tipo: bool
  • Padrão: false
  • Descrição: Determina se os gamepads podem navegar na interface de chat.

Mostrar Mensagem do Usuário Filtrada

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

Bate-papo com a barra superior desligada

  • Tipo: bool
  • Padrão: false
  • Descrição: Determina se a interface de chat está habilitada mesmo se a barra superior estiver desativada.

Chat de bolhasativado

  • Tipo: bool
  • Padrão: game:GetService("Players").BubbleChat
  • Descrição: Determina se o chat de bolhas está habilitado.

Chat Clássico Ativo

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

Configurações de tamanho de texto do chat

Tamanho do Texto da Janela de Bate-papo

Tamanho do Texto da Barra de Chat

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

Tamanho do Texto da Janela de Bate-papoPhone

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

Tamanho do Texto da Barra de ChatPhone

  • 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

Fonte da Barra de Chat

Configurações de cores

Cor de Fundo de Fundo

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

Cor da Mensagem Padrão

Cor do Nome Padrão

Cor de Fundo da Barra de Chat

  • Tipo: Color3
  • Padrão: Color3.new(0, 0, 0)
  • Descrição: Determina o BackgroundColor3 da Barra de Chat.

Cor da Caixa de Barra de Chat

  • Tipo: Color3
  • Padrão: Color3.new(1, 1, 1)
  • Descrição: Determina o da Barra de Chat .

Cor do Texto da Barra de Chat

  • Tipo: Color3
  • Padrão: Color3.new(0, 0, 0)
  • Descrição: Determina o TextColor3 da Barra de Chat.

Cor do Texto da 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 mínimo possível do Janela de Bate-papo (dado que JanelaResizable está habilitada).

Tamanho máximo da janela

  • Tipo: UDim2
  • Padrão: UDim2.new(1, 0, 1, 0)
  • Descrição: Determina o tamanho máximo possível do Janela de Chat (dado que Redimensionável da Janela está habilitado).
  • Notas: Se isso for alterado para ser maior que o tamanho total da tela, coisas estranhas começam a acontecer com a verificação de limites de tamanho/posição.

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 de janela padrãoPhone

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

Tablet de tamanho de 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 tabelas.

Tamanho da janela padrão do desktop

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

Desaparecer e nas configurações

Tempo de desaparecimento do ChatWindowBackgroundFadeOut

  • Tipo: flutuar (segundos)
  • Padrão: 0.5
  • Descrição: Determina quanto tempo deve demorar para desaparecer o plano de fundo do ChatWindow.

Tempo de desaparecimento do texto da janela de bate-papo

  • Tipo: flutuar (segundos)
  • Padrão: 30
  • Descrição: Determina quanto tempo deve demorar para desaparecer o texto da Janela de Chat.

Duração do Desaparecimento Padrão do Chat

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

ChatShouldFadeInDe Nova Informação

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

Animação de ChatFPS

  • Tipo: flutuação
  • Padrão: 20.0
  • Descrição: Determina a taxa de quadros de animações de desaparecimento na interface de bate-papo.

Configurações de canal

Nome do Canal Geral

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

Mensagens de Eco no Canal Geral

  • Tipo: bool
  • Padrão: true
  • Descrição: Determina se mensagens para canais diferentes do canal padrão devem ser ecoadas no canal padrão.

Nome do Canal Máximo Comprimento

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

Comprimento da História de Mensagens por Canal

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

MostrarAjudaJoinAndLeave

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

Configurações de mensagem

Comprimento Máximo da Mensagem

Espaço em branco não permitido

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

Clique em PlayerNameToWhisper para sussurrar

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

Clique no nome do canal para definir o canal principal

  • Tipo: bool
  • Padrão: true
  • Descrição: Determina se o jogador pode clicar na aba de um canal para definir como seu principal canal.

Configurações diversas

Nomes de Comandos de Sussurro Automáticos para Jogadores

  • Tipo: bool
  • Padrão: true
  • Descrição: Determina se o comando sussurrar deve preencher automaticamente os nomes dos jogadores.

Eventos

Configurações Alteradas

  • Parâmetros: Library.string``settingName , Variáveis newValue
  • Descrição: Dispara quando uma configuração com o dado settingName é alterada para newValue .

Nesta página