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

マッチメイクセッションの検索条件を格納するデータクラスです。 [詳解]

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

DDLCLASSMatchmakeSessionSearchCriteriaを継承しています。

公開メンバ関数

 MatchmakeSessionSearchCriteria ()
 コンストラクタです。 [詳解]
 
 MatchmakeSessionSearchCriteria (qUnsignedInt32 gameMode, MatchmakeSystemType matchmakeSystemType)
 コンストラクタです。 [詳解]
 
virtual ~MatchmakeSessionSearchCriteria ()
 デストラクタです。
 
qBool IsValid () const
 検索条件が有効かどうか調べます。 [詳解]
 
void Reset ()
 全ての検索条件をリセットします。 [詳解]
 
void SetAttribute (qUnsignedInt32 uiIndex, qUnsignedInt32 val)
 検索する属性を指定します。 [詳解]
 
qBool SetAttribute (qUnsignedInt32 uiIndex, const qVector< qUnsignedInt32 > &vals)
 検索する属性を指定します。属性値を複数指定できます。 [詳解]
 
void SetAttributeWithRange (qUnsignedInt32 uiIndex, qUnsignedInt32 min, qUnsignedInt32 max)
 検索する属性を範囲で指定します。 [詳解]
 
qBool SetCodeword (const String &codeword)
 検索対象のあいことばをセットします [詳解]
 
void SetExcludeLocked (bool excludeLocked)
 すでに参加がロックされているものを除外するかを設定します。 [詳解]
 
void SetExcludeNonHostPid (bool excludeNonHostPid_)
 ホストが決定していないものを除外するかを設定します。 [詳解]
 
void SetExcludeUserPasswordSet (bool excludeUserPasswordSet_)
 マッチメイクセッションユーザーパスワードが設定されたものを除外するかを設定します。 [詳解]
 
void SetGameMode (qUnsignedInt32 gameMode)
 検索するゲームモードを指定します。 [詳解]
 
void SetMatchmakeSystemType (MatchmakeSystemType matchmakeSystemType)
 検索するマッチメイクシステムタイプを指定します。 [詳解]
 
void SetMaxParticipants (qUnsignedInt16 maxParticipants)
 最大参加人数を指定します。 [詳解]
 
void SetMaxParticipantsWithRange (qUnsignedInt16 min, qUnsignedInt16 max)
 最大参加人数を範囲指定します。 [詳解]
 
void SetMinParticipants (qUnsignedInt16 minParticipants)
 最少参加人数を指定します。 [詳解]
 
void SetMinParticipantsWithRange (qUnsignedInt16 min, qUnsignedInt16 max)
 最少参加人数を範囲指定します。 [詳解]
 
void SetReferPersistentGatheringId (GatheringID referPersistentGatheringId)
 検索する関連する永続ギャザリングの ID をセットします。 [詳解]
 
void SetResultRange (const ResultRange &resultRange)
 検索範囲をセットします。 [詳解]
 
void SetSelectionMethod (MatchmakeSelectionMethod selectionMethod)
 検索結果から参加するマッチメイクセッションを選ぶ方法を指定します。 [詳解]
 
void SetSelectionMethod (MatchmakeSelectionMethod selectionMethod, const MatchmakeParam &param)
 検索結果から参加するマッチメイクセッションを選ぶ方法を指定します。 [詳解]
 
void SetVacantOnly (bool vacantOnly)
 満員のものを除外するかを設定します。 [詳解]
 
qBool SetVacantOnly (bool vacantOnly, qUnsignedInt16 participants)
 満員のものを除外するかを設定します。空き人数の条件を指定できます。 [詳解]
 

詳解

マッチメイクセッションの検索条件を格納するデータクラスです。

AutoMatchmakeParam::SetSearchCriteria() で検索条件を指定した場合は設定にかかわらず、クローズされているもの、満員のもの、パスワードがセットされているものは自動的に除外されます。

クローズされているもの、満員のもの、パスワードがセットされているものを除外するかの設定は、 MatchmakeExtensionClient::BrowseMatchmakeSession() を利用した際に有効になります。

構築子と解体子

nn::nex::MatchmakeSessionSearchCriteria::MatchmakeSessionSearchCriteria ( )

コンストラクタです。

