Puoi usare i seguenti moduli di chat per supportare i comportamenti lato client del Legacy Chat System.
Finestra di chat
La ChatWindow è il modulo di chat principale del lato client del sistema di chat di eredità.
Metodi
Aggiungi canale
- Ritorna: ChatChannelUI
Rimuovi canale
- Ritorna: void
Ottieni canale
Ottieni il canale corrente
- Descrizione: Ritorna il current ChatChannelUI .
- Ritorna: ChatChannelUI
Cambia canale
- Ritorna: void
Rendi visibile
- Parametri: Nessuno
- Descrizione: Ritorna se la finestra è visibile o no. Nota: questo si riferisce all'interfaccia utente di chat in Generale; quando la finestra della chat scompare a causa dell'inattività, la finestra è ancora considerata visibile.
- Ritorna: boolo
ImpostareVisible
- Descrizione: Imposta la visibilità della finestra di chat.
- Ritorna: void
BackgroundFadeOut
- Descrizione: Sbiadisce il background sulle opzioni fornite duration in secondi. Nota: le chiamate successive per controllare la fading in/out sostituiranno le chiamate precedenti.
- Ritorna: void
FadeInBackground
- Descrizione: Sparisce nel background over the given duration in seconds. Nota: le chiamate successive per controllare la fading in/out sostituiranno le chiamate precedenti.
- Ritorna: void
Testo sbiadito
- Descrizione: Sbiadisce il testo sopra il given duration in seconds. Nota: le chiamate successive per controllare la fading in/out sostituiranno le chiamate precedenti.
- Ritorna: void
FadeInText
- Descrizione: Sparisce nel testo sopra il duration in secondi. Nota: le chiamate successive per controllare la fading in/out sostituiranno le chiamate precedenti.
- Ritorna: void
ChatBar
Il ChatBar gestisce l'ingresso del testo lato client per il sistema di chat Lua. Ci sono due componenti chiave del ChatBar:
- ChatBar , a TextBox , where the player inputs messages and commands ( highlighted in orange)
- MessageMode , a TextLabel , which can display information about the message being sent (highlighted in green)
Metodi
Ottieni TIMEX
- Parametri: Nessuno
- Descrizione: Ritorna il TextBox della barra di chat.
- Ritorna: TextBox
OttieniMessageModeTextLabel
- Parametri: Nessuno
- Descrizione: Ritorna il MessageMode TextLabel .
- Ritorna: TextLabel
È focalizzato
- Parametri: Nessuno
- Descrizione: Ritorna se la barra di chat è in focus (player sta digitando nella Quadro di selezione). Equivalente a chiamare TextBox sul risultato di GetTexture.
- Ritorna: boolo
CatturaFocus
- Parametri: Nessuno
- Descrizione: Forza il cliente a concentrarsi sulla TextBox della barra di chat. Equivalente a chiamare TextBox:CaptureFocus sul risultato di Get:` Texas.
- Ritorna: void
Rilascia il focus
- Descrizione: Rilascia il focus della barra di chat TextBox . Se submitted è vero, questo si comporta come se il giocatore avesse premuto Enter per inviare il Messaggio.
- Ritorna: void
Resetta il testo
- Parametri: Nessuno
- Descrizione: Imposta il Text della barra di chat TextBox alla Stringavuota.
- Ritorna: void
Imposta TESTO di STATO
- Descrizione: Imposta il Text della barra di chat TextBox al 0> text0> specificato.
- Ritorna: void
Ottieni TEXT di TIMEX
- Parametri: Nessuno
- Descrizione: Ritorna il testo nella barra di chat TextBox.Text .
- Ritorna: string
Imposta TextLabelText
- Descrizione: Imposta il Text della Modalità Messaggio TextLabel al valore dato 0> text0> .
- Ritorna: void
Ottieni abilitato
- Parametri: Nessuno
- Descrizione: Ritorna se la barra di chat è Visible .
- Ritorna: boolo
Abilitato
- Descrizione: Imposta se la barra di chat è Visible .
- Ritorna: void
ImpostaDimensioneTesto
- Descrizione: Imposta il TextSize di both the chat bar's TextBox e MessageMode 0> TextLabel0> .
- Ritorna: void
Ripristina taglia
- Parametri: Nessuno
- Descrizione: Ripristina la dimensione della barra di chat a una riga di testo.
- Ritorna: void
ImpostaCanaleTarget
- Descrizione: Imposta il target ChatChannelUI che gli viene dato il suo channelName in cui la barra di chat dovrebbe inviare messaggi.
- Ritorna: void
BackgroundFadeOut
- Descrizione: Sbiadisce il background sulle opzioni fornite duration in secondi. Nota: le chiamate successive per controllare la fading in/out sostituiranno le chiamate precedenti.
- Ritorna: void
FadeInBackground
- Descrizione: Sparisce nel background over the given duration in seconds. Nota: le chiamate successive per controllare la fading in/out sostituiranno le chiamate precedenti.
- Ritorna: void
Testo sbiadito
- Descrizione: Sbiadisce il testo sopra il given duration in seconds. Nota: le chiamate successive per controllare la fading in/out sostituiranno le chiamate precedenti.
- Ritorna: void
FadeInText
- Descrizione: Sparisce nel testo sopra il duration in secondi. Nota: le chiamate successive per controllare la fading in/out sostituiranno le chiamate precedenti.
- Ritorna: void
ChatChannelUI
Il ChatChannelUI è la versione client-side di ChatChannel . Riceve ChatMessages dal server e li trasmette al 1>ChatMessageLogDisplay1> . associato.
Metodi
Aggiungi Messaggio al Canale
Parametri: ChatMessage
Descrizione: Aggiunge un messaggio di chat ricevuto dal server al ChatMessageLogDisplay .
Ritorna: void
Rimuovi l'ultimo messaggio dal canale
- Parametri: Nessuno
- Ritorna: void
ClearMessageLog
- Parametri: Nessuno
- Ritorna: void
Log del messaggio di chat
Il ChatMessageLogDisplay gestisce la rappresentazione di ChatMessages in un ChatChannelUI .
Metodi
Aggiungi messaggio
- Descrizione: Aggiunge un message alla schermata di messaggio.
- Ritorna: void
Rimuovi l'ultimo messaggio
- Parametri: Nessuno
- Descrizione: Rimuove il più vecchio ChatMessage nella schermata di messaggi.
- Ritorna: void
Risaluta tutti i messaggi
- Parametri: Nessuno
- Descrizione: Ripristina tutti gli schermi del messaggio in ordine crescente, rispetto alla dimensione dello schermo del messaggio. Questo dovrebbe essere chiamato se lo schermo del messaggio viene ridimensionato.
- Ritorna: void
Svuota
- Parametri: Nessuno
- Descrizione: Rimuove tutti ChatMessages dalla schermata di visualizzazione del messaggio.
- Ritorna: void
Testo sbiadito
- Descrizione: Sbiadisce il testo sopra il given duration in seconds. Nota: le chiamate successive per controllare la fading in/out sostituiranno le chiamate precedenti.
- Ritorna: void
FadeInText
- Descrizione: Sparisce nel testo sopra il duration in secondi. Nota: le chiamate successive per controllare la fading in/out sostituiranno le chiamate precedenti.
- Ritorna: void
Stato della chat personalizzato
Il ChatCustomState è un interfaccia di richiami usati quando si crea uno stato di chat personalizzato nella barra di chat.
Il chat di sotto il radar e lo chat di squadra usano ChatCustomState per indicare al giocatore dove verrà inviato il loro messaggio.
Chiamate
Testo aggiornato
- Parametri: Nessuno
- Descrizione: Chiamato quando il testo nella barra di chat viene aggiornato.
- Ritorna: void
Ottieni il messaggio
- Parametri: Nessuno
- Descrizione: Chiamato per recuperare il testo del messaggio come sarebbe scritto come un singolo comando. Questo viene utilizzato nel caso in cui il server debba elaborare il comando come testo, invece che lo stato visualizzato del comando.
- Ritorna: string
Messaggio di completamento del processo
- Parametri: Nessuno
- Descrizione: Chiamato quando il giocatore invia il messaggio che viene elaborato dallo stato personalizzato. Questo dovrebbe restituire true se il messaggio non dovrebbe essere visualizzato o inviato al Server.
- Ritorna: boolo
Distruggi
- Parametri: Nessuno
- Descrizione: Chiamato come il ChatBar viene ripristinato al suo stato originale prima della modifica dello stato personalizzato.
- Ritorna: void
Impostazioni di chat
Il ChatSettings è un dizionario di impostazioni per il lato client del sistema di chat Lua. Vengono memorizzati in un ModuleScript chiamato ChatSettings, che può essere trovato all'interno del servizio di gioco 1> Chat1> , sotto il 4> Folder4> chiamato
Per cambiare una Configurazione, richiedi questo modulo usando un LocalScript nel modo seguente:
-- Richiedi il modulo ChatSettings (aspetta che si Caricare)local Chat = game:GetService("Chat")local ClientChatModules = Chat:WaitForChild("ClientChatModules")local ChatSettings = require(ClientChatModules:WaitForChild("ChatSettings"))-- Cambia le impostazioni come le altre tabelle.ChatSettings.MaximumMessageLength = 100
Impostazioni di comportamento della chat
Finestra trascinabile
- Tipo: boolo
- Predefinito: false
- Descrizione: Determina se la finestra di chat è Draggable .
Finestra Resizable
- Tipo: boolo
- Predefinito: false
- Descrizione: Determina se la finestra di chat può essere ridimensionata dal Giocatore
GamepadRotationAbilitata
- Tipo: boolo
- Predefinito: false
- Descrizione: Determina se i gamepad possono navigare nell'interfaccia utente di chat.
MostraUserOwnFilteredMessage
- Tipo: boolo
- Predefinito: true
- Descrizione: Determina se i giocatori dovrebbero vedere la versione filtrata dei loro messaggi di chat, o il contenuto originale che hanno digitato.
ChatOnWithTopBarOff
- Tipo: boolo
- Predefinito: false
- Descrizione: Determina se l'interfaccia utente della chat è abilitata anche se la barra superiore è disabilitata.
BubbleChatAbilitato
- Tipo: boolo
- Predefinito: game:GetService("Players").BubbleChat
- Descrizione:: Determina se la chat a bolle è abilitata.
ClassicChatAbilitato
- Tipo: boolo
- Predefinito: game:GetService("Players").ClassicChat
- Descrizione:: Determina se la chat classica è abilitata.
Impostazioni dimensioni testo chat
Dimensione di chat
- Tipo: int
- Predefinito: 18
- Descrizione: Determina la dimensione del testo nella ChatWindow .
Dimensione di chat
ChatWindowTextSizePhone
- Tipo: int
- Predefinito: 14
- Descrizione: Determina la dimensione del testo nella ChatWindow per i telefoni.
ChatBarTextSizePhone
- Tipo: int
- Predefinito: 14
- Descrizione: Determina la dimensione del testo nella ChatBar per i telefoni.
Impostazioni carattere
Carattere predefinito
- Tipo: Enum.Font
- Predefinito: Enum.Font.SourceSansBold
ChatBarFont
- Tipo: Enum.Font
- Predefinito: Enum.Font.SourceSansBold
Impostazioni di colore
Colore di sfondo
- Tipo: Color3
- Predefinito: Color3.new(0, 0, 0)
Colore del messaggio predefinito
- Tipo: Color3
- Predefinito: Color3.new(1, 1, 1)
Colore predefinito
- Tipo: Color3
- Predefinito: Color3.new(1, 1, 1)
- Descrizione: Determina il valore predefinito TextColor3 dei nomi dei ChatMessage nella 0>ChatWindow0> .
Colore di sfondo della ChatBar
- Tipo: Color3
- Predefinito: Color3.new(0, 0, 0)
Colore della ChatBar
- Tipo: Color3
- Predefinito: Color3.new(1, 1, 1)
Colore della Chat
- Tipo: Color3
- Predefinito: Color3.new(0, 0, 0)
Colore del messaggio di errore
- Tipo: Color3
- Predefinito: Color3.fromRGB(245, 50, 50)
- Descrizione: Determina il TextColor3 di messaggi di errore.
Impostazioni di finestra
Dimensione minima della finestra
- Tipo: UDim2
- Predefinito: UDim2.new(0.3, 0, 0.25, 0)
- Descrizione: Determina la dimensione più piccola possibile della Finestra di dialogo (given che WindowResizable è abilitato).
Dimensione massima della finestra
- Tipo: UDim2
- Predefinito: UDim2.new(1, 0, 1, 0)
- Descrizione: Determina la dimensione più grande possibile della Finestra di chat (dato che WindowResizable è abilitato).
- Notizie: Se questo viene cambiato per essere più grande della dimensione di schermo completa, strane cose iniziano a succedere con il controllo delle limitazioni di dimensioni/posizione.
Posizione di finestra predefinita
- Tipo: UDim2
- Predefinito: UDim2.new(0, 0, 0, 0)
- Descrizione: Determina la posizione predefinita della ChatWindow.
Dimensione di base della finestra
- Tipo: UDim2
- Predefinito: UDim2.new(0.5, 0, 0.5, (7 * 2) + (5 * 2))
- Descrizione: Determina la dimensione predefinita della ChatWindow sul telefono.
DefaultWindowSizeTablet
- Tipo: UDim2
- Predefinito: UDim2.new(0.4, 0, 0.3, (7 * 2) + (5 * 2))
- Descrizione: Determina la dimensione predefinita della ChatWindow sulle tabelle.
Dimensione di base della finestra
- Tipo: UDim2
- Predefinito: UDim2.new(0.3, 0, 0.25, (7 * 2) + (5 * 2))
- Descrizione: Determina la dimensione predefinita della ChatWindow sul Desktop.
Disattivare e impostare in impostazioni
Tempo di fusione della finestra di chat
- Tipo: float (secondi)
- Predefinito: 0.5
- Descrizione: Determina quanto tempo il sfondo del ChatWindow deve durare.
ChatWindowTextFadeOutTime
- Tipo: float (secondi)
- Predefinito: 30
- Descrizione: Determina quanto tempo deve durare l'esplosione del testo ChatWindow.
ChatDefaultFadeDuration
- Tipo: float (secondi)
- Predefinito: 0.8
- Descrizione: Determina quanto tempo devono durare gli elementi dell'interfaccia utente di chat.
ChatShouldFadeInFromNewInformation
- Tipo: boolo
- Predefinito: false
- Descrizione: Determina se la chat dovrebbe sbiadire quando ricevi nuovi messaggi.
ChatAnimazioneFPS
- Tipo: fluttua
- Predefinito: 20.0
- Descrizione:: Determina la velocità di fotogrammazione delle animazioni in chat UI.
Impostazioni del canale
Nome generale del canale
- Tipo: string
- Predefinito: "All"
- Descrizione: Determina il nome del canale predefinito.
EchoMessageInGeneralChannel
- Tipo: boolo
- Predefinito: true
- Descrizione: Determina se i messaggi ai canali non predefiniti dovrebbero essere echeggiati nel canale predefinito.
Lunghezza massima del canale
- Tipo: int
- Predefinito: 12
- Descrizione: Determina la lunghezza massima di un nome del canale prima che venga abbreviato.
Lunghezza del messaggio per canale
- Tipo: int
- Predefinito: 50
- Descrizione: Determina il numero massimo di ChatMessage che può essere mostrato in un canale di chat.
MostraJoinAndLeaveHelpText
- Tipo: boolo
- Predefinito: false
- Descrizione: Determina se il testo di aiuto per unirsi/lasciare i canali viene mostrato.
Impostazioni del messaggio
Lunghezza del messaggio massimo
- Tipo: int
- Predefinito: 200
- Descrizione: Determina la lunghezza massima di ChatMessage .
Spazio non consentito bianco
- Tipo: array< string >
- Predefinito: {"\n", "\r", "\t", "\v", "\f"}
- Descrizione: Determina i caratteri non supportati.
Fai clic su PlayerNameToWhisper
- Tipo: boolo
- Predefinito: true
- Descrizione:: Determina se il giocatore può fare clic sul nome di un altro Giocatoreper impegnarsi in una chat di sottovento con loro.
Fai clic sul canale principale per impostare il nome del canale
- Tipo: boolo
- Predefinito: true
- Descrizione: Determina se il giocatore può fare clic su una scheda del canale per impostarlo come loro canale principale.
Impostazioni varie
WhisperCommandAutoCompletePlayerNames
- Tipo: boolo
- Predefinito: true
- Descrizione: Determina se il comando Whisper dovrebbe completare automaticamente i nomi dei giocatori.
Eventi
Impostazioni modificato
- Parametri: Library.string``settingName , variante 0> newValue0>
- Descrizione: Fires when a setting with the given settingName is changed to newValue .