CTR NEX API Reference
nn::nex::AutoMatchmakeParam クラス

MatchmakeExtensionClient::AutoMatchmake() に関するパラメータを格納するデータクラスです。 [詳解]

#include <RendezVous/Services/Jugem/Matchmake/src/Common/AutoMatchmakeParam.h>

DDLCLASSAutoMatchmakeParamを継承しています。

公開メンバ関数

 AutoMatchmakeParam ()
 コンストラクタです。 [詳解]
 
virtual ~AutoMatchmakeParam ()
 デストラクタです。
 
const qList< PrincipalID > & GetAdditionalParticipants () const
 追加で参加させるユーザーを取得します。 [詳解]
 
qUnsignedInt32 GetAutoMatchmakeOption () const
 AutoMatchmakeOption で列挙されるオプションビットフラグを取得します。 [詳解]
 
const MatchmakeBlockListParamGetBlockListParam () const
 ブロックリストの挙動を指定するパラメータを取得します。 [詳解]
 
GatheringID GetGatheringIdForParticipationCheck () const
 自分と追加で参加させるユーザーが、指定したギャザリングに参加しているかを確認するためのギャザリング ID を取得します。 [詳解]
 
const StringGetJoinMessage () const
 ギャザリングのオーナーもしくは参加者に通知されるメッセージを取得します。 [詳解]
 
const qList< MatchmakeSessionSearchCriteria > & GetSearchCriteria () const
 マッチメイクセッションの検索条件を取得します。 [詳解]
 
const MatchmakeSessionGetSourceMatchmakeSession () const
 適切なマッチメイクセッションが見つからなかった場合に作成するマッチメイクセッションを取得します。 [詳解]
 
const qList< GatheringID > & GetTargetGatheringId () const
 参加したいギャザリング ID を取得します。 [詳解]
 
void Reset ()
 オブジェクトをデフォルトコンストラクタで生成した状態に初期化します。
 
void SetAdditionalParticipant (const qList< PrincipalID > &additionalParticipants_)
 追加で参加させるユーザーを設定します。 [詳解]
 
void SetAutoMatchmakeOption (qUnsignedInt32 autoMatchmakeOption_)
 AutoMatchmakeOption で列挙されるオプションビットフラグを設定します。 [詳解]
 
void SetBlockListParam (const MatchmakeBlockListParam &blockListParam_)
 ブロックリストの挙動を指定するパラメータを設定します。 [詳解]
 
void SetGatheringIdForParticipationCheck (GatheringID gidForParticipationCheck_)
 自分と追加で参加させるユーザーが、指定したギャザリングに参加しているかを確認するためのギャザリング ID を設定します。 [詳解]
 
void SetJoinMessage (const String &joinMessage_)
 ギャザリングのオーナーもしくは参加者に通知されるメッセージを設定します。 [詳解]
 
void SetSearchCriteria (const qList< MatchmakeSessionSearchCriteria > &searchCriteria)
 マッチメイクセッションの検索条件を設定します。 [詳解]
 
void SetSourceMatchmakeSession (const MatchmakeSession &sourceMatchmakeSession_)
 適切なマッチメイクセッションが見つからなかった場合に作成するマッチメイクセッションを設定します。 [詳解]
 
void SetTargetGatheringId (const qList< GatheringID > &targetGids_)
 参加したいギャザリング ID を設定します。 [詳解]
 
void Trace (qUnsignedInt64 uiTraceFlags=TRACE_ALWAYS) const
 AutoMatchmakeParam オブジェクトの内容をトレースします。 [詳解]
 

詳解

MatchmakeExtensionClient::AutoMatchmake() に関するパラメータを格納するデータクラスです。

構築子と解体子

nn::nex::AutoMatchmakeParam::AutoMatchmakeParam ( )

コンストラクタです。

コンストラクタです。最低限 AutoMatchmakeParam::SetSourceMatchmakeSession() で作成するマッチメイクセッションを設定する必要があります。

関数詳解

void nn::nex::AutoMatchmakeParam::SetSourceMatchmakeSession ( const MatchmakeSession sourceMatchmakeSession_)

適切なマッチメイクセッションが見つからなかった場合に作成するマッチメイクセッションを設定します。

AutoMatchmakeParam::SetSearchCriteria() もしくは AutoMatchmakeParam::SetTargetGatheringId() で条件が指定されない場合はここで指定したマッチメイクセッションの

  • ゲームモード
  • 最小・最大参加人数
  • マッチメイクシステムタイプ
  • 検索属性

