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

永続ギャザリングの情報を格納するクラスです。 [詳解]

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

+ nn::nex::PersistentGathering の継承関係図

公開メンバ関数

 PersistentGathering ()
 コンストラクタです。 [詳解]
 
virtual ~PersistentGathering ()
 デストラクタです。
 
void ClearFlag (qUnsignedInt32 uiFlag)
 ギャザリングフラグをクリアします [詳解]
 
qBool FlagIsSet (qUnsignedInt32 uiFlag) const
 ギャザリングフラグがセットされているかを確認します [詳解]
 
const qVector< qByte > & GetApplicationBuffer () const
 アプリケーション定義のデータを取得します。 [詳解]
 
qUnsignedInt32 GetAttribute (qUnsignedInt32 uiIndex) const
 属性を取得します。 [詳解]
 
const StringGetDescription () const
 説明文字列を取得します。 [詳解]
 
virtual String GetGatheringType () const
 自分のクラス名を返します [詳解]
 
PrincipalID GetHostPID () const
 ギャザリングのホストの プリンシパルID を取得します。 [詳解]
 
GatheringID GetID () const
 ギャザリングの ID を取得します。 [詳解]
 
qUnsignedInt32 GetMatchmakeSessionCount () const
 この永続ギャザリングに関連する永続ギャザリングマッチの数を取得します。 [詳解]
 
qUnsignedInt16 GetMaxParticipants () const
 ギャザリングの最大参加人数を取得します [詳解]
 
qUnsignedInt16 GetMinParticipants () const
 ギャザリングの最小参加人数を取得します [詳解]
 
PrincipalID GetOwnerPID () const
 ギャザリングのオーナーの PrincipalID を取得します。 [詳解]
 
qUnsignedInt32 GetParticipationCount () const
 この永続ギャザリングへの参加人数を取得します [詳解]
 
const DateTimeGetParticipationEndDate () const
 この永続ギャザリングへの参加締め切り日を取得します。 [詳解]
 
const DateTimeGetParticipationStartDate () const
 この永続ギャザリングに参加可能となる日時を取得します。 [詳解]
 
const StringGetPassword () const
 永続ギャザリング参加時のパスワードを取得します。 [詳解]
 
PersistentGatheringType::PersistentGatheringType GetPersistentGatheringType () const
 永続ギャザリングタイプを取得します。 [詳解]
 
virtual qBool IsA (const String &strClass) const
 引数で与えられたクラス名のオブジェクトであるかを判定します。 [詳解]
 
virtual qBool IsAKindOf (const String &strClass) const
 引数で与えられたクラス名のクラスか、それを継承したオブジェクトかを判定します。 [詳解]
 
void Reset ()
 セットしたデータを初期化します。 [詳解]
 
void SetApplicationBuffer (qVector< qByte > buffer)
 アプリケーション定義のデータをセットします。 [詳解]
 
void SetAttribute (qUnsignedInt32 uiIndex, qUnsignedInt32 val)
 属性をセットします。 [詳解]
 
void SetDescription (const String &strDescription)
 説明文字列をセットします。 [詳解]
 
void SetFlag (qUnsignedInt32 uiFlag)
 GatheringFlags で列挙されているギャザリングフラグをセットします [詳解]
 
GatheringID SetID (GatheringID id)
 ギャザリングの ID を設定します。 [詳解]
 
void SetMaxParticipants (qUnsignedInt16 uiMaxParticipants)
 ギャザリングの最大参加人数をセットします [詳解]
 
void SetMinParticipants (qUnsignedInt16 uiMinParticipants)
 ギャザリングの最小参加人数をセットします [詳解]
 
void SetParticipationEndDate (const DateTime &date)
 この永続ギャザリングへの参加締め切り日を設定します。 [詳解]
 
void SetParticipationStartDate (const DateTime &date)
 この永続ギャザリングに参加可能となる日時を設定します。 [詳解]
 
void SetPassword (const String &password)
 永続ギャザリング参加時のパスワードをセットします。 [詳解]
 
void SetPersistentGatheringType (PersistentGatheringType::PersistentGatheringType type)
 永続ギャザリングタイプをセットします。 [詳解]
 

詳解

永続ギャザリングの情報を格納するクラスです。

構築子と解体子

nn::nex::PersistentGathering::PersistentGathering ( )

コンストラクタです。

初期状態は永続ギャザリングタイプはOpen、属性は全て 0 となります。

関数詳解

void nn::nex::PersistentGathering::Reset ( )

セットしたデータを初期化します。

永続ギャザリングタイプはOpen、属性は全て 0 となります。

void nn::nex::PersistentGathering::SetPersistentGatheringType ( PersistentGatheringType::PersistentGatheringType  type)

永続ギャザリングタイプをセットします。

