Módulos de chat del lado del cliente

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

Puedes usar los siguientes módulos de chat para soportar los comportamientos del lado del cliente del sistema de chat Legado.

Ventana de chat

La ventana de chat es el módulo de chat principal del lado del cliente del Sistema de chat legado.

Métodos

Agregar canal

Quitar canal

  • Parámetros: string : channelName
  • Descripción: Elimina un ChatChannelUI con el dado channelName de la ventana.
  • Regresos: vacío

Obtener canal

Obtener canal actual

Cambiar canal actual

  • Parámetros: string : channelName
  • Descripción: Cambia el canal actual al ChatChannelUI con el dado channelName si existe.
  • Regresos: vacío

Hacer visible

  • Parámetros: Ninguno
  • Descripción: Devuelve si la ventana es visible o no.Nota: esto se refiere a la interfaz de chat en general; cuando la ventana de chat desaparece a transparente debido a la inactividad, la ventana aún se considera visible.
  • Devoluciones: bool

Establecer visible

  • Parámetros: bool : visible
  • Descripción: Establece la visibilidad de la ventana de chat.
  • Regresos: vacío

Fondo de desaparición

  • Parámetros: flotar : duration
  • Descripción: Fadea el fondo durante los segundos dados duration en segundos.Nota: las llamadas posteriores para controlar la desaparición entrante/saliente anularán las llamadas anteriores.
  • Regresos: vacío

Desaparecer en el fondo

  • Parámetros: flotar : duration
  • Descripción: Se desvanece en el fondo sobre el dado duration en segundos.Nota: las llamadas posteriores para controlar la desaparición entrante/saliente anularán las llamadas anteriores.
  • Regresos: vacío

Texto de desaparición

  • Parámetros: flotar : duration
  • Descripción: Fadea el texto sobre el dado duration en segundos.Nota: las llamadas posteriores para controlar la desaparición entrante/saliente anularán las llamadas anteriores.
  • Regresos: vacío

Texto de desaparición

  • Parámetros: flotar : duration
  • Descripción: Desaparece en el texto sobre el dado duration en segundos.Nota: las llamadas posteriores para controlar la desaparición entrante/saliente anularán las llamadas anteriores.
  • Regresos: vacío

Barra de chat

La barra de chat maneja la entrada de texto del lado del cliente para el sistema de chat de Lua. Hay dos componentes clave de la barra de chat:

  • Barra de chat , un TextBox , donde el jugador ingresa mensajes y comandos (resaltados en naranja)
  • Mode de mensaje , un TextLabel , que puede mostrar información sobre el mensaje que se está enviando (resaltado en verde)

Métodos

Obtener texto

  • Parámetros: Ninguno
  • Descripción: Devuelve el TextBox de la barra de chat.
  • Devoluciones: TextBox

Obtener etiqueta de texto de modo de mensaje

  • Parámetros: Ninguno
  • Descripción: Regresa el modo de mensaje TextLabel .
  • Devoluciones: TextLabel

Se centra

  • Parámetros: Ninguno
  • Descripción: Devuelve si la barra de chat TextBox está en foco (el jugador está escribiendo en la caja delimitadora).Equivalente a llamar TextBox:IsFocused al resultado de GetTextBox.
  • Devoluciones: bool

Enfoque de captura

  • Parámetros: Ninguno
  • Descripción: Obliga al cliente a centrarse en el TextBox de la barra de chat. Equivalente a llamar TextBox:CaptureFocus al resultado de GetTextBox.
  • Regresos: vacío

Enfoque de lanzamiento

  • Parámetros: bool : submitted = false
  • Descripción: Libera el enfoque de la barra de chat TextBox .Si submitted es verdadero, este se comportará como si el jugador presionara Entrar para enviar el mensaje.
  • Regresos: vacío

Reiniciar texto

  • Parámetros: Ninguno
  • Descripción: Establece el Text de la barra de chat TextBox a la cadena vacía.
  • Regresos: vacío

Establecer texto del cuadro de texto

  • Parámetros: string : text
  • Descripción: Establece el Text de la barra de chat TextBox al dado text.
  • Regresos: vacío

Obtener texto de textbox

  • Parámetros: Ninguno
  • Descripción: Devuelve el texto en la barra de chat TextBox.Text .
  • Devoluciones: string

Establecer texto de etiqueta

  • Parámetros: string : text
  • Descripción: Establece el Text del modo de mensaje TextLabel al dado text.
  • Regresos: vacío

Habilitarse

  • Parámetros: Ninguno
  • Descripción: Regresa si la barra de chat es Visible .
  • Devoluciones: bool

