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

マッチメイクセッションに関するパラメータを格納するデータクラスです。 [詳解]

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

DDLCLASSMatchmakeParamを継承しています。

公開メンバ関数

 MatchmakeParam ()
 コンストラクタです。 [詳解]
 
virtual ~MatchmakeParam ()
 デストラクタです。
 
qBool GetDisconnectionRate (qUnsignedInt32 *disconnectionRate) const
 切断率を取得します。 [詳解]
 
qBool GetGeoIpResult (MATCHMAKE_GEO_IP_RESULT *geoIpResult) const
 位置情報の取得結果を取得します。 [詳解]
 
qBool GetOverrideIpAddress (String *overrideIpAddress)
 デバッグ用の IP アドレスを取得します。 [詳解]
 
qBool GetRatingValue (qUnsignedInt32 *ratingValue) const
 レーティング値を取得します。 [詳解]
 
qBool GetSettingIndex (qUnsignedInt32 *settingIndex) const
 設定インデックスを取得します。 [詳解]
 
qBool GetTotalScore (qUnsignedInt32 *totalScore) const
 トータルスコアを取得します。 [詳解]
 
qBool GetUpdateGeoIp (qBool *updateGeoIp) const
 位置情報を更新するかどうかを取得します。 [詳解]
 
qBool GetUseGeoIp (qBool *useGeoIp) const
 位置情報を使うかどうかを取得します。 [詳解]
 
qBool GetViolationRate (qUnsignedInt32 *violationRate) const
 違反率を取得します。 [詳解]
 
void Reset ()
 オブジェクトをデフォルトコンストラクタで生成した状態に初期化します。
 
qBool SetCountryCode (const String &countryCode)
 ISO 3166-1 alpha-2 によるアルファベット 2 文字の国コードを設定します。 [詳解]
 
void SetDisconnectionRate (qUnsignedInt32 disconnectionRate)
 切断率をセットします。 [詳解]
 
void SetNintendoCountryCode (qUnsignedInt32 nintendoCountryCode)
 国コードをセットします。 [詳解]
 
void SetOverrideIpAddress (const String &overrideIpAddress)
 デバッグ用の IP アドレスをセットします。 [詳解]
 
void SetRatingValue (qUnsignedInt32 ratingValue)
 レーティング値をセットします。 [詳解]
 
void SetSettingIndex (qUnsignedInt32 settingIndex)
 設定インデックスをセットします。 [詳解]
 
void SetUpdateGeoIp (qBool updateGeoIp)
 位置情報を更新するかどうかをセットします。 [詳解]
 
void SetUseGeoIp (qBool useGeoIp)
 位置情報を使うかどうかをセットします。 [詳解]
 
void SetViolationRate (qUnsignedInt32 violationRate)
 違反率をセットします。 [詳解]
 
void Trace (qUnsignedInt64 uiTraceFlags=TRACE_ALWAYS) const
 MatchmakeParam オブジェクトの内容をトレースします。 [詳解]
 

詳解

マッチメイクセッションに関するパラメータを格納するデータクラスです。

構築子と解体子

nn::nex::MatchmakeParam::MatchmakeParam ( )

コンストラクタです。

コンストラクタです。初期状態は空のパラメータです。

関数詳解

void nn::nex::MatchmakeParam::SetSettingIndex ( qUnsignedInt32  settingIndex)

設定インデックスをセットします。

スコア換算表の設定インデックスをセットします。設定インデックスをセットしていない場合は 0 が使用されます。 MatchmakeSessionSearchCriteria::SetSelectionMethod() で指定する MatchmakeParam オブジェクトに指定した場合のみこのパラメータが参照されます。

引数
[in]settingIndex設定インデックス。未設定の設定インデックスを指定した場合はマッチメイクセッションを評価したときの トータルスコアが 0 となります。
qBool nn::nex::MatchmakeParam::GetSettingIndex ( qUnsignedInt32 settingIndex) const

設定インデックスを取得します。

スコア換算表の設定インデックスを取得します。引数に NULL を渡すとパラメータの有無をのみを確認できます。 サーバーから取得した MatchmakeSession に含まれる MatchmakeParam オブジェクトにはこのパラメータは含まれません。

引数
[out]settingIndex取得した設定インデックスを書き込む先のポインタ。NULL を渡した場合は書き込まれません。
戻り値
パラメータがこのオブジェクトにセットされているかどうか。
void nn::nex::MatchmakeParam::SetRatingValue ( qUnsignedInt32  ratingValue)

