DWC_GetFriendStatus

構文

#include <dwc.h>
u8 DWC_GetFriendStatus(const DWCFriendData *friendData,
                       char *statusString);

引数

friendData DWCFriendData型の友達情報へのポインタ
statusString 友達のstatus文字列格納先ポインタ。
NULLを渡せば文字列のコピーは行わない。
文字列は最大DWC_FRIEND_STATUS_STRING_LEN文字(NULL終端含む)。

返り値

DWC_STATUS_OFFLINE オフライン
自分がオフラインの時、または相手と友達関係が成立していないとき
DWC_STATUS_ONLINE オンライン(Wi-Fiコネクションサーバにログイン済み)
DWC_STATUS_PLAYING ・クライアントとしてゲームプレイ中(マッチメイクタイプの種類によらない)
・友達指定マッチメイク又はサーバクライアントマッチメイクで、一度でもサーバ交代が起こった後のサーバとしてゲームプレイ中
上記2状態は共通して、この相手に対して接続に行くことは出来ない事を示している。(PLAYING状態は受付可能な状態では無い)
DWC_STATUS_MATCH_ANYBODY ・友達無指定ピアマッチメイク中で接続相手を検索中
・友達無指定ピアマッチメイク中でサーバとしてゲームプレイ中
DWC_STATUS_MATCH_FRIEND ・友達指定ピアマッチメイク中で接続相手を検索中
・友達指定ピアマッチメイク中でサーバとしてゲームプレイ中
DWC_STATUS_MATCH_SC_CL ・サーバクライアントマッチメイク中のクライアントホストとして、サーバと接続処理中
・グループID接続のクライアントホストとして、サーバと接続処理中
DWC_STATUS_MATCH_SC_SV ・サーバクライアントマッチメイク中のサーバホストとしてゲームプレイ中

説明

friendDataで指定された友達の通信状態を取得します。友達の通信状態は変化がある度にGameSpyサーバから通知され、DWCライブラリ内のキャッシュに保存されるので、本関数ではそれを参照し、通信は行いません。

プレイヤーの通信状態は、本関数の返り値で表されるstatusフラグと、引数statusStringで表されるstatus文字列から成っており、GameSpyサーバ上で管理されています。statusフラグはDWCライブラリが自動的にセットしますが、status文字列はDWC_SetOwnStatusString関数を用いてアプリケーションが設定することができます。

サーバクライアントマッチメイクに特有の情報も取得したい場合は、DWC_GetFriendStatusSC関数を使用してください。また、statusStringのような文字列ではなく、バイナリデータをDWC_SetOwnStatusData関数でセットしているアプリケーションの場合は、DWC_GetFriendStatusData/DWC_GetFriendStatusDataSC関数を使用してバイナリデータを取得してください。

履歴

5.1pr2より前の変更履歴はこちら