Chat

Mostrar obsoleto

*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.

Não criável
Serviço
Não replicado

El servicio Chat alberga el código Lua responsable de la ejecución del sistema de chat de legado. Como con StarterPlayerScripts , los objetos predeterminados como 1> Class.Script|Scripts1> y 4> Class.ModuleScript|ModuleScripts4> se insertan en el servicio.

Resumo

Propriedades

  • Determina si los mensajes del chat del jugador aparecerán encima de su avatar.

  • Segurança não acessível
    Ler Parallel

    Alterna si el marco de chat predeterminado debería cargarse automáticamente cuando se ejecuta el juego.

Métodos

Propriedades

BubbleChatEnabled

Ler Parallel

Si es así, ingresar un mensaje en el chat resultará en una burbuja de chat que aparecerá encima del jugadorde Player.Character . Este comportamiento se puede habilitar directamente haciendo clic en este control desplegable en Studio, o usando un LocalScript :


local ChatService = game:GetService("Chat")
ChatService.BubbleChatEnabled = true

Esto debe hacerse en el cliente, alternando este valor en un lado del servidor Script no tendrá ningún efecto.

LoadDefaultChat

Segurança não acessível
Ler Parallel

Alterna si el marco de chat predeterminado debería cargarse automáticamente cuando se ejecuta el juego.

Métodos

Chat

void

La función de chat dispara el evento Chat.Chatted con los parámetros especificados en este método.

Por defecto, hay un LocalScript dentro de cada objeto de jugador llamado PlayerScripts , que causa una ventana de diálogo para aparecer encima del personaje o personaje de chat cuando se activa el evento de chat.

Nota: Ya que los diálogos son controlados por un LocalScript, no podrás ver ningún diálogo creado desde este método a menos que estés ejecutando en el modo Jugar Solo

Parâmetros

partOrCharacter: Instance

Una instancia que es la parte o personaje del que el BubbleChat diálogo debería aparecer encima.

message: string

La cadena de mensajes está siendo chateada.

Un Enum.ChatColor que especifica el color del mensaje de chat.

Valor Padrão: "Blue"

Devolução

void

Amostras de código

Chat:Chat

local ChatService = game:GetService("Chat")
local part = Instance.new("Part")
part.Anchored = true
part.Parent = workspace
ChatService:Chat(part, "Blame John!", "Red")

InvokeChatCallback

InvokeChatCallback llamará a una función registrada por RegisterChatCallback, dado el Catálogo de funciones y los argumentos para enviar la función. Mostrará el resultado de la función registrada o aumentará un error si no se ha registrado ninguna función.

Esta función es llamada por el sistema de chat Lua para que los llamados de chat se registren para cambiar el comportamiento de ciertas características. A menos que estés reemplazando el sistema de chat Lua por defecto con el en posesión, no deberías necesitar llamar a esta función. Puedes leer sobre las diferentes funciones de llamado en Chat:RegisterChatCallback() .

Parâmetros

callbackType: Enum.ChatCallbackType

El tipo de llamada de retorno para invocar.

callbackArguments: Tuple

Los argumentos que se enviarán a la función de llamada registrada.


Devolução

Los valores devueltos por la función registrada en el ChatCallbackType.

RegisterChatCallback

void

RegisterChatCallback vincula una función a un evento de chat en algún sistema de chat para afectar el comportamiento del sistema de chat Lua. El primer argumento determina el evento (usando el conjunto de datos Enum.ChatCallbackType ) a la que el segundo argumento, la función, se vinculará. El sistema de

Al crear una ventana de chat

Solo cliente. Invocado antes de que el cliente construya la ventana de chat. Debe返回一个表 of settings para ser fusionado en la información devuelta por el módulo ChatSettings.

Mensaje de formato de cliente

Solo cliente. Invocado antes de que el cliente muestre un mensaje (ya sea un mensaje de chat del cliente, un mensaje del sistema o /me command). Esta función se invoca con el objeto de mensaje y puede (o no puede) devolver una tabla para ser fusionada en message.ExtraData .

EnClientSendingMessage

No está invocado en este momento.

EnServerReceivingMessage

Solo para el servidor. Invocado cuando el servidor recibe un mensaje de un orador (nota que los oradores pueden no ser necesariamente un Player chateando). Este llamado se realiza con el objeto de mensaje. La función puede hacer cambios en el objeto de mensaje para cambiar la manera en que se procesa el mensaje. El objeto de mensaje debe devolverse para que este llamado se pueda realizar. Configurar este llam

  • Establece message.ShouldDeliver para false para cancelar la entrega del mensaje a los jugadores (útil para implementar una lista de exclusión de chat)
  • Obtener/establecer el color del nombre del bocina( message.ExtraData.NameColor , un Color3) en una base de mensajes por mensaje