EstablecerActivado

  • Parámetros: bool : enabled
  • Descripción: Establece si la barra de chat es Visible .
  • Regresos: vacío

Establecer tamaño de texto

  • Parámetros: int : textSize
  • Descripción: Establece el TextSize de ambos el chat bar's TextBox y MessageMode TextLabel .
  • Regresos: vacío

Restablecer tamaño

  • Parámetros: Ninguno
  • Descripción: Restablece el tamaño de la barra de chat a una línea de texto.
  • Regresos: vacío

Establecer objetivo de canal

  • Parámetros: string : channelName
  • Descripción: Establece el objetivo ChatChannelUI dado su channelName al que la barra de chat debería enviar mensajes.
  • Regresos: vacío

Fondo de desaparición

  • Parámetros: flotar : duration``duration
  • Descripción: Fadea el fondo durante los segundos dados duration en segundos.Nota: las llamadas posteriores para controlar la desaparición entrante/saliente anularán las llamadas anteriores.
  • Regresos: vacío

Desaparecer en el fondo

  • Parámetros: flotar : duration``duration
  • Descripción: Se desvanece en el fondo sobre el dado duration en segundos.Nota: las llamadas posteriores para controlar la desaparición entrante/saliente anularán las llamadas anteriores.
  • Regresos: vacío

Texto de desaparición

  • Parámetros: flotar : duration``duration
  • Descripción: Fadea el texto sobre el dado duration en segundos.Nota: las llamadas posteriores para controlar la desaparición entrante/saliente anularán las llamadas anteriores.
  • Regresos: vacío

Texto de desaparición

  • Parámetros: flotar : duration``duration
  • Descripción: Desaparece en el texto sobre el dado duration en segundos.Nota: las llamadas posteriores para controlar la desaparición entrante/saliente anularán las llamadas anteriores.
  • Regresos: vacío

Interfaz de chatChannelUI

El ChatChannelUI es la versión del lado del cliente de ChatChannel.Recibe mensajes de chat del servidor y los pasa al registro de mensajes de chat.asociado con ella.

Métodos

Añadir mensaje al canal

Eliminar último mensaje del canal

Registro de mensajes claros

Mostrar registro de mensajes de chat

El ChatMessageLogDisplay gestiona el renderizado de mensajes de chat en un ChatChannelUI.

Métodos

Agregar mensaje

  • Parámetros: Mensaje de chatmessage
  • Descripción: Añade un message a la pantalla de registro de mensajes.
  • Regresos: vacío

Eliminar último mensaje

  • Parámetros: Ninguno
  • Descripción: Elimina el más antiguo mensaje de chat en la pantalla del registro de mensajes.
  • Regresos: vacío

Reordenar todos los mensajes

  • Parámetros: Ninguno
  • Descripción: Reordena todos los displays de mensajes en orden ascendente, en relación con el tamaño del display de mensajes.Esto debe llamarse si el indicador de registro de mensajes se redimensiona.
  • Regresos: vacío

Borrar

  • Parámetros: Ninguno
  • Descripción: Elimina todos los mensajes de chat de la pantalla de registro de mensajes.
  • Regresos: vacío

Texto de desaparición

  • Parámetros: flotarduration
  • Descripción: Fadea el texto sobre el dado duration en segundos.Nota: las llamadas posteriores para controlar la desaparición entrante/saliente anularán las llamadas anteriores.
  • Regresos: vacío

Texto de desaparición

  • Parámetros: flotarduration
  • Descripción: Desaparece en el texto sobre el dado duration en segundos.Nota: las llamadas posteriores para controlar la desaparición entrante/saliente anularán las llamadas anteriores.
  • Regresos: vacío

Estado personalizado de chat

El estado de chat personalizado es una interfaz de llamadas utilizada al crear un estado de chat personalizado en la barra de chat.

El chat de susurro y el chat de equipo usan ChatCustomState para indicar al jugador dónde se enviará su mensaje.

Devoluciones de llamada

Texto actualizado

  • Parámetros: Ninguno
  • Descripción: Se llama cuando el texto en la barra de chat se actualiza.
  • Regresos: vacío

Obtener mensaje

  • Parámetros: Ninguno
  • Descripción: Se llama para recuperar el texto del mensaje como se escribiría como un solo comando.Esto se usa en el caso de que el servidor deba procesar el comando como texto, en lugar del estado visualizado del comando.
  • Devoluciones: string