が全て一致する物でかつ参加がロックされていない物、人数に余裕がある物、P2P 通信のホストが決定している物を検索します。 AutoMatchmakeParam::SetSearchCriteria() もしくは AutoMatchmakeParam::SetTargetGatheringId() で条件が指定された場合はその条件で検索します。 検索条件に一致する物が見つからなかった場合は sourceMatchmakeSession に指定したパラメータでマッチメイクセッションを作成します。

引数
[in]sourceMatchmakeSession_適切なマッチメイクセッションが見つからなかった場合に作成するマッチメイクセッション
const MatchmakeSession& nn::nex::AutoMatchmakeParam::GetSourceMatchmakeSession ( ) const

適切なマッチメイクセッションが見つからなかった場合に作成するマッチメイクセッションを取得します。

戻り値
適切なマッチメイクセッションが見つからなかった場合に作成するマッチメイクセッション。
void nn::nex::AutoMatchmakeParam::SetAdditionalParticipant ( const qList< PrincipalID > &  additionalParticipants_)

追加で参加させるユーザーを設定します。

自分が参加すると同時に他人も同時にマッチメイクセッションに参加させたい場合、本関数でそのプリンシパル ID を指定します。 例えば、フレンドとチームを組んで対戦したいといった場合に利用できます。 対象のユーザーは NGS にログインしている必要があります。 追加で参加したユーザに対しては NotificationEvents::AddedToGathering の通知が送信されます。 追加で参加したユーザは MatchmakeExtensionClient::FindMatchmakeSessionByGatheringIdDetail() で P2P 通信用の共通鍵を含んだマッチメイクセッションの詳細情報を取得できます。 初期状態は空です。

引数
[in]additionalParticipants_追加で参加させるユーザー。
参照
AutoMatchmakeParam::SetGatheringIdForParticipationCheck()
const qList<PrincipalID>& nn::nex::AutoMatchmakeParam::GetAdditionalParticipants ( ) const

追加で参加させるユーザーを取得します。

戻り値
追加で参加させるユーザー。
void nn::nex::AutoMatchmakeParam::SetGatheringIdForParticipationCheck ( GatheringID  gidForParticipationCheck_)

自分と追加で参加させるユーザーが、指定したギャザリングに参加しているかを確認するためのギャザリング ID を設定します。

自分を含む参加者全員が特定のギャザリングに参加している事を条件とする場合は本関数でそのギャザリング ID を指定します。 初期状態は INVALID_GATHERINGID です。

引数
[in]gidForParticipationCheck_参加を条件とするギャザリングの ID 。INVALID_GATHERINGID を指定するとチェックは行われません。
参照
AutoMatchmakeParam::SetAdditionalParticipant()
GatheringID nn::nex::AutoMatchmakeParam::GetGatheringIdForParticipationCheck ( ) const

自分と追加で参加させるユーザーが、指定したギャザリングに参加しているかを確認するためのギャザリング ID を取得します。

戻り値
参加を条件とするギャザリングの ID 。
void nn::nex::AutoMatchmakeParam::SetAutoMatchmakeOption ( qUnsignedInt32  autoMatchmakeOption_)

AutoMatchmakeOption で列挙されるオプションビットフラグを設定します。

初期状態は AUTO_MATCHMAKE_OPTION_NONE です。

引数
[in]autoMatchmakeOption_オプションビットフラグ。
qUnsignedInt32 nn::nex::AutoMatchmakeParam::GetAutoMatchmakeOption ( ) const

AutoMatchmakeOption で列挙されるオプションビットフラグを取得します。

戻り値
オプションビットフラグ。
void nn::nex::AutoMatchmakeParam::SetJoinMessage ( const String joinMessage_)

ギャザリングのオーナーもしくは参加者に通知されるメッセージを設定します。

このメッセージはユーザーごとにサーバーに保存され、MatchmakeExtensionClient::GetDetailedParticipants() で取得できます。 AutoMatchmakeParam::SetAdditionalParticipant() で参加させたユーザーのメッセージも本関数で設定したものになります。 初期状態は空文字列です。

引数
[in]joinMessage_ギャザリングのオーナーもしくは参加者に通知されるメッセージ。
参照
MatchmakeExtensionClient::GetDetailedParticipants()
const String& nn::nex::AutoMatchmakeParam::GetJoinMessage ( ) const

ギャザリングのオーナーもしくは参加者に通知されるメッセージを取得します。

戻り値
ギャザリングのオーナーもしくは参加者に通知されるメッセージ。
void nn::nex::AutoMatchmakeParam::SetSearchCriteria ( const qList< MatchmakeSessionSearchCriteria > &  searchCriteria)

マッチメイクセッションの検索条件を設定します。