引数
[in]type永続ギャザリングタイプ
PersistentGatheringType::PersistentGatheringType nn::nex::PersistentGathering::GetPersistentGatheringType ( ) const

永続ギャザリングタイプを取得します。

戻り値
永続ギャザリングタイプ
void nn::nex::PersistentGathering::SetPassword ( const String password)

永続ギャザリング参加時のパスワードをセットします。

パスワードは永続ギャザリングタイプが PasswordLocked の場合にのみ有効です。

引数
[in]password永続ギャザリング参加時のパスワード
const String& nn::nex::PersistentGathering::GetPassword ( ) const

永続ギャザリング参加時のパスワードを取得します。

ゲームサーバから永続ギャザリングを取得したときにはパスワードはセットされません。

戻り値
永続ギャザリング参加時のパスワード
void nn::nex::PersistentGathering::SetAttribute ( qUnsignedInt32  uiIndex,
qUnsignedInt32  val 
)

属性をセットします。

このマッチメイクセッションの属性をセットします。最大6つ指定できます。

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

属性を取得します。

このマッチメイクセッションにセットされた属性を取得します。

引数
[in]uiIndex取得する属性のインデックス。0以上NUM_MATCHMAKE_SESSION_ATTRIBUTES - 1以下の値を指定できます。
戻り値
指定されたインデックスの属性値。
void nn::nex::PersistentGathering::SetApplicationBuffer ( qVector< qByte buffer)

アプリケーション定義のデータをセットします。

このマッチメイクセッションにアプリケーション定義のデータをセットします。最大512byteです。

引数
[in]bufferアプリケーション定義のデータ。
const qVector<qByte>& nn::nex::PersistentGathering::GetApplicationBuffer ( ) const

アプリケーション定義のデータを取得します。

このマッチメイクセッションにセットされたアプリケーション定義のデータを取得します。

戻り値
アプリケーション定義のデータの参照
void nn::nex::PersistentGathering::SetParticipationStartDate ( const DateTime date)

この永続ギャザリングに参加可能となる日時を設定します。

この日時より前に MatchmakeExtensionClient::JoinPersistentGathering() を実行しても参加することはできません。 DateTime::Never を設定すると、参加可能日時の条件は無視されます。 日時は UTC 時刻で入力してください。

引数
[in]date永続ギャザリングに参加可能となる日時
const DateTime& nn::nex::PersistentGathering::GetParticipationStartDate ( ) const

この永続ギャザリングに参加可能となる日時を取得します。

戻り値
永続ギャザリングに参加可能となる日時
void nn::nex::PersistentGathering::SetParticipationEndDate ( const DateTime date)

この永続ギャザリングへの参加締め切り日を設定します。

この日時より後に MatchmakeExtensionClient::JoinPersistentGathering() を実行しても参加することはできません。 DateTime::Never を設定すると、参加締め切り日の条件は無視されます。 日時は UTC 時刻で入力してください。

引数
[in]date永続ギャザリングへの参加締め切る日時
const DateTime& nn::nex::PersistentGathering::GetParticipationEndDate ( ) const

この永続ギャザリングへの参加締め切り日を取得します。

戻り値
永続ギャザリングへの参加を締め切る日時
qUnsignedInt32 nn::nex::PersistentGathering::GetMatchmakeSessionCount ( ) const

この永続ギャザリングに関連する永続ギャザリングマッチの数を取得します。

戻り値
この永続ギャザリングに関連する永続ギャザリングマッチの数
参照
MatchmakeSession::SetReferPersistentGatheringId()
qUnsignedInt32 nn::nex::PersistentGathering::GetParticipationCount ( ) const

この永続ギャザリングへの参加人数を取得します

戻り値
この永続ギャザリングへの参加人数
GatheringID nn::nex::Gathering::GetID ( ) const
inherited

ギャザリングの ID を取得します。

戻り値
ギャザリングの ID
GatheringID nn::nex::Gathering::SetID ( GatheringID  id)
inherited

ギャザリングの ID を設定します。

MatchmakeExtensionClient::AutoMatchmake()MatchmakeExtensionClient::CreateMatchmakeSession() などでギャザリングを 登録する際は必ず INVALID_GATHERINGID を指定してください また、 MatchmakeExtensionClient::UpdateMatchmakeSession() を使用する際、 本関数を用いて更新するマッチメイクセッションのギャザリングIDを指定してください。

引数
[in]idギャザリングの ID
戻り値
設定された後のギャザリング ID
virtual String nn::nex::Gathering::GetGatheringType ( ) const
virtualinherited

自分のクラス名を返します

戻り値
自分のクラス名
virtual qBool nn::nex::Gathering::IsA ( const String strClass) const
virtualinherited

引数で与えられたクラス名のオブジェクトであるかを判定します。

注釈
true を返す場合、そのクラスへキャストすることが可能です。
引数
[in]strClassクラス名