Parâmetros

callbackType: Enum.ChatCallbackType

El llamado a la cual la función se registrará (esto determina de qué manera se llama la función).

callbackFunction: function

La función para llamar cuando se invoca el retorno de llamada usando chat:ExecuteChatCallback.


Devolução

void

SetBubbleChatSettings

void

Esta función personaliza varios ajustes del chat de burbujas en el juego.

Antes de usar esto, asegúrese de que el chat de burbujas esté habilitado al configurar Chat.BubbleChatEnabled para que sea verdadero.

El argumento de configuración es una tabla donde las llaves son los nombres de las configuraciones que desea editar y los valores son lo que desea cambiar estas configuraciones. Tenga en cuenta que no tiene que incluir todas en el argumento de configuración, omitiendo algunas de ellas resultará en que mantengan su valor predeterminado.

Esta función solo es del lado del cliente, intentando llamarla desde el servidor se producirá un error.

Parâmetros

settings: Variant

Una tabla de configuración.


Devolução

void

Amostras de código

Customize visual aspects

local ChatService = game:GetService("Chat")
ChatService:SetBubbleChatSettings({
BackgroundColor3 = Color3.fromRGB(180, 210, 228),
TextSize = 20,
Font = Enum.Font.Cartoon,
})
Restore default settings

local ChatService = game:GetService("Chat")
ChatService:SetBubbleChatSettings({})

CanUserChatAsync

Rendimentos

Devolverá false si el jugador con el ID de Player.UserId especificado no está permitido para chatear debido a su configuración de cuenta.

Parâmetros

userId: number

Devolução

CanUsersChatAsync

Rendimentos

Devolverá false si los dos usuarios no pueden comunicarse porque sus configuraciones de cuenta no lo permiten.

Parâmetros

userIdFrom: number
userIdTo: number

Devolução

FilterStringAsync

Rendimentos

Advertencia de desaparición parcial : Calling this function from the client using a LocalScript is desusar, en desuso (noun), and will be disabled in the future. El filtrado de texto debe hacerse desde un Script en el servidor que utiliza el mismo nombre de parámetro y introducirde regreso.

Los juegos que no filtran adecuadamente el texto generado por los jugadores podrían estar sujetos a la acción de moderación. Por favor, asegúrese de que un juego filtre adecuadamente el texto antes de publicarlo.

FilterStringAsync filtra una cadena usando el filtrado que es apropiado para el envío y la recepción del jugador. Si la cadena filtrada se usa para un mensaje persistente, como el nombre de una comprar, escribiendo en un letrero, etc, entonces la función debe ser llamada con el autor como tanto el remitente como el receptor.

Esta función debería usarse cada vez que un jugador puede ingresar texto personalizado en cualquier contexto , lo más comúnmente usando un TextBox . Algunos ejemplos de texto para ser filtrados:

  • Mensajes de chat personalizados
  • Nombres de personajes personalizados
  • Nombres para una tienda en un juego de estilo de tycoon

Parâmetros

stringToFilter: string

La cadena de texto原始值 para ser filtrado, exactamente como ingresó el jugador.

playerFrom: Player

El autor del texto.

playerTo: Player

El destinatario propuesto del texto proporcionado; usa al autor si el texto es persistente (ver la descripción).


Devolução

FilterStringForBroadcast

Rendimentos

Filtra una cadena enviada desde playerFrom para transmitir a ningún destino en particular. El mensaje filtrado tiene más limitaciones que Chat:FilterStringAsync() .

Algunos ejemplos de dónde se puede usar este método:

  • Paredes de mensajes
  • Gritos entre servidores
  • Signos creados por usuarios

Llamar FilterString desde LocalScripts está obsoleto y se desactivará en el futuro. La filtración de texto deberse hacer desde el lado del servidor Scripts usando FilterStringAsync.

Nota:: Un juego que no utilice esta función de filtro para el chat personalizado o el texto generado por el usuario puede ser objeto de acción de moderación.

Parâmetros

stringToFilter: string

La cadena de mensaje está siendo filtrada.

playerFrom: Player

Instancia del jugador que envía el mensaje.


Devolução

cadenade mensaje filtrada.

Amostras de código

Chat:FilterStringForBroadcast

local Players = game:GetService("Players")
local Chat = game:GetService("Chat")
local playerFrom = Players.LocalPlayer
local message = "Hello world!"
-- Filter the string and store the result in the 'FilteredString' variable
local filteredString = Chat:FilterStringForBroadcast(message, playerFrom)
print(filteredString)

Eventos

Chatted

Se activa cuando se llama Chat:Chat() .

Parâmetros

part: Instance
message: string