永続ギャザリングの情報を格納するクラスです。 [詳解]
#include <RendezVous/Services/Jugem/Matchmake/src/Common/PersistentGathering.h>
公開メンバ関数 | |
PersistentGathering () | |
コンストラクタです。 [詳解] | |
virtual | ~PersistentGathering () |
デストラクタです。 | |
void | ClearFlag (qUnsignedInt32 uiFlag) |
ギャザリングフラグをクリアします [詳解] | |
qBool | FlagIsSet (qUnsignedInt32 uiFlag) const |
ギャザリングフラグがセットされているかを確認します [詳解] | |
const qVector< qByte > & | GetApplicationBuffer () const |
アプリケーション定義のデータを取得します。 [詳解] | |
qUnsignedInt32 | GetAttribute (qUnsignedInt32 uiIndex) const |
属性を取得します。 [詳解] | |
const String & | GetDescription () 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 DateTime & | GetParticipationEndDate () const |
この永続ギャザリングへの参加締め切り日を取得します。 [詳解] | |
const DateTime & | GetParticipationStartDate () const |
この永続ギャザリングに参加可能となる日時を取得します。 [詳解] | |
const String & | GetPassword () 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以下の値を指定できます。 |
アプリケーション定義のデータをセットします。
このマッチメイクセッションにアプリケーション定義のデータをセットします。最大512byteです。
[in] | buffer | アプリケーション定義のデータ。 |
アプリケーション定義のデータを取得します。
このマッチメイクセッションにセットされたアプリケーション定義のデータを取得します。
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 |
この永続ギャザリングに関連する永続ギャザリングマッチの数を取得します。
qUnsignedInt32 nn::nex::PersistentGathering::GetParticipationCount | ( | ) | const |
この永続ギャザリングへの参加人数を取得します
|
inherited |
ギャザリングの ID を取得します。
|
inherited |
ギャザリングの ID を設定します。
MatchmakeExtensionClient::AutoMatchmake() や MatchmakeExtensionClient::CreateMatchmakeSession() などでギャザリングを 登録する際は必ず INVALID_GATHERINGID を指定してください また、 MatchmakeExtensionClient::UpdateMatchmakeSession() を使用する際、 本関数を用いて更新するマッチメイクセッションのギャザリングIDを指定してください。
[in] | id | ギャザリングの ID |
|
virtualinherited |
自分のクラス名を返します
引数で与えられたクラス名のオブジェクトであるかを判定します。
[in] | strClass | クラス名 |
true 引数で与えられたクラス名のクラスオブジェクトである
false 引数で与えられたクラス名のクラスオブジェクトではない
引数で与えられたクラス名のクラスか、それを継承したオブジェクトかを判定します。
[in] | strClass | クラス名 |
true 引数で与えられたクラス名のクラスまたはそれを継承したオブジェクトである
false 引数で与えられたクラス名のクラスまたはそれを継承したオブジェクトではない
|
inherited |
説明文字列をセットします。
ギャザリングの説明文字列をセットします。アプリケーションが任意の値を設定できます(最大 MATCHMAKE_STRING_MAX_LENGTH 文字)。
[in] | strDescription | 説明文字列 |
|
inherited |
説明文字列を取得します。
ギャザリングの説明文字列を取得します。
|
inherited |
ギャザリングのオーナーの PrincipalID を取得します。
ギャザリングのオーナーの PrincipalID を取得します。オーナーはギャザリングを変更できる唯一のユーザーで、 マッチメイクの募集状態の変更や、ギャザリングの削除などを行うことができます。
初期状態では、ギャザリングの登録ユーザーがオーナーとなりますが、MatchMakingClient::MigrateGatheringOwnership() を 実行するか、GatheringFlag に MigrateOwner をセットした状態でオーナーが退出することでオーナーを変更することができます。
|
inherited |
ギャザリングのホストの プリンシパルID を取得します。
ホストは P2P セッションの管理者で、 ギャザリングの状態を変更したりすることはできません。他のユーザーが P2P セッションに参加する場合、 ホストの URL をサーバーから取得する必要があります。
|
inherited |
ギャザリングの最小参加人数を取得します
|
inherited |
ギャザリングの最大参加人数を取得します
|
inherited |
ギャザリングの最小参加人数をセットします
ギャザリングの最小参加人数をセットします。現在、本関数でセットした値はマッチメイクに影響を与えません。
[in] | uiMinParticipants | ギャザリングの最小参加人数 |
|
inherited |
ギャザリングの最大参加人数をセットします
この人数を越えてギャザリングに参加することはできません。 0 を指定した場合は最大参加人数が無制限になります。 MatchmakeExtensionClient::UpdateMatchmakeSession() や MatchmakeExtensionClient::UpdatePersistentGathering() で最大参加人数を更新する場合、 現在の参加人数未満の値を指定する事もできます。この場合は既存の参加者が退出させられることはありませんが、 現在の参加人数が最大参加人数を下回るまでそのギャザリングに参加することはできません。
[in] | uiMaxParticipants | ギャザリングの最大参加人数 |
|
inherited |
ギャザリングフラグがセットされているかを確認します
指定されたギャザリングフラグがセットされているかを確認します。
[in] | uiFlag | セットされているかどうか確認するギャザリングフラグ |
|
inherited |
|
inherited |