Personalizzare la Chatdi testo

Il sistema chat di testo in-experience alimentato da TextChatService , consente ai giocatori di comunicare facilmente e socializzare tra loro in esperienze dal vivo. Oltre a supportare il chat di testo predefinito, puoi personalizzare l'interfaccia utente front-end.

Configurazione della finestra di chat

La finestra di chat generale consiste della finestra di chat, di una barra di input e di opzionali schede di canale.

Le schede del canale sono disabilitate per impostazione predefinita e ogni component può essere attivato/disattivato in Studio o tramite scripting:

Direttamente nella finestra Explorer di Studio, espandi il ramo TextChatService e seleziona ChatWindowConfiguration , 1> Class.ChatInputBarConfiguration1> o 4> Class.ChannelTabsConfiguration4> . Quindi, nella finestra 7> Proprietà7>, abilita o disabilita il component.

Quando ChannelTabsConfiguration è abilitato, ogni Class.TextChannel apparirà in una scheda come descritti nella seguente tabella. Inoltre, ogni TextChannel1> Class.TextChannel1> creerà una scheda corrispondente alla Proprietàdel canale 4> Class.Instance.

Aspetto della finestra

L'aspetto della finestra di chat generale è personalizzabile attraverso Class.ChatWindowConfiguration.

Aspetto della barra di input

L'aspetto della chat barra di input è personalizzabile attraverso ChatInputBarConfiguration .

Aspetto delle schede del canale

L'aspetto delle schede del canale è personalizzabile attraverso ChannelTabsConfiguration .

Personalizzare i messaggi

Puoi personalizzare l'aspetto dei messaggi di chat e dei premi di ChatWindowMessageProperties e TextChatService.OnChatWindowAdded callback senza sovrascrivere l'interfaccia utente esistente. Le opzioni di personalizzazione ti consentono di modificare l'aspetto dei messaggi di chat per corrispondere all'argomento della tua esperienza e puoi anche ordinare o evidenziare i messaggi

Colorare i nomi utente

Quando un utente invia un Messaggiodi chat, il suo DisplayName viene visualizz

Script locale - Colori di nome utente casuali
local TextChatService = game:GetService("TextChatService")

local chatWindowConfiguration = TextChatService.ChatWindowConfiguration

local nameColors = {
	Color3.fromRGB(255, 0, 0),
	Color3.fromRGB(0, 255, 0),
	Color3.fromRGB(0, 0, 255),
	Color3.fromRGB(255, 255, 0),
}

