CTR-Pia
5.4.3
Game Communication Engine
|
セッションを検索する際に使用する検索条件のクラスです。 [詳細]
Public メソッド | |
NexSessionSearchCriteria () | |
デフォルトコンストラクタ。 | |
NexSessionSearchCriteria (const NexSessionSearchCriteria &rhs) | |
コピーコンストラクタ。 | |
virtual | ~NexSessionSearchCriteria () |
デストラクタ。 | |
void | Copy (const NexSessionSearchCriteria &rhs) |
設定をコピーします。 | |
NexSessionSearchCriteria & | operator= (const NexSessionSearchCriteria &rhs) |
代入演算子です。 | |
virtual void | Reset () |
設定をリセットします。 | |
Result | SetAttribute (uint32_t index, uint32_t value) |
1つの属性に対して検索時に使用する値を指定します。 | |
Result | SetAttribute (uint32_t index, const uint32_t *value, uint32_t attributeNum) |
1つの属性に対して検索時に使用する値を複数指定します。 | |
Result | SetAttributeRange (uint32_t index, uint32_t min, uint32_t max) |
1つの属性に対して検索時に使用する値を範囲指定します。 | |
void | SetCommunityId (uint32_t gid) |
関連付けるコミュニティの ID を設定します。 | |
void | SetCountryCode (uint32_t countryCode) |
スコアベースマッチメイク指定時に、比較に使用する国コードを設定します。国コードはプラットフォームで定義された値を設定します。 | |
void | SetDisconnectionRate (uint32_t disconnectionRate) |
スコアベースマッチメイク指定時に、比較に使用する切断率を設定します。 | |
void | SetExcludeNonHostPrincipalId (bool bExclude) |
ホストが存在しないセッションを検索対象から外すかどうか指定します。(デフォルトは対象から外します) | |
void | SetExcludeUserPasswordSet (bool bExclude) |
ユーザパスワードが設定されたセッションを検索対象から外すかどうか指定します。(デフォルトは対象から外します) | |
void | SetGameMode (uint32_t gameMode) |
検索条件にゲームモードを指定します。 | |
void | SetMaxParticipantNum (uint16_t max) |
検索条件に最大参加人数を指定します。 | |
void | SetMaxParticipantNumRange (uint16_t min, uint16_t max) |
検索条件に最大参加人数を範囲指定します。 | |
void | SetMinParticipantNum (uint16_t min) |
検索条件に最小参加人数を指定します。 | |
void | SetMinParticipantNumRange (uint16_t min, uint16_t max) |
検索条件に最小参加人数を範囲指定します。 | |
void | SetOpenedOnly (bool bOpenedOnly) |
検索条件に参加受付状態のセッションのみを検索するか指定します。 | |
Result | SetOverrideIpAddress (const common::InetAddress &ipAddress) |
スコアベースマッチメイク指定時に、比較に使用するデバッグ用の IP アドレスを設定します。 | |
void | SetRandomSessionSelectionMethod (SelectionMethod selectionMethod) |
ランダムマッチメイク実行時に参加するセッションの選択方法を指定します。 | |
void | SetRatingValue (uint32_t ratingValue) |
スコアベースマッチメイク指定時に、比較に使用するレーティング値を設定します。 | |
virtual Result | SetResultRange (uint32_t offset, uint32_t size) |
検索結果の取得範囲を指定します。 | |
void | SetScoreSettingIndex (uint32_t settingIndex) |
スコアベースマッチメイク指定時に、比較に使用するスコア換算方法の設定インデックスを設定します。 | |
Result | SetSessionMatchmakeKeyword (const common::String &keyword) |
あいことばマッチメイク用のあいことばを設定します。 | |
void | SetSessionType (SessionType sessionType) |
検索条件にセッションタイプを指定します。 | |
void | SetUseGeoIp (bool use) |
スコアベースマッチメイク指定時に、比較に位置情報 (緯度経度、国コード) を使用するかどうかを設定します。 | |
void | SetVacantOnly (bool bVacantOnly) |
検索条件に空きがあるセッションのみを検索するか指定します。 | |
void | SetViolationRate (uint32_t violationRate) |
スコアベースマッチメイク指定時に、比較に使用する違反率を設定します。 | |
セッションを検索する際に使用する検索条件のクラスです。
検索結果として得られるセッションの最大数は SetResultRange で指定する値になりますが、 nn::pia::session::Session::CreateInstance 呼び出し時に指定する nn::pia::session::Session::Setting 構造体の browsedSessionInfoListNum 以下の値を 指定する必要があります。
nn::pia::inet::NexSessionSearchCriteria::NexSessionSearchCriteria | ( | const NexSessionSearchCriteria & | rhs | ) |
コピーコンストラクタ。
[in] | rhs | コピー元のオブジェクトです。 |
void nn::pia::inet::NexSessionSearchCriteria::Copy | ( | const NexSessionSearchCriteria & | rhs | ) |
設定をコピーします。
[in] | rhs | コピー元のオブジェクトです。 |
NexSessionSearchCriteria& nn::pia::inet::NexSessionSearchCriteria::operator= | ( | const NexSessionSearchCriteria & | rhs | ) |
代入演算子です。
[in] | rhs | 代入するオブジェクトです。 |
Result nn::pia::inet::NexSessionSearchCriteria::SetAttribute | ( | uint32_t | index, |
uint32_t | value | ||
) |
1つの属性に対して検索時に使用する値を指定します。
設定されなかったインデックスの属性に対しては任意の値を検索対象とします。
[in] | index | 指定する属性のインデックス。AttributeSizeMax 以下である必要があります。 |
[in] | value | 指定する属性の値。 |
Result nn::pia::inet::NexSessionSearchCriteria::SetAttribute | ( | uint32_t | index, |
const uint32_t * | value, | ||
uint32_t | attributeNum | ||
) |
1つの属性に対して検索時に使用する値を複数指定します。
設定されなかったインデックスの属性に対しては任意の値を検索対象とします。
[in] | index | 指定する属性のインデックス。AttributeSizeMax 以下である必要があります。 |
[in] | value | 指定する属性の値のリスト。 |
[in] | attributeNum | 指定する属性の値の個数。AttributeArraySizeMax 以下である必要があります。 |
Result nn::pia::inet::NexSessionSearchCriteria::SetAttributeRange | ( | uint32_t | index, |
uint32_t | min, | ||
uint32_t | max | ||
) |
1つの属性に対して検索時に使用する値を範囲指定します。
設定されなかったインデックスの属性に対しては任意の値を検索対象とします。
[in] | index | 指定する属性のインデックス。AttributeSizeMax 以下である必要があります。 |
[in] | min | 指定する属性の値の下限。 |
[in] | max | 指定する属性の値の上限。 |
void nn::pia::inet::NexSessionSearchCriteria::SetCommunityId | ( | uint32_t | gid | ) |
関連付けるコミュニティの ID を設定します。
inet::NexCreateSessionSetting::SetCommunityId で同じコミュニティ ID を指定して作成されたセッションを検索の対象とします。
void nn::pia::inet::NexSessionSearchCriteria::SetCountryCode | ( | uint32_t | countryCode | ) |
スコアベースマッチメイク指定時に、比較に使用する国コードを設定します。国コードはプラットフォームで定義された値を設定します。
SetUseGeoIp で位置情報を使用しない設定をした場合、もしくは位置情報を使用する設定をしたが位置情報を得られなかった場合に使用する国コードをセットします。 位置情報が得られた場合はここで指定した国コードは使用されません。 国コードをセットしない場合は SetUseGeoIp で位置情報を使用しない設定をした場合、もしくは位置情報を使用する設定をしたが位置情報を得られなかった場合、 国コードの比較に関するスコアがデフォルトスコアとして評価されます。
[in] | countryCode | 国コード |
void nn::pia::inet::NexSessionSearchCriteria::SetDisconnectionRate | ( | uint32_t | disconnectionRate | ) |
スコアベースマッチメイク指定時に、比較に使用する切断率を設定します。
セットしない場合は切断率の差に関するスコアがデフォルトスコアとして評価されます。
[in] | disconnectionRate | 切断率 |
void nn::pia::inet::NexSessionSearchCriteria::SetExcludeNonHostPrincipalId | ( | bool | bExclude | ) |
ホストが存在しないセッションを検索対象から外すかどうか指定します。(デフォルトは対象から外します)
[in] | bExclude | ホストが存在しないセッションを検索対象から外す場合は true を指定します。 |
void nn::pia::inet::NexSessionSearchCriteria::SetExcludeUserPasswordSet | ( | bool | bExclude | ) |
ユーザパスワードが設定されたセッションを検索対象から外すかどうか指定します。(デフォルトは対象から外します)
[in] | bExclude | ユーザパスワードが設定されたセッションを検索対象から外す場合は true を指定します。 |
void nn::pia::inet::NexSessionSearchCriteria::SetGameMode | ( | uint32_t | gameMode | ) |
検索条件にゲームモードを指定します。
ゲームモードの指定は必須となります。指定しないまま、セッションの非同期処理を呼び出すとエラーを返します。
[in] | gameMode | 検索条件に指定するゲームモード。 |
void nn::pia::inet::NexSessionSearchCriteria::SetMaxParticipantNum | ( | uint16_t | max | ) |
検索条件に最大参加人数を指定します。
[in] | max | 検索条件に指定する最大参加人数。 |
void nn::pia::inet::NexSessionSearchCriteria::SetMaxParticipantNumRange | ( | uint16_t | min, |
uint16_t | max | ||
) |
検索条件に最大参加人数を範囲指定します。
[in] | min | 検索条件に指定する最大参加人数の範囲の下限。 |
[in] | max | 検索条件に指定する最大参加人数の範囲の上限。 |
void nn::pia::inet::NexSessionSearchCriteria::SetMinParticipantNum | ( | uint16_t | min | ) |
検索条件に最小参加人数を指定します。
[in] | min | 検索条件に指定する最小参加人数。 |
void nn::pia::inet::NexSessionSearchCriteria::SetMinParticipantNumRange | ( | uint16_t | min, |
uint16_t | max | ||
) |
検索条件に最小参加人数を範囲指定します。
[in] | min | 検索条件に指定する最小参加人数の範囲の下限。 |
[in] | max | 検索条件に指定する最小参加人数の範囲の上限。 |
void nn::pia::inet::NexSessionSearchCriteria::SetOpenedOnly | ( | bool | bOpenedOnly | ) |
検索条件に参加受付状態のセッションのみを検索するか指定します。
[in] | bOpenedOnly | 参加受付状態のセッションのみを検索する場合は true を指定します。 |
Result nn::pia::inet::NexSessionSearchCriteria::SetOverrideIpAddress | ( | const common::InetAddress & | ipAddress | ) |
スコアベースマッチメイク指定時に、比較に使用するデバッグ用の IP アドレスを設定します。
自身の IP アドレスの代わりにこの IP アドレスを使用して GeoIP による位置情報を取得します。 デバッグ用にのみ使用可能です。
[in] | ipAddress | 代わりに使用する IP アドレス |
void nn::pia::inet::NexSessionSearchCriteria::SetRandomSessionSelectionMethod | ( | SelectionMethod | selectionMethod | ) |
ランダムマッチメイク実行時に参加するセッションの選択方法を指定します。
[in] | selectionMethod | 指定するセッションの選択方法。 |
void nn::pia::inet::NexSessionSearchCriteria::SetRatingValue | ( | uint32_t | ratingValue | ) |
スコアベースマッチメイク指定時に、比較に使用するレーティング値を設定します。
セットしない場合はレーティング値の差に関するスコアがデフォルトスコアとして評価されます。
[in] | ratingValue | レーティング値 |
|
virtual |
検索結果の取得範囲を指定します。
offset に 0xFFFFFFFF を指定すると、検索結果をランダムに並び替えた上で指定されたエントリー数を取得するように振る舞います。
[in] | offset | 検索条件にマッチしたエントリーリストから検索結果として取得するエントリー群の開始位置。 |
[in] | size | 検索条件にマッチしたエントリーリストから検索結果として取得するエントリー数。 session::Session::Setting 構造体の browsedSessionInfoListNum 以下、かつSearchCriteriaResultSizeMax 以下の値である必要があります。 |
nn::pia::session::SessionSearchCriteriaを再定義しています。
void nn::pia::inet::NexSessionSearchCriteria::SetScoreSettingIndex | ( | uint32_t | settingIndex | ) |
スコアベースマッチメイク指定時に、比較に使用するスコア換算方法の設定インデックスを設定します。
設定インデックスをセットしていない場合は 0 が使用されます。
[in] | settingIndex | スコア換算設定のインデックス |
Result nn::pia::inet::NexSessionSearchCriteria::SetSessionMatchmakeKeyword | ( | const common::String & | keyword | ) |
あいことばマッチメイク用のあいことばを設定します。
[in] | keyword | 設定するあいことばマッチメイク用のあいことば。あいことばの文字列は SessionMatchmakeKeywordLength 以下である必要があります。 |
void nn::pia::inet::NexSessionSearchCriteria::SetSessionType | ( | SessionType | sessionType | ) |
検索条件にセッションタイプを指定します。
指定しなかった場合、デフォルト値(SessionType_Anybody)が指定されます。
[in] | sessionType | 検索条件に指定するセッションタイプ。 |
void nn::pia::inet::NexSessionSearchCriteria::SetUseGeoIp | ( | bool | use | ) |
スコアベースマッチメイク指定時に、比較に位置情報 (緯度経度、国コード) を使用するかどうかを設定します。
位置情報を使うかどうかをセットしない場合は距離の比較に関するスコアがデフォルトスコアとして評価されます。
[in] | use | 位置情報を使用するかどうか |
void nn::pia::inet::NexSessionSearchCriteria::SetVacantOnly | ( | bool | bVacantOnly | ) |
検索条件に空きがあるセッションのみを検索するか指定します。
[in] | bVacantOnly | 空きがあるセッションのみを検索する場合は true を指定します。 |
void nn::pia::inet::NexSessionSearchCriteria::SetViolationRate | ( | uint32_t | violationRate | ) |
スコアベースマッチメイク指定時に、比較に使用する違反率を設定します。
セットしない場合は違反率の差に関するスコアがデフォルトスコアとして評価されます。
[in] | violationRate | 違反率 |