TextChannel
*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
Proprietà
Metodi
Mostra un messaggio di sistema all'utente.
Aggiunge un TextSource al TextChannel dato l'ID di un Player .
Invia un TextChatMessage al Server.
Eventi
Si attiva quando TextChannel:DisplaySystemMessage() è invocato sul client, o quando il client riceve una risposta valida TextChannel:SendAsync() dal Server.
Richiami
Chiamato quando TextChannel riceve un Messaggioin arrivo.
Chiamato per ogni client quando TextChannel riceve un messaggio in arrivo per determinare se o no consegnarlo a quel client.
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
Il messaggio del sistema inviato al TextChannel .
Utilizzato per identificare i tipi di messaggio del sistema, come i messaggi di sistema predefiniti.
Restituzioni
Un TextChatMessage con TextChatMessage.Status proprietà che indica la condizione del Messaggio.
AddUserAsync
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
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
SendAsync
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
Il messaggio da inviare al TextChannel .
Metadati personalizzati da attaccare al Messaggio.
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
Il ricevuto TextChatMessage .
Richiami
OnIncomingMessage
Chiamato quando TextChannel riceve un Messaggioin arrivo. Può essere implementato solo sul client.
Usa questo per decorare TextChatMessages . Se questo callback restituisce un TextChatMessageProperties , queste proprietà vengono messe in relazione con il parametro TextChatMessage per creare un nuovo 1> Class.TextChatMessage1> .
Quando è legato al client per l'invio di un Messaggio, questo callback viene eseguito due volte; prima quando il messaggio viene inviato e ricevuto localmente e poi quando il client riceve il risultato del messaggio filtrato dal Server.
TextChannel.OnIncomingMessage i callback vengono sempre eseguiti dopo il RichiamaClass.TextChatService.OnIncomingMessage.
Questo dovrebbe essere definito solo una volta per TextChannel nel codice di origine. Multi-binding al canale stesso sarà sovrascritto l'uno dall'altro in modo non deterministico.
Quando TextChatService:CreateDefaultTextChannels() è vero, questi TextChannels hanno i loro TextChannel.OnIncomingMessage callback assegnati internamente per mostrare un comportamento speciale predefinito.
Parametri
Il messaggio TextChatMessage in arrivo.
Restituzioni
Se un TextChatMessageProperties viene restituito, queste proprietà vengono messe in fusione con il parametro TextChatMessage per creare un nuovo TextChatMessage con queste proprietà.
ShouldDeliverCallback
Chiamato per ogni client quando TextChannel riceve un messaggio in arrivo per determinare se o no essere consegnato a quel client. Può essere definito solo sul Server.
Una volta definito, questo callback deve restituire un valore veritiero come true , 1 , o "hello" per consegnare il messaggio al client. Se il callback restituisce qualsiasi altra cosa (inclusa 1> nil1> ) il messaggio non verrà consegnato a quel client, anche se il mittente lo vedrà comunque.
Il mittente può essere riferito da TextChatMessage.TextSource .