GS2-ConsumableItem¶

目次

アイテム入手時
- Request
- Response
アイテム入手完了時
- Request
- Response
アイテム消費時
- Request
- Response
アイテム消費完了時
- Request
- Response

アイテム入手時 ¶

アイテム入手時に呼び出されます。このイベントが発生した瞬間にはまだアイテムの加算は実行されておらず、スクリプトの結果として「作成を許可しない」というレスポンスを返すことが出来ます。また、このスクリプトをレスポンスした直後、インベントリの永続化処理時に何らかのエラーが発生した場合には、アイテムの加算が失敗する可能性があります。

Request ¶

{
  itemPoolName=[string] GS2-ConsumableItem のアイテムプール名,
  itemName=[string] GS2-ConsumableItem のアイテム名,
  userId=[string] ユーザID,
  count=[number] 入手数量,
  accessToken=[string] アクセストークン
}

Response ¶

{
  permit=[bool] アイテムの加算を許可するか,
  (overrideCount=[number] 実際に適用する入手数量)
}

アイテム入手完了時 ¶

アイテムの入手が完了した時に呼び出されます。このイベントが発生した瞬間にはインベントリの永続化が完了されていることが保証されています。

Request ¶

{
  itemPoolName=[string] GS2-ConsumableItem のアイテムプール名,
  itemName=[string] GS2-ConsumableItem のアイテム名,
  userId=[string] ユーザID,
  count=[number] 入手数量,
  accessToken=[string] アクセストークン
}

Response ¶

{
}

アイテム消費時 ¶

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

Request ¶

{
  itemPoolName=[string] GS2-ConsumableItem のアイテムプール名,
  itemName=[string] GS2-ConsumableItem のアイテム名,
  userId=[string] ユーザID,
  count=[number] 消費数量,
  accessToken=[string] アクセストークン
}

Response ¶

{
  permit=[bool] アイテムの消費を許可するか,
  (overrideCount=[number] 実際に適用する消費数量)
}

アイテム消費完了時 ¶

アイテムの消費が完了した時に呼び出されます。このイベントが発生した瞬間にはインベントリの永続化が完了されていることが保証されています。

Request ¶

{
  itemPoolName=[string] GS2-ConsumableItem のアイテムプール名,
  itemName=[string] GS2-ConsumableItem のアイテム名,
  userId=[string] ユーザID,
  count=[number] 消費数量,
  accessToken=[string] アクセストークン
}

Response ¶

{
}