TextChannel

顯示已棄用項目

*此內容是使用 AI(Beta 測試版)翻譯,可能含有錯誤。若要以英文檢視此頁面,請按一下這裡

代表一個文字聊天頻道。包含 TextSources 作為後代。

要將聊天訊息傳送至 TextChannel,請從 TextChannel:SendAsync() 呼叫 LocalScript 。用戶的相應 1> Class.TextSource1> 必須在該頻道中。

不同的文字頻道訊息可以在聊天窗口使用 ChannelTabsConfiguration 分別在不同的標籤中。

要了解更多內容,請參閱 體驗內容聊天

概要

方法

活動

屬性

DirectChatRequester

唯讀
未複製
平行讀取

方法

DisplaySystemMessage

顯示系統訊息給使用者。 只能在 LocalScriptScript 中使用,或在 RunContext 中使用 2>Class.Script.RunContext|RunContext2> 的 5>Class.Script.RunContext5> 。 訊息只對該使用者可見,並且不會自動過濾或本地化。

參數

systemMessage: string

系統訊息已傳送至 TextChannel

metadata: string

用於識別系統訊息類型,例如預設系統訊息。

預設值:""

返回

Class.TextChatMessage 與 TextChatMessage.Status 屬性,表示訊息的狀態。

SetDirectChatRequester

void

參數

requester: Player

返回

void

AddUserAsync

暫停

添加 TextSourceTextChannel 的使用者的指定用戶名 (使用 Player.UserId )。只能在 1> Class.Script1> 中使用。

如果代表用戶存在的 TextSource 不存在,這會增加一個 TextSource

如果代表用戶存在的 TextSource,這會返回 TextSource

如果使用者關閉聊天或不在服務伺服器中,這會返回一個tuple nilfalse

參數

userId: number

Class.Player 的用戶名。


返回

如果有新的 TextSource 為用戶創建,trueTextSource 如果現有的 2>Class.TextSource2> 已為用戶創建,5>Class.TextSource5> 和 <

暫停

發送一個 TextChatMessage 到服務伺服器。只能在 LocalScriptScript 中使用,或在 1> Class.Script.RunContext|RunContext1> 中使用 4> Class.Script.RunContext|RunContext4> 的 7> Class.Script.RunContext7> 。

參數

message: string

發送訊息給 TextChannel

metadata: string

自訂標籤,可以附在訊息上。

預設值:""

返回

Class.TextChatMessage 與 TextChatMessage.Status 屬性,表示訊息的狀態。

活動

MessageReceived

喜歡 TextChatService.MessageReceived ,發生在客戶端呼叫 TextChannel:DisplaySystemMessage() 或收到服務伺服器發送的有效 TextChannel:SendAsync() 回應時。此事件只在客戶端發生。

如果服務伺服器的 TextChannel.ShouldDeliverCallback 屬性是綁定的,並且返回 false ,客戶將不會發射 TextChannel.MessageReceived

使用 TextChatMessage 參數取得 TextSource 和訊息的文字 (含 TextChatMessage.Text)。

Class.TextChatMessage 參數是指任何綁定到 TextChatService.OnIncomingMessageTextChannel.OnIncomingMessage 的函數的最終結果。

參數

incomingMessage: TextChatMessage

收到的 TextChatMessage


回調

OnIncomingMessage

參數


返回

ShouldDeliverCallback

參數

textSource: TextSource

返回