TextChatService.OnChatWindowAdded = function(message: TextChatMessage)
	local properties = chatWindowConfiguration:DeriveNewMessageProperties()

	local textSource = message.TextSource
	if textSource then
		local index: number = (textSource.UserId % #nameColors) + 1
		local randomColor: Color3 = nameColors[index]

    	properties.PrefixTextProperties = chatWindowConfiguration:DeriveNewMessageProperties()
		properties.PrefixTextProperties.TextColor3 = randomColor
	end

	return properties
end

Puoi anche applicare colori e gradi di trasparenza ai premi del messaggio di colore usando UIGradient .

Colori utente gradiente
local TextChatService = game:GetService("TextChatService")

local chatWindowConfiguration = TextChatService.ChatWindowConfiguration

local gradient = Instance.new("UIGradient")
gradient.Color = ColorSequence.new{
	ColorSequenceKeypoint.new(0, Color3.fromRGB(255, 0, 0)),
	ColorSequenceKeypoint.new(0.5, Color3.fromRGB(255, 255, 0)),
	ColorSequenceKeypoint.new(1, Color3.fromRGB(255, 0, 255))
}

TextChatService.OnChatWindowAdded = function(message: TextChatMessage)
	local properties = chatWindowConfiguration:DeriveNewMessageProperties()

	local textSource = message.TextSource
	if textSource then
    	properties.PrefixTextProperties = chatWindowConfiguration:DeriveNewMessageProperties()
		gradient:Clone().Parent = properties.PrefixTextProperties
	end

	return properties
end

Aggiungere Tag di Chat

Se la tua esperienza ha utenti con attributi speciali come lo StatoVIP, puoi aggiungere tag di chat avvolti in parentesi alla parte anteriore dei messaggi dell'utente per evidenziare i loro messaggi. Il seguente LocalScript in 2> Class

Tag di chat di appuntamento
local TextChatService = game:GetService("TextChatService")
local Players = game:GetService("Players")

local chatWindowConfiguration = TextChatService.ChatWindowConfiguration

TextChatService.OnChatWindowAdded = function(message: TextChatMessage)
	local properties = chatWindowConfiguration:DeriveNewMessageProperties()

	if message.TextSource then
		local player = Players:GetPlayerByUserId(message.TextSource.UserId)
		if player:GetAttribute("IsVIP") then
			properties.PrefixText = "[VIP] " .. message.PrefixText

			properties.PrefixTextProperties = chatWindowConfiguration:DeriveNewMessageProperties()
			properties.PrefixTextProperties.TextColor3 = Color3.fromRGB(255, 125, 50)
		end
	end

	return properties
end

Personalizzazione del testo ricco

I colori di carattere possono essere usati per formattare i messaggi di chat, utile se si vuole applicare la formattazione alle parti molto specifiche del Messaggio. Nota che i colori di carattere non supportano i gradienti, ma il seguente esempio di codice mostra come si può spostare il nome utente ( memorizzato in Class.TextChatMessage.PrefixText ) nel corpo del messaggio e quindi applicare il taglio di carattere per solo la parte

Personalizzazione del testo ricco
local TextChatService = game:GetService("TextChatService")
local Players = game:GetService("Players")

local chatWindowConfiguration = TextChatService.ChatWindowConfiguration

local gradient = Instance.new("UIGradient")
gradient.Color = ColorSequence.new{
	ColorSequenceKeypoint.new(0, Color3.fromRGB(255, 0, 0)),
	ColorSequenceKeypoint.new(0.5, Color3.fromRGB(255, 255, 0)),
	ColorSequenceKeypoint.new(1, Color3.fromRGB(255, 0, 255))
}

TextChatService.OnChatWindowAdded = function(message: TextChatMessage)
	local properties = chatWindowConfiguration:DeriveNewMessageProperties()

	if message.TextSource then
		properties.PrefixText = "[VIP]"
		properties.Text = string.format("<font color='#00ffff'>%s</font>", message.PrefixText) .. " " .. message.Text

		properties.PrefixTextProperties = chatWindowConfiguration:DeriveNewMessageProperties()
		gradient:Clone().Parent = properties.PrefixTextProperties
	end

	return properties
end

Invio di messaggi da fonti non giocatore

In alcuni scenari di progettazione, potresti voler mostrare un dialogo non giocatore nella finestra di chat, come "parola" da un sistema di indirizzo pubblico o un personaggio non giocatore.

Sistema

Per fornire un messaggio del sistema non stilato al Giocatorelocale, chiama semplicemente DisplaySystemMessage() dal canale predefinito RBXGeneral con un prefisso prima del nome di visualizzazione del Giocatore.

Script del client
local Players = game:GetService("Players")
local TextChatService = game:GetService("TextChatService")

local player = Players.LocalPlayer
local generalChannel: TextChannel = TextChatService:WaitForChild("TextChannels").RBXGeneral

local PREFIX = "[Guide] Welcome "

-- Invia "system Messaggio" al giocatore con il loro nome visualizzato
generalChannel:DisplaySystemMessage(PREFIX .. player.DisplayName)

NPC/Oggetto

Puoi anche stilizzare il dialogo non giocatore e aggiungere bolle di chat per farlo sembrare come se i messaggi provengano da un NPC o un oggetto all'interno del Mondo3D.

Script del client
local TextChatService = game:GetService("TextChatService")

local generalChannel: TextChannel = TextChatService:WaitForChild("TextChannels").RBXGeneral

TextChatService.OnIncomingMessage = function(textChatMessage: TextChatMessage)
	local properties = Instance.new("TextChatMessageProperties")

	-- Controlla i messaggi del sistema che contengono metadati
	if not textChatMessage.TextSource and textChatMessage.Metadata ~= "" then

		-- Aggiungi un prefisso per far sembrare il messaggio che è stato inviato da un Giocatore
		properties.PrefixText = string.format("<font color='#%s'>%s: </font>", "#50C999", textChatMessage.Metadata)

		-- Aggiungi chat a bolle
		TextChatService:DisplayBubble(workspace.Statue, textChatMessage.Text)
	end

	return properties
end

local message = "Welcome! I will be your guide."
local speakerName = "Ancient Knight"
generalChannel:DisplaySystemMessage(message, speakerName)