TextChannel

Mostrar obsoleto

*Este contenido se traduce usando la IA (Beta) y puede contener errores. Para ver esta página en inglés, haz clic en aquí.

Representa un canal de chat de texto. Contiene TextSources como descendientes.

Para enviar un mensaje de chat a la TextChannel , llama a TextChannel:SendAsync() desde un LocalScript . El correspondiente 1> Class.TextSource1> del usuario con 4> TextSource.CanSend = true4> debe estar en ese canal.

Mensajes de diferentes canales de texto se pueden separar en diferentes pestañas en la ventana de chat utilizando ChannelTabsConfiguration .

Para aprender más, see Chat de texto en la experiencia .

Resumen

Métodos

Eventos

Propiedades

DirectChatRequester

Solo lectura
No replicado
Leer paralelo

Métodos

DisplaySystemMessage

Muestra un mensaje del sistema al usuario. Solo se puede usar en un LocalScript , o en un Script con RunContext de 2> Class.Script.RunContext2> . Los mensajes solo son visibles para ese usuario y no se filtran o localizan automáticamente.

Parámetros

systemMessage: string

El mensaje del sistema enviado al TextChannel .

metadata: string

Úsalo para identificar tipos de mensajes del sistema, como los mensajes del sistema por defecto.

Valor predeterminado: ""

Devuelve

Un TextChatMessage con propiedad TextChatMessage.Status que indica la condición del mensaje.

SetDirectChatRequester

void

Parámetros

requester: Player

Devuelve

void

AddUserAsync

Proporciona

Agrega un TextSource a la TextChannel dada con el ID de usuario (con Player.UserId). Solo se puede usar en un 2>Class.Script2> .

Si no existe un TextSource representando al usuario, esto agrega un TextSource .

Si un TextSource representando al usuario existe, esto devuelve el TextSource.

Si el usuario tiene chat desactivado o no está en el servidor, esto devuelve un tuple nil , false .

Parámetros

userId: number

El ID de usuario del Player .


Devuelve

Regresa TextSource y true si se crea un nuevo TextSource para el usuario, 1> Class.TextSource1> y 4> false4> si hay un existente 7> Class.Text

Proporciona

Envía un TextChatMessage al servidor. Solo se puede usar en un LocalScript o en un Script con 1> Class.Script.RunContext|RunContext1> de 4> Ennum.RunContext.Client4> .

Parámetros

message: string

El mensaje para enviar a la TextChannel .

metadata: string

Metadatos personalizados para añadir a la mensaje.

Valor predeterminado: ""

Devuelve

Un TextChatMessage con propiedad TextChatMessage.Status que indica la condición del mensaje.

Eventos

MessageReceived

Al igual que TextChatService.MessageReceived, se activa cuando se invoca TextChannel:DisplaySystemMessage() o cuando el cliente recibe una respuesta válida de TextChannel:SendAsync() del servidor. Este evento solo se activa en el cliente.

Si la propiedad del servidor TextChannel.ShouldDeliverCallback está vinculada y返回false, el cliente no dispararáTextChannel.MessageReceived .

Usa el parámetro TextChatMessage para obtener el TextSource y el texto del mensaje (con TextChatMessage.Text).

El parámetro TextChatMessage es el resultado final de cualquier función vinculada a TextChatService.OnIncomingMessage o TextChannel.OnIncomingMessage .

Parámetros

incomingMessage: TextChatMessage

El recibido TextChatMessage .


Llamadas

OnIncomingMessage

Parámetros


Devuelve

ShouldDeliverCallback

Parámetros

textSource: TextSource

Devuelve