コンストラクタです。初期状態は不正な検索条件となります。 最低限 MatchmakeSessionSearchCriteria::SetGameMode() 及び MatchmakeSessionSearchCriteria::SetMatchmakeSystemType() でゲームモードとマッチメイクシステムタイプを指定する必要があります。 指定したゲームモードとマッチメイクシステムタイプと一致し、ホストが決定していないもの、パスワードがセットされているもの、 参加がロックされているもの、満員のものを除外したマッチメイクセッションにマッチします。 検索範囲は、 RESULTRANGE_ANY_OFFSET になります。

nn::nex::MatchmakeSessionSearchCriteria::MatchmakeSessionSearchCriteria ( qUnsignedInt32  gameMode,
MatchmakeSystemType  matchmakeSystemType 
)

コンストラクタです。

コンストラクタです。最低限必要なパラメータがセットされた有効なオブジェクトを生成します。 指定したゲームモードとマッチメイクシステムタイプと一致し、ホストが決定していないもの、パスワードがセットされているもの、 参加がロックされているもの、満員のものを除外したマッチメイクセッションにマッチします。 取得件数は 20 件、オフセットはランダム (RESULTRANGE_ANY_OFFSET) になります。

関数詳解

void nn::nex::MatchmakeSessionSearchCriteria::SetGameMode ( qUnsignedInt32  gameMode)

検索するゲームモードを指定します。

検索するゲームモードを指定します。指定は必須です。

引数
[in]gameModeゲームモード。
void nn::nex::MatchmakeSessionSearchCriteria::SetMinParticipants ( qUnsignedInt16  minParticipants)

最少参加人数を指定します。

最少参加人数を指定します。指定しなかった場合、任意の値にマッチするようになります

引数
[in]minParticipants最少参加人数
void nn::nex::MatchmakeSessionSearchCriteria::SetMinParticipantsWithRange ( qUnsignedInt16  min,
qUnsignedInt16  max 
)

最少参加人数を範囲指定します。

最少参加人数を指定します。指定しなかった場合、任意の値にマッチするようになります min値 <= 最少参加人数 <= max値 で検索します。

引数
[in]min最少参加人数の最小値。
[in]max最少参加人数の最大値。
void nn::nex::MatchmakeSessionSearchCriteria::SetMaxParticipants ( qUnsignedInt16  maxParticipants)

最大参加人数を指定します。

最大参加人数を指定します。指定しなかった場合、任意の値にマッチするようになります

引数
[in]maxParticipants最大参加人数
void nn::nex::MatchmakeSessionSearchCriteria::SetMaxParticipantsWithRange ( qUnsignedInt16  min,
qUnsignedInt16  max 
)

最大参加人数を範囲指定します。

最大参加人数を指定します。指定しなかった場合、任意の値にマッチするようになります min値 <= 最大参加人数 <= max値 で検索します。

引数
[in]min最大参加人数の最小値。
[in]max最大参加人数の最大値。
void nn::nex::MatchmakeSessionSearchCriteria::SetAttribute ( qUnsignedInt32  uiIndex,
qUnsignedInt32  val 
)

検索する属性を指定します。

検索する属性を指定します。最大NUM_MATCHMAKE_SESSION_ATTRIBUTES個の属性を指定できます。指定しなかったインデックスは任意の値にマッチするようになります。

属性値は、インデックス 0 から NUM_MATCHMAKE_SESSION_ATTRIBUTES - 1 まで一括して評価されます。インデックスの順番は関係ありません。

引数
[in]uiIndexセットする属性のインデックス。0以上NUM_MATCHMAKE_SESSION_ATTRIBUTES - 1以下の値を指定できます。
[in]valアプリケーション定義の属性値。
qBool nn::nex::MatchmakeSessionSearchCriteria::SetAttribute ( qUnsignedInt32  uiIndex,
const qVector< qUnsignedInt32 > &  vals 
)

検索する属性を指定します。属性値を複数指定できます。

検索する属性を指定します。最大NUM_MATCHMAKE_SESSION_ATTRIBUTES個の属性を指定できます。指定しなかったインデックスは任意の値にマッチするようになります。

属性値は、インデックス 0 から NUM_MATCHMAKE_SESSION_ATTRIBUTES - 1 まで一括して評価されます。インデックスの順番は関係ありません。

