TextChannel

Mostrar obsoleto

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

Representa um canal de chat de texto. Contém TextSources como descendentes.

Para enviar uma mensagem de chat para o TextChannel , chame TextChannel:SendAsync() a partir de um LocalScript . O correspondente 1> Class.TextSource1> do usuário com 4> TextSource.CanSend = true4> deve estar nesse canal.

Mensagens de diferentes canais de texto podem ser separadas em diferentes abas na janela de chat usando ChannelTabsConfiguration.

Para saber mais, see Chat de Texto Na Experiência .

Resumo

Métodos

Eventos

Callbacks

Propriedades

Métodos

DisplaySystemMessage

Exibe uma mensagem do sistema para o usuário. Só pode ser usado em um LocalScript , ou em um Script com RunContext de 2>Class.Script2>. Mensagens só são visíveis para aquele usuário e não são filtradas automaticamente ou localizadas.

Parâmetros

systemMessage: string

A mensagem do sistema enviada para o TextChannel .

metadata: string

Use para identificar tipos de mensagens do sistema, como as mensagens padrão do sistema.

Valor Padrão: ""

Devolução

Um TextChatMessage com TextChatMessage.Status propriedade que indica a condição da mensagem.

AddUserAsync

Rendimentos

Adiciona um TextSource ao TextChannel dado pelo usuário (com Player.UserId). Somente pode ser usado em um 2>Class.Script2> .

Se um TextSource representando o usuário não existe, isso adiciona um TextSource.

Se um TextSource representando o usuário existir, isso retorna o TextSource.

Se o usuário tiver o chat desligado ou não estiver no servidor, isso retorna um tuple nil , false .

Parâmetros

userId: number

O usuário do Player.


Devolução

Retorna TextSource e true se um novo TextSource for criado para o usuário, 1> Class.TextSource1> e 4> false4> se houver um 7> Class.TextSource

Rendimentos

Envia uma TextChatMessage para o servidor. Somente pode ser usado em um LocalScript ou em um Script com 2>Class.Script.RunContext|RunContext2> de 5>Class.Script5> .

Parâmetros

message: string

A mensagem para enviar para o TextChannel.

metadata: string

Metadados personalizados para anexar à mensagem.

Valor Padrão: ""

Devolução

Um TextChatMessage com TextChatMessage.Status propriedade que indica a condição da mensagem.

Eventos

MessageReceived

Como TextChatService.MessageReceived , dispara quando TextChannel:DisplaySystemMessage() é invocado no cliente, ou quando o cliente recebe uma resposta válida de TextChannel:SendAsync() do servidor. Este evento só é invocado no cliente.

Se a propriedade TextChannel.ShouldDeliverCallback do servidor estiver vinculada e retornar false, o cliente não irá executar TextChannel.MessageReceived.

Use o parâmetro TextChatMessage para obter o TextSource e o texto da mensagem (com TextChatMessage.Text).

O parâmetro TextChatMessage é o resultado final de qualquer função vinculada a TextChatService.OnIncomingMessage ou TextChannel.OnIncomingMessage.

Parâmetros

incomingMessage: TextChatMessage

O recebido TextChatMessage .


Callbacks

OnIncomingMessage

Chamado quando TextChannel está recebendo uma mensagem entrante. Só pode ser implementado no cliente.

Use isso para decorar TextChatMessages. Se este retornar um TextChatMessageProperties, essas propriedades são fundidas com o parâmetro TextChatMessage para criar um novo 1> Class.TextChatMessage1>.

Quando vinculado ao cliente enviar uma mensagem, este retorno de chamada é executado duas vezes; primeiro quando a mensagem é inicialmente enviada e recebida localmente, e novamente quando o cliente recebe o resultado da mensagem filtrada do servidor.

TextChannel.OnIncomingMessage chamadas sempre são executadas depois do retorno de chamada TextChatService.OnIncomingMessage.

Isso deve ser definido apenas uma vez por TextChannel no código de fonte. Vários vinculos ao mesmo canal substituirão um ao outro de uma maneira não determinista.

Quando TextChatService:CreateDefaultTextChannels() é verdadeiro, esses canais de texto padrão TextChannels têm seus retornos de chamada TextChannel.OnIncomingMessage atribuídos internamente para exibir comportamento padrão especial.

Parâmetros

O TextChatMessage recebido.


Devolução

Se um TextChatMessageProperties for retornado, essas propriedades são fundidas com o parâmetro TextChatMessage para criar um novo TextChatMessage com essas propriedades.

ShouldDeliverCallback

Chamado para cada cliente quando TextChannel está recebendo uma mensagem entrante para determinar se ela deve ser entregue para esse cliente. Só pode ser definido no servidor.

Uma vez definido, este retorno de chamada precisa retornar um valor verdadeiro, como true , 1 ou "hello" para entregar a mensagem ao cliente. Se o retorno de chamada retornar qualquer outro valor (incluindo 2> nil2>), a mensagem não será entregue ao cliente, embora o remetente veja a mensagem de qualquer maneira.

O remetente pode ser referenciado por TextChatMessage.TextSource .

Parâmetros

textSource: TextSource

Devolução