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 al TextChannel , llama a TextChannel:SendAsync() desde un LocalScript .El correspondiente TextSource del usuario con TextSource.CanSend = true debe estar en ese canal.
Los mensajes de diferentes canales de texto se pueden separar en diferentes pestañas en la ventana de chat usando ChannelTabsConfiguration .
Para obtener más información, vea In-Experience Text Chat.
Resumen
Propiedades
El TextChannel solo enviará mensajes a usuarios que puedan enviar mensajes directos al DirectChatRequester.
Métodos
Muestra un mensaje del sistema al usuario.
Establece el DirectChatRequester para el TextChannel. El TextChannel solo enviará mensajes a usuarios que puedan enviar mensajes directos al DirectChatRequester .
Añade un al ID de usuario dado de un .
Envía un TextChatMessage al servidor.
Eventos
Se activa cuando TextChannel:DisplaySystemMessage() se invoca en el cliente, o cuando el cliente recibe una respuesta válida de TextChannel:SendAsync() del servidor.
Llamadas
Se llama cuando TextChannel recibe un mensaje entrante.
Se llama a cada cliente cuando TextChannel recibe un mensaje entrante para determinar si debe o no entregarse a ese cliente.
Propiedades
DirectChatRequester
El TextChannel solo enviará mensajes a usuarios que puedan enviar mensajes directos al DirectChatRequester. Esta propiedad solo se puede configurar usando SetDirectChatRequester().
Métodos
DisplaySystemMessage
Muestra un mensaje del sistema al usuario.Solo se puede usar en un LocalScript , o en un Script con RunContext de Enum.RunContext.Client .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.
Use para identificar tipos de mensajes del sistema, como los mensajes del sistema predeterminados.
Devuelve
Un TextChatMessage con la propiedad TextChatMessage.Status que indica la condición del mensaje.
SetDirectChatRequester
Establece el DirectChatRequester para el TextChannel. Este método solo está disponible para su uso en scripts del servidor.
Usa esta API si estás trabajando con TextChatService y tienes una implementación personalizada de chat directo fuera de los canales de texto predeterminados.
Cuando se llama a un TextChannel que es padre de TextChatService y no tiene ningún TextSources existente, SetDirectChatRequester agrega a los usuarios solicitados como un TextSource y establece la propiedad DirectChatRequester para el canal.
Cuando se establecerDirectChatRequester, solo se entregan mensajes entre usuarios que puedan dirigir el chat con el DirectChatRequester .
local function createWhisperChannel(fromPlayer, toPlayer)
local whisperChannel = Instance.new("TextChannel")
whisperChannel:SetDirectChatRequester(fromPlayer)
whisperChannel:AddUserAsync(toPlayer.UserId)
-- La instancia de TextChannel ahora tiene dos instancias de TextSource.
return whisperChannel
end
Parámetros
Devuelve
AddUserAsync
Añade un TextSource al ID de usuario dado TextChannel (con Player.UserId ). Solo se puede utilizar en un Script .
Si un TextSource que representa al usuario no existe, esto agrega un TextSource .
Si un TextSource que representa al usuario existe, esto devuelve el TextSource .
Si el usuario tiene el chat desactivado o no está en el servidor, esto devuelve un túnel nil , false .
Parámetros
Devuelve
Devuelve TextSource y true si se crea un nuevo TextSource para el usuario, TextSource y false si hay un existente TextSource o nil y false si el usuario tiene el chat desactivado o no está en este servidor.
SendAsync
Envía un TextChatMessage al servidor. Solo se puede usar en un LocalScript o en un Script con RunContext de Enum.RunContext.Client .
El argumento metadata tiene un límite de 200 caracteres.Si se llama con un argumento metadata que tiene más de 200 caracteres, el mensaje no se enviará a otros usuarios.En cambio, el remitente recibirá un TextChatMessage con las propiedades TextChatMessage.Metadata y TextChatMessage.Text establecidas como cadenas vacías.
Parámetros
El mensaje para enviar al TextChannel.
metadata personalizado para adjuntar al mensaje.
Devuelve
Un TextChatMessage con la propiedad TextChatMessage.Status que indica la condición del mensaje.
Eventos
MessageReceived
Como TextChatService.MessageReceived , se activa cuando TextChannel:DisplaySystemMessage() se invoca en el cliente, o cuando el cliente recibe una respuesta válida de TextChannel:SendAsync() del servidor.Este evento solo se dispara en el cliente.
Si la propiedad TextChannel.ShouldDeliverCallback del servidor está vinculada y devuelve 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 recibe un mensaje entrante. Solo se puede implementar en el cliente.
Usa esto para decorar TextChatMessages .Si esta llamada de devolución devuelve un TextChatMessageProperties , esas propiedades se fusionan con el parámetro TextChatMessage para crear un nuevo TextChatMessage.
Cuando se vincula al cliente que envía un mensaje, este llamado de devolución se ejecuta dos veces; primero cuando el mensaje se envía y recibe inicialmente localmente, y nuevamente cuando el cliente recibe el resultado del mensaje filtrado del servidor.
TextChannel.OnIncomingMessage llamadas de devolución siempre se ejecutan después de la llamada de devolución TextChatService.OnIncomingMessage.
Esto debe definirse solo una vez por TextChannel en el código fuente.Múltiples vinculaciones al mismo canal anularán una a otra de manera no determinista.
Cuando es verdadero, esos llamados predeterminados tienen sus llamadas de devolución asignadas internamente para exhibir un comportamiento predeterminado especial.
Parámetros
El 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 a cada cliente cuando TextChannel recibe un mensaje entrante para determinar si debe o no entregarse a ese cliente.Solo se puede definir en el servidor.
Una vez definido, este llamado de vuelta debe devolver un valor verdadero como true , 1 o "hello" para entregar el mensaje al cliente dicho.Si la llamada de devolución devuelve cualquier otra cosa (incluido nil ), el mensaje no se enviará a ese cliente, aunque el remitente verá el mensaje independientemente.
El remitente se puede referenciar por TextChatMessage.TextSource , mientras que el receptor es el argumento textSource.Tenga en cuenta que el remitente y el receptor pueden ser los mismos, ya que la llamada de devolución recorre todos los receptores posibles.En Roblox Studio, serás el único remitente y receptor de un mensaje mientras estás en el modo de juego en solitario Jugar .
Parámetros
El mensaje que se está enviando, que también contiene al remitente del mensaje.
El TextSource del usuario que recibirá el mensaje.