CTR-Pia
5.4.3
Game Communication Engine
|
セッション構築処理に関する設定を管理するクラスです。 [詳細]
Public メソッド | |
NexCreateSessionSetting () | |
デフォルトコンストラクタ。 | |
NexCreateSessionSetting (const NexCreateSessionSetting &rhs) | |
コピーコンストラクタ。 | |
virtual | ~NexCreateSessionSetting () |
デストラクタ。 | |
void | Copy (const NexCreateSessionSetting &rhs) |
設定をコピーします。 | |
NexCreateSessionSetting & | operator= (const NexCreateSessionSetting &rhs) |
代入演算子です。 | |
virtual void | Reset () |
設定をリセットします。 | |
virtual Result | SetApplicationData (const void *pData, uint32_t size) |
アプリケーション定義のデータを指定します。 | |
Result | SetAttribute (uint32_t index, uint32_t value) |
構築するセッションに属性を指定します。 | |
void | SetCommunityId (uint32_t gid) |
関連付けるコミュニティの ID を設定します。 | |
void | SetCountryCode (uint32_t countryCode) |
スコアベースマッチメイク指定時に、比較に使用する国コードを設定します。国コードはプラットフォームで定義された値を設定します。 | |
void | SetDisconnectionRate (uint32_t disconnectionRate) |
スコアベースマッチメイク指定時に、比較に使用する切断率を設定します。 | |
void | SetGameMode (uint32_t gameMode) |
構築するセッションのゲームモードを指定します。 | |
virtual void | SetMaxParticipantNum (uint16_t max) |
作成するセッションの最大参加人数を指定します。 | |
void | SetMinParticipantNum (uint16_t min) |
作成するセッションの最小参加人数を指定します。 | |
void | SetOpenSession (bool isOpen) |
構築したセッションが参加可能で構築されるか、参加不可で構築されるかを指定します。指定しなかった場合、参加不可で構築されます。 | |
Result | SetOverrideIpAddress (const common::InetAddress &inetAddress) |
スコアベースマッチメイク指定時に、比較に使用するデバッグ用の IP アドレスを設定します。 | |
void | SetRatingValue (uint32_t ratingValue) |
スコアベースマッチメイク指定時に、比較に使用するレーティング値を設定します。 | |
void | SetSelectionPriority (uint8_t priority) |
同じ条件のセッションが見つかった際のマッチメイクの優先度を設定します。 | |
Result | SetSessionMatchmakeKeyword (const common::String &keyword) |
作成したセッションにあいことばマッチメイク用のあいことばを設定します。 | |
void | SetSessionType (SessionType sessionType, bool isAutoCloseSession=false) |
構築するセッションのセッションタイプとホストマイグレーション時にセッションを自動的に参加締切状態にする設定を指定します。 | |
Result | SetSessionUserPassword (const common::String &userPassword) |
作成したセッションにユーザーパスワードを設定します。 | |
void | SetUseGeoIp (bool use) |
スコアベースマッチメイク指定時に、比較に位置情報 (緯度経度、国コード) を使用するかどうかを設定します。 | |
void | SetViolationRate (uint32_t violationRate) |
スコアベースマッチメイク指定時に、比較に使用する違反率を設定します。 | |
セッション構築処理に関する設定を管理するクラスです。
nn::pia::inet::NexCreateSessionSetting::NexCreateSessionSetting | ( | const NexCreateSessionSetting & | rhs | ) |
コピーコンストラクタ。
[in] | rhs | コピー元のオブジェクトです。 |
void nn::pia::inet::NexCreateSessionSetting::Copy | ( | const NexCreateSessionSetting & | rhs | ) |
設定をコピーします。
[in] | rhs | コピー元のオブジェクトです。 |
NexCreateSessionSetting& nn::pia::inet::NexCreateSessionSetting::operator= | ( | const NexCreateSessionSetting & | rhs | ) |
代入演算子です。
[in] | rhs | 代入するオブジェクトです。 |
|
virtual |
アプリケーション定義のデータを指定します。
[in] | pData | 構築するセッションに指定するアプリケーション定義データのバッファ。 |
[in] | size | 構築するセッションに指定するアプリケーション定義データのサイズ。ApplicationDataBufferSizeMax 以下である必要があります。 |
Result nn::pia::inet::NexCreateSessionSetting::SetAttribute | ( | uint32_t | index, |
uint32_t | value | ||
) |
構築するセッションに属性を指定します。
設定されなかったインデックスの属性には 0 が設定されます。
[in] | index | 構築するセッションに指定する属性のインデックス。AttributeSizeMax 以下である必要があります。 |
[in] | value | 構築するセッションに指定する属性の値。 |
void nn::pia::inet::NexCreateSessionSetting::SetCommunityId | ( | uint32_t | gid | ) |
関連付けるコミュニティの ID を設定します。
inet::NexSessionSearchCriteria::SetCommunityId で同じコミュニティ ID を指定して検索したプレイヤーのみに検索結果として見つけられるセッションになります。 また、NEX のランキング機能との連携を行う際に必要となります。ランキング機能との連携については、NEX の永続ギャザリングに関するドキュメントを参照してください。
void nn::pia::inet::NexCreateSessionSetting::SetCountryCode | ( | uint32_t | countryCode | ) |
スコアベースマッチメイク指定時に、比較に使用する国コードを設定します。国コードはプラットフォームで定義された値を設定します。
SetUseGeoIp で位置情報を使用しない設定をした場合、もしくは位置情報を使用する設定をしたが位置情報を得られなかった場合に使用する国コードをセットします。 位置情報が得られた場合はここで指定した国コードは使用されません。 国コードをセットしない場合は SetUseGeoIp で位置情報を使用しない設定をした場合、もしくは位置情報を使用する設定をしたが位置情報を得られなかった場合、 国コードの比較に関するスコアがデフォルトスコアとして評価されます。
[in] | countryCode | 国コード |
void nn::pia::inet::NexCreateSessionSetting::SetDisconnectionRate | ( | uint32_t | disconnectionRate | ) |
スコアベースマッチメイク指定時に、比較に使用する切断率を設定します。
[in] | disconnectionRate | 切断率 |
void nn::pia::inet::NexCreateSessionSetting::SetGameMode | ( | uint32_t | gameMode | ) |
構築するセッションのゲームモードを指定します。
[in] | gameMode | 構築するセッションに指定するゲームモード。 |
|
virtualinherited |
作成するセッションの最大参加人数を指定します。
[in] | max | 作成するセッションに指定する最大参加人数。 |
nn::pia::local::UdsCreateSessionSettingで再定義されています。
|
inherited |
作成するセッションの最小参加人数を指定します。
[in] | min | 作成するセッションに指定する最小参加人数。 |
void nn::pia::inet::NexCreateSessionSetting::SetOpenSession | ( | bool | isOpen | ) |
構築したセッションが参加可能で構築されるか、参加不可で構築されるかを指定します。指定しなかった場合、参加不可で構築されます。
[in] | isOpen | true を設定した場合、セッションは始めから参加可能な状態で構築されます。 |
Result nn::pia::inet::NexCreateSessionSetting::SetOverrideIpAddress | ( | const common::InetAddress & | inetAddress | ) |
スコアベースマッチメイク指定時に、比較に使用するデバッグ用の IP アドレスを設定します。
自身の IP アドレスの代わりにこの IP アドレスを使用して GeoIP による位置情報を取得します。 デバッグ用にのみ使用可能です。
[in] | inetAddress | 代わりに使用する IP アドレス |
void nn::pia::inet::NexCreateSessionSetting::SetRatingValue | ( | uint32_t | ratingValue | ) |
スコアベースマッチメイク指定時に、比較に使用するレーティング値を設定します。
[in] | ratingValue | レーティング値 |
void nn::pia::inet::NexCreateSessionSetting::SetSelectionPriority | ( | uint8_t | priority | ) |
同じ条件のセッションが見つかった際のマッチメイクの優先度を設定します。
作成したセッションのマッチメイクの優先度を設定します。 設定しなかった場合、0 が設定されます。 nn::pia::inet::SelectionMethod_BroadenRangeWithSelectionPriority, SelectionMethod_ScoreBased で検索を行った場合のみ有効です。 nn::pia::inet::SessionSelectionPriorityMax を超えた値を引数にした場合、nn::pia::inet::SessionSelectionPriorityMax が設定されます。
[in] | priority | 設定するマッチメイクの優先度 |
Result nn::pia::inet::NexCreateSessionSetting::SetSessionMatchmakeKeyword | ( | const common::String & | keyword | ) |
作成したセッションにあいことばマッチメイク用のあいことばを設定します。
[in] | keyword | 設定するあいことばマッチメイク用のあいことば。あいことばの文字列は SessionMatchmakeKeywordLength 以下である必要があります。 |
void nn::pia::inet::NexCreateSessionSetting::SetSessionType | ( | SessionType | sessionType, |
bool | isAutoCloseSession = false |
||
) |
構築するセッションのセッションタイプとホストマイグレーション時にセッションを自動的に参加締切状態にする設定を指定します。
デフォルトではセッションタイプは SessionType_Anybody、ホストマイグレーション時にセッションを自動的に参加締切状態に変更しない設定になります。
[in] | sessionType | 構築するセッションに指定するセッションタイプ。 |
[in] | isAutoCloseSession | ホストマイグレーション時にセッションを自動的に参加締切状態にする設定。 |
Result nn::pia::inet::NexCreateSessionSetting::SetSessionUserPassword | ( | const common::String & | userPassword | ) |
作成したセッションにユーザーパスワードを設定します。
[in] | userPassword | 設定するユーザーパスワード。パスワードの文字列は SessionUserPasswordLengthMax 以下である必要があります。 |
void nn::pia::inet::NexCreateSessionSetting::SetUseGeoIp | ( | bool | use | ) |
スコアベースマッチメイク指定時に、比較に位置情報 (緯度経度、国コード) を使用するかどうかを設定します。
位置情報を使うかどうかをセットしない場合は距離の比較に関するスコアがデフォルトスコアとして評価されます。
[in] | use | 位置情報を使用するかどうか |
void nn::pia::inet::NexCreateSessionSetting::SetViolationRate | ( | uint32_t | violationRate | ) |
スコアベースマッチメイク指定時に、比較に使用する違反率を設定します。
[in] | violationRate | 違反率 |