TextChannel

非推奨を表示

*このコンテンツは、ベータ版のAI(人工知能)を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、 こちら をクリックしてください。

テキストチャットチャンネルを表示します。 TextSources を受け取ります。

チャットメッセージを TextChannel に送信するには、 TextChannel:SendAsync() から LocalScript を呼び出します。ユーザーの 2>Class.TextSource2> の相当な 5>Class.TextSource5> が、8>TextSource.CanSend = true8> である必要があります

異なるテキストチャンネルからのメッセージは、ChannelTabsConfiguration を使用して、チャットウィンドウの異なるタブに分割できます。

詳しくは、In-Experience Text Chatを参照してください。

概要

方法

イベント

コールバック

プロパティ

方法

DisplaySystemMessage

ユーザーにシステムメッセージを表示します。LocalScript 、または ScriptRunContext の Class.Script.RunContext|RunContext が含まれている場合にのみ表示されます。メッセージは、1>Enumerate.RunContext.Client1> の Class.Script.RunContext|Run

パラメータ

systemMessage: string

システムメッセージは TextChannel に送信されます。

metadata: string

デフォルトのシステムメッセージなどのシステムメッセージの種類を識別するために使用されます。

既定値: ""

戻り値

Class.TextChatMessage メッセージ に TextChatMessage.Status プロパティが含まれている。メッセージの状態を示す。

AddUserAsync

イールド

ユーザーのユーザー名を持つ TextChannelPlayer.UserId を追加します (1> Class.Player.UserId1> を持つ)。4> Class.Script4> のみで使用できます。

ユーザーを表示する TextSource が存在しない場合、これにより TextSource が追加されます。

ユーザーを表す Class.TextSource が存在する場合、これは Class.TextSource を返します。

ユーザーがチャットをオフにしたか、サーバーにいない場合、これは次のようなツプルトを返します nilfalse

パラメータ

userId: number

Class.Player のユーザーID。


戻り値

ユーザーのために新しい Class.TextSource が作成される場合、 trueTextSource が返されます。如果、ユーザーのために既存の Class.TextSource が作成される場合、 <

イールド

サーバーに TextChatMessage を送信します。LocalScript または Script に 1> Class.Script.RunContext|RunContext1> の 14> Class.Script.RunContext4> のみ使用できます。

パラメータ

message: string

Class.TextChannel にメッセージを送信する。

metadata: string

メッセージに付けるカスタムメタデータ。

既定値: ""

戻り値

Class.TextChatMessage メッセージ に TextChatMessage.Status プロパティが含まれている。メッセージの状態を示す。

イベント

MessageReceived

Class.TextChatService.MessageReceived のように、 Class.TextChannel:DisplaySystemMessage() がクライアントで呼び出されたとき、またはサーバーから有効な1> Class.TextChannel:SendAsync()1> の返信を受信したとき、このイベントは発動します。このイベントは、クライアントにのみ発動します。

サーバーの TextChannel.ShouldDeliverCallback プロパティがバインドされ、false を返すと、クライアントは TextChannel.MessageReceived を発射しません。

Use the TextChatMessage パラメーター to get the TextSource and the text of the message (with TextChatMessage.Text).

Class.TextChatMessage パラメータは、TextChatService.OnIncomingMessage または TextChannel.OnIncomingMessage にバインドされた関数の最終結果です。

パラメータ

incomingMessage: TextChatMessage

受信した TextChatMessage


コールバック

OnIncomingMessage

Class.TextChannel が入ってくるメッセージを受信するときに呼び出されます。クライアント上でのみ実装できます。

これを使用して TextChatMessages を装飾します。このコールバックが TextChatMessageProperties を返すと、これらのプロパティは TextChatMessage パラメータとマージされて新しい 1> Class.TextChatMessage1> を作成します。

クライアントにメッセージを送信するときにバインドされるこのコールバックは、メッセージが最初にローカルに送信され、受信されるときに実行されます。メッセージがフィルターされたメッセージの結果をサーバーから受信すると、コールバックは再び実行されます。

TextChannel.OnIncomingMessage コールバックは常に にある TextChatService.OnIncomingMessage コールバックの後に実行されます。

これは、ソースコードの TextChannel にのみ定義される必要があります。複数のバインディングを同じチャンネルに設定すると、非線形な方法で互いにオーバーライドされます。

Class.TextChatService:CreateDefaultTextChannels() が true であるとき、デフォルトの TextChannels は、特別なデフォルト動作を示すために内部で割り当てられた TextChannel.OnIncomingMessage コールバックを持つ。

パラメータ

入ってくる TextChatMessage


戻り値

Class.TextChatMessageProps が返されると、これらのプロパティは TextChatMessage パラメータとマージされて、新しい TextChatMessage を作成します。これらのプロパティを持つ新しい 1>Class.TextChatMessage1> が返されます。

ShouldDeliverCallback

Class.TextChannel が入ってくるメッセージを受信するときに、そのクライアントに呼び出されます。サーバーでのみ定義できます。

定義された後、このコールバックは true1 、または "hello" を返す必要があります。コールバックがその他の値を返す場合 (含めて 1> nil1> )、メッセージはそのクライアントに配信されません。送信者がメッセージを見るには

送信者は TextChatMessage.TextSource によって参照できます。

パラメータ

textSource: TextSource

戻り値