TextChannel
*このコンテンツは、ベータ版のAI（人工知能）を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、 こちら をクリックしてください。
テキストチャットチャネルを表示します。子孫に TextSources が含まれています。
チャットメッセージを TextChannel に送信するには、TextChannel:SendAsync() から LocalScript に電話します。対応する TextSource ユーザーの TextSource.CanSend = true は、そのチャネルにある必要があります。
異なるテキストチャンネルからのメッセージは、ChannelTabsConfiguration を使用してチャットウィンドウの異なるタブに分離できます。
詳しくは、インエクスペリエンステキストチャットを参照してください。
概要
プロパティ
The TextChannel は、DirectChatRequester に直接メッセージを送信できるユーザーにのみメッセージを配信します。
方法
ユーザーにシステムメッセージを表示します。
セットする DirectChatRequester は、TextChannel です。TextChannel は、DirectChatRequester に直接メッセージを送信できるユーザーにのみメッセージを配信します。
添加する TextSource を TextChannel の指定されたユーザーIDに Player します。
サーバーに TextChatMessage を送信します。
イベント
クライアントで TextChannel:DisplaySystemMessage() が呼び出されたとき、またはクライアントがサーバーから有効な TextChannel:SendAsync() 応答を受け取ったときに発火します。
コールバック
TextChannel が受信しているメッセージを受信すると呼び出されます。
TextChannel が受信している受信メッセージに応答して、そのクライアントに配信するべきかどうかを判断するために、それぞれのクライアントに呼び出されます。
プロパティ
DirectChatRequester
The TextChannel は、DirectChatRequester に直接メッセージを送信できるユーザーにのみメッセージを配信します。このプロパティは SetDirectChatRequester() を使用してのみ設定できます。
方法
DisplaySystemMessage
ユーザーにシステムメッセージを表示します。Can only be used in a LocalScript , or in a Script with RunContext of Enum.RunContext.Client .メッセージはそのユーザーにのみ表示され、自動的にフィルタリングされたりローカライズされたりはしません。
パラメータ
システムメッセージが TextChannel に送信されました。
デフォルトシステムメッセージなどのシステムメッセージタイプを識別するために使用します。
戻り値
メッセージの状態を示す TextChatMessage プロパティを持つ A TextChatMessage.Status 。
SetDirectChatRequester
DirectChatRequester を TextChannel に設定します。このメソッドは、サーバースクリプトでのみ使用できます。
この API を使用するには、TextChatService と協力し、デフォルトのテキストチャンネルの外部にカスタムの直接チャット実装を持っている必要があります。
When called on a TextChannel that is parented to TextChatService and has no existing TextSources , SetDirectChatRequester は、リクエストされたユーザーをチャネルの TextSource として追加し、 DirectChatRequester プロパティを設定します。
DirectChatRequester が設設定するされると、DirectChatRequester でチャットを行えるユーザー間のメッセージのみが送信されます。
local function createWhisperChannel(fromPlayer, toPlayer)
local whisperChannel = Instance.new("TextChannel")
whisperChannel:SetDirectChatRequester(fromPlayer)
whisperChannel:AddUserAsync(toPlayer.UserId)
-- TextChannel インスタンスには今、2つの TextSource インスタンスがあります。
return whisperChannel
end
パラメータ
戻り値
AddUserAsync
ユーザーの指定されたユーザーID TextSource に TextChannel を追加します (Player.UserId で). は Script でのみ使用できます。
ユーザーを表現する TextSource が存在しない場合、これに TextSource が追加されます。
ユーザーを表現する TextSource が存在する場合、これは TextSource を返します。
ユーザーがチャットをオフにしたか、サーバーにいない場合、これは tuple nil、false を返します。
パラメータ
戻り値
ユーザーに新しい が作成された場合、 、または既存の がある場合、 、または 、ユーザーがチャットをオフにしているか、このサーバーにいない場合、 、または 、ユーザーがチャットをオフにしているか、このサーバーにいない場合、 を返します。
SendAsync
サーバーに TextChatMessage を送信します。LocalScript または Script でのみ使用でき、RunContext の Enum.RunContext.Client で使用できます。
パラメータ
TextChannel に送信するメッセージ。
メッセージに付属するカスタムメタデータ。
戻り値
メッセージの状態を示す TextChatMessage プロパティを持つ A TextChatMessage.Status 。
イベント
MessageReceived
Like TextChatService.MessageReceived , クライアントで TextChannel:DisplaySystemMessage() が呼び出されたとき、またはサーバーから有効な TextChannel:SendAsync() 応答が受信されたときに発動します。このイベントはクライアントでのみ発動します。
サーバーの TextChannel.ShouldDeliverCallback プロパティがバインドされ、false を返す場合、クライアントは TextChannel.MessageReceived を発射しません。
TextChatMessage パラメータを使用して、TextSource とメッセージのテキスト (TextChatMessage.Text を含む) を取得します。
TextChatMessage パラメータは、TextChatService.OnIncomingMessage または TextChannel.OnIncomingMessage にバインドされた関数の最終結果です。
パラメータ
受信した TextChatMessage 。
コールバック
OnIncomingMessage
TextChannel が受信しているメッセージを受信するときに呼び出されます。クライアント上でのみ実装できます。
これを使用して TextChatMessages を装飾します。このコールバックが TextChatMessageProperties を返す場合、それらのプロパティは TextChatMessage パラメータとマージして、新しい TextChatMessage を作成します。
クライアントからメッセージを送信するときにバインドされると、このコールバックは 2 回実行されます;最初はメッセージが最初にローカルで送信されて受信され、再びクライアントがサーバーからフィルタリングされたメッセージの結果を受け取るときです。
TextChannel.OnIncomingMessage コールバックは常に 後 の TextChatService.OnIncomingMessage コールバックの後に実行します。
ソースコードでは、これは TextChannel 一度だけ定義する必要があります。同じチャネルに複数のバインドがあると、非決定的な方法でお互いを上書きします。
When が true であると、デフォルトの は、特別なデフォルト動作を展示するために、内部で割り当てられた呼び出しを持つことになります。
パラメータ
受信する TextChatMessage 。
戻り値
TextChatMessageProperties が返された場合、それらのプロパティは TextChatMessage パラメータとマージされて、それらのプロパティを持つ新しい TextChatMessage を作成します。
ShouldDeliverCallback
TextChannel が受信している受信メッセージに応答して、そのクライアントに配信するべきかどうかを判断するために、それぞれのクライアントに呼び出されます。サーバー上でのみ定義できます。
定義されたら、このコールバックは true 、 1 、または "hello" のような真実の値を返して、そのクライアントにメッセージを送信する必要があります。コールバックが他の何かを返す (including nil ) 場合、メッセージはそのクライアントに送信されませんが、送信者はメッセージを見ることができます。
送信者は TextChatMessage.TextSource に参照でき、受信者は textSource 引数です。送信者と受信者が同じであることに注意してください、コールバックが可能なすべての受信者を通り抜けるためです。Roblox Studio では、ソロ プレイ モードでメッセージの送信者と受信者が唯一になります。
パラメータ
メッセージを送信するメッセージ送信者も含まれるメッセージが送信されます。
メッセージを受信するユーザーの TextSource