レーティング値をセットします。

レーティング値をセットします。レーティング値をセットしない場合はレーティング値の差に関するスコアがデフォルトスコアとして評価されます。

引数
[in]ratingValueレーティング値。
qBool nn::nex::MatchmakeParam::GetRatingValue ( qUnsignedInt32 ratingValue) const

レーティング値を取得します。

レーティング値を取得します。引数に NULL を渡すとパラメータの有無をのみを確認できます。

引数
[out]ratingValue取得したレーティング値を書き込む先のポインタ。NULL を渡した場合は書き込まれません。
戻り値
パラメータがこのオブジェクトにセットされているかどうか。
void nn::nex::MatchmakeParam::SetDisconnectionRate ( qUnsignedInt32  disconnectionRate)

切断率をセットします。

切断率をセットします。切断率をセットしない場合は切断率の差に関するスコアがデフォルトスコアとして評価されます。

引数
[in]disconnectionRate切断率。
qBool nn::nex::MatchmakeParam::GetDisconnectionRate ( qUnsignedInt32 disconnectionRate) const

切断率を取得します。

切断率を取得します。引数に NULL を渡すとパラメータの有無をのみを確認できます。

引数
[out]disconnectionRate取得した切断率を書き込む先のポインタ。NULL を渡した場合は書き込まれません。
戻り値
パラメータがこのオブジェクトにセットされているかどうか。
void nn::nex::MatchmakeParam::SetViolationRate ( qUnsignedInt32  violationRate)

違反率をセットします。

違反率をセットします。違反率をセットしない場合は違反率の差に関するスコアがデフォルトスコアとして評価されます。

引数
[in]violationRate違反率。
qBool nn::nex::MatchmakeParam::GetViolationRate ( qUnsignedInt32 violationRate) const

違反率を取得します。

違反率を取得します。引数に NULL を渡すとパラメータの有無をのみを確認できます。

引数
[out]violationRate取得した違反率を書き込む先のポインタ。NULL を渡した場合は書き込まれません。
戻り値
パラメータがこのオブジェクトにセットされているかどうか。
void nn::nex::MatchmakeParam::SetNintendoCountryCode ( qUnsignedInt32  nintendoCountryCode)

国コードをセットします。

UseGeoIP() で位置情報を使用しない設定をした場合、もしくは位置情報を使用する設定をしたが位置情報を得られなかった場合に 使用する国コードをセットします。位置情報が得られた場合はここで指定した国コードは使用されません。 国コードをセットしない場合はUseGeoIP() で位置情報を使用しない設定をした場合、 もしくは位置情報を使用する設定をしたが位置情報を得られなかった場合に国コードの比較に関するスコアがデフォルトスコアとして評価されます。

CountryCodeが設定してあればCountryCodeの値が優先され、こちらで設定した値は無視されます。

引数
[in]nintendoCountryCode国コード。
qBool nn::nex::MatchmakeParam::SetCountryCode ( const String countryCode)

ISO 3166-1 alpha-2 によるアルファベット 2 文字の国コードを設定します。

UseGeoIP() で位置情報を使用しない設定をした場合、もしくは位置情報を使用する設定をしたが位置情報を得られなかった場合に 使用する国コードをセットします。位置情報が得られた場合はここで指定した国コードは使用されません。 国コードをセットしない場合はUseGeoIP() で位置情報を使用しない設定をした場合、 もしくは位置情報を使用する設定をしたが位置情報を得られなかった場合に国コードの比較に関するスコアがデフォルトスコアとして評価されます。

引数
[in]countryCode国コード。
戻り値
国コードとして適切な文字列か。適切ではない場合には設定が行われません。
void nn::nex::MatchmakeParam::SetOverrideIpAddress ( const String overrideIpAddress)

デバッグ用の IP アドレスをセットします。

デバッグ用の IP アドレスをセットします。自身の IP アドレスの代わりにこの IP アドレスを使用して GeoIP による位置情報を取得します。 デバッグ用にのみ使用可能です。 サーバーから取得した MatchmakeSession に含まれる MatchmakeParam オブジェクトを MatchmakeExtensionClient::UpdateMatchmakeSession() で使用する際にデバッグ用の IP アドレスを使用する場合は 再度本 API で再セットする必要があります。

