Methods summary
public
|
#
__construct( string $region, GS2\Core\Gs2Credentials $credentials, array $options = [] )
コンストラクタ
Parameters
- $region
- リージョン名
- $credentials
- 認証情報
- $options
- オプション
|
public
array
|
#
describeMatchmaking( string $pageToken = NULL, integer $limit = NULL )
マッチメイキングリストを取得
Parameters
- $pageToken
- ページトークン
- $limit
- 取得件数
Returns
array
- items
- array
- matchmakingId => マッチメイキングID
- ownerId => オーナーID
- name => マッチメイキング名
- description => 説明文
- type => 種類
- maxPlayer => 最大プレイヤー数
- serviceClass => サービスクラス
- callback => コールバックURL
- createAt => 作成日時
- updateAt => 更新日時
- nextPageToken => 次ページトークン
|
public
array
|
|
public
array
|
#
createMatchmaking( array $request )
マッチメイキングを作成
GS2-Matchmaking を利用するためにまず作成するデータモデルです。
マッチメイキングの設定項目として、マッチメイキングの方式や最大プレイヤー数を設定します。
マッチメイキングを作成
GS2-Matchmaking を利用するためにまず作成するデータモデルです。
マッチメイキングの設定項目として、マッチメイキングの方式や最大プレイヤー数を設定します。
Parameters
- $request
- name => マッチメイキング名
- description => 説明文
- serviceClass => サービスクラス
- type => 種類
- maxPlayer => 最大プレイヤー数
- callback => コールバックURL
Returns
array
- item
- matchmakingId => マッチメイキングID
- ownerId => オーナーID
- name => マッチメイキング名
- description => 説明文
- type => 種類
- maxPlayer => 最大プレイヤー数
- serviceClass => サービスクラス
- callback => コールバックURL
- createAt => 作成日時
- updateAt => 更新日時
|
public
array
|
#
getMatchmaking( array $request )
マッチメイキングを取得
Parameters
- $request
- matchmakingName => マッチメイキング名
Returns
array
- item
- matchmakingId => マッチメイキングID
- ownerId => オーナーID
- name => マッチメイキング名
- description => 説明文
- type => 種類
- maxPlayer => 最大プレイヤー数
- serviceClass => サービスクラス
- callback => コールバックURL
- createAt => 作成日時
- updateAt => 更新日時
|
public
array
|
#
getMatchmakingStatus( array $request )
マッチメイキングの状態を取得
Parameters
- $request
- matchmakingName => マッチメイキング名
Returns
|
public
array
|
#
updateMatchmaking( array $request )
マッチメイキングを更新
Parameters
- $request
- matchmakingName => マッチメイキング名
- description => 説明文
- serviceClass => サービスクラス
- callback => コールバックURL
Returns
array
- item
- matchmakingId => マッチメイキングID
- ownerId => オーナーID
- name => マッチメイキング名
- description => 説明文
- type => 種類
- maxPlayer => 最大プレイヤー数
- serviceClass => サービスクラス
- callback => コールバックURL
- createAt => 作成日時
- updateAt => 更新日時
|
public
|
#
deleteMatchmaking( array $request )
マッチメイキングを削除
Parameters
- $request
- matchmakingName => マッチメイキング名
|
public
array
|
#
anybodyDoMatchmaking( array $request )
Anybodyマッチメイキング - マッチメイキングを実行
Anybodyマッチメイキングのマッチメイキングプロセスは、このAPIを呼び出すことで完結します。
このAPIを呼び出した段階で参加者を待っているギャザリングが存在すれば参加し、
参加者を待っているギャザリングが存在しなければ、新しくギャザリングに作成して、そのギャザリングに参加します。
戻り値にはギャザリングに参加している人数が含まれますので、自分がギャザリングを作成したのかはそこで確認することができます。
マッチメイキング完了コールバックをが返るまで待つことでマッチメイキングの完了を待つことができます。
マッチメイキングの進捗を確認したい場合は GS2\Matchmaking\Gs2MatchmakingClient::anybodyDescribeJoinedUser() を呼び出すことで、
ギャザリングに参加しているユーザIDが取得できるため、誰とマッチメイキングが行われているか途中経過を取得できます。
ユーザ操作などにより、マッチメイキングを中断する場合は GS2\Matchmaking\Gs2MatchmakingClient::anybodyLeaveGathering() を呼び出すことで中断できます。
GS2-Matchmaking にはホストという明確な役割は存在しないため、ギャザリングを作成したユーザがマッチメイキングを中断したとしてもマッチメイキングは継続されます。
accessToken には GS2\Auth\Gs2AuthClient::login() でログインして取得したアクセストークンを指定してください。
Parameters
- $request
- matchmakingName => マッチメイキング名
- accessToken => アクセストークン
Returns
array
- item
- gatheringId => ギャザリングID
- joinPlayer => 参加プレイヤー数
- updateAt => 更新日時
|
public
array
|
|
public
|
|
public
array
|
#
customAutoDoMatchmaking( array $request )
CustomAutoマッチメイキング -
CustomAutoマッチメイキングを実行する場合は、基本的にはこのAPIを呼び出すことで完結します。
CustomAutoマッチメイキングのリクエストパラメータには、参加対象となるギャザリングの属性値の範囲を指定して行われます。
属性値は最大5個指定することができ、属性値毎に検索する最小値・最大値を指定できます。
すべての属性値が希望する範囲内に収まっているギャザリングを見つけた場合はそのギャザリングに参加します。
一定時間内にすべてのギャザリングの検索を終えることができなかった場合は、searchContext というパラメータを応答します。
この場合、searchContext を指定して このAPIを再度呼び出すことで、検索を再開することができます。
この際に指定する検索条件は以前の searchContext と同じ条件にするようにしてください。
条件が変更されたうえで、searchContext を利用した場合の動作は保証できません。
すべてのギャザリングを検索した結果、対象となるギャザリングが存在しなかった場合は、新しくギャザリングを作成し、そのギャザリングに参加します。
戻り値にはギャザリングに参加している人数が含まれますので、自分がギャザリングを作成したのかはそこで確認することができます。
マッチメイキング完了コールバックをが返るまで待つことでマッチメイキングの完了を待つことができます。
マッチメイキングの進捗を確認したい場合は GS2\Matchmaking\Gs2MatchmakingClient::customAutoDescribeJoinedUser() を呼び出すことで、
ギャザリングに参加しているユーザIDが取得できるため、誰とマッチメイキングが行われているか途中経過を取得できます。
ユーザ操作などにより、マッチメイキングを中断する場合は GS2\Matchmaking\Gs2MatchmakingClient::customAutoLeaveGathering() を呼び出すことで中断できます。
GS2-Matchmaking にはホストという明確な役割は存在しないため、ギャザリングを作成したユーザがマッチメイキングを中断したとしてもマッチメイキングは継続されます。
accessToken には GS2\Auth\Gs2AuthClient::login() でログインして取得したアクセストークンを指定してください。
CustomAutoマッチメイキング -
CustomAutoマッチメイキングを実行する場合は、基本的にはこのAPIを呼び出すことで完結します。
CustomAutoマッチメイキングのリクエストパラメータには、参加対象となるギャザリングの属性値の範囲を指定して行われます。
属性値は最大5個指定することができ、属性値毎に検索する最小値・最大値を指定できます。
すべての属性値が希望する範囲内に収まっているギャザリングを見つけた場合はそのギャザリングに参加します。
一定時間内にすべてのギャザリングの検索を終えることができなかった場合は、searchContext というパラメータを応答します。
この場合、searchContext を指定して このAPIを再度呼び出すことで、検索を再開することができます。
この際に指定する検索条件は以前の searchContext と同じ条件にするようにしてください。
条件が変更されたうえで、searchContext を利用した場合の動作は保証できません。
すべてのギャザリングを検索した結果、対象となるギャザリングが存在しなかった場合は、新しくギャザリングを作成し、そのギャザリングに参加します。
戻り値にはギャザリングに参加している人数が含まれますので、自分がギャザリングを作成したのかはそこで確認することができます。
マッチメイキング完了コールバックをが返るまで待つことでマッチメイキングの完了を待つことができます。
マッチメイキングの進捗を確認したい場合は GS2\Matchmaking\Gs2MatchmakingClient::customAutoDescribeJoinedUser() を呼び出すことで、
ギャザリングに参加しているユーザIDが取得できるため、誰とマッチメイキングが行われているか途中経過を取得できます。
ユーザ操作などにより、マッチメイキングを中断する場合は GS2\Matchmaking\Gs2MatchmakingClient::customAutoLeaveGathering() を呼び出すことで中断できます。
GS2-Matchmaking にはホストという明確な役割は存在しないため、ギャザリングを作成したユーザがマッチメイキングを中断したとしてもマッチメイキングは継続されます。
accessToken には GS2\Auth\Gs2AuthClient::login() でログインして取得したアクセストークンを指定してください。
Parameters
- $request
- matchmakingName => マッチメイキング名
- attribute1 => ギャザリング新規作成時の属性1
- attribute2 => ギャザリング新規作成時の属性2
- attribute3 => ギャザリング新規作成時の属性3
- attribute4 => ギャザリング新規作成時の属性4
- attribute5 => ギャザリング新規作成時の属性5
- searchAttribute1Min => 検索対象ギャザリング属性1の下限
- searchAttribute1Max => 検索対象ギャザリング属性1の上限
- searchAttribute2Min => 検索対象ギャザリング属性2の下限
- searchAttribute2Max => 検索対象ギャザリング属性2の上限
- searchAttribute3Min => 検索対象ギャザリング属性3の下限
- searchAttribute3Max => 検索対象ギャザリング属性3の上限
- searchAttribute4Min => 検索対象ギャザリング属性4の下限
- searchAttribute4Max => 検索対象ギャザリング属性4の上限
- searchAttribute5Min => 検索対象ギャザリング属性5の下限
- searchAttribute5Max => 検索対象ギャザリング属性5の上限
- searchContext => 検索コンテキスト
- accessToken => アクセストークン
Returns
array
- done => 検索が完了したか
- item
- gatheringId => ギャザリングID
- joinPlayer => 参加プレイヤー数
- updateAt => 更新日時
- searchContext => 検索コンテキスト
|
public
array
|
|
public
|
|
public
array
|
#
passcodeCreateGathering( array $request )
Passcodeマッチメイキング - ギャザリングを作成
Passcodeマッチメイキングの開始手段は2つに別れます。
ひとつ目は既存のギャザリングに参加すること。もう一つはこのAPIで実行できる、新しくギャザリングを作成する。という手段です。
ギャザリングを新しく作成するにあたって必要なパラメータなどはありません。
このAPIを呼び出すことでギャザリングが新しく作られ、ギャザリングには固有のパスコード(8ケタ数字)が割り当てられます。
割り当てられたパスコードは戻り値に含まれています。
パスコードの上位は乱数、下位はミリ秒単位のタイムスタンプで構成されています。
そのため、非常に短い間隔でリクエストを出した時に、乱数もあるため可能性は低くいですがパスコードが衝突する可能性があります。
その場合はパスコードを入力した時に同一パスコードを持つギャザリングのうちどのギャザリングに参加するかは不定です。
万全を期するには、ミリ秒単位でルームの作成が多数衝突する頻度でギャザリングを作成する必要がある場合は、
Anybody や CustomAuto といった方法のマッチメイキングも併用していただき、友達同士と遊びたい場合にのみ Passcode 方式を利用するよう誘導いただくのが得策です。
ギャザリング作成後は、マッチメイキング完了コールバックをが返るまで待つことでマッチメイキングの完了を待つことができます。
マッチメイキングの進捗を確認したい場合は GS2\Matchmaking\Gs2MatchmakingClient::passcodeDescribeJoinedUser() を呼び出すことで、
ギャザリングに参加しているユーザIDが取得できるため、誰とマッチメイキングが行われているか途中経過を取得できます。
ユーザ操作などにより、マッチメイキングを中断する場合は GS2\Matchmaking\Gs2MatchmakingClient::passcodeLeaveGathering() を呼び出すことで中断できます。
GS2-Matchmaking にはホストという明確な役割は存在しないため、ギャザリングを作成したユーザがマッチメイキングを中断したとしてもマッチメイキングは継続されます。
accessToken には GS2\Auth\Gs2AuthClient::login() でログインして取得したアクセストークンを指定してください。
Passcodeマッチメイキング - ギャザリングを作成
Passcodeマッチメイキングの開始手段は2つに別れます。
ひとつ目は既存のギャザリングに参加すること。もう一つはこのAPIで実行できる、新しくギャザリングを作成する。という手段です。
ギャザリングを新しく作成するにあたって必要なパラメータなどはありません。
このAPIを呼び出すことでギャザリングが新しく作られ、ギャザリングには固有のパスコード(8ケタ数字)が割り当てられます。
割り当てられたパスコードは戻り値に含まれています。
パスコードの上位は乱数、下位はミリ秒単位のタイムスタンプで構成されています。
そのため、非常に短い間隔でリクエストを出した時に、乱数もあるため可能性は低くいですがパスコードが衝突する可能性があります。
その場合はパスコードを入力した時に同一パスコードを持つギャザリングのうちどのギャザリングに参加するかは不定です。
万全を期するには、ミリ秒単位でルームの作成が多数衝突する頻度でギャザリングを作成する必要がある場合は、
Anybody や CustomAuto といった方法のマッチメイキングも併用していただき、友達同士と遊びたい場合にのみ Passcode 方式を利用するよう誘導いただくのが得策です。
ギャザリング作成後は、マッチメイキング完了コールバックをが返るまで待つことでマッチメイキングの完了を待つことができます。
マッチメイキングの進捗を確認したい場合は GS2\Matchmaking\Gs2MatchmakingClient::passcodeDescribeJoinedUser() を呼び出すことで、
ギャザリングに参加しているユーザIDが取得できるため、誰とマッチメイキングが行われているか途中経過を取得できます。
ユーザ操作などにより、マッチメイキングを中断する場合は GS2\Matchmaking\Gs2MatchmakingClient::passcodeLeaveGathering() を呼び出すことで中断できます。
GS2-Matchmaking にはホストという明確な役割は存在しないため、ギャザリングを作成したユーザがマッチメイキングを中断したとしてもマッチメイキングは継続されます。
accessToken には GS2\Auth\Gs2AuthClient::login() でログインして取得したアクセストークンを指定してください。
Parameters
- $request
- matchmakingName => マッチメイキング名
- accessToken => アクセストークン
Returns
array
- item
- gatheringId => ギャザリングID
- joinPlayer => 参加プレイヤー数
- passcode => ギャザリング参加用パスコード
- updateAt => 更新日時
|
public
array
|
|
public
array
|
|
public
|
|
public
array
|
|
public
array
|
|
public
array
|
|
public
array
|
|
public
|
|