引数
[in]uiIndexセットする属性のインデックス。0以上NUM_MATCHMAKE_SESSION_ATTRIBUTES - 1以下の値を指定できます。
[in]valsアプリケーション定義の属性値。要素数は1以上SETATTIBUTE_VECTOR_SIZE_MAX以下としてください。
戻り値
属性値の要素数が0、もしくはSETATTIBUTE_VECTOR_SIZE_MAXより大きい場合は、何もせずにfalseを返します。 それ以外の場合は、属性を指定しtrueを返します。
void nn::nex::MatchmakeSessionSearchCriteria::SetAttributeWithRange ( qUnsignedInt32  uiIndex,
qUnsignedInt32  min,
qUnsignedInt32  max 
)

検索する属性を範囲で指定します。

検索する属性を範囲で指定します。最大NUM_MATCHMAKE_SESSION_ATTRIBUTES個の属性を指定できます。 指定しなかったインデックスは任意の値にマッチするようになります。 min値 <= 属性値 <= max値 で検索します。

属性値は、インデックス 0 から NUM_MATCHMAKE_SESSION_ATTRIBUTES - 1 まで一括して評価されます。インデックスの順番は関係ありません。

引数
[in]uiIndexセットする属性のインデックス。0 以上 NUM_MATCHMAKE_SESSION_ATTRIBUTES - 1以下の値を指定できます。
[in]minアプリケーション定義の属性値の最小値。
[in]maxアプリケーション定義の属性値の最大値。
void nn::nex::MatchmakeSessionSearchCriteria::SetMatchmakeSystemType ( MatchmakeSystemType  matchmakeSystemType)

検索するマッチメイクシステムタイプを指定します。

検索するマッチメイクシステムタイプを指定します。指定は必須です。 MATCHMAKE_SYSTEM_TYPE_PERSISTENT_GATHERING を指定した場合、SetAttribute() で 0 番目の属性値に永続ギャザリングのギャザリングIDをセットする必要があります。

引数
[in]matchmakeSystemTypeマッチメイクシステムタイプ。
void nn::nex::MatchmakeSessionSearchCriteria::SetExcludeLocked ( bool  excludeLocked)

すでに参加がロックされているものを除外するかを設定します。

すでに参加がクローズされているものを除外するかを設定します。 クローズは MatchmakeExtensionClient::CloseParticipation() で行います。 デフォルトでは true です。

AutoMatchmakeParam::SetSearchCriteria() で指定した場合は設定にかかわらず除外します。 MatchmakeExtensionClient::BrowseMatchmakeSession() を利用した際に有効になります。

引数
[in]excludeLocked参加がロック、クローズされているものを除外する場合はtrue、含む場合はfalseを指定してください。
void nn::nex::MatchmakeSessionSearchCriteria::SetVacantOnly ( bool  vacantOnly)

満員のものを除外するかを設定します。

満員のものを除外するかを設定します。デフォルトでは除外しません。

AutoMatchmakeParam::SetSearchCriteria() で指定した場合は設定にかかわらず除外します。 MatchmakeExtensionClient::BrowseMatchmakeSession() を利用した際に有効になります。

引数
[in]vacantOnly満員のものを除外する場合はtrue、除外しない場合はfalseを指定してください。
qBool nn::nex::MatchmakeSessionSearchCriteria::SetVacantOnly ( bool  vacantOnly,
qUnsignedInt16  participants 
)

満員のものを除外するかを設定します。空き人数の条件を指定できます。

満員のものを除外するかを設定します。デフォルトでは除外しません。 除外する場合、検索するマッチメイクセッションの空き人数を指定できます。

MatchmakeExtensionClient::BrowseMatchmakeSession() では、participantsに指定した値以上の空きがあるマッチメイクセッションを検索します。

AutoMatchmakeParam::SetSearchCriteria() で指定した場合は設定にかかわらず参加する人数分の空きがあるマッチメイクセッションを検索します。

引数
[in]vacantOnly満員のものを除外する場合はtrue、除外しない場合はfalseを指定してください。
[in]participants空き人数。1以上の値を設定してください。vacantOnlyがfalseのとき、この値は無視されます。


戻り値一覧:

true 設定に成功。

false 失敗。vacantOnlyがtrueかつ、participantsが0のとき失敗します。

void nn::nex::MatchmakeSessionSearchCriteria::SetExcludeNonHostPid ( bool  excludeNonHostPid_)

ホストが決定していないものを除外するかを設定します。

