PartyLocalChatControl::SendText
指定した各ターゲット チャット コントロールにチャット テキスト文字列を送信します。
構文
PartyError SendText(
uint32_t targetChatControlCount,
PartyChatControlArray targetChatControls,
PartyString chatText,
uint32_t dataBufferCount,
const PartyDataBuffer* dataBuffers
)
パラメーター
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 つのローカル チャット コントロールがある場合に可能です。 いずれかのローカル チャット コントロールに接続されているターゲット チャット コントロールが、他のすべてのローカル チャット コントロールに接続されていない可能性があります。
dataBuffers 配列の PartyDataBuffer 構造体は、チャット テキストに関連付けられている補助データ用です。たとえば、テキストのレンダリングに使用する色を示すメタデータや、チャット テキストと共にレンダリングするアイコンの画像データを含むバイナリ BLOB などです。 テキスト チャットとは無関係なゲーム データを送信する方法については、「 PartyLocalEndpoint::SendMessage()」を参照してください。これは、メッセージ転送動作の細かい制御を公開するメッセージング オプションです。
発信者は、dataBuffers 配列で 0 個以上の PartyDataBuffer 構造体を提供します。 構造体が参照するメモリは連続している必要はないため、たとえば、固定のヘッダー バッファーと可変ペイロードを簡単に組み合わせることができます。 バッファーは順番に組み立てられ、送信され、PartyChatTextReceivedStateChange の中で、チャット テキストとは異なり 1 つの連続したデータ ブロックとして対象となるチャット コントロールに配信されます。 Party ライブラリは、元の PartyDataBuffer セグメンテーションを記述するためにメタデータを送信する帯域幅を拡張しません。
要件
ヘッダー: Party.h