GS2-Matchmaking

ギャザリング新規作成時

ギャザリング新規作成時に呼び出されます。 このイベントが発生した瞬間にはまだギャザリングの作成は実行されておらず、スクリプトの結果として「作成を許可しない」というレスポンスを返すことが出来ます。 また、このスクリプトをレスポンスした後、何らかのエラーが発生した場合には、ギャザリングの作成が失敗する可能性があります。

Request

{
  matchmakingName=[string] GS2-Matchmaking のマッチメイキング名,
  type=[string] マッチメイキング方式(anybody/customauto/passcode/room),
  userId=[string] ギャザリングの作成を行ったユーザID,
  attributes=[array] ギャザリングの属性値,
  accessToken=[string] ギャザリングの作成を行ったユーザのアクセストークン
}

ギャザリングの属性値 の内容はマッチメイキング方式によって異なりますが、各方式で以下の値が設定されます。

Anybody

なし

CustomAuto

  • attribute1=[number] 属性値1

  • attribute2=[number] 属性値2

  • attribute3=[number] 属性値3

  • attribute4=[number] 属性値4

  • attribute5=[number] 属性値5

Passcode

  • passcode=[string] ルームに参加するために使用するパスコード

Room

  • meta=[string] ルームのメタデータ

Response

{
  permit=[bool] ギャザリングの作成を許可するか
}

ギャザリング新規作成完了時

ギャザリングの新規作成が完了した時に呼び出されます。 このイベントが発生した瞬間にはギャザリングの永続化が完了されていることが保証されています。

Request

{
  matchmakingName=[string] GS2-Matchmaking のマッチメイキング名,
  type=[string] マッチメイキング方式(anybody/customauto/passcode/room),
  userId=[string] ギャザリングの作成を行ったユーザID,
  attributes=[array] ギャザリングの属性値,
  accessToken=[string] ギャザリングの作成を行ったユーザのアクセストークン
}

ギャザリング参加時

ギャザリング参加時に呼び出されます。 このイベントが発生した瞬間にはまだギャザリングへの参加は実行されておらず、スクリプトの結果として「参加を許可しない」というレスポンスを返すことが出来ます。 また、このスクリプトをレスポンスした後、何らかのエラーが発生した場合には、ギャザリングへの参加が失敗する可能性があります。

Request

{
  matchmakingName=[string] GS2-Matchmaking のマッチメイキング名,
  type=[string] マッチメイキング方式(anybody/customauto/passcode/room),
  gatheringId=[string] ギャザリングID,
  userId=[string] ギャザリングへの参加を行ったユーザID,
  attributes=[array] ギャザリングの属性値,
  accessToken=[string] ギャザリングへの参加を行ったユーザのアクセストークン
}

ギャザリングの属性値 の内容はマッチメイキング方式によって異なりますが、各方式で以下の値が設定されます。

Anybody

なし

CustomAuto

  • attribute1=[number] 属性値1

  • attribute2=[number] 属性値2

  • attribute3=[number] 属性値3

  • attribute4=[number] 属性値4

  • attribute5=[number] 属性値5

Passcode

  • passcode=[string] ルームに参加するために使用するパスコード

Room

  • meta=[string] ルームのメタデータ

Response

{
  permit=[bool] ギャザリングへの参加を許可するか
}

ギャザリング参加完了時

ギャザリングの参加が完了した時に呼び出されます。 このイベントが発生した瞬間にはギャザリングへの参加が完了されていることが保証されています。

Request

{
  matchmakingName=[string] GS2-Matchmaking のマッチメイキング名,
  type=[string] マッチメイキング方式(anybody/customauto/passcode/room),
  gatheringId=[string] ギャザリングID,
  userId=[string] ギャザリングの作成を行ったユーザID,
  attributes=[array] ギャザリングの属性値,
  accessToken=[string] ギャザリングの作成を行ったユーザのアクセストークン
}

ギャザリング離脱時

ギャザリング離脱時に呼び出されます。 このイベントが発生した瞬間にはまだギャザリングからの離脱は実行されておらず、スクリプトの結果として「離脱を許可しない」というレスポンスを返すことが出来ます。 また、このスクリプトをレスポンスした後、何らかのエラーが発生した場合には、ギャザリングからの離脱が失敗する可能性があります。

Request

{
  matchmakingName=[string] GS2-Matchmaking のマッチメイキング名,
  type=[string] マッチメイキング方式(anybody/customauto/passcode/room),
  gatheringId=[string] ギャザリングID,
  userId=[string] ギャザリングからの離脱を行ったユーザID,
  attributes=[array] ギャザリングの属性値,
  accessToken=[string] ギャザリングからの離脱を行ったユーザのアクセストークン
}

ギャザリングの属性値 の内容はマッチメイキング方式によって異なりますが、各方式で以下の値が設定されます。

Anybody

なし

CustomAuto

  • attribute1=[number] 属性値1

  • attribute2=[number] 属性値2

  • attribute3=[number] 属性値3

  • attribute4=[number] 属性値4

  • attribute5=[number] 属性値5

Passcode

  • passcode=[string] ルームに離脱するために使用するパスコード

Room

  • meta=[string] ルームのメタデータ

Response

{
  permit=[bool] ギャザリングからの離脱を許可するか
}

ギャザリング離脱完了時

ギャザリングの離脱が完了した時に呼び出されます。 このイベントが発生した瞬間にはギャザリングからの離脱が完了されていることが保証されています。

Request

{
  matchmakingName=[string] GS2-Matchmaking のマッチメイキング名,
  type=[string] マッチメイキング方式(anybody/customauto/passcode/room),
  gatheringId=[string] ギャザリングID,
  userId=[string] ギャザリングの作成を行ったユーザID,
  attributes=[array] ギャザリングの属性値,
  accessToken=[string] ギャザリングの作成を行ったユーザのアクセストークン
}

ギャザリング解散時

ギャザリング解散時に呼び出されます。 参加者が全員ギャザリングから離脱した場合、またはギャザリングの作成者がギャザリングを解散した場合に発生します。

Request

{
  matchmakingName=[string] GS2-Matchmaking のマッチメイキング名,
  type=[string] マッチメイキング方式(anybody/customauto/passcode/room),
  gatheringId=[string] ギャザリングID,
}

マッチメイキング完了時

マッチメイキング完了時に呼び出されます。 マッチメイキングが成立した場合に発生します。

Request

{
  matchmakingName=[string] GS2-Matchmaking のマッチメイキング名,
  type=[string] マッチメイキング方式(anybody/customauto/passcode/room),
  gatheringId=[string] ギャザリングID,
  attributes=[array] ギャザリングの属性値,
  joinPlayers=[array<string>] 参加しているユーザIDリスト
}

ギャザリングの属性値 の内容はマッチメイキング方式によって異なりますが、各方式で以下の値が設定されます。

Anybody

なし

CustomAuto

  • attribute1=[number] 属性値1

  • attribute2=[number] 属性値2

  • attribute3=[number] 属性値3

  • attribute4=[number] 属性値4

  • attribute5=[number] 属性値5

Passcode

  • passcode=[string] ルームに解散するために使用するパスコード

Room

  • meta=[string] ルームのメタデータ