Mensaje de proceso completado

  • Parámetros: Ninguno
  • Descripción: Se llama cuando el jugador envía el mensaje que está siendo procesado por el estado personalizado.Esto debería devolver verdadero si el mensaje no debe mostrarse o enviarse al servidor.
  • Devoluciones: bool

Destruir

  • Parámetros: Ninguno
  • Descripción: Se llama como la barra de chat se está reiniciando de vuelta a su estado original antes de la modificación de estado personalizada.
  • Regresos: vacío

Configuración de chat

El Configuración de chat es un diccionario de configuraciones para el lado del cliente del sistema de chat de Lua.Se almacenan en un ModuleScript llamado Configuración de chat , que se puede encontrar dentro del servicio de juego Chat , bajo el Folder llamado ClientChatModules .El módulo puede ser requerido y sus propiedades pueden cambiarse durante el tiempo de ejecución.

Para cambiar una configuración, requiera este módulo usando un LocalScript de la siguiente manera:

-- Requiere el módulo de Configuración de chat (espere a que se cargar)

local Chat = game:GetService("Chat")

local ClientChatModules = Chat:WaitForChild("ClientChatModules")

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

-- Cambia las configuraciones como lo harías con cualquier otra tabla.

ChatSettings.MaximumMessageLength = 100

Configuración del comportamiento del chat

Ventana arrastrable

Ventana resizable

  • Tipo: bool
  • Por defecto: false
  • Descripción: Determina si el ventana de chat se puede redimensionar por el jugador

Juego de navegación habilitado

  • Tipo: bool
  • Por defecto: false
  • Descripción: Determina si los gamepads pueden navegar por la interfaz de chat.

Mostrar mensaje filtrado de usuario

  • Tipo: bool
  • Por defecto: true
  • Descripción: Determina si los jugadores deben ver la versión filtrada de sus mensajes de chat o el contenido original que escribieron.

ChatOnConBarraSuperiorDesactivada

  • Tipo: bool
  • Por defecto: false
  • Descripción: Determina si la interfaz de chat está habilitada incluso si la barra superior está deshabilitada.

BubbleChatEnabled

  • Tipo: bool
  • Por defecto: game:GetService("Players").BubbleChat
  • Descripción: Determina si el chat de burbujas está habilitado.

ClasicoChatEnabled

  • Tipo: bool
  • Por defecto: game:GetService("Players").ClassicChat
  • Descripción: Determina si el chat clásico está habilitado.

Configuración del tamaño del texto del chat

Tamaño del texto de la ventana de chat

  • Tipo: int
  • Por defecto: 18
  • Descripción: Determina el tamaño del texto en la ventana de chat.

Tamaño del texto de la barra de chat

  • Tipo: int
  • Por defecto: 18
  • Descripción: Determina el tamaño del texto en la barra de chat.

Tamaño del texto de la ventana de chatPhone

  • Tipo: int
  • Por defecto: 14
  • Descripción: Determina el tamaño del texto en la ventana de chat para teléfonos.

Tamaño del texto de la barra de chatPhone

  • Tipo: int
  • Por defecto: 14
  • Descripción: Determina el tamaño del texto en la barra de chat para teléfonos.

Configuración de fuente

Fuente predeterminada

Fuente de barra de chat

Configuración de color

Color de fondo

  • Tipo: Color3
  • Por defecto: Color3.new(0, 0, 0)
  • Descripción: Determina el BackgroundColor3 de la ventana de chat.

Color predeterminado del mensaje

Color de nombre predeterminado

Color de fondo de barra de chat

  • Tipo: Color3
  • Por defecto: Color3.new(0, 0, 0)
  • Descripción: Determina el BackgroundColor3 de la barra de chat.

Color de la caja de chat

  • Tipo: Color3
  • Por defecto: Color3.new(1, 1, 1)
  • Descripción: Determina el BackgroundColor3 de la barra de chatTextBox .

Color del texto de la barra de chat

  • Tipo: Color3
  • Por defecto: Color3.new(0, 0, 0)
  • Descripción: Determina el TextColor3 de la barra de chat.

Color del mensaje de error

  • Tipo: Color3
  • Por defecto: Color3.fromRGB(245, 50, 50)
  • Descripción: Determina el TextColor3 de mensajes de error.

Configuración de ventana

Tamaño mínimo de ventana

  • Tipo: UDim2
  • Por defecto: UDim2.new(0.3, 0, 0.25, 0)
  • Descripción: Determina el tamaño más pequeño posible del ventana de chat (dado que WindowResizable está habilitado).

