TextChannel
*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
Propiedades
Métodos
Muestra un mensaje del sistema al usuario.
Agrega un TextSource a la TextChannel dada la ID de un Player .
Envía un TextChatMessage al servidor.
Eventos
Se activa cuando se invoca TextChannel:DisplaySystemMessage() en el cliente, o cuando el cliente recibe una respuesta válida de TextChannel:SendAsync() del servidor.
Llamadas
Se llama cuando TextChannel está recibiendo un mensaje entrante.
Se llama para cada cliente cuando TextChannel está recibiendo un mensaje entrante para determinar si debe enviarse o no a ese cliente.
Propiedades
DirectChatRequester
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
El mensaje del sistema enviado al TextChannel .
Úsalo para identificar tipos de mensajes del sistema, como los mensajes del sistema por defecto.
Devuelve
Un TextChatMessage con propiedad TextChatMessage.Status que indica la condición del mensaje.
AddUserAsync
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
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
SendAsync
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
El mensaje para enviar a la TextChannel .
Metadatos personalizados para añadir a la mensaje.
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
El recibido TextChatMessage .
Llamadas
OnIncomingMessage
Se llama cuando TextChannel está recibiendo un mensaje entrante. Solo se puede implementar en el cliente.
Usa esto para decorar TextChatMessages . Si este llamado de regreso una propiedad TextChatMessageProperties , estas propiedades se fusionan con el parámetro TextChatMessage para crear una nueva 1> Class.TextChatMessage1> .
Cuando está vinculado al cliente para enviar un mensaje, este llamado de regreso se ejecuta dos veces; primero cuando el mensaje se envía inicialmente y se recibe localmente, y de nuevo cuando el cliente recibe el resultado del mensaje filtrado del servidor.
TextChannel.OnIncomingMessage llamadas siempre se ejecutan después del llamado de retorno de la devolución de llamadaClass.TextChatService.OnIncomingMessage.
Esto debería definirse solo una vez por TextChannel en el código de fuente. Las múltiples referencias al mismo canal se anularán uno el otro de forma no determinista.
Cuando TextChatService:CreateDefaultTextChannels() es cierto, esos canales de texto predeterminados TextChannels tienen sus llamadas de TextChannel.OnIncomingMessage asignadas internamente para mostrar un comportamiento de defecto especial.
Parámetros
El mensaje de texto entrante TextChatMessage .
Devuelve
Si se devuelve un TextChatMessageProperties, esas propiedades se fusionan con el parámetro TextChatMessage para crear un nuevo TextChatMessage con esas propiedades.
ShouldDeliverCallback
Se llama para cada cliente cuando TextChannel está recibiendo un mensaje entrante para determinar si debe enviarse a ese cliente o no. Solo se puede definir en el servidor.
Una vez definido, este llamado debe devolver un valor verdadero, como true , 1 o "hello" para entregar el mensaje al cliente. Si el llamado devuelve algo más (incluida la 1> nil1> ) el mensaje no se entregará a ese cliente, aunque el remitente lo verá sin embargo.
El remitente puede ser referido por TextChatMessage.TextSource .