GS2-Stamina

スタミナ消費時

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

Request

{
  staminaPoolName=[string] GS2-Stamina のスタミナプール名,
  userId=[string] スタミナの消費を行ったユーザID,
  maxValue=[number] スタミナの最大値,
  value=[number] スタミナの消費量,
  accessToken=[string] スタミナの消費を行ったユーザのアクセストークン
}

Response

{
  permit=[bool] スタミナの消費を許可するか,
  (overrideValue=[number] 実際に適用するスタミナの消費量)
}

スタミナ消費完了時

スタミナの消費が完了した時に呼び出されます。 このイベントが発生した瞬間にはスタミナの消費が完了されていることが保証されています。

Request

{
  staminaPoolName=[string] GS2-Stamina のスタミナプール名,
  userId=[string] スタミナの消費を行ったユーザID,
  maxValue=[number] スタミナの最大値,
  consumeValue=[number] スタミナの消費量,
  currentValue=[number] 消費後のスタミナ値,
  currentOverflow=[number] 最大値を超えて保持しているスタミナ値,
  accessToken=[string] スタミナの消費を行ったユーザのアクセストークン
}

スタミナ回復時

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

Request

{
  staminaPoolName=[string] GS2-Stamina のスタミナプール名,
  userId=[string] スタミナの回復を行ったユーザID,
  maxValue=[number] スタミナの最大値,
  value=[number] スタミナの回復量,
  accessToken=[string] スタミナの回復を行ったユーザのアクセストークン
}

Response

{
  permit=[bool] スタミナの回復を許可するか,
  (overrideValue=[number] 実際に適用するスタミナの回復量)
}

スタミナ回復完了時

スタミナの回復が完了した時に呼び出されます。自然回復では呼び出されません。 このイベントが発生した瞬間にはスタミナの回復が完了されていることが保証されています。

Request

{
  staminaPoolName=[string] GS2-Stamina のスタミナプール名,
  userId=[string] スタミナの回復を行ったユーザID,
  maxValue=[number] スタミナの最大値,
  consumeValue=[number] スタミナの回復量,
  currentValue=[number] 回復後のスタミナ値,
  currentOverflow=[number] 最大値を超えて保持しているスタミナ値,
  accessToken=[string] スタミナの回復を行ったユーザのアクセストークン
}

スタミナ最大値取得

スタミナ最大値取得時に呼び出されます。 GS2-SDK のクライアント向けSDK で標準で提供されている手段は、クライアントの申告したスタミナ最大値を元に現在のスタミナ値の計算を行います。 しかし、この場合はクライアントの改ざんを行うことでスタミナの最大値を偽装することが出来ます。 このスクリプトを通してスタミナ値の最大値の制御を行うことで、そのような改ざんを行えなくすることが出来ます。

Request

{
  staminaPoolName=[string] GS2-Stamina のスタミナプール名,
  userId=[string] スタミナの最大値取得を行ったユーザID,
  accessToken=[string] スタミナの最大値取得を行ったユーザのアクセストークン
}

Response

{
  maxValue=[number] スタミナの最大値
}