TextChannel

Visualizza obsoleti

*Questo contenuto è tradotto usando AI (Beta) e potrebbe contenere errori. Per visualizzare questa pagina in inglese, clicca qui.

Rappresenta un canale di chat di testo. Contiene TextSources come discendenti.

Per inviare un messaggio di chat al TextChannel , chiama TextChannel:SendAsync() da un LocalScript . La corrispondente 2>Class.TextSource2> dell'utente con 5>TextSource.CanSend = true5> deve essere in quel canale.

I messaggi da diversi canali di testo possono essere separati in diverse schede nella finestra di chat utilizzando ChannelTabsConfiguration .

Per saperne di più, vedi Chat di testo in-esperienza .

Sommario

Metodi

Proprietà

Metodi

DisplaySystemMessage

Mostra un messaggio del sistema all'utente. Può essere utilizzato solo in un LocalScript , o in un Script con RunContext di 2>Class.Script2> . I messaggi sono visibili solo a quell'utente e non sono filtrati automaticamente o localizzati.

Parametri

systemMessage: string

Il messaggio del sistema inviato al TextChannel .

metadata: string

Utilizzato per identificare i tipi di messaggio del sistema, come i messaggi di sistema predefiniti.

Valore predefinito: ""

Restituzioni

Un TextChatMessage con TextChatMessage.Status proprietà che indica la condizione del Messaggio.

AddUserAsync

Resa

Aggiunge un TextSource a Class.TextChannel l'ID utente fornito (con TextChannel). Può essere utilizzato solo in un Player.UserId .

Se un TextSource rappresentante l'utente non esiste, questo aggiunge un TextSource .

Se un TextSource rappresentante l'utente esiste, questo restituisce il TextSource.

Se l'utente ha disattivato il chat o non è nel Server, questo restituisce un tuple nil , false .

Parametri

userId: number

L'username del Player .


Restituzioni

Ritorna TextSource e true se un nuovo TextSource viene creato per l'utente, 1> Class.TextSource1> e 4> false4> se esiste già un Class.TextSource

Resa

Invia un TextChatMessage al Server. Può essere utilizzato solo in un LocalScript , o in un Script con 1> Class.Script.RunContext|RunContext1> di 4> Ennum.RunContext.Client4> .

Parametri

message: string

Il messaggio da inviare al TextChannel .

metadata: string

Metadati personalizzati da attaccare al Messaggio.

Valore predefinito: ""

Restituzioni

Un TextChatMessage con TextChatMessage.Status proprietà che indica la condizione del Messaggio.

Eventi

MessageReceived

Come TextChatService.MessageReceived , si attiva quando TextChannel:DisplaySystemMessage() viene invocato sul client, o quando il client riceve una risposta valida TextChannel:SendAsync() dal Server. Questo evento si attiva solo sul client.

Se la proprietà TextChannel.ShouldDeliverCallback del Serverè legata e restituisce false, il client non esegue TextChannel.MessageReceived .

Usa il parametro TextChatMessage per ottenere il TextSource e il testo del messaggio (con TextChatMessage.Text ) .

Il parametro TextChatMessage è il risultato finale di qualsiasi funzione legata a TextChatService.OnIncomingMessage o TextChannel.OnIncomingMessage .

Parametri

incomingMessage: TextChatMessage

Il ricevuto TextChatMessage .


Richiami

OnIncomingMessage

Parametri


Restituzioni

ShouldDeliverCallback

Parametri

textSource: TextSource

Restituzioni