引数
[in]overrideIpAddressデバッグ用の IP アドレス。
qBool nn::nex::MatchmakeParam::GetOverrideIpAddress ( String overrideIpAddress)

デバッグ用の IP アドレスを取得します。

デバッグ用の IP アドレスを取得します。引数に NULL を渡すとパラメータの有無をのみを確認できます。 サーバーから取得した MatchmakeSession に含まれる MatchmakeParam オブジェクトにはこのパラメータは含まれません。

引数
[out]overrideIpAddress取得したデバッグ用の IP アドレスを書き込む先のポインタ。NULL を渡した場合は書き込まれません。
戻り値
パラメータがこのオブジェクトにセットされているかどうか。
qBool nn::nex::MatchmakeParam::GetTotalScore ( qUnsignedInt32 totalScore) const

トータルスコアを取得します。

トータルスコアを取得します。引数に NULL を渡すとパラメータの有無をのみを確認できます。 MatchmakeExtensionClient::AutoMatchmake() において MATCHMAKE_SELECTION_METHOD_SCORE_BASED を使用した検索条件を指定し、 自身がマッチメイクセッションのオーナーにならなかった場合のみ MatchmakeExtensionClient::AutoMatchmake() で取得したマッチメイクセッションからトータルスコアを取得できます。

引数
[out]totalScore取得したトータルスコアを書き込む先のポインタ。NULL を渡した場合は書き込まれません。
戻り値
パラメータがこのオブジェクトにセットされているかどうか。
void nn::nex::MatchmakeParam::SetUseGeoIp ( qBool  useGeoIp)

位置情報を使うかどうかをセットします。

位置情報 (緯度経度、国コード) を使うかどうかをセットします。 位置情報を使うかどうかをセットしない場合は距離の比較に関するスコアがデフォルトスコアとして評価されます。

引数
[in]useGeoIp位置情報を使うかどうか。
qBool nn::nex::MatchmakeParam::GetUseGeoIp ( qBool useGeoIp) const

位置情報を使うかどうかを取得します。

位置情報を使うかどうかを取得します。引数に NULL を渡すとパラメータの有無をのみを確認できます。

引数
[out]useGeoIp位置情報を使うかどうかを書き込む先のポインタ。NULL を渡した場合は書き込まれません。
戻り値
パラメータがこのオブジェクトにセットされているかどうか。
void nn::nex::MatchmakeParam::SetUpdateGeoIp ( qBool  updateGeoIp)

位置情報を更新するかどうかをセットします。

位置情報を更新するかどうかをセットします。 MatchmakeExtensionClient::UpdateMatchmakeSession() に指定する MatchmakeSessionMatchmakeParam オブジェクトに対して使用できます。 更新する場合は自身の位置情報で置き換えられます。 位置情報を更新するかどうかをセットしない場合は更新されます。 サーバーに記録されている位置情報を更新しない場合は該当のマッチメイクセッションをサーバーから取得し、その MatchmakeParam オブジェクトを利用する必要があります。 クライアントで生成した MatchmakeParam を利用して更新しない設定をすると位置情報が削除されます。

引数
[in]updateGeoIp位置情報を使うかどうか。
qBool nn::nex::MatchmakeParam::GetUpdateGeoIp ( qBool updateGeoIp) const

位置情報を更新するかどうかを取得します。

位置情報を更新するかどうかを取得します。引数に NULL を渡すとパラメータの有無をのみを確認できます。 サーバーから取得した MatchmakeSession に含まれる MatchmakeParam オブジェクトにはこのパラメータは含まれません。

引数
[out]updateGeoIp位置情報を更新するかどうかを書き込む先のポインタ。NULL を渡した場合は書き込まれません。
戻り値
パラメータがこのオブジェクトにセットされているかどうか。
qBool nn::nex::MatchmakeParam::GetGeoIpResult ( MATCHMAKE_GEO_IP_RESULT geoIpResult) const

位置情報の取得結果を取得します。

サーバーで位置情報を取得したときの結果を取得します。引数に NULL を渡すとパラメータの有無をのみを確認できます。 サーバーから取得したマッチメイクセッションからこのパラメータを取得できます。

引数
[out]geoIpResult位置情報を更新するかどうかを書き込む先のポインタ。NULL を渡した場合は書き込まれません。
戻り値
パラメータがこのオブジェクトにセットされているかどうか。
void nn::nex::MatchmakeParam::Trace ( qUnsignedInt64  uiTraceFlags = TRACE_ALWAYS) const

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

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