Tamaño máximo de ventana

  • Tipo: UDim2
  • Por defecto: UDim2.new(1, 0, 1, 0)
  • Descripción: Determina el tamaño más grande posible de la ventana de chat (dado que WindowResizable está habilitado).
  • Notas: Si esto se cambia para que sea mayor que el tamaño completo de la pantalla, empiezan a suceder cosas extrañas con la verificación de los límites de tamaño/posición.

Posición de ventana predeterminada

  • Tipo: UDim2
  • Por defecto: UDim2.new(0, 0, 0, 0)
  • Descripción: Determina la posición predeterminada de la ventana de chat.

Tamaño predeterminado de la ventana Phone

  • Tipo: UDim2
  • Por defecto: UDim2.new(0.5, 0, 0.5, (7 * 2) + (5 * 2))
  • Descripción: Determina el tamaño predeterminado de la ventana de chat en los teléfonos.

Tableta de tamaño de ventana predeterminada

  • Tipo: UDim2
  • Por defecto: UDim2.new(0.4, 0, 0.3, (7 * 2) + (5 * 2))
  • Descripción: Determina el tamaño predeterminado de la ventana de chat en las tablas.

Tamaño predeterminado de la ventana Desktop

  • Tipo: UDim2
  • Por defecto: UDim2.new(0.3, 0, 0.25, (7 * 2) + (5 * 2))
  • Descripción: Determina el tamaño predeterminado de la ventana de chat en el equipo de escritorio.

Desaparecer y configurar en las opciones

Tiempo de desaparición del fondo de la ventana de chat

  • Tipo: flotar (segundos)
  • Por defecto: 0.5
  • Descripción: Determina cuánto tiempo debe tardar en desaparecer el fondo de la ventana de chat.

Tiempo de desaparición del texto de la ventana de chat

  • Tipo: flotar (segundos)
  • Por defecto: 30
  • Descripción: Determina cuánto tiempo debe tardar en desaparecer el texto de la ventana de chat.

Duración predeterminada del chat

  • Tipo: flotar (segundos)
  • Por defecto: 0.8
  • Descripción: Determina cuánto tiempo deben tardar en desaparecer los elementos de la interfaz de usuario de chat.

ChatShouldFadeInFromNuevaInformación

  • Tipo: bool
  • Por defecto: false
  • Descripción: Determina si el chat debe desaparecer al recibir nuevos mensajes.

Animación de chatFPS

  • Tipo: flotar
  • Por defecto: 20.0
  • Descripción: Determina la tasa de fotogramas de las animaciones de desaparición en la interfaz de chat.

Configuración del canal

Nombre de canal general

  • Tipo: string
  • Por defecto: "All"
  • Descripción: Determina el nombre del canal predeterminado.

Mensajes de eco en canal general

  • Tipo: bool
  • Por defecto: true
  • Descripción: Determina si los mensajes a canales diferentes del canal predeterminado deben ser replicados en el canal predeterminado.

Nombre de canal máximo

  • Tipo: int
  • Por defecto: 12
  • Descripción: Determina la longitud máxima de un nombre de canal antes de que se recorte.

Longitud de historia de mensajes por canal

  • Tipo: int
  • Por defecto: 50
  • Descripción: Determina el número máximo de mensajes de chat que se pueden mostrar en un canal de chat.

Mostrar texto de ayuda para unirse y salir

  • Tipo: bool
  • Por defecto: false
  • Descripción: Determina si se muestra el texto de ayuda para unirse/salir de los canales.

Configuración de mensajes

Longitud máxima del mensaje

Espacio blanco no permitido

  • Tipo: array< string >
  • Por defecto: {"\n", "\r", "\t", "\v", "\f"}
  • Descripción: Determina los caracteres de espacio en blanco que no se permiten.

Haga clic en el nombre del jugador para susurrar

  • Tipo: bool
  • Por defecto: true
  • Descripción: Determina si el jugador puede hacer clic en el nombre de otro jugador para mantener una conversación susurrada con ellos.

Haga clic en el nombre del canal para establecer el canal principal

  • Tipo: bool
  • Por defecto: true
  • Descripción: Determina si el jugador puede hacer clic en la pestaña de un canal para establecerlo como su canal principal.

Configuraciones diversas

Nombres de jugadores de comando de susurro automático completos

  • Tipo: bool
  • Por defecto: true
  • Descripción: Determina si el comando susurro debe completar automáticamente los nombres de los jugadores.

Eventos

Configuración cambiada

  • Parámetros: Library.string``settingName , Variante newValue
  • Descripción: Se enciende cuando un ajuste con el dado settingName se cambia a newValue .