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í.

Puede usar los siguientes módulos de chat para apoyar 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

Añadir canal

Eliminar canal

  • Parámetros: string : channelName
  • Descripción: Elimina un ChatChannelUI con el nombre de channelName dado de la ventana.
  • Retornos: nulo

Obtener canal

Obtener el canal actual

Cambiar canal actual

  • Parámetros: string : channelName
  • Descripción: Cambia el canal actual a la ChatChannelUI con el dado channelName si existe.
  • Retornos: nulo

Haz que tu vista sea visible

  • Parámetros: Ninguno
  • Descripción: Muestra si la ventana es visible o no. Nota: esto se refiere a la interfaz de usuario de chat en general; cuando la ventana de chat se hace transparente debido a la inactividad, la ventana aún se considera visible.
  • Retornos: Booleano

Pantalla de visibilidad

  • Parámetros: Booleano : visible
  • Descripción: Establece la visibilidad de la ventana de chat.
  • Retornos: nulo

Fondo de pantalla

  • Parámetros: flotar : duration
  • Descripción: Se desvanecerá el fondo sobre el dado duration en segundos. Nota: las llamadas posteriores para controlar el desvanecimiento en/out anularán las llamadas anteriores.
  • Retornos: nulo

Fondo de pantalla

  • Parámetros: flotar : duration
  • Descripción: Desaparece en el fondo por el duration dado en segundos. Nota: las llamadas posteriores para controlar el desaparicio en/out anularán las llamadas anteriores.
  • Retornos: nulo

Texto de FadeOut

  • Parámetros: flotar : duration
  • Descripción: Desaparece el texto sobre el tiempo dado duration en segundos. Nota: las llamadas posteriores para controlar el desaparicio en/fuera anularán las llamadas anteriores.
  • Retornos: nulo

FadeInTexto

  • Parámetros: flotar : duration
  • Descripción: Desaparece en el texto sobre el tiempo dado duration en segundos. Nota: las llamadas posteriores para controlar el desaparicio en/out anularán las llamadas anteriores.
  • Retornos: nulo

Barra de chat

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

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

Métodos

Obtener Texas

  • Parámetros: Ninguno
  • Descripción: Muestra el TextBox del chat.
  • Retornos: TextBox

Obtener etiqueta de mensaje

  • Parámetros: Ninguno
  • Descripción: Muestra el modo de mensaje TextLabel .
  • Retornos: TextLabel

Está enfocado

  • Parámetros: Ninguno
  • Descripción: Muestra si la barra de chat está en el enfoque (el jugador está escribiendo en la caja delimitadora). Equivalente a llamar a TextBox en el resultado de GetExecutor.
  • Retornos: Booleano

Enfoque de captura

  • Parámetros: Ninguno
  • Descripción: Obliga al cliente a enfocarse en el TextBox de la barra de chat. Equivalente a llamar a TextBox:CaptureFocus en el resultado de GetExecutor.
  • Retornos: nulo

Enfoque de lanzamiento

  • Parámetros: Booleano : submitted = false
  • Descripción: Relea el enfoque de la barra de chat TextBox . Si submitted es cierto, esto se comportará como si el jugador hubiera presionado Enter para enviar el mensaje.
  • Retornos: nulo

Restablecer texto

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

Establecer Texto de Título

  • Parámetros: string : text
  • Descripción: Establece el Text de la barra de chat TextBox al 0> text0> dado.
  • Retornos: nulo

Obtener TexasText

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

Establecer texto de etiqueta de texto

  • Parámetros: string : text
  • Descripción: Establece el Text del modo de mensaje TextLabel a el dado 0> text0> .
  • Retornos: nulo

Habilitar

  • Parámetros: Ninguno
  • Descripción: Muestra si la barra de chat es Visible .
  • Retornos: Booleano

Habilitado

  • Parámetros: Booleano : enabled
  • Descripción: Establece si la barra de chat es Visible .
  • Retornos: nulo

Establecer el tamaño de texto

  • Parámetros: int : textSize
  • Descripción: Establece el TextSize de ambas la barra de chat's TextBox y el modo de mensajes's 0> TextLabel0> .
  • Retornos: nulo

Restablecer tamaño

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

Establecer el objetivo de canal

  • Parámetros: string : channelName
  • Descripción: Establece el objetivo ChatChannelUI que se le da su channelName a la que la barra de chat debe enviar mensajes.
  • Retornos: nulo

Fondo de pantalla

  • Parámetros: flotar : duration 0> duration0>
  • Descripción: Se desvanecerá el fondo sobre el dado duration en segundos. Nota: las llamadas posteriores para controlar el desvanecimiento en/out anularán las llamadas anteriores.
  • Retornos: nulo