指定したマッチメイクセッション検索条件でマッチメイクセッション(ギャザリング)を検索し、一致するものが見つかればそこに参加します。 検索条件はリストとして複数渡すことができ、先頭の検索条件から順番に使用されます。一つの検索条件で最大 50 件のマッチメイクセッションを列挙し、 それらへの参加を試みます。参加できた場合はその後の検索は行われません。 マッチメイクセッションが見つからなかったり、見つかった全てのマッチメイクセッションへの参加ができなかった場合は次の検索条件で検索します。 したがって条件を徐々に緩めながらマッチメイクセッションを検索していくことが可能です。 全ての検索条件に合致するものが存在しない場合、AutoMatchmakeParam::SetSourceMatchmakeSession() に指定したパラメータでマッチメイクセッションを作成します。 検索条件は最大 2 つまで指定できます。3 つ以上指定した場合は QERROR(Core, InvalidArgument) となります。 本関数と AutoMatchmakeParam::SetTargetGatheringId() は排他です。両方を指定することはできません。 初期状態は空です。

引数
[in]searchCriteriaマッチメイクセッションの検索条件。最大 2 つまで指定できます。
参照
AutoMatchmakeParam::SetTargetGatheringId()
const qList<MatchmakeSessionSearchCriteria>& nn::nex::AutoMatchmakeParam::GetSearchCriteria ( ) const

マッチメイクセッションの検索条件を取得します。

戻り値
マッチメイクセッションの検索条件。
void nn::nex::AutoMatchmakeParam::SetTargetGatheringId ( const qList< GatheringID > &  targetGids_)

参加したいギャザリング ID を設定します。

ギャザリング ID を指定してマッチメイクセッション(ギャザリング)に参加します。 ギャザリング ID は複数指定でき、与えられたギャザリング ID のリストの先頭から順に参加を試みます。 本関数を使用して MatchmakeExtensionClient::AutoMatchmake() を行った場合、過去 3 回にわたって参加したマッチメイクセッションを参加の対象から取り除く処理は含まれていません。 アプリケーション側で MatchmakeExtensionClient::BrowseMatchmakeSession() を用いて検索を行い、検索結果のフィルタリングを行った後で、本関数を用いてマッチメイクセッションに参加、 もしくはを作成するような実装は許容されています。しかし多くの場合、 検索条件を指定できる MatchmakeExtensionClient::AutoMatchmake() を使用しても、 MatchmakeSessionSearchCriteria を適切に指定することで同様のことは実現できます。まずは検索条件を指定できる AutoMatchmakeParam::SetSearchCriteria() の利用をご検討ください。

その上で本関数を使用される場合、指定したマッチメイクセッションに参加できないなどの理由で不必要にマッチメイクセッションが作成されないよう、 ギャザリング ID は複数指定し、リストの並び順はなるべくクライアント毎に異なるようにするような実装を強く推奨します。 全てのマッチメイクセッションに参加できなかった場合、AutoMatchmakeParam::SetSourceMatchmakeSession() に指定したパラメータでマッチメイクセッションを作成します。 本関数と AutoMatchmakeParam::SetSearchCriteria() は排他です。両方を指定することはできません。 初期状態は空です。

引数
[in]targetGids_参加したいギャザリング ID。
参照
AutoMatchmakeParam::SetSearchCriteria()
const qList<GatheringID>& nn::nex::AutoMatchmakeParam::GetTargetGatheringId ( ) const

参加したいギャザリング ID を取得します。

戻り値
参加したいギャザリング ID。
void nn::nex::AutoMatchmakeParam::SetBlockListParam ( const MatchmakeBlockListParam blockListParam_)

ブロックリストの挙動を指定するパラメータを設定します。

マッチメイクセッションへ参加する際にブロックリストのチェックを行うかどうかを指定するパラメータを設定します。 blockListParam_ の初期状態は MatchmakeBlockListParam::SetUseMyBlockList(true) および MatchmakeBlockListParam::SetUseBlockListByOthers(true) された状態です。

引数
[in]blockListParam_ブロックリストの挙動を指定するパラメータ。
const MatchmakeBlockListParam& nn::nex::AutoMatchmakeParam::GetBlockListParam ( ) const

ブロックリストの挙動を指定するパラメータを取得します。

戻り値
ブロックリストの挙動を指定するパラメータ。
void nn::nex::AutoMatchmakeParam::Trace ( qUnsignedInt64  uiTraceFlags = TRACE_ALWAYS) const

AutoMatchmakeParam オブジェクトの内容をトレースします。

引数
[in]uiTraceFlagsTraceLog::SetFlag() の引数と同様です。