構文
パラメーター
targetChatControlCount uint32_t
targetChatControls 配列内のターゲット チャット コントロールの数。
targetChatControls PartyChatControlArrayサイズ
targetChatControlCount の入力配列
ターゲット PartyChatControls の targetChatControlCount エントリ配列。
chatText PartyString
送信するテキスト。
dataBufferCount uint32_t
dataBuffers 配列で提供されるバッファー構造体の数。
dataBuffers PartyDataBuffer*サイズ
dataBufferCount の入力配列
送信する補助メッセージ ペイロードを記述する PartyDataBuffer 構造体の dataBufferCount エントリ配列。これは dataBufferCount がゼロの場合は無視されます。
戻り値
PartyError 呼び出しが成功した場合はc_partyErrorSuccess、それ以外の場合はエラー コード。エラー コードの人間が読める形式は、PartyManager::GetErrorMessage() で取得できます。
解説
ローカル チャット コントロールへのチャット テキストの送信は現在サポートされていません。ターゲット チャット コントロールの配列にローカル ターゲットが含まれている場合、この呼び出しは同期的に失敗します。テキスト コンテンツの翻訳、ローカライズ、または不適切な言葉のフィルタリングは保証されません。チャット テキスト文字列はそのまま提示されます。
テキスト文字列は、PartyLocalChatControl::SetPermissions() を介してローカル チャット コントロールからテキスト メッセージを受信するように独自のインスタンスを構成しているターゲット チャット コントロールにのみ配信されます。
ターゲット チャット コントロールが、送信元のチャット コントロールと少なくとも 1 つの共通ネットワークに接続されていない場合、テキスト文字列は配信されません。これは、2 つのローカル チャット コントロールがある場合に発生する可能性があります。ローカル チャット コントロールの 1 つに接続されたターゲット チャット コントロールは、他のすべてのローカル チャット コントロールに接続されていない可能性があります。
dataBuffers 配列内の PartyDataBuffer 構造体は、テキストのレンダリングに使用する色を示すメタデータや、チャット テキストと共にレンダリングするアイコンの画像データを含むバイナリ BLOB など、チャット テキストに関連する補助データ用です。テキスト チャットに関連しないゲーム データを送信する場合は、メッセージ送信動作をきめ細かく制御できるメッセージング オプションである PartyLocalEndpoint::SendMessage() を参照してください。呼び出し元は、
dataBuffers 配列に 0 個以上の PartyDataBuffer 構造体を提供します。構造体が参照するメモリは連続している必要はなく、たとえば固定ヘッダー バッファーの後に可変ペイロードを続けることが容易になります。バッファーは順番に組み立てられ、送信され、PartyChatTextReceivedStateChange で、チャット テキストとは別に単一の連続したデータ ブロックとしてターゲット チャット コントロールに配信されます。Party ライブラリは、元の PartyDataBuffer のセグメンテーションを記述するメタデータの送信に帯域幅を消費しません。
要件
ヘッダー: Party.h関連項目
PartyLocalChatControlPartyChatTextReceivedStateChange