戻り値一覧:

true 引数で与えられたクラス名のクラスオブジェクトである

false 引数で与えられたクラス名のクラスオブジェクトではない

virtual qBool nn::nex::Gathering::IsAKindOf ( const String strClass) const
virtualinherited

引数で与えられたクラス名のクラスか、それを継承したオブジェクトかを判定します。

注釈
true を返す場合、そのクラスへキャストすることが可能です。
引数
[in]strClassクラス名


戻り値一覧:

true 引数で与えられたクラス名のクラスまたはそれを継承したオブジェクトである

false 引数で与えられたクラス名のクラスまたはそれを継承したオブジェクトではない

void nn::nex::Gathering::SetDescription ( const String strDescription)
inherited

説明文字列をセットします。

ギャザリングの説明文字列をセットします。アプリケーションが任意の値を設定できます(最大 MATCHMAKE_STRING_MAX_LENGTH 文字)。

引数
[in]strDescription説明文字列
const String& nn::nex::Gathering::GetDescription ( ) const
inherited

説明文字列を取得します。

ギャザリングの説明文字列を取得します。

戻り値
ギャザリングの説明文字列
PrincipalID nn::nex::Gathering::GetOwnerPID ( ) const
inherited

ギャザリングのオーナーの PrincipalID を取得します。

ギャザリングのオーナーの PrincipalID を取得します。オーナーはギャザリングを変更できる唯一のユーザーで、 マッチメイクの募集状態の変更や、ギャザリングの削除などを行うことができます。

初期状態では、ギャザリングの登録ユーザーがオーナーとなりますが、MatchMakingClient::MigrateGatheringOwnership() を 実行するか、GatheringFlag に MigrateOwner をセットした状態でオーナーが退出することでオーナーを変更することができます。

戻り値
ギャザリングのオーナーの PrincipalID
参照
MatchMakingClient::MigrateGatheringOwnership()
PrincipalID nn::nex::Gathering::GetHostPID ( ) const
inherited

ギャザリングのホストの プリンシパルID を取得します。

ホストは P2P セッションの管理者で、 ギャザリングの状態を変更したりすることはできません。他のユーザーが P2P セッションに参加する場合、 ホストの URL をサーバーから取得する必要があります。

戻り値
ギャザリングのホストの プリンシパルID
参照
MatchMakingClient::UpdateSessionHost()
qUnsignedInt16 nn::nex::Gathering::GetMinParticipants ( ) const
inherited

ギャザリングの最小参加人数を取得します

戻り値
ギャザリングの最小参加人数
qUnsignedInt16 nn::nex::Gathering::GetMaxParticipants ( ) const
inherited

ギャザリングの最大参加人数を取得します

戻り値
ギャザリングの最大参加人数
void nn::nex::Gathering::SetMinParticipants ( qUnsignedInt16  uiMinParticipants)
inherited

ギャザリングの最小参加人数をセットします

ギャザリングの最小参加人数をセットします。現在、本関数でセットした値はマッチメイクに影響を与えません。

引数
[in]uiMinParticipantsギャザリングの最小参加人数
void nn::nex::Gathering::SetMaxParticipants ( qUnsignedInt16  uiMaxParticipants)
inherited

ギャザリングの最大参加人数をセットします

この人数を越えてギャザリングに参加することはできません。 0 を指定した場合は最大参加人数が無制限になります。 MatchmakeExtensionClient::UpdateMatchmakeSession()MatchmakeExtensionClient::UpdatePersistentGathering() で最大参加人数を更新する場合、 現在の参加人数未満の値を指定する事もできます。この場合は既存の参加者が退出させられることはありませんが、 現在の参加人数が最大参加人数を下回るまでそのギャザリングに参加することはできません。

引数
[in]uiMaxParticipantsギャザリングの最大参加人数
qBool nn::nex::Gathering::FlagIsSet ( qUnsignedInt32  uiFlag) const
inherited

ギャザリングフラグがセットされているかを確認します

指定されたギャザリングフラグがセットされているかを確認します。

引数
[in]uiFlagセットされているかどうか確認するギャザリングフラグ
戻り値
フラグがセットされているかどうか
参照
GatheringFlags
void nn::nex::Gathering::SetFlag ( qUnsignedInt32  uiFlag)
inherited

GatheringFlags で列挙されているギャザリングフラグをセットします

指定された ギャザリングフラグをセットします。

引数
[in]uiFlagセットするギャザリングフラグ
参照
GatheringFlags
void nn::nex::Gathering::ClearFlag ( qUnsignedInt32  uiFlag)
inherited

ギャザリングフラグをクリアします

指定されたギャザリングフラグをクリアします。

引数
[in]uiFlagクリアするギャザリングフラグ
参照
GatheringFlags