ホストのプリンシパル ID がマッチメイクセッションに登録されていないものを除外するかを設定します。除外する場合はtrueを指定してください。デフォルトでは除外します。 MatchmakeExtensionClient::CreateMatchmakeSession()MatchmakeExtensionClient::AutoMatchmake() でマッチメイクセッションを作成した場合は自動的にオーナーがホストになります。

引数
[in]excludeNonHostPid_ホストが決定していないものを除外する場合はtrue、除外しない場合はfalseを指定してください。
void nn::nex::MatchmakeSessionSearchCriteria::SetExcludeUserPasswordSet ( bool  excludeUserPasswordSet_)

マッチメイクセッションユーザーパスワードが設定されたものを除外するかを設定します。

マッチメイクセッションユーザーパスワードが設定されたものを除外するかを設定します。除外する場合はtrueを指定してください。デフォルトでは除外します。

AutoMatchmakeParam::SetSearchCriteria() で指定した場合は設定にかかわらず除外します。 MatchmakeExtensionClient::BrowseMatchmakeSession() を利用した際に有効になります。

引数
[in]excludeUserPasswordSet_マッチメイクセッションユーザーパスワードが設定されたものを除外する場合はtrue、除外しない場合はfalseを指定してください。
void nn::nex::MatchmakeSessionSearchCriteria::SetSelectionMethod ( MatchmakeSelectionMethod  selectionMethod)

検索結果から参加するマッチメイクセッションを選ぶ方法を指定します。

検索条件に一致した複数のマッチメイクセッションの中から参加するマッチメイクセッションを選ぶ方法を設定します(オートマッチメイク時のみ利用)。 MATCHMAKE_SELECTION_METHOD_SCORE_BASED 以外を使用する場合はこちらのオーバーロード関数を使用します。

引数
[in]selectionMethod選び方
void nn::nex::MatchmakeSessionSearchCriteria::SetSelectionMethod ( MatchmakeSelectionMethod  selectionMethod,
const MatchmakeParam param 
)

検索結果から参加するマッチメイクセッションを選ぶ方法を指定します。

検索条件に一致した複数のマッチメイクセッションの中から参加するマッチメイクセッションを選ぶ方法を設定します(オートマッチメイク時のみ利用)。 MATCHMAKE_SELECTION_METHOD_SCORE_BASED を使用する場合はこちらのオーバーロード関数を使用します。

引数
[in]selectionMethod選び方
[in]param選び方に対するパラメータ
void nn::nex::MatchmakeSessionSearchCriteria::SetReferPersistentGatheringId ( GatheringID  referPersistentGatheringId)

検索する関連する永続ギャザリングの ID をセットします。

検索する関連する永続ギャザリングの ID をセットします。指定した永続ギャザリングに関連するマッチメイクセッションが検索されます。

引数
[in]referPersistentGatheringId関連する永続ギャザリングの ID。 INVALID_GATHERING を指定した場合は任意の値にマッチするようになります。デフォルトは INVALID_GATHERING です。
qBool nn::nex::MatchmakeSessionSearchCriteria::SetCodeword ( const String codeword)

検索対象のあいことばをセットします

空文字列をセットすることにより、あいことばを検索しない設定にすることができます。 初期状態は空文字列です。

引数
[in]codewordあいことば


戻り値一覧:

true 成功。あいことばとして使用できる文字列もしくは空文字列です

false 失敗。あいことばとして使用できない文字が含まれています

void nn::nex::MatchmakeSessionSearchCriteria::SetResultRange ( const ResultRange resultRange)

検索範囲をセットします。

MatchmakeExtensionClient::BrowseMatchmakeSession()ResultRange を引数に取らないオーバーロード関数でのみここでセットした検索範囲が使用されます。 それ以外のオーバーロード関数を使用した場合は引数で直接指定したものが使用されます。 また、 MatchmakeExtensionClient::AutoMatchmake() に指定した場合も無視されます。

引数
[in]resultRange検索範囲
参照
MatchmakeExtensionClient::BrowseMatchmakeSession()
void nn::nex::MatchmakeSessionSearchCriteria::Reset ( )

全ての検索条件をリセットします。

全ての検索条件をリセットし、デフォルトコンストラクタで生成した状態にします。

qBool nn::nex::MatchmakeSessionSearchCriteria::IsValid ( ) const

検索条件が有効かどうか調べます。

ゲームモードとマッチメイクシステムタイプがセットされていれば有効となります。

戻り値
検索条件が有効かどうか