MatchmakeExtensionClient::UpdateMatchmakeSession() に関するパラメータを格納するデータクラスです。 [詳解]
#include <RendezVous/Services/Jugem/Matchmake/src/Common/UpdateMatchmakeSessionParam.h>
DDLCLASSUpdateMatchmakeSessionParamを継承しています。
公開メンバ関数 | |
UpdateMatchmakeSessionParam () | |
コンストラクタです。 [詳解] | |
virtual | ~UpdateMatchmakeSessionParam () |
デストラクタです。 | |
void | GetApplicationBuffer (qVector< qUnsignedInt8 > *pApplicationBuffer) const |
アプリケーション定義のデータを取得します。 [詳解] | |
void | GetAttribute (qUnsignedInt32 attributes_[NUM_MATCHMAKE_SESSION_ATTRIBUTES]) const |
属性を取得します。 [詳解] | |
const String & | GetCodeword () const |
あいことばを取得します。 [詳解] | |
const String & | GetDescription () const |
説明文字列を取得します。 [詳解] | |
qUnsignedInt32 | GetGameMode () const |
ゲームモードを取得します。 [詳解] | |
const MatchmakeParam & | GetMatchmakeParam () const |
マッチメイクパラメータを取得します。 [詳解] | |
MatchmakeSystemType | GetMatchmakeSystemType () const |
マッチメイクシステムタイプを取得します。 [詳解] | |
qUnsignedInt16 | GetMaxParticipants () const |
最大参加人数を取得します [詳解] | |
qUnsignedInt16 | GetMinParticipants () const |
最小参加人数を取得します [詳解] | |
qUnsignedInt32 | GetModificationFlag () const |
変更フラグを取得します。 [詳解] | |
qBool | GetOpenParticipation () const |
マッチメイクセッションへ参加可能かどうかを取得します。 [詳解] | |
qUnsignedInt8 | GetProgressScore () const |
ゲーム進行度を取得します。 [詳解] | |
const DateTime & | GetStartedTime () const |
マッチメイク開始日時を取得します。 [詳解] | |
GatheringID | GetTargetGatheringId () const |
変更する対象のギャザリング ID を取得します。 [詳解] | |
const String & | GetUserPassword () const |
マッチメイクセッションユーザーパスワードを取得します。 [詳解] | |
void | Reset () |
オブジェクトをデフォルトコンストラクタで生成した状態に初期化します。 | |
void | SetApplicationBuffer (const qVector< qUnsignedInt8 > &applicationBuffer_) |
アプリケーション定義のデータを設定します。 [詳解] | |
void | SetAttribute (const qUnsignedInt32 attributes_[NUM_MATCHMAKE_SESSION_ATTRIBUTES]) |
属性を設定します。 [詳解] | |
qBool | SetCodeword (const String &codeword_) |
あいことばを設定します。 [詳解] | |
void | SetDescription (const String &description_) |
説明文字列をセットします。 [詳解] | |
void | SetGameMode (qUnsignedInt32 gameMode_) |
ゲームモードをセットします。 [詳解] | |
void | SetMatchmakeParam (const MatchmakeParam &matchmakeParam_) |
マッチメイクパラメータを設定します。 [詳解] | |
void | SetMatchmakeSystemType (MatchmakeSystemType matchmakeSystemType_, qUnsignedInt32 policyArgument_=0) |
マッチメイクシステムタイプをセットします。 [詳解] | |
void | SetMaxParticipants (qUnsignedInt16 maxParticipants_) |
最大参加人数をセットします。 [詳解] | |
void | SetMinParticipants (qUnsignedInt16 minParticipants_) |
最小参加人数をセットします。 [詳解] | |
void | SetModificationFlag (qUnsignedInt32 modificationFlag_) |
変更する箇所を表すフラグを設定します。 [詳解] | |
void | SetOpenParticipation (qBool openParticipation_) |
マッチメイクセッションへ参加可能かどうかを設定します。 [詳解] | |
qBool | SetProgressScore (qUnsignedInt8 progressScore_) |
ゲーム進行度をセットします。 [詳解] | |
void | SetStartedTime (const DateTime &startedTime_=DateTime::Future) |
マッチメイク開始日時をセットします。 [詳解] | |
void | SetTargetGatheringId (GatheringID gid_) |
変更する対象のギャザリング ID を設定します。本パラメータは必ず指定する必要があります。 [詳解] | |
void | SetUserPassword (const String &userPassword_) |
マッチメイクセッションユーザーパスワードを設定します。 [詳解] | |
void | Trace (qUnsignedInt64 uiTraceFlags=TRACE_ALWAYS) const |
UpdateMatchmakeSessionParam オブジェクトの内容をトレースします。 [詳解] | |
MatchmakeExtensionClient::UpdateMatchmakeSession() に関するパラメータを格納するデータクラスです。
nn::nex::UpdateMatchmakeSessionParam::UpdateMatchmakeSessionParam | ( | ) |
コンストラクタです。
コンストラクタです。
void nn::nex::UpdateMatchmakeSessionParam::SetTargetGatheringId | ( | GatheringID | gid_ | ) |
変更する対象のギャザリング ID を設定します。本パラメータは必ず指定する必要があります。
初期状態は INVALID_GATHERINGID です。
[in] | gid_ | 変更する対象のギャザリング ID。 |
GatheringID nn::nex::UpdateMatchmakeSessionParam::GetTargetGatheringId | ( | ) | const |
変更する対象のギャザリング ID を取得します。
void nn::nex::UpdateMatchmakeSessionParam::SetModificationFlag | ( | qUnsignedInt32 | modificationFlag_ | ) |
変更する箇所を表すフラグを設定します。
変更する箇所を表すフラグを指定します。本パラメータは必ず指定する必要があります。 MatchmakeSessionModificationFlag に対してビット単位の論理和を用いて複数指定することができます。
[in] | modificationFlag_ | 変更する箇所を表すビットフラグ。 MatchmakeSessionModificationFlag に対するビット単位の論理和です。 |
qUnsignedInt32 nn::nex::UpdateMatchmakeSessionParam::GetModificationFlag | ( | ) | const |
変更フラグを取得します。
void nn::nex::UpdateMatchmakeSessionParam::SetAttribute | ( | const qUnsignedInt32 | attributes_[NUM_MATCHMAKE_SESSION_ATTRIBUTES] | ) |
属性を設定します。
全ての属性を設定します。
[in] | attributes_ | 変更後の属性値の配列。 |
void nn::nex::UpdateMatchmakeSessionParam::GetAttribute | ( | qUnsignedInt32 | attributes_[NUM_MATCHMAKE_SESSION_ATTRIBUTES] | ) | const |
属性を取得します。
[out] | attributes_ | 変更後の属性値の配列。 |
void nn::nex::UpdateMatchmakeSessionParam::SetOpenParticipation | ( | qBool | openParticipation_ | ) |
マッチメイクセッションへ参加可能かどうかを設定します。
このマッチメイクセッションへ参加可能であるかを設定します。
[in] | openParticipation_ | 変更後のマッチメイクセッションへ参加可能かどうかの状態。 |
qBool nn::nex::UpdateMatchmakeSessionParam::GetOpenParticipation | ( | ) | const |
マッチメイクセッションへ参加可能かどうかを取得します。
void nn::nex::UpdateMatchmakeSessionParam::SetApplicationBuffer | ( | const qVector< qUnsignedInt8 > & | applicationBuffer_ | ) |
アプリケーション定義のデータを設定します。
アプリケーション定義のデータを設定します。最大 MATCHMAKE_BUFFER_MAX_LENGTH byteです。
[in] | applicationBuffer_ | 変更後のアプリケーション定義のデータ。 |
void nn::nex::UpdateMatchmakeSessionParam::GetApplicationBuffer | ( | qVector< qUnsignedInt8 > * | pApplicationBuffer | ) | const |
アプリケーション定義のデータを取得します。
[out] | pApplicationBuffer | 変更後のアプリケーション定義のデータへのポインタ。 |
qBool nn::nex::UpdateMatchmakeSessionParam::SetProgressScore | ( | qUnsignedInt8 | progressScore_ | ) |
ゲーム進行度をセットします。
ゲーム進行度をセットします。
[in] | progressScore_ | 変更後のアプリケーション定義のゲーム進行度。0 以上 MAX_PROGRESS_SCORE 以下の値を指定できます。 |
qUnsignedInt8 nn::nex::UpdateMatchmakeSessionParam::GetProgressScore | ( | ) | const |
ゲーム進行度を取得します。
void nn::nex::UpdateMatchmakeSessionParam::SetMatchmakeParam | ( | const MatchmakeParam & | matchmakeParam_ | ) |
マッチメイクパラメータを設定します。
マッチメイクパラメータを設定します。
[in] | matchmakeParam_ | 変更後のマッチメイクパラメータ。 |
const MatchmakeParam& nn::nex::UpdateMatchmakeSessionParam::GetMatchmakeParam | ( | ) | const |
マッチメイクパラメータを取得します。
void nn::nex::UpdateMatchmakeSessionParam::SetUserPassword | ( | const String & | userPassword_ | ) |
マッチメイクセッションユーザーパスワードを設定します。
マッチメイクセッションユーザーパスワードを設定します。 マッチメイクセッションユーザーパスワードは最大 MAX_MATCHMAKE_SESSION_USER_PASSWORD_LENGTH 文字までセットできます。
[in] | userPassword_ | 変更後のマッチメイクセッションユーザーパスワード。 |
const String& nn::nex::UpdateMatchmakeSessionParam::GetUserPassword | ( | ) | const |
マッチメイクセッションユーザーパスワードを取得します。
void nn::nex::UpdateMatchmakeSessionParam::SetStartedTime | ( | const DateTime & | startedTime_ = DateTime::Future | ) |
マッチメイク開始日時をセットします。
マッチメイクを開始した日時をセットします。 現在時刻より未来の日時が設定された場合は、現在時刻がサーバーでセットされます。
[in] | startedTime_ | 変更後のマッチメイク開始日時。デフォルトは9999/12/31 23:59:59。 |
const DateTime& nn::nex::UpdateMatchmakeSessionParam::GetStartedTime | ( | ) | const |
マッチメイク開始日時を取得します。
void nn::nex::UpdateMatchmakeSessionParam::SetGameMode | ( | qUnsignedInt32 | gameMode_ | ) |
ゲームモードをセットします。
ゲームモードをセットします。
[in] | gameMode_ | 変更後のゲームモード。 |
qUnsignedInt32 nn::nex::UpdateMatchmakeSessionParam::GetGameMode | ( | ) | const |
ゲームモードを取得します。
void nn::nex::UpdateMatchmakeSessionParam::SetDescription | ( | const String & | description_ | ) |
説明文字列をセットします。
説明文字列をセットします。アプリケーションが任意の値を設定できます(最大 MATCHMAKE_STRING_MAX_LENGTH 文字)。
[in] | description_ | 変更後の説明文字列。 |
const String& nn::nex::UpdateMatchmakeSessionParam::GetDescription | ( | ) | const |
説明文字列を取得します。
説明文字列を取得します。
void nn::nex::UpdateMatchmakeSessionParam::SetMinParticipants | ( | qUnsignedInt16 | minParticipants_ | ) |
最小参加人数をセットします。
最小参加人数をセットします。現在、本関数でセットした値はマッチメイクに影響を与えません。
[in] | minParticipants_ | 変更後の最小参加人数。 |
qUnsignedInt16 nn::nex::UpdateMatchmakeSessionParam::GetMinParticipants | ( | ) | const |
最小参加人数を取得します
void nn::nex::UpdateMatchmakeSessionParam::SetMaxParticipants | ( | qUnsignedInt16 | maxParticipants_ | ) |
最大参加人数をセットします。
この人数を越えてギャザリングに参加することはできません。 0 を指定した場合は最大参加人数が無制限になります。 現在の参加人数未満の値を指定する事もできます。この場合は既存の参加者が退出させられることはありませんが、 現在の参加人数が最大参加人数を下回るまでそのマッチメイクセッションに参加することはできません。
[in] | maxParticipants_ | 変更後の最大参加人数。 |
qUnsignedInt16 nn::nex::UpdateMatchmakeSessionParam::GetMaxParticipants | ( | ) | const |
最大参加人数を取得します
void nn::nex::UpdateMatchmakeSessionParam::SetMatchmakeSystemType | ( | MatchmakeSystemType | matchmakeSystemType_, |
qUnsignedInt32 | policyArgument_ = 0 |
||
) |
マッチメイクシステムタイプをセットします。
MATCHMAKE_SYSTEM_TYPE_ANYBODY と MATCHMAKE_SYSTEM_TYPE_FRIEND との間の変更のみ行えます。 マッチメイクシステムタイプは変更せず、ポリシー引数のみを変更することもできます。 MATCHMAKE_SYSTEM_TYPE_ANYBODY もしくは MATCHMAKE_SYSTEM_TYPE_FRIEND 以外への変更や、 MATCHMAKE_SYSTEM_TYPE_ANYBODY もしくは MATCHMAKE_SYSTEM_TYPE_FRIEND 以外からの変更はエラーになります。
[in] | matchmakeSystemType_ | 変更後のマッチメイクシステムタイプ。 |
[in] | policyArgument_ | 変更後のポリシー引数(デフォルト値 0) |
MatchmakeSystemType nn::nex::UpdateMatchmakeSessionParam::GetMatchmakeSystemType | ( | ) | const |
マッチメイクシステムタイプを取得します。
あいことばを設定します。
空文字列をセットすることにより、あいことばを利用しない設定にすることができます。
[in] | codeword_ | あいことばの文字列 |
true 成功。あいことばとして使用できる文字列もしくは空文字列です
false 失敗。あいことばとして使用できない文字が含まれています
const String& nn::nex::UpdateMatchmakeSessionParam::GetCodeword | ( | ) | const |
あいことばを取得します。
void nn::nex::UpdateMatchmakeSessionParam::Trace | ( | qUnsignedInt64 | uiTraceFlags = TRACE_ALWAYS | ) | const |
UpdateMatchmakeSessionParam オブジェクトの内容をトレースします。
[in] | uiTraceFlags | TraceLog::SetFlag() の引数と同様です。 |