Fondo de pantalla

  • Parámetros: flotar : duration 0> duration0>
  • Descripción: Desaparece en el fondo por el duration dado en segundos. Nota: las llamadas posteriores para controlar el desaparicio en/out anularán las llamadas anteriores.
  • Retornos: nulo

Texto de FadeOut

  • Parámetros: flotar : duration 0> duration0>
  • Descripción: Desaparece el texto sobre el tiempo dado duration en segundos. Nota: las llamadas posteriores para controlar el desaparicio en/fuera anularán las llamadas anteriores.
  • Retornos: nulo

FadeInTexto

  • Parámetros: flotar : duration 0> duration0>
  • Descripción: Desaparece en el texto sobre el tiempo dado duration en segundos. Nota: las llamadas posteriores para controlar el desaparicio en/out anularán las llamadas anteriores.
  • Retornos: nulo

Interfaz de usuario de chat

El ChatChannelUI es la versión del cliente de ChatChannel . Recibe ChatMessages del servidor y los transmite a 1> ChatMessageLogDisplay1> . Asociado con él.

Métodos

Añadir mensaje al canal

Eliminar el último mensaje del canal

Borrar registro de mensajes

Mostrar el mensaje de chat

El ChatMessageLogDisplay maneja la renderización de ChatMessages en un ChatChannelUI .

Métodos

Añadir mensaje

  • Parámetros: ChatMessagemessage
  • Descripción: Añade un message a la pantalla de mensajes.
  • Retornos: nulo

Eliminar el último mensaje

  • Parámetros: Ninguno
  • Descripción: Elimina el mensaje de chat más antiguo en la pantalla de mensajes.
  • Retornos: nulo

Restablecer el orden de todos los mensajes

  • Parámetros: Ninguno
  • Descripción: Re-ordenar todos los elementos de la pantalla de mensajes en orden ascendente, en relación con el tamaño de la pantalla de mensajes. Esto debería llamarse si se cambia el tamaño del registro de mensajes.
  • Retornos: nulo

Borrar

  • Parámetros: Ninguno
  • Descripción: Elimina todos los ChatMessages del mensaje de la pantalla.
  • Retornos: nulo

Texto de FadeOut

  • Parámetros: flotarduration
  • Descripción: Desaparece el texto sobre el tiempo dado duration en segundos. Nota: las llamadas posteriores para controlar el desaparicio en/fuera anularán las llamadas anteriores.
  • Retornos: nulo

FadeInTexto

  • Parámetros: flotarduration
  • Descripción: Desaparece en el texto sobre el tiempo dado duration en segundos. Nota: las llamadas posteriores para controlar el desaparicio en/out anularán las llamadas anteriores.
  • Retornos: nulo

Estado de chat personalizado

El ChatCustomState es una interfaz de llamadas de uso múltiple que se utiliza al crear un estado de chat personalizado en la barra de chat.

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

Llamadas

Actualizado de Texto

  • Parámetros: Ninguno
  • Descripción: Llamado cuando el texto en la barra de chat se actualiza.
  • Retornos: nulo

Obtener mensaje

  • Parámetros: Ninguno
  • Descripción: Llamado para recuperar el texto del mensaje como se escribiría como un solo comando. Esto se usa en el caso de que el servidor necesite procesar el comando como texto, en lugar de la forma visualizada del comando.
  • Retornos: string

Mensaje de Proceso Completado

  • Parámetros: Ninguno
  • Descripción: Llamado cuando el jugador envía el mensaje que se está procesando por el estado personalizado. Esto debería devolver true si el mensaje no debería ser mostrado o enviado al servidor.
  • Retornos: Booleano

Destruir

  • Parámetros: Ninguno
  • Descripción: Llamado como el ChatBar está siendo restablecido a su estado original antes de la modificación de estado personalizado.
  • Retornos: nulo

Configuración del Chat

El ChatSettings es un diccionario de configuraciones para el lado del cliente del sistema de chat Lua. Están almacenados en un ModuleScript llamado ChatSettings, que se puede encontrar dentro del servicio de juego 1> Chat 1> , bajo el nombre de 4> Folder4> nombrado 7>

Para cambiar una configuración, requiere este módulo usando un LocalScript en el modo siguiente:

-- Requiere el módulo de ChatSettings (espera a que se cargar)

local Chat = game:GetService("Chat")

local ClientChatModules = Chat:WaitForChild("ClientChatModules")

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

-- Cambia la configuración como lo harías con cualquier otra tabla.

ChatSettings.MaximumMessageLength = 100

Configuración de comportamiento de chat

Ventana de arrastre

  • Tipo: Booleano
  • Por defecto: false
  • Descripción: Determina si la ventana de chat es Draggable .

Ventana escalable

  • Tipo: Booleano
  • Por defecto: false
  • Descripción: Determina si la Ventana de chat se puede redimensionar por el jugador

Gamepadナビゲーション有効

  • Tipo: Booleano
  • Por defecto: false
  • Descripción: Determina si las plataformas de juegos pueden navegar por la interfaz de usuario de chat.

Mostrar mensaje filtrado de usuario

  • Tipo: Booleano
  • 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.

Chat con barra superior desactivada

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

BubbleChatHabilitado

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

ChatClásicoActivado

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

Configuración del tamaño del texto de chat

Tamaño de ventana de chat

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

Tamaño de ChatBarText

  • Tipo: int
  • Por defecto: 18
  • Descripción: Determina el tamaño del texto en el ChatBar .

Tamaño de ventana de chat

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

Tamaño de texto de chat

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

Configuración de fuentes

Fuente predeterminada

Barra de chat

Configuración de colores

Color de fondo

  • Tipo: Color3
  • Por defecto: Color3.new(0, 0, 0)
  • Descripción: Determina el BackgroundColor3 del ChatWindow .

Color de mensaje predeterminado

  • Tipo: Color3
  • Por defecto: Color3.new(1, 1, 1)
  • Descripción: Determina el color predeterminado de TextColor3 de ChatMessages en la 0>Ventana de chat0> .

Color de nombre predeterminado

  • Tipo: Color3
  • Por defecto: Color3.new(1, 1, 1)
  • Descripción: Determina el valor predeterminado de TextColor3 de los nombres de los hablantes de ChatMessages en la 0> ventana de chat0> .

Color de fondo de chat

  • Tipo: Color3
  • Por defecto: Color3.new(0, 0, 0)
  • Descripción: Determina el BackgroundColor3 del ChatBar.

Color de ChatBarBox

  • Tipo: Color3
  • Por defecto: Color3.new(1, 1, 1)
  • Descripción: Determina el BackgroundColor3 del ChatBar .

Color de chatBarText

  • Tipo: Color3
  • Por defecto: Color3.new(0, 0, 0)
  • Descripción: Determina el TextColor3 del ChatBar .

Color de mensaje de error

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

Configuración de la ventana

Tamaño de ventana mínimo

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

Tamaño máximo de la ventana

  • Tipo: UDim2
  • Por defecto: UDim2.new(1, 0, 1, 0)
  • Descripción: Determina el tamaño más grande posible del ChatWindow (dado que WindowResizable está habilitado).
  • Notas: Si esto se cambia para ser mayor que el tamaño de la pantalla completa, comienzan a ocurrir cosas extrañas con el chequeo de 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 de ventana predeterminado

  • 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 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.

Escritorio de tamaño de ventana predeterminado

  • 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.

Desvanecer y configurar en la configuración

Tiempo de desvanecimiento de la ventana de chat

  • Tipo: flotar (segundos)
  • Por defecto: 0.5
  • Descripción: Determina la duración de la transición degradada del fondo del ChatWindow .

Tiempo de desvanecimiento de ChatWindowText

  • Tipo: flotar (segundos)
  • Por defecto: 30
  • Descripción: Determina la duración de la desaparición del texto del ChatWindow

Tiempo de desaparición predeterminado

  • Tipo: flotar (segundos)
  • Por defecto: 0.8
  • Descripción: Determina la duración de los elementos de la interfaz de usuario de chat que se desvanecen.

ChatShouldFadeInFromNewInformation

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

Animación de chat

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

Configuración del canal

Nombre general del canal

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

Canal general de mensajes de Echo

  • Tipo: Booleano
  • Por defecto: true
  • Descripción: Determina si los mensajes a los canales que no son el canal por defecto deben ser echados en el canal por defecto.

Longitud máxima de nombre de canal

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

Longitud de mensaje por canal

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

Mostrar texto de unión y salida

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

Configuración de mensajes

Largo de mensaje máximo

  • Tipo: int
  • Por defecto: 200
  • Descripción: Determina la máxima longitud de ChatMessages .

Espacio no permitido

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

Haga clic en el nombre de jugador para susurrar

  • Tipo: Booleano
  • Por defecto: true
  • Descripción: Determina si el jugador puede hacer clic en el nombre de otro jugador para involucrarse en un chat de susurros con ellos.

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

  • Tipo: Booleano
  • 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 Misceláneas

Nombres de jugadores que se escuchan automáticamente

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

Eventos

CambiadoConfigurado

  • Parámetros: Library.string``settingName , Variante 0> newValue0>
  • Descripción: Dispara cuando se cambia una configuración con el nombre